Compare commits
23 Commits
Author | SHA1 | Date | |
---|---|---|---|
098845bccd | |||
0f526f05ab | |||
24b1d1e4be | |||
1c1ad7d0f9 | |||
05efa96950 | |||
46d1c2fa1a | |||
9b1db3f461 | |||
2d6ebedb0f | |||
12d9acfdb3 | |||
537285b0b1 | |||
d23068be44 | |||
c88402491b | |||
36f93ee1a6 | |||
752a8492c7 | |||
cfac507e9c | |||
9a05fd8b8d | |||
24e337834f | |||
c36625cb56 | |||
a067f0ee4c | |||
28f833757e | |||
04e535038e | |||
09cbe40f67 | |||
9baca36b2c |
@ -4,8 +4,6 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- master
|
||||||
tags:
|
|
||||||
- v*
|
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
@ -14,9 +12,8 @@ jobs:
|
|||||||
name: Main Process
|
name: Main Process
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
env:
|
env:
|
||||||
GO_VERSION: 1.15
|
GO_VERSION: 1.19
|
||||||
GOLANGCI_LINT_VERSION: v1.33.0
|
GOLANGCI_LINT_VERSION: v1.49.0
|
||||||
SEIHON_VERSION: v0.5.1
|
|
||||||
CGO_ENABLED: 0
|
CGO_ENABLED: 0
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
@ -47,7 +44,6 @@ jobs:
|
|||||||
go mod tidy
|
go mod tidy
|
||||||
git diff --exit-code go.mod
|
git diff --exit-code go.mod
|
||||||
git diff --exit-code go.sum
|
git diff --exit-code go.sum
|
||||||
go mod download
|
|
||||||
|
|
||||||
# https://golangci-lint.run/usage/install#other-ci
|
# https://golangci-lint.run/usage/install#other-ci
|
||||||
- name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }}
|
- name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }}
|
||||||
@ -60,22 +56,3 @@ jobs:
|
|||||||
|
|
||||||
- name: Make Image
|
- name: Make Image
|
||||||
run: make image
|
run: make image
|
||||||
|
|
||||||
# Install Docker image multi-arch builder
|
|
||||||
- name: Install seihon ${{ env.SEIHON_VERSION }}
|
|
||||||
if: startsWith(github.ref, 'refs/tags/v')
|
|
||||||
run: |
|
|
||||||
curl -sSfL https://raw.githubusercontent.com/ldez/seihon/master/godownloader.sh | sh -s -- -b $(go env GOPATH)/bin ${SEIHON_VERSION}
|
|
||||||
seihon --version
|
|
||||||
|
|
||||||
- name: Docker Login
|
|
||||||
if: startsWith(github.ref, 'refs/tags/v')
|
|
||||||
env:
|
|
||||||
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
|
||||||
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
|
|
||||||
run: |
|
|
||||||
echo "${DOCKER_PASSWORD}" | docker login --username "${DOCKER_USERNAME}" --password-stdin
|
|
||||||
|
|
||||||
- name: Deploy Docker Images (seihon)
|
|
||||||
if: startsWith(github.ref, 'refs/tags/v')
|
|
||||||
run: make publish-images
|
|
21
.github/workflows/go-cross.yml
vendored
21
.github/workflows/go-cross.yml
vendored
@ -1,5 +1,9 @@
|
|||||||
name: Go Matrix
|
name: Go Matrix
|
||||||
on: [push, pull_request]
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
|
||||||
@ -11,7 +15,7 @@ jobs:
|
|||||||
|
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
go-version: [ 1.14, 1.15, 1.x ]
|
go-version: [ 1.19, 1.x ]
|
||||||
os: [ubuntu-latest, macos-latest, windows-latest]
|
os: [ubuntu-latest, macos-latest, windows-latest]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
@ -29,11 +33,16 @@ jobs:
|
|||||||
- name: Cache Go modules
|
- name: Cache Go modules
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
with:
|
with:
|
||||||
|
# In order:
|
||||||
|
# * Module download cache
|
||||||
|
# * Build cache (Linux)
|
||||||
|
# * Build cache (Mac)
|
||||||
|
# * Build cache (Windows)
|
||||||
path: |
|
path: |
|
||||||
~/go/pkg/mod # Module download cache
|
~/go/pkg/mod
|
||||||
~/.cache/go-build # Build cache (Linux)
|
~/.cache/go-build
|
||||||
~/Library/Caches/go-build # Build cache (Mac)
|
~/Library/Caches/go-build
|
||||||
'%LocalAppData%\go-build' # Build cache (Windows)
|
%LocalAppData%\go-build
|
||||||
key: ${{ runner.os }}-${{ matrix.go-version }}-go-${{ hashFiles('**/go.sum') }}
|
key: ${{ runner.os }}-${{ matrix.go-version }}-go-${{ hashFiles('**/go.sum') }}
|
||||||
restore-keys: |
|
restore-keys: |
|
||||||
${{ runner.os }}-${{ matrix.go-version }}-go-
|
${{ runner.os }}-${{ matrix.go-version }}-go-
|
||||||
|
50
.github/workflows/release.yml
vendored
Normal file
50
.github/workflows/release.yml
vendored
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
name: "Release a tag"
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- v*
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
name: Release Process
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
env:
|
||||||
|
GO_VERSION: 1.19
|
||||||
|
SEIHON_VERSION: v0.9.0
|
||||||
|
CGO_ENABLED: 0
|
||||||
|
|
||||||
|
steps:
|
||||||
|
|
||||||
|
# https://github.com/marketplace/actions/setup-go-environment
|
||||||
|
- name: Set up Go ${{ env.GO_VERSION }}
|
||||||
|
uses: actions/setup-go@v2
|
||||||
|
with:
|
||||||
|
go-version: ${{ env.GO_VERSION }}
|
||||||
|
|
||||||
|
# https://github.com/marketplace/actions/checkout
|
||||||
|
- name: Check out code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Docker Login
|
||||||
|
env:
|
||||||
|
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
||||||
|
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
|
||||||
|
run: |
|
||||||
|
echo "${DOCKER_PASSWORD}" | docker login --username "${DOCKER_USERNAME}" --password-stdin
|
||||||
|
|
||||||
|
- name: Set up QEMU
|
||||||
|
uses: docker/setup-qemu-action@v2
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v2
|
||||||
|
|
||||||
|
# https://goreleaser.com/ci/actions/
|
||||||
|
- name: Run GoReleaser
|
||||||
|
uses: goreleaser/goreleaser-action@v2
|
||||||
|
with:
|
||||||
|
version: latest
|
||||||
|
args: release --rm-dist
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GH_TOKEN_REPO }}
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,3 +1,4 @@
|
|||||||
.idea
|
.idea
|
||||||
vendor/
|
vendor/
|
||||||
/whoami
|
/whoami
|
||||||
|
dist/
|
||||||
|
@ -1,49 +0,0 @@
|
|||||||
[run]
|
|
||||||
deadline = "2m"
|
|
||||||
skip-files = []
|
|
||||||
|
|
||||||
[linters-settings]
|
|
||||||
|
|
||||||
[linters-settings.govet]
|
|
||||||
check-shadowing = true
|
|
||||||
|
|
||||||
[linters-settings.gocyclo]
|
|
||||||
min-complexity = 12.0
|
|
||||||
|
|
||||||
[linters-settings.maligned]
|
|
||||||
suggest-new = true
|
|
||||||
|
|
||||||
[linters-settings.goconst]
|
|
||||||
min-len = 3.0
|
|
||||||
min-occurrences = 3.0
|
|
||||||
|
|
||||||
[linters-settings.misspell]
|
|
||||||
locale = "US"
|
|
||||||
|
|
||||||
[linters]
|
|
||||||
enable-all = true
|
|
||||||
disable = [
|
|
||||||
"maligned",
|
|
||||||
"lll",
|
|
||||||
"gosec",
|
|
||||||
"dupl",
|
|
||||||
"prealloc",
|
|
||||||
"gochecknoglobals",
|
|
||||||
"gochecknoinits",
|
|
||||||
"gomnd",
|
|
||||||
"wsl",
|
|
||||||
"nlreturn",
|
|
||||||
"testpackage",
|
|
||||||
"paralleltest",
|
|
||||||
"tparallel",
|
|
||||||
"goerr113",
|
|
||||||
"wrapcheck",
|
|
||||||
"exhaustive",
|
|
||||||
"exhaustivestruct",
|
|
||||||
]
|
|
||||||
|
|
||||||
[issues]
|
|
||||||
exclude-use-default = false
|
|
||||||
max-per-linter = 0
|
|
||||||
max-same-issues = 0
|
|
||||||
exclude = []
|
|
93
.golangci.yml
Normal file
93
.golangci.yml
Normal file
@ -0,0 +1,93 @@
|
|||||||
|
run:
|
||||||
|
timeout: 2m
|
||||||
|
skip-files: []
|
||||||
|
|
||||||
|
linters-settings:
|
||||||
|
govet:
|
||||||
|
enable-all: true
|
||||||
|
disable:
|
||||||
|
- fieldalignment
|
||||||
|
gocyclo:
|
||||||
|
min-complexity: 16
|
||||||
|
goconst:
|
||||||
|
min-len: 3
|
||||||
|
min-occurrences: 3
|
||||||
|
misspell:
|
||||||
|
locale: US
|
||||||
|
funlen:
|
||||||
|
lines: -1
|
||||||
|
statements: 40
|
||||||
|
gofumpt:
|
||||||
|
extra-rules: true
|
||||||
|
depguard:
|
||||||
|
list-type: blacklist
|
||||||
|
include-go-root: false
|
||||||
|
packages:
|
||||||
|
- github.com/pkg/errors
|
||||||
|
godox:
|
||||||
|
keywords:
|
||||||
|
- FIXME
|
||||||
|
gocritic:
|
||||||
|
enabled-tags:
|
||||||
|
- diagnostic
|
||||||
|
- style
|
||||||
|
- performance
|
||||||
|
disabled-checks:
|
||||||
|
- sloppyReassign
|
||||||
|
- rangeValCopy
|
||||||
|
- octalLiteral
|
||||||
|
- paramTypeCombine # already handle by gofumpt.extra-rules
|
||||||
|
settings:
|
||||||
|
hugeParam:
|
||||||
|
sizeThreshold: 100
|
||||||
|
forbidigo:
|
||||||
|
forbid:
|
||||||
|
- '^print(ln)?$'
|
||||||
|
- '^panic$'
|
||||||
|
- '^spew\.Print(f|ln)?$'
|
||||||
|
- '^spew\.Dump$'
|
||||||
|
|
||||||
|
linters:
|
||||||
|
enable-all: true
|
||||||
|
disable:
|
||||||
|
- deadcode # deprecated
|
||||||
|
- exhaustivestruct # deprecated
|
||||||
|
- golint # deprecated
|
||||||
|
- ifshort # deprecated
|
||||||
|
- interfacer # deprecated
|
||||||
|
- maligned # deprecated
|
||||||
|
- nosnakecase # deprecated
|
||||||
|
- scopelint # deprecated
|
||||||
|
- scopelint # deprecated
|
||||||
|
- structcheck # deprecated
|
||||||
|
- varcheck # deprecated
|
||||||
|
- execinquery # not relevant (SQL)
|
||||||
|
- rowserrcheck # not relevant (SQL)
|
||||||
|
- sqlclosecheck # not relevant (SQL)
|
||||||
|
- cyclop # duplicate of gocyclo
|
||||||
|
- dupl
|
||||||
|
- exhaustive
|
||||||
|
- exhaustruct
|
||||||
|
- forbidigo
|
||||||
|
- gochecknoglobals
|
||||||
|
- gochecknoinits
|
||||||
|
- goerr113
|
||||||
|
- gomnd
|
||||||
|
- gosec
|
||||||
|
- lll
|
||||||
|
- nilnil
|
||||||
|
- nlreturn
|
||||||
|
- paralleltest
|
||||||
|
- prealloc
|
||||||
|
- testpackage
|
||||||
|
- tparallel
|
||||||
|
- varnamelen
|
||||||
|
- wrapcheck
|
||||||
|
- wsl
|
||||||
|
|
||||||
|
issues:
|
||||||
|
exclude-use-default: false
|
||||||
|
max-per-linter: 0
|
||||||
|
max-same-issues: 0
|
||||||
|
exclude:
|
||||||
|
- 'package-comments: should have a package comment'
|
86
.goreleaser.yml
Normal file
86
.goreleaser.yml
Normal file
@ -0,0 +1,86 @@
|
|||||||
|
project_name: whoami
|
||||||
|
|
||||||
|
builds:
|
||||||
|
- binary: whoami
|
||||||
|
goos:
|
||||||
|
- windows
|
||||||
|
- darwin
|
||||||
|
- linux
|
||||||
|
goarch:
|
||||||
|
- amd64
|
||||||
|
- arm
|
||||||
|
- arm64
|
||||||
|
goarm:
|
||||||
|
- '7'
|
||||||
|
|
||||||
|
changelog:
|
||||||
|
sort: asc
|
||||||
|
filters:
|
||||||
|
exclude:
|
||||||
|
- '^docs:'
|
||||||
|
- '^doc:'
|
||||||
|
- '^chore:'
|
||||||
|
- '^chore(deps):'
|
||||||
|
- '^test:'
|
||||||
|
- '^tests:'
|
||||||
|
|
||||||
|
archives:
|
||||||
|
- id: whoami
|
||||||
|
name_template: '{{ .ProjectName }}_v{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm}}v{{ .Arm }}{{ end }}'
|
||||||
|
format: tar.gz
|
||||||
|
format_overrides:
|
||||||
|
- goos: windows
|
||||||
|
format: zip
|
||||||
|
files:
|
||||||
|
- LICENSE
|
||||||
|
|
||||||
|
docker_manifests:
|
||||||
|
- name_template: 'traefik/whoami:{{ .Tag }}'
|
||||||
|
image_templates:
|
||||||
|
- 'traefik/whoami:{{ .Tag }}-amd64'
|
||||||
|
- 'traefik/whoami:{{ .Tag }}-arm64'
|
||||||
|
- name_template: 'traefik/whoami:latest'
|
||||||
|
image_templates:
|
||||||
|
- 'traefik/whoami:{{ .Tag }}-amd64'
|
||||||
|
- 'traefik/whoami:{{ .Tag }}-arm64'
|
||||||
|
- name_template: 'traefik/whoami:v{{ .Major }}.{{ .Minor }}'
|
||||||
|
image_templates:
|
||||||
|
- 'traefik/whoami:v{{ .Major }}.{{ .Minor }}-amd64'
|
||||||
|
- 'traefik/whoami:v{{ .Major }}.{{ .Minor }}-arm64'
|
||||||
|
|
||||||
|
dockers:
|
||||||
|
- use: buildx
|
||||||
|
goos: linux
|
||||||
|
goarch: amd64
|
||||||
|
dockerfile: buildx.Dockerfile
|
||||||
|
image_templates:
|
||||||
|
- 'traefik/whoami:latest-amd64'
|
||||||
|
- 'traefik/whoami:{{ .Tag }}-amd64'
|
||||||
|
- 'traefik/whoami:v{{ .Major }}.{{ .Minor }}-amd64'
|
||||||
|
build_flag_templates:
|
||||||
|
- '--pull'
|
||||||
|
- '--label=org.opencontainers.image.description=Tiny Go webserver that prints OS information and HTTP request to output'
|
||||||
|
- '--label=org.opencontainers.image.created={{.Date}}'
|
||||||
|
- '--label=org.opencontainers.image.title={{.ProjectName}}'
|
||||||
|
- '--label=org.opencontainers.image.revision={{.FullCommit}}'
|
||||||
|
- '--label=org.opencontainers.image.version={{.Version}}'
|
||||||
|
- '--label=org.opencontainers.image.source={{.GitURL}}'
|
||||||
|
- '--platform=linux/amd64'
|
||||||
|
|
||||||
|
- use: buildx
|
||||||
|
goos: linux
|
||||||
|
goarch: arm64
|
||||||
|
dockerfile: buildx.Dockerfile
|
||||||
|
image_templates:
|
||||||
|
- 'traefik/whoami:latest-arm64'
|
||||||
|
- 'traefik/whoami:{{ .Tag }}-arm64'
|
||||||
|
- 'traefik/whoami:v{{ .Major }}.{{ .Minor }}-arm64'
|
||||||
|
build_flag_templates:
|
||||||
|
- '--pull'
|
||||||
|
- '--label=org.opencontainers.image.description=Tiny Go webserver that prints OS information and HTTP request to output'
|
||||||
|
- '--label=org.opencontainers.image.created={{.Date}}'
|
||||||
|
- '--label=org.opencontainers.image.title={{.ProjectName}}'
|
||||||
|
- '--label=org.opencontainers.image.revision={{.FullCommit}}'
|
||||||
|
- '--label=org.opencontainers.image.version={{.Version}}'
|
||||||
|
- '--label=org.opencontainers.image.source={{.GitURL}}'
|
||||||
|
- '--platform=linux/arm64'
|
4
LICENSE
4
LICENSE
@ -186,8 +186,8 @@
|
|||||||
same "printed page" as the copyright notice for easier
|
same "printed page" as the copyright notice for easier
|
||||||
identification within third-party archives.
|
identification within third-party archives.
|
||||||
|
|
||||||
Copyright [2015-2018] [Containous]
|
Copyright [2015-2019] [Containous]
|
||||||
Copyright [2020] [Traefik Labs]
|
Copyright [2020-2022] [Traefik Labs]
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
|
2
Makefile
2
Makefile
@ -1,4 +1,4 @@
|
|||||||
.PHONY: default build image check publish-images
|
.PHONY: default check test build image publish-images
|
||||||
|
|
||||||
TAG_NAME := $(shell git tag -l --contains HEAD)
|
TAG_NAME := $(shell git tag -l --contains HEAD)
|
||||||
|
|
||||||
|
63
README.md
63
README.md
@ -3,27 +3,54 @@
|
|||||||
[](https://hub.docker.com/r/traefik/whoami/)
|
[](https://hub.docker.com/r/traefik/whoami/)
|
||||||
[](https://github.com/traefik/whoami/actions)
|
[](https://github.com/traefik/whoami/actions)
|
||||||
|
|
||||||
Tiny Go webserver that prints os information and HTTP request to output
|
Tiny Go webserver that prints OS information and HTTP request to output.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Paths
|
### Paths
|
||||||
|
|
||||||
- `/data?size=n[&unit=u]`: creates a response with a size `n`. The unit of measure, if specified, accepts the following values: `KB`, `MB`, `GB`, `TB` (optional, default: bytes).
|
#### `/[?wait=d]`
|
||||||
- `/echo`: webSocket echo.
|
|
||||||
- `/bench`: always return the same response (`1`).
|
Returns the whoami information (request and network information).
|
||||||
- `/[?wait=d]`: returns the whoami information (request and network information). The optional `wait` query parameter can be provided to tell the server to wait before sending the response. The duration is expected in Go's [`time.Duration`](https://golang.org/pkg/time/#ParseDuration) format (e.g. `/?wait=100ms` to wait 100 milliseconds).
|
|
||||||
- `/api`: returns the whoami information as JSON.
|
The optional `wait` query parameter can be provided to tell the server to wait before sending the response.
|
||||||
- `/health`: heath check
|
The duration is expected in Go's [`time.Duration`](https://golang.org/pkg/time/#ParseDuration) format (e.g. `/?wait=100ms` to wait 100 milliseconds).
|
||||||
|
|
||||||
|
#### `/api`
|
||||||
|
|
||||||
|
Returns the whoami information as JSON.
|
||||||
|
|
||||||
|
#### `/bench`
|
||||||
|
|
||||||
|
Always return the same response (`1`).
|
||||||
|
|
||||||
|
#### `/data?size=n[&unit=u]`
|
||||||
|
|
||||||
|
Creates a response with a size `n`.
|
||||||
|
|
||||||
|
The unit of measure, if specified, accepts the following values: `KB`, `MB`, `GB`, `TB` (optional, default: bytes).
|
||||||
|
|
||||||
|
#### `/echo`
|
||||||
|
|
||||||
|
WebSocket echo.
|
||||||
|
|
||||||
|
#### `/health`
|
||||||
|
|
||||||
|
Heath check.
|
||||||
|
|
||||||
- `GET`, `HEAD`, ...: returns a response with the status code defined by the `POST`
|
- `GET`, `HEAD`, ...: returns a response with the status code defined by the `POST`
|
||||||
- `POST`: changes the status code of the `GET` (`HEAD`, ...) response.
|
- `POST`: changes the status code of the `GET` (`HEAD`, ...) response.
|
||||||
|
|
||||||
### Flags
|
### Flags
|
||||||
|
|
||||||
- `cert`: give me a certificate.
|
| Flag | Env var | Description |
|
||||||
- `key`: give me a key.
|
|-----------|----------------------|-----------------------------------------|
|
||||||
- `port`: give me a port number. (default: 80)
|
| `cert` | | Give me a certificate. |
|
||||||
- `name`: give me a name. (it can be also defined with `WHOAMI_NAME` environment variable)
|
| `key` | | Give me a key. |
|
||||||
|
| `cacert` | | Give me a CA chain, enforces mutual TLS |
|
||||||
|
| `port` | `WHOAMI_PORT_NUMBER` | Give me a port number. (default: `80`) |
|
||||||
|
| `name` | `WHOAMI_NAME` | Give me a name. |
|
||||||
|
| `verbose` | | Enable verbose logging. |
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@ -66,5 +93,17 @@ $ curl -v http://localhost:80/health
|
|||||||
```
|
```
|
||||||
|
|
||||||
```console
|
```console
|
||||||
docker run -d -P -v ./certs:/certs --name iamfoo traefik/whoami --cert /certs/cert.cer --key /certs/key.key
|
docker run -d -P -v ./certs:/certs --name iamfoo traefik/whoami --cert /certs/example.cert --key /certs/example.key
|
||||||
|
```
|
||||||
|
|
||||||
|
```yml
|
||||||
|
version: '3.9'
|
||||||
|
|
||||||
|
services:
|
||||||
|
whoami:
|
||||||
|
image: traefik/whoami
|
||||||
|
command:
|
||||||
|
# It tells whoami to start listening on 2001 instead of 80
|
||||||
|
- --port 2001
|
||||||
|
- --name iamfoo
|
||||||
```
|
```
|
||||||
|
94
app.go
94
app.go
@ -1,7 +1,8 @@
|
|||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"crypto/tls"
|
||||||
|
"crypto/x509"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
@ -31,14 +32,18 @@ const (
|
|||||||
var (
|
var (
|
||||||
cert string
|
cert string
|
||||||
key string
|
key string
|
||||||
|
ca string
|
||||||
port string
|
port string
|
||||||
name string
|
name string
|
||||||
|
verbose bool
|
||||||
)
|
)
|
||||||
|
|
||||||
func init() {
|
func init() {
|
||||||
|
flag.BoolVar(&verbose, "verbose", false, "Enable verbose logging")
|
||||||
flag.StringVar(&cert, "cert", "", "give me a certificate")
|
flag.StringVar(&cert, "cert", "", "give me a certificate")
|
||||||
flag.StringVar(&key, "key", "", "give me a key")
|
flag.StringVar(&key, "key", "", "give me a key")
|
||||||
flag.StringVar(&port, "port", "80", "give me a port number")
|
flag.StringVar(&ca, "cacert", "", "give me a CA chain, enforces mutual TLS")
|
||||||
|
flag.StringVar(&port, "port", getEnv("WHOAMI_PORT_NUMBER", "80"), "give me a port number")
|
||||||
flag.StringVar(&name, "name", os.Getenv("WHOAMI_NAME"), "give me a name")
|
flag.StringVar(&name, "name", os.Getenv("WHOAMI_NAME"), "give me a name")
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -50,19 +55,64 @@ var upgrader = websocket.Upgrader{
|
|||||||
func main() {
|
func main() {
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
|
|
||||||
http.HandleFunc("/data", dataHandler)
|
mux := http.NewServeMux()
|
||||||
http.HandleFunc("/echo", echoHandler)
|
mux.Handle("/data", handle(dataHandler, verbose))
|
||||||
http.HandleFunc("/bench", benchHandler)
|
mux.Handle("/echo", handle(echoHandler, verbose))
|
||||||
http.HandleFunc("/", whoamiHandler)
|
mux.Handle("/bench", handle(benchHandler, verbose))
|
||||||
http.HandleFunc("/api", apiHandler)
|
mux.Handle("/api", handle(apiHandler, verbose))
|
||||||
http.HandleFunc("/health", healthHandler)
|
mux.Handle("/health", handle(healthHandler, verbose))
|
||||||
|
mux.Handle("/", handle(whoamiHandler, verbose))
|
||||||
|
|
||||||
fmt.Println("Starting up on port " + port)
|
if cert == "" || key == "" {
|
||||||
|
log.Printf("Starting up on port %s", port)
|
||||||
|
|
||||||
if len(cert) > 0 && len(key) > 0 {
|
log.Fatal(http.ListenAndServe(":"+port, mux))
|
||||||
log.Fatal(http.ListenAndServeTLS(":"+port, cert, key, nil))
|
|
||||||
}
|
}
|
||||||
log.Fatal(http.ListenAndServe(":"+port, nil))
|
|
||||||
|
server := &http.Server{
|
||||||
|
Addr: ":" + port,
|
||||||
|
Handler: mux,
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(ca) > 0 {
|
||||||
|
server.TLSConfig = setupMutualTLS(ca)
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Printf("Starting up with TLS on port %s", port)
|
||||||
|
|
||||||
|
log.Fatal(server.ListenAndServeTLS(cert, key))
|
||||||
|
}
|
||||||
|
|
||||||
|
func setupMutualTLS(ca string) *tls.Config {
|
||||||
|
clientCACert, err := os.ReadFile(ca)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
clientCertPool := x509.NewCertPool()
|
||||||
|
clientCertPool.AppendCertsFromPEM(clientCACert)
|
||||||
|
|
||||||
|
tlsConfig := &tls.Config{
|
||||||
|
ClientAuth: tls.RequireAndVerifyClientCert,
|
||||||
|
ClientCAs: clientCertPool,
|
||||||
|
PreferServerCipherSuites: true,
|
||||||
|
MinVersion: tls.VersionTLS12,
|
||||||
|
}
|
||||||
|
|
||||||
|
return tlsConfig
|
||||||
|
}
|
||||||
|
|
||||||
|
func handle(next http.HandlerFunc, verbose bool) http.Handler {
|
||||||
|
if !verbose {
|
||||||
|
return next
|
||||||
|
}
|
||||||
|
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
next(w, r)
|
||||||
|
|
||||||
|
// <remote_IP_address> - [<timestamp>] "<request_method> <request_path> <request_protocol>" -
|
||||||
|
log.Printf("%s - - [%s] \"%s %s %s\" - -", r.RemoteAddr, time.Now().Format("02/Jan/2006:15:04:05 -0700"), r.Method, r.URL.Path, r.Proto)
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func benchHandler(w http.ResponseWriter, _ *http.Request) {
|
func benchHandler(w http.ResponseWriter, _ *http.Request) {
|
||||||
@ -129,7 +179,7 @@ func dataHandler(w http.ResponseWriter, r *http.Request) {
|
|||||||
attachment = false
|
attachment = false
|
||||||
}
|
}
|
||||||
|
|
||||||
content := fillContent(size)
|
content := &contentReader{size: size}
|
||||||
|
|
||||||
if attachment {
|
if attachment {
|
||||||
w.Header().Set("Content-Disposition", "Attachment")
|
w.Header().Set("Content-Disposition", "Attachment")
|
||||||
@ -259,18 +309,10 @@ func healthHandler(w http.ResponseWriter, req *http.Request) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func fillContent(length int64) io.ReadSeeker {
|
func getEnv(key, fallback string) string {
|
||||||
charset := "-ABCDEFGHIJKLMNOPQRSTUVWXYZ"
|
value := os.Getenv(key)
|
||||||
b := make([]byte, length)
|
if value == "" {
|
||||||
|
return fallback
|
||||||
for i := range b {
|
|
||||||
b[i] = charset[i%len(charset)]
|
|
||||||
}
|
}
|
||||||
|
return value
|
||||||
if length > 0 {
|
|
||||||
b[0] = '|'
|
|
||||||
b[length-1] = '|'
|
|
||||||
}
|
|
||||||
|
|
||||||
return bytes.NewReader(b)
|
|
||||||
}
|
}
|
||||||
|
@ -1,25 +1,17 @@
|
|||||||
|
# syntax=docker/dockerfile:1.2
|
||||||
FROM golang:1-alpine as builder
|
FROM golang:1-alpine as builder
|
||||||
|
|
||||||
RUN apk --no-cache --no-progress add git ca-certificates tzdata make \
|
RUN apk --no-cache --no-progress add git ca-certificates tzdata make \
|
||||||
&& update-ca-certificates \
|
&& update-ca-certificates \
|
||||||
&& rm -rf /var/cache/apk/*
|
&& rm -rf /var/cache/apk/*
|
||||||
|
|
||||||
WORKDIR /go/whoami
|
# syntax=docker/dockerfile:1.2
|
||||||
|
# Create a minimal container to run a Golang static binary
|
||||||
# Download go modules
|
|
||||||
COPY go.mod .
|
|
||||||
COPY go.sum .
|
|
||||||
RUN GO111MODULE=on GOPROXY=https://proxy.golang.org go mod download
|
|
||||||
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
RUN GOARCH={{ .GoARCH }} GOARM={{ .GoARM }} make build
|
|
||||||
|
|
||||||
FROM scratch
|
FROM scratch
|
||||||
|
|
||||||
COPY --from=builder /usr/share/zoneinfo /usr/share/zoneinfo
|
COPY --from=builder /usr/share/zoneinfo /usr/share/zoneinfo
|
||||||
COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
|
COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
|
||||||
COPY --from=builder /go/whoami/whoami .
|
COPY whoami /
|
||||||
|
|
||||||
ENTRYPOINT ["/whoami"]
|
ENTRYPOINT ["/whoami"]
|
||||||
EXPOSE 80
|
EXPOSE 80
|
66
content.go
Normal file
66
content.go
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
)
|
||||||
|
|
||||||
|
const contentCharset = "-ABCDEFGHIJKLMNOPQRSTUVWXYZ"
|
||||||
|
|
||||||
|
type contentReader struct {
|
||||||
|
size int64
|
||||||
|
cur int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read implements the io.Read interface.
|
||||||
|
func (r *contentReader) Read(p []byte) (int, error) {
|
||||||
|
length := r.size - 1
|
||||||
|
|
||||||
|
if r.cur >= length {
|
||||||
|
return 0, io.EOF
|
||||||
|
}
|
||||||
|
if len(p) == 0 {
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var n int
|
||||||
|
if r.cur == 0 {
|
||||||
|
p[n] = '|'
|
||||||
|
r.cur++
|
||||||
|
n++
|
||||||
|
}
|
||||||
|
|
||||||
|
for n < len(p) && r.cur <= length {
|
||||||
|
p[n] = contentCharset[int(r.cur)%len(contentCharset)]
|
||||||
|
r.cur++
|
||||||
|
n++
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.cur >= length {
|
||||||
|
p[n-1] = '|'
|
||||||
|
}
|
||||||
|
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Seek implements the io.Seek interface.
|
||||||
|
func (r *contentReader) Seek(offset int64, whence int) (int64, error) {
|
||||||
|
switch whence {
|
||||||
|
default:
|
||||||
|
return 0, errors.New("seek: invalid whence")
|
||||||
|
case io.SeekStart:
|
||||||
|
offset += 0
|
||||||
|
case io.SeekCurrent:
|
||||||
|
offset += r.cur
|
||||||
|
case io.SeekEnd:
|
||||||
|
offset += r.size - 1
|
||||||
|
}
|
||||||
|
|
||||||
|
if offset < 0 {
|
||||||
|
return 0, errors.New("seek: invalid offset")
|
||||||
|
}
|
||||||
|
|
||||||
|
r.cur = offset
|
||||||
|
|
||||||
|
return offset, nil
|
||||||
|
}
|
82
content_test.go
Normal file
82
content_test.go
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func Test_contentReader_Read(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
size int64
|
||||||
|
content string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "simple",
|
||||||
|
size: 40,
|
||||||
|
content: "|ABCDEFGHIJKLMNOPQRSTUVWXYZ-ABCDEFGHIJK|",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, test := range tests {
|
||||||
|
test := test
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
d := &contentReader{size: test.size}
|
||||||
|
|
||||||
|
b, err := io.ReadAll(d)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("contentReader.Read() error = %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if string(b) != test.content {
|
||||||
|
t.Errorf("return content does not match expected value: got %s want %s", b, test.content)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_contentReader_ReadSeek(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
offset int64
|
||||||
|
seekWhence int
|
||||||
|
size int64
|
||||||
|
content string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "simple",
|
||||||
|
offset: 10,
|
||||||
|
seekWhence: io.SeekCurrent,
|
||||||
|
size: 40,
|
||||||
|
content: "JKLMNOPQRSTUVWXYZ-ABCDEFGHIJK|",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, test := range tests {
|
||||||
|
test := test
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
d := &contentReader{size: test.size}
|
||||||
|
|
||||||
|
_, err := d.Seek(test.offset, test.seekWhence)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("contentReader.Seek() error = %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
b, err := io.ReadAll(d)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("contentReader.Read() error = %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if string(b) != test.content {
|
||||||
|
t.Errorf("return content does not match expected value: got %s want %s", b, test.content)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
Reference in New Issue
Block a user