1 Commits

Author SHA1 Message Date
2f65441981 Enable benchHandler on "/bench/" in addition of "/bench"
Adding the trailing slash allows to trigger the bench handler for
performance measurements in situations where a trailing slash
character '/' is added to the request.

For example, in traefik addPrefix middleware, if you specify a
"/bench" prefix, a request on "http://localhost" will be transformed
from "GET /" to "GET /bench/" with no way to remove the trailing
'/' (at least without adding another rewrite rule, which would
modify measurements).
2021-04-27 15:39:57 +02:00
24 changed files with 295 additions and 1429 deletions

View File

@ -1,72 +0,0 @@
name: Bug Report
description: Create a report to help us improve.
body:
- type: checkboxes
id: terms
attributes:
label: Welcome!
description: |
The issue tracker is for reporting bugs and feature requests only.
All new/updated issues are triaged regularly by the maintainers.
All issues closed by a bot are subsequently double-checked by the maintainers.
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
options:
- label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/whoami/issues) and didn't find any.
required: true
- type: textarea
attributes:
label: What did you do?
description: |
How to write a good bug report?
- Respect the issue template as much as possible.
- The title should be short and descriptive.
- Explain the conditions which led you to report this issue: the context.
- The context should lead to something, an idea or a problem that youre facing.
- Remain clear and concise.
- Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
placeholder: What did you do?
validations:
required: true
- type: textarea
attributes:
label: What were you expecting?
placeholder: What were you expecting?
validations:
required: true
- type: textarea
attributes:
label: What version are you using?
description: |
`latest` is not considered as a valid version.
placeholder: Paste your output here.
validations:
required: true
- type: textarea
attributes:
label: What is your environment & configuration?
description: arguments, toml, provider, platform, ...
placeholder: Add information here.
value: |
```yaml
# (paste your configuration here)
```
Add more configuration information here.
validations:
required: true
- type: textarea
attributes:
label: If applicable, please paste the log output in DEBUG level
description: "`--log.level=DEBUG` switch."
placeholder: Paste your output here.
validations:
required: false

View File

@ -1,5 +0,0 @@
blank_issues_enabled: false
contact_links:
- name: Traefik Community Support
url: https://community.traefik.io/
about: If you have a question, or are looking for advice, please post on our Discuss forum! The community loves to chime in to help. Happy Coding!

View File

@ -1,30 +0,0 @@
name: Feature Request
description: Suggest an idea for this project.
body:
- type: checkboxes
id: terms
attributes:
label: Welcome!
description: |
The issue tracker is for reporting bugs and feature requests only.
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
options:
- label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/whoami/issues) and didn't find any.
required: true
- type: textarea
attributes:
label: What did you expect to see?
description: |
How to write a good issue?
- Respect the issue template as much as possible.
- The title should be short and descriptive.
- Explain the conditions which led you to report this issue: the context.
- The context should lead to something, an idea or a problem that youre facing.
- Remain clear and concise.
- Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
placeholder: What did you expect to see?
validations:
required: true

View File

@ -1,49 +0,0 @@
name: Main
on:
push:
branches:
- master
pull_request:
jobs:
main:
name: Main Process
runs-on: ubuntu-latest
env:
GO_VERSION: stable
GOLANGCI_LINT_VERSION: v2.1.2
CGO_ENABLED: 0
steps:
# https://github.com/marketplace/actions/checkout
- name: Check out code
uses: actions/checkout@v4
with:
fetch-depth: 0
# https://github.com/marketplace/actions/setup-go-environment
- name: Set up Go ${{ env.GO_VERSION }}
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
- name: Check and get dependencies
run: |
go mod tidy
git diff --exit-code go.mod
git diff --exit-code go.sum
# https://golangci-lint.run/usage/install#other-ci
- name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }}
run: |
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
golangci-lint --version
- name: Make
run: make
- name: Make Image
run: make image

View File

@ -1,9 +1,5 @@
name: Go Matrix name: Go Matrix
on: on: [push, pull_request]
push:
branches:
- master
pull_request:
jobs: jobs:
@ -15,20 +11,33 @@ jobs:
strategy: strategy:
matrix: matrix:
go-version: [ stable, oldstable ] go-version: [ 1.14, 1.15, 1.x ]
os: [ubuntu-latest, macos-latest, windows-latest] os: [ubuntu-latest, macos-latest, windows-latest]
steps: steps:
# https://github.com/marketplace/actions/checkout
- name: Checkout code
uses: actions/checkout@v4
# https://github.com/marketplace/actions/setup-go-environment # https://github.com/marketplace/actions/setup-go-environment
- name: Set up Go ${{ matrix.go-version }} - name: Set up Go ${{ matrix.go-version }}
uses: actions/setup-go@v5 uses: actions/setup-go@v2
with: with:
go-version: ${{ matrix.go-version }} go-version: ${{ matrix.go-version }}
# https://github.com/marketplace/actions/checkout
- name: Checkout code
uses: actions/checkout@v2
# https://github.com/marketplace/actions/cache
- name: Cache Go modules
uses: actions/cache@v2
with:
path: |
~/go/pkg/mod # Module download cache
~/.cache/go-build # Build cache (Linux)
~/Library/Caches/go-build # Build cache (Mac)
'%LocalAppData%\go-build' # Build cache (Windows)
key: ${{ runner.os }}-${{ matrix.go-version }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-${{ matrix.go-version }}-go-
- name: Test - name: Test
run: go test -v -cover ./... run: go test -v -cover ./...

81
.github/workflows/main.yml vendored Normal file
View File

@ -0,0 +1,81 @@
name: Main
on:
push:
branches:
- master
tags:
- v*
pull_request:
jobs:
main:
name: Main Process
runs-on: ubuntu-latest
env:
GO_VERSION: 1.15
GOLANGCI_LINT_VERSION: v1.33.0
SEIHON_VERSION: v0.5.1
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
# https://github.com/marketplace/actions/cache
- name: Cache Go modules
uses: actions/cache@v2
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Check and get dependencies
run: |
go mod tidy
git diff --exit-code go.mod
git diff --exit-code go.sum
go mod download
# https://golangci-lint.run/usage/install#other-ci
- name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }}
run: |
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
golangci-lint --version
- name: Make
run: make
- name: 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

View File

@ -1,55 +0,0 @@
name: "Release a tag"
on:
push:
tags:
- v*
jobs:
release:
name: Release Process
runs-on: ubuntu-latest
env:
GO_VERSION: stable
CGO_ENABLED: 0
steps:
# https://github.com/marketplace/actions/checkout
- name: Check out code
uses: actions/checkout@v4
with:
fetch-depth: 0
# https://github.com/marketplace/actions/setup-go-environment
- name: Set up Go ${{ env.GO_VERSION }}
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
- name: dockerhub-login
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
- name: ghcr-login
uses: docker/login-action@v3
with:
registry: ghcr.io
username: traefiker
password: ${{ secrets.GHCR_TOKEN }}
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
# https://goreleaser.com/ci/actions/
- name: Run GoReleaser
uses: goreleaser/goreleaser-action@v5
with:
version: latest
args: release --clean
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN_REPO }}

1
.gitignore vendored
View File

@ -1,4 +1,3 @@
.idea .idea
vendor/ vendor/
/whoami /whoami
dist/

49
.golangci.toml Normal file
View File

@ -0,0 +1,49 @@
[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 = []

View File

@ -1,84 +0,0 @@
version: "2"
linters:
default: all
disable:
- cyclop
- dupl
- err113
- exhaustive
- exhaustruct
- forbidigo
- gochecknoglobals
- gochecknoinits
- gosec
- lll
- mnd
- nilnil
- nlreturn
- paralleltest
- prealloc
- rowserrcheck
- sqlclosecheck
- testpackage
- tparallel
- varnamelen
- wrapcheck
- wsl
settings:
depguard:
rules:
main:
deny:
- pkg: github.com/instana/testify
desc: not allowed
- pkg: github.com/pkg/errors
desc: Should be replaced by standard lib errors package
forbidigo:
forbid:
- pattern: ^print(ln)?$
- pattern: ^panic$
- pattern: ^spew\.Print(f|ln)?$
- pattern: ^spew\.Dump$
funlen:
lines: -1
statements: 40
goconst:
min-len: 3
min-occurrences: 3
gocritic:
disabled-checks:
- sloppyReassign
- rangeValCopy
- octalLiteral
- paramTypeCombine
enabled-tags:
- diagnostic
- style
- performance
settings:
hugeParam:
sizeThreshold: 100
gocyclo:
min-complexity: 16
godox:
keywords:
- FIXME
govet:
disable:
- fieldalignment
enable-all: true
misspell:
locale: US
exclusions:
presets:
- comments
issues:
max-issues-per-linter: 0
max-same-issues: 0
formatters:
enable:
- gci
- gofumpt
settings:
gofumpt:
extra-rules: true

View File

@ -1,142 +0,0 @@
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'
- 'traefik/whoami:{{ .Tag }}-armv7'
- name_template: 'traefik/whoami:latest'
image_templates:
- 'traefik/whoami:{{ .Tag }}-amd64'
- 'traefik/whoami:{{ .Tag }}-arm64'
- 'traefik/whoami:{{ .Tag }}-armv7'
- name_template: 'traefik/whoami:v{{ .Major }}.{{ .Minor }}'
image_templates:
- 'traefik/whoami:v{{ .Major }}.{{ .Minor }}-amd64'
- 'traefik/whoami:v{{ .Major }}.{{ .Minor }}-arm64'
- 'traefik/whoami:v{{ .Major }}.{{ .Minor }}-armv7'
- name_template: 'ghcr.io/traefik/whoami:{{ .Tag }}'
image_templates:
- 'ghcr.io/traefik/whoami:{{ .Tag }}-amd64'
- 'ghcr.io/traefik/whoami:{{ .Tag }}-arm64'
- 'ghcr.io/traefik/whoami:{{ .Tag }}-armv7'
- name_template: 'ghcr.io/traefik/whoami:latest'
image_templates:
- 'ghcr.io/traefik/whoami:{{ .Tag }}-amd64'
- 'ghcr.io/traefik/whoami:{{ .Tag }}-arm64'
- 'ghcr.io/traefik/whoami:{{ .Tag }}-armv7'
- name_template: 'ghcr.io/traefik/whoami:v{{ .Major }}.{{ .Minor }}'
image_templates:
- 'ghcr.io/traefik/whoami:v{{ .Major }}.{{ .Minor }}-amd64'
- 'ghcr.io/traefik/whoami:v{{ .Major }}.{{ .Minor }}-arm64'
- 'ghcr.io/traefik/whoami:v{{ .Major }}.{{ .Minor }}-armv7'
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'
- 'ghcr.io/traefik/whoami:latest-amd64'
- 'ghcr.io/traefik/whoami:{{ .Tag }}-amd64'
- 'ghcr.io/traefik/whoami:v{{ .Major }}.{{ .Minor }}-amd64'
build_flag_templates:
- '--pull'
# https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys
- '--label=org.opencontainers.image.title={{.ProjectName}}'
- '--label=org.opencontainers.image.description=Tiny Go webserver that prints OS information and HTTP request to output'
- '--label=org.opencontainers.image.source={{.GitURL}}'
- '--label=org.opencontainers.image.url={{.GitURL}}'
- '--label=org.opencontainers.image.documentation={{.GitURL}}'
- '--label=org.opencontainers.image.created={{.Date}}'
- '--label=org.opencontainers.image.revision={{.FullCommit}}'
- '--label=org.opencontainers.image.version={{.Version}}'
- '--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'
- 'ghcr.io/traefik/whoami:latest-arm64'
- 'ghcr.io/traefik/whoami:{{ .Tag }}-arm64'
- 'ghcr.io/traefik/whoami:v{{ .Major }}.{{ .Minor }}-arm64'
build_flag_templates:
- '--pull'
# https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys
- '--label=org.opencontainers.image.title={{.ProjectName}}'
- '--label=org.opencontainers.image.description=Tiny Go webserver that prints OS information and HTTP request to output'
- '--label=org.opencontainers.image.source={{.GitURL}}'
- '--label=org.opencontainers.image.url={{.GitURL}}'
- '--label=org.opencontainers.image.documentation={{.GitURL}}'
- '--label=org.opencontainers.image.created={{.Date}}'
- '--label=org.opencontainers.image.revision={{.FullCommit}}'
- '--label=org.opencontainers.image.version={{.Version}}'
- '--platform=linux/arm64'
- use: buildx
goos: linux
goarch: arm
goarm: '7'
dockerfile: buildx.Dockerfile
image_templates:
- 'traefik/whoami:latest-armv7'
- 'traefik/whoami:{{ .Tag }}-armv7'
- 'traefik/whoami:v{{ .Major }}.{{ .Minor }}-armv7'
- 'ghcr.io/traefik/whoami:latest-armv7'
- 'ghcr.io/traefik/whoami:{{ .Tag }}-armv7'
- 'ghcr.io/traefik/whoami:v{{ .Major }}.{{ .Minor }}-armv7'
build_flag_templates:
- '--pull'
# https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys
- '--label=org.opencontainers.image.title={{.ProjectName}}'
- '--label=org.opencontainers.image.description=Tiny Go webserver that prints OS information and HTTP request to output'
- '--label=org.opencontainers.image.source={{.GitURL}}'
- '--label=org.opencontainers.image.url={{.GitURL}}'
- '--label=org.opencontainers.image.documentation={{.GitURL}}'
- '--label=org.opencontainers.image.created={{.Date}}'
- '--label=org.opencontainers.image.revision={{.FullCommit}}'
- '--label=org.opencontainers.image.version={{.Version}}'
- '--platform=linux/arm/v7'

View File

@ -1,4 +1,4 @@
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 \

View File

@ -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-2019] [Containous] Copyright [2015-2018] [Containous]
Copyright [2020-2022] [Traefik Labs] Copyright [2020] [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.

View File

@ -1,4 +1,6 @@
.PHONY: default check test build image .PHONY: default build image check publish-images
TAG_NAME := $(shell git tag -l --contains HEAD)
IMAGE_NAME := traefik/whoami IMAGE_NAME := traefik/whoami
@ -16,5 +18,5 @@ check:
image: image:
docker build -t $(IMAGE_NAME) . docker build -t $(IMAGE_NAME) .
protoc: publish-images:
protoc --proto_path . ./grpc.proto --go-grpc_out=./ --go_out=./ seihon publish -v "$(TAG_NAME)" -v "latest" --image-name $(IMAGE_NAME) --dry-run=false

150
README.md
View File

@ -3,148 +3,68 @@
[![Docker Pulls](https://img.shields.io/docker/pulls/traefik/whoami.svg)](https://hub.docker.com/r/traefik/whoami/) [![Docker Pulls](https://img.shields.io/docker/pulls/traefik/whoami.svg)](https://hub.docker.com/r/traefik/whoami/)
[![Build Status](https://github.com/traefik/whoami/workflows/Main/badge.svg?branch=master)](https://github.com/traefik/whoami/actions) [![Build Status](https://github.com/traefik/whoami/workflows/Main/badge.svg?branch=master)](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
#### `/[?wait=d]` - `/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.
Returns the whoami information (request and network information). - `/bench`: always return the same response (`1`).
- `/[?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).
The optional `wait` query parameter can be provided to tell the server to wait before sending the response. - `/api`: returns the whoami information as JSON.
The duration is expected in Go's [`time.Duration`](https://golang.org/pkg/time/#ParseDuration) format (e.g. `/?wait=100ms` to wait 100 milliseconds). - `/health`: heath check
- `GET`, `HEAD`, ...: returns a response with the status code defined by the `POST`
The optional `env` query parameter can be set to `true` to add the environment variables to the response. - `POST`: changes the status code of the `GET` (`HEAD`, ...) response.
#### `/api`
Returns the whoami information (and some extra information) as JSON.
The optional `env` query parameter can be set to `true` to add the environment variables to the response.
#### `/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`
- `POST`: changes the status code of the `GET` (`HEAD`, ...) response.
### Flags ### Flags
| Flag | Env var | Description | - `cert`: give me a certificate.
|-----------|----------------------|-----------------------------------------| - `key`: give me a key.
| `cert` | | Give me a certificate. | - `port`: give me a port number. (default: 80)
| `key` | | Give me a key. | - `name`: give me a name. (it can be also defined with `WHOAMI_NAME` environment variable)
| `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
```console ```console
$ docker run -d -p 8080:80 --name iamfoo traefik/whoami $ docker run -d -P --name iamfoo traefik/whoami
$ curl http://localhost:8080 $ docker inspect --format '{{ .NetworkSettings.Ports }}' iamfoo
Hostname: 9c9c93da54b5 map[80/tcp:[{0.0.0.0 32769}]]
IP: 127.0.0.1
IP: ::1 $ curl "http://0.0.0.0:32769"
IP: 172.17.0.2 Hostname : 6e0030e67d6a
RemoteAddr: 172.17.0.1:41040 IP : 127.0.0.1
IP : ::1
IP : 172.17.0.27
IP : fe80::42:acff:fe11:1b
GET / HTTP/1.1 GET / HTTP/1.1
Host: localhost:8080 Host: 0.0.0.0:32769
User-Agent: curl/8.5.0 User-Agent: curl/7.35.0
Accept: */* Accept: */*
``` ```
```console ```console
# updates health check status # updates health check status
$ curl -X POST -d '500' http://localhost:8080/health $ curl -X POST -d '500' http://localhost:80/health
# calls the health check # calls the health check
$ curl -v http://localhost:8080/health $ curl -v http://localhost:80/health
* Host localhost:8080 was resolved. * Trying ::1:80...
* IPv6: ::1 * TCP_NODELAY set
* IPv4: 127.0.0.1 * Connected to localhost (::1) port 80 (#0)
* Trying [::1]:8080...
* Connected to localhost (::1) port 8080
> GET /health HTTP/1.1 > GET /health HTTP/1.1
> Host: localhost:8080 > Host: localhost:80
> User-Agent: curl/8.5.0 > User-Agent: curl/7.65.3
> Accept: */* > Accept: */*
> >
* Mark bundle as not supporting multiuse
< HTTP/1.1 500 Internal Server Error < HTTP/1.1 500 Internal Server Error
< Date: Fri, 18 Apr 2025 13:36:02 GMT < Date: Mon, 16 Sep 2019 22:52:40 GMT
< Content-Length: 0 < Content-Length: 0
``` ```
```console ```console
$ openssl req -newkey rsa:4096 \ docker run -d -P -v ./certs:/certs --name iamfoo traefik/whoami --cert /certs/cert.cer --key /certs/key.key
-x509 \
-sha256 \
-days 3650 \
-nodes \
-out ./certs/example.crt \
-keyout ./certs/example.key
$ docker run -d -p 8080:80 -v ./certs:/certs --name iamfoo traefik/whoami --cert /certs/example.crt --key /certs/example.key
$ curl https://localhost:8080 -k --cert certs/example.crt --key certs/example.key
Hostname: 25bc0df47b95
IP: 127.0.0.1
IP: ::1
IP: 172.17.0.2
RemoteAddr: 172.17.0.1:50278
Certificate[0] Subject: CN=traefik.io,O=TraefikLabs,L=Lyon,ST=France,C=FR
GET / HTTP/1.1
Host: localhost:8080
User-Agent: curl/8.5.0
Accept: */*
```
```console
$ docker run -d -p 8080:80 --name iamfoo traefik/whoami
$ grpcurl -plaintext -proto grpc.proto localhost:8080 whoami.Whoami/Whoami
{
"hostname": "5a45e21984b4",
"iface": [
"127.0.0.1",
"::1",
"172.17.0.2"
]
}
$ grpcurl -plaintext -proto grpc.proto localhost:8080 whoami.Whoami/Bench
{
"data": 1
}
```
```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
``` ```

287
app.go
View File

@ -1,9 +1,7 @@
package main package main
import ( import (
"context" "bytes"
"crypto/tls"
"crypto/x509"
"encoding/json" "encoding/json"
"flag" "flag"
"fmt" "fmt"
@ -11,6 +9,7 @@ import (
"log" "log"
"net" "net"
"net/http" "net/http"
"net/url"
"os" "os"
"strconv" "strconv"
"strings" "strings"
@ -18,10 +17,6 @@ import (
"time" "time"
"github.com/gorilla/websocket" "github.com/gorilla/websocket"
grpcWhoami "github.com/traefik/whoami/grpc"
"golang.org/x/net/http2"
"golang.org/x/net/http2/h2c"
"google.golang.org/grpc"
) )
// Units. // Units.
@ -33,113 +28,42 @@ const (
TB TB
) )
var upgrader = websocket.Upgrader{
ReadBufferSize: 1024,
WriteBufferSize: 1024,
CheckOrigin: func(_ *http.Request) bool {
return true
},
}
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(&ca, "cacert", "", "give me a CA chain, enforces mutual TLS") flag.StringVar(&port, "port", "80", "give me a port number")
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")
} }
// Data whoami information. var upgrader = websocket.Upgrader{
type Data struct { ReadBufferSize: 1024,
Hostname string `json:"hostname,omitempty"` WriteBufferSize: 1024,
IP []string `json:"ip,omitempty"`
Headers http.Header `json:"headers,omitempty"`
URL string `json:"url,omitempty"`
Host string `json:"host,omitempty"`
Method string `json:"method,omitempty"`
Name string `json:"name,omitempty"`
RemoteAddr string `json:"remoteAddr,omitempty"`
Environ map[string]string `json:"environ,omitempty"`
} }
func main() { func main() {
flag.Parse() flag.Parse()
mux := http.NewServeMux() http.HandleFunc("/data", dataHandler)
mux.Handle("/data", handle(dataHandler, verbose)) http.HandleFunc("/echo", echoHandler)
mux.Handle("/echo", handle(echoHandler, verbose)) http.HandleFunc("/bench", benchHandler)
mux.Handle("/bench", handle(benchHandler, verbose)) http.HandleFunc("/bench/", benchHandler)
mux.Handle("/api", handle(apiHandler, verbose)) http.HandleFunc("/", whoamiHandler)
mux.Handle("/health", handle(healthHandler, verbose)) http.HandleFunc("/api", apiHandler)
mux.Handle("/", handle(whoamiHandler, verbose)) http.HandleFunc("/health", healthHandler)
serverGRPC := grpc.NewServer() fmt.Println("Starting up on port " + port)
grpcWhoami.RegisterWhoamiServer(serverGRPC, whoamiServer{})
mux.Handle("/whoami.Whoami/", serverGRPC)
h := handle(mux.ServeHTTP, verbose) if len(cert) > 0 && len(key) > 0 {
log.Fatal(http.ListenAndServeTLS(":"+port, cert, key, nil))
if cert == "" || key == "" {
log.Printf("Starting up on port %s", port)
log.Fatal(http.ListenAndServe(":"+port, h2c.NewHandler(h, &http2.Server{})))
} }
log.Fatal(http.ListenAndServe(":"+port, nil))
server := &http.Server{
Addr: ":" + port,
TLSConfig: &tls.Config{ClientAuth: tls.RequestClientCert},
Handler: h,
}
if ca != "" {
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) {
@ -171,14 +95,15 @@ func echoHandler(w http.ResponseWriter, r *http.Request) {
func printBinary(s []byte) { func printBinary(s []byte) {
fmt.Printf("Received b:") fmt.Printf("Received b:")
for n := range s { for n := 0; n < len(s); n++ {
fmt.Printf("%d,", s[n]) fmt.Printf("%d,", s[n])
} }
fmt.Printf("\n") fmt.Printf("\n")
} }
func dataHandler(w http.ResponseWriter, r *http.Request) { func dataHandler(w http.ResponseWriter, r *http.Request) {
queryParams := r.URL.Query() u, _ := url.Parse(r.URL.String())
queryParams := u.Query()
size, err := strconv.ParseInt(queryParams.Get("size"), 10, 64) size, err := strconv.ParseInt(queryParams.Get("size"), 10, 64)
if err != nil { if err != nil {
@ -205,7 +130,7 @@ func dataHandler(w http.ResponseWriter, r *http.Request) {
attachment = false attachment = false
} }
content := &contentReader{size: size} content := fillContent(size)
if attachment { if attachment {
w.Header().Set("Content-Disposition", "Attachment") w.Header().Set("Content-Disposition", "Attachment")
@ -219,11 +144,10 @@ func dataHandler(w http.ResponseWriter, r *http.Request) {
} }
} }
func whoamiHandler(w http.ResponseWriter, r *http.Request) { func whoamiHandler(w http.ResponseWriter, req *http.Request) {
queryParams := r.URL.Query() u, _ := url.Parse(req.URL.String())
wait := u.Query().Get("wait")
wait := queryParams.Get("wait") if len(wait) > 0 {
if wait != "" {
duration, err := time.ParseDuration(wait) duration, err := time.ParseDuration(wait)
if err == nil { if err == nil {
time.Sleep(duration) time.Sleep(duration)
@ -237,54 +161,66 @@ func whoamiHandler(w http.ResponseWriter, r *http.Request) {
hostname, _ := os.Hostname() hostname, _ := os.Hostname()
_, _ = fmt.Fprintln(w, "Hostname:", hostname) _, _ = fmt.Fprintln(w, "Hostname:", hostname)
for _, ip := range getIPs() { ifaces, _ := net.Interfaces()
_, _ = fmt.Fprintln(w, "IP:", ip) for _, i := range ifaces {
} addrs, _ := i.Addrs()
// handle err
_, _ = fmt.Fprintln(w, "RemoteAddr:", r.RemoteAddr) for _, addr := range addrs {
var ip net.IP
if r.TLS != nil { switch v := addr.(type) {
for i, cert := range r.TLS.PeerCertificates { case *net.IPNet:
_, _ = fmt.Fprintf(w, "Certificate[%d] Subject: %v\n", i, cert.Subject) ip = v.IP
case *net.IPAddr:
ip = v.IP
}
_, _ = fmt.Fprintln(w, "IP:", ip)
} }
} }
if err := r.Write(w); err != nil { _, _ = fmt.Fprintln(w, "RemoteAddr:", req.RemoteAddr)
if err := req.Write(w); err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError) http.Error(w, err.Error(), http.StatusInternalServerError)
return return
} }
if ok, _ := strconv.ParseBool(queryParams.Get("env")); ok {
for _, env := range os.Environ() {
_, _ = fmt.Fprintln(w, env)
}
}
} }
func apiHandler(w http.ResponseWriter, r *http.Request) { func apiHandler(w http.ResponseWriter, req *http.Request) {
queryParams := r.URL.Query()
hostname, _ := os.Hostname() hostname, _ := os.Hostname()
environ := make(map[string]string) data := struct {
Hostname string `json:"hostname,omitempty"`
if ok, _ := strconv.ParseBool(queryParams.Get("env")); ok { IP []string `json:"ip,omitempty"`
for _, env := range os.Environ() { Headers http.Header `json:"headers,omitempty"`
before, after, _ := strings.Cut(env, "=") URL string `json:"url,omitempty"`
environ[before] = after Host string `json:"host,omitempty"`
} Method string `json:"method,omitempty"`
Name string `json:"name,omitempty"`
}{
Hostname: hostname,
IP: []string{},
Headers: req.Header,
URL: req.URL.RequestURI(),
Host: req.Host,
Method: req.Method,
Name: name,
} }
data := Data{ ifaces, _ := net.Interfaces()
Hostname: hostname, for _, i := range ifaces {
IP: getIPs(), addrs, _ := i.Addrs()
Headers: r.Header, // handle err
URL: r.URL.RequestURI(), for _, addr := range addrs {
Host: r.Host, var ip net.IP
Method: r.Method, switch v := addr.(type) {
Name: name, case *net.IPNet:
RemoteAddr: r.RemoteAddr, ip = v.IP
Environ: environ, case *net.IPAddr:
ip = v.IP
}
if ip != nil {
data.IP = append(data.IP, ip.String())
}
}
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json")
@ -324,69 +260,18 @@ func healthHandler(w http.ResponseWriter, req *http.Request) {
} }
} }
func getEnv(key, fallback string) string { func fillContent(length int64) io.ReadSeeker {
value := os.Getenv(key) charset := "-ABCDEFGHIJKLMNOPQRSTUVWXYZ"
if value == "" { b := make([]byte, length)
return fallback
}
return value
}
func getIPs() []string { for i := range b {
var ips []string b[i] = charset[i%len(charset)]
ifaces, _ := net.Interfaces()
for _, i := range ifaces {
addrs, _ := i.Addrs()
// handle err
for _, addr := range addrs {
var ip net.IP
switch v := addr.(type) {
case *net.IPNet:
ip = v.IP
case *net.IPAddr:
ip = v.IP
}
if ip != nil {
ips = append(ips, ip.String())
}
}
} }
return ips if length > 0 {
} b[0] = '|'
b[length-1] = '|'
type whoamiServer struct {
grpcWhoami.UnimplementedWhoamiServer
}
func (g whoamiServer) Bench(_ context.Context, _ *grpcWhoami.BenchRequest) (*grpcWhoami.BenchReply, error) {
return &grpcWhoami.BenchReply{Data: 1}, nil
}
func (g whoamiServer) Whoami(_ context.Context, _ *grpcWhoami.WhoamiRequest) (*grpcWhoami.WhoamiReply, error) {
reply := &grpcWhoami.WhoamiReply{}
if name != "" {
reply.Name = name
} }
reply.Hostname, _ = os.Hostname() return bytes.NewReader(b)
ifaces, _ := net.Interfaces()
for _, i := range ifaces {
addrs, _ := i.Addrs()
// handle err
for _, addr := range addrs {
var ip net.IP
switch v := addr.(type) {
case *net.IPNet:
ip = v.IP
case *net.IPAddr:
ip = v.IP
}
reply.Iface = append(reply.Iface, ip.String())
}
}
return reply, nil
} }

View File

@ -1,66 +0,0 @@
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
}

View File

@ -1,80 +0,0 @@
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 {
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 {
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)
}
})
}
}

15
go.mod
View File

@ -1,16 +1,5 @@
module github.com/traefik/whoami module github.com/traefik/whoami
go 1.24 go 1.13
require ( require github.com/gorilla/websocket v1.4.2
github.com/gorilla/websocket v1.5.3
golang.org/x/net v0.34.0
google.golang.org/grpc v1.71.1
google.golang.org/protobuf v1.36.6
)
require (
golang.org/x/sys v0.29.0 // indirect
golang.org/x/text v0.21.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20250115164207-1a7da9e5054f // indirect
)

38
go.sum
View File

@ -1,36 +1,2 @@
github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY= github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc=
github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=
go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=
go.opentelemetry.io/otel v1.34.0 h1:zRLXxLCgL1WyKsPVrgbSdMN4c0FMkDAskSTQP+0hdUY=
go.opentelemetry.io/otel v1.34.0/go.mod h1:OWFPOQ+h4G8xpyjgqo4SxJYdDQ/qmRH+wivy7zzx9oI=
go.opentelemetry.io/otel/metric v1.34.0 h1:+eTR3U0MyfWjRDhmFMxe2SsW64QrZ84AOhvqS7Y+PoQ=
go.opentelemetry.io/otel/metric v1.34.0/go.mod h1:CEDrp0fy2D0MvkXE+dPV7cMi8tWZwX3dmaIhwPOaqHE=
go.opentelemetry.io/otel/sdk v1.34.0 h1:95zS4k/2GOy069d321O8jWgYsW3MzVV+KuSPKp7Wr1A=
go.opentelemetry.io/otel/sdk v1.34.0/go.mod h1:0e/pNiaMAqaykJGKbi+tSjWfNNHMTxoC9qANsCzbyxU=
go.opentelemetry.io/otel/sdk/metric v1.34.0 h1:5CeK9ujjbFVL5c1PhLuStg1wxA7vQv7ce1EK0Gyvahk=
go.opentelemetry.io/otel/sdk/metric v1.34.0/go.mod h1:jQ/r8Ze28zRKoNRdkjCZxfs6YvBTG1+YIqyFVFYec5w=
go.opentelemetry.io/otel/trace v1.34.0 h1:+ouXS2V8Rd4hp4580a8q23bg0azF2nI8cqLYnC8mh/k=
go.opentelemetry.io/otel/trace v1.34.0/go.mod h1:Svm7lSjQD7kG7KJ/MUHPVXSDGz2OX4h0M2jHBhmSfRE=
golang.org/x/net v0.34.0 h1:Mb7Mrk043xzHgnRM88suvJFwzVrRfHEHJEl5/71CKw0=
golang.org/x/net v0.34.0/go.mod h1:di0qlW3YNM5oh6GqDGQr92MyTozJPmybPK4Ev/Gm31k=
golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
google.golang.org/genproto/googleapis/rpc v0.0.0-20250115164207-1a7da9e5054f h1:OxYkA3wjPsZyBylwymxSHa7ViiW1Sml4ToBrncvFehI=
google.golang.org/genproto/googleapis/rpc v0.0.0-20250115164207-1a7da9e5054f/go.mod h1:+2Yz8+CLJbIfL9z73EW45avw8Lmge3xVElCP9zEKi50=
google.golang.org/grpc v1.71.1 h1:ffsFWr7ygTUscGPI0KKK6TLrGz0476KUvvsbqWK0rPI=
google.golang.org/grpc v1.71.1/go.mod h1:H0GRtasmQOh9LkFoCPDu3ZrwUtD1YGE+b2vYBYd/8Ec=
google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9xY=
google.golang.org/protobuf v1.36.6/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY=

View File

@ -1,26 +0,0 @@
syntax = "proto3";
package whoami;
option go_package = "./grpc";
service Whoami {
rpc Whoami (WhoamiRequest) returns (WhoamiReply) {}
rpc Bench(BenchRequest) returns (BenchReply) {}
}
message WhoamiRequest {}
message WhoamiReply {
string name = 1;
string hostname = 2;
repeated string iface = 3;
}
// The empty request message
message BenchRequest {}
// The response message containing simple data
message BenchReply {
int32 data = 1;
}

View File

@ -1,274 +0,0 @@
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.36.6
// protoc v3.21.12
// source: grpc.proto
package grpc
import (
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
reflect "reflect"
sync "sync"
unsafe "unsafe"
)
const (
// Verify that this generated code is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
// Verify that runtime/protoimpl is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
type WhoamiRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *WhoamiRequest) Reset() {
*x = WhoamiRequest{}
mi := &file_grpc_proto_msgTypes[0]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
func (x *WhoamiRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*WhoamiRequest) ProtoMessage() {}
func (x *WhoamiRequest) ProtoReflect() protoreflect.Message {
mi := &file_grpc_proto_msgTypes[0]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use WhoamiRequest.ProtoReflect.Descriptor instead.
func (*WhoamiRequest) Descriptor() ([]byte, []int) {
return file_grpc_proto_rawDescGZIP(), []int{0}
}
type WhoamiReply struct {
state protoimpl.MessageState `protogen:"open.v1"`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Hostname string `protobuf:"bytes,2,opt,name=hostname,proto3" json:"hostname,omitempty"`
Iface []string `protobuf:"bytes,3,rep,name=iface,proto3" json:"iface,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *WhoamiReply) Reset() {
*x = WhoamiReply{}
mi := &file_grpc_proto_msgTypes[1]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
func (x *WhoamiReply) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*WhoamiReply) ProtoMessage() {}
func (x *WhoamiReply) ProtoReflect() protoreflect.Message {
mi := &file_grpc_proto_msgTypes[1]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use WhoamiReply.ProtoReflect.Descriptor instead.
func (*WhoamiReply) Descriptor() ([]byte, []int) {
return file_grpc_proto_rawDescGZIP(), []int{1}
}
func (x *WhoamiReply) GetName() string {
if x != nil {
return x.Name
}
return ""
}
func (x *WhoamiReply) GetHostname() string {
if x != nil {
return x.Hostname
}
return ""
}
func (x *WhoamiReply) GetIface() []string {
if x != nil {
return x.Iface
}
return nil
}
// The empty request message
type BenchRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *BenchRequest) Reset() {
*x = BenchRequest{}
mi := &file_grpc_proto_msgTypes[2]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
func (x *BenchRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*BenchRequest) ProtoMessage() {}
func (x *BenchRequest) ProtoReflect() protoreflect.Message {
mi := &file_grpc_proto_msgTypes[2]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use BenchRequest.ProtoReflect.Descriptor instead.
func (*BenchRequest) Descriptor() ([]byte, []int) {
return file_grpc_proto_rawDescGZIP(), []int{2}
}
// The response message containing simple data
type BenchReply struct {
state protoimpl.MessageState `protogen:"open.v1"`
Data int32 `protobuf:"varint,1,opt,name=data,proto3" json:"data,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *BenchReply) Reset() {
*x = BenchReply{}
mi := &file_grpc_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
func (x *BenchReply) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*BenchReply) ProtoMessage() {}
func (x *BenchReply) ProtoReflect() protoreflect.Message {
mi := &file_grpc_proto_msgTypes[3]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use BenchReply.ProtoReflect.Descriptor instead.
func (*BenchReply) Descriptor() ([]byte, []int) {
return file_grpc_proto_rawDescGZIP(), []int{3}
}
func (x *BenchReply) GetData() int32 {
if x != nil {
return x.Data
}
return 0
}
var File_grpc_proto protoreflect.FileDescriptor
const file_grpc_proto_rawDesc = "" +
"\n" +
"\n" +
"grpc.proto\x12\x06whoami\"\x0f\n" +
"\rWhoamiRequest\"S\n" +
"\vWhoamiReply\x12\x12\n" +
"\x04name\x18\x01 \x01(\tR\x04name\x12\x1a\n" +
"\bhostname\x18\x02 \x01(\tR\bhostname\x12\x14\n" +
"\x05iface\x18\x03 \x03(\tR\x05iface\"\x0e\n" +
"\fBenchRequest\" \n" +
"\n" +
"BenchReply\x12\x12\n" +
"\x04data\x18\x01 \x01(\x05R\x04data2u\n" +
"\x06Whoami\x126\n" +
"\x06Whoami\x12\x15.whoami.WhoamiRequest\x1a\x13.whoami.WhoamiReply\"\x00\x123\n" +
"\x05Bench\x12\x14.whoami.BenchRequest\x1a\x12.whoami.BenchReply\"\x00B\bZ\x06./grpcb\x06proto3"
var (
file_grpc_proto_rawDescOnce sync.Once
file_grpc_proto_rawDescData []byte
)
func file_grpc_proto_rawDescGZIP() []byte {
file_grpc_proto_rawDescOnce.Do(func() {
file_grpc_proto_rawDescData = protoimpl.X.CompressGZIP(unsafe.Slice(unsafe.StringData(file_grpc_proto_rawDesc), len(file_grpc_proto_rawDesc)))
})
return file_grpc_proto_rawDescData
}
var file_grpc_proto_msgTypes = make([]protoimpl.MessageInfo, 4)
var file_grpc_proto_goTypes = []any{
(*WhoamiRequest)(nil), // 0: whoami.WhoamiRequest
(*WhoamiReply)(nil), // 1: whoami.WhoamiReply
(*BenchRequest)(nil), // 2: whoami.BenchRequest
(*BenchReply)(nil), // 3: whoami.BenchReply
}
var file_grpc_proto_depIdxs = []int32{
0, // 0: whoami.Whoami.Whoami:input_type -> whoami.WhoamiRequest
2, // 1: whoami.Whoami.Bench:input_type -> whoami.BenchRequest
1, // 2: whoami.Whoami.Whoami:output_type -> whoami.WhoamiReply
3, // 3: whoami.Whoami.Bench:output_type -> whoami.BenchReply
2, // [2:4] is the sub-list for method output_type
0, // [0:2] is the sub-list for method input_type
0, // [0:0] is the sub-list for extension type_name
0, // [0:0] is the sub-list for extension extendee
0, // [0:0] is the sub-list for field type_name
}
func init() { file_grpc_proto_init() }
func file_grpc_proto_init() {
if File_grpc_proto != nil {
return
}
type x struct{}
out := protoimpl.TypeBuilder{
File: protoimpl.DescBuilder{
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: unsafe.Slice(unsafe.StringData(file_grpc_proto_rawDesc), len(file_grpc_proto_rawDesc)),
NumEnums: 0,
NumMessages: 4,
NumExtensions: 0,
NumServices: 1,
},
GoTypes: file_grpc_proto_goTypes,
DependencyIndexes: file_grpc_proto_depIdxs,
MessageInfos: file_grpc_proto_msgTypes,
}.Build()
File_grpc_proto = out.File
file_grpc_proto_goTypes = nil
file_grpc_proto_depIdxs = nil
}

View File

@ -1,159 +0,0 @@
// Code generated by protoc-gen-go-grpc. DO NOT EDIT.
// versions:
// - protoc-gen-go-grpc v1.5.1
// - protoc v3.21.12
// source: grpc.proto
package grpc
import (
context "context"
grpc "google.golang.org/grpc"
codes "google.golang.org/grpc/codes"
status "google.golang.org/grpc/status"
)
// This is a compile-time assertion to ensure that this generated file
// is compatible with the grpc package it is being compiled against.
// Requires gRPC-Go v1.64.0 or later.
const _ = grpc.SupportPackageIsVersion9
const (
Whoami_Whoami_FullMethodName = "/whoami.Whoami/Whoami"
Whoami_Bench_FullMethodName = "/whoami.Whoami/Bench"
)
// WhoamiClient is the client API for Whoami service.
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
type WhoamiClient interface {
Whoami(ctx context.Context, in *WhoamiRequest, opts ...grpc.CallOption) (*WhoamiReply, error)
Bench(ctx context.Context, in *BenchRequest, opts ...grpc.CallOption) (*BenchReply, error)
}
type whoamiClient struct {
cc grpc.ClientConnInterface
}
func NewWhoamiClient(cc grpc.ClientConnInterface) WhoamiClient {
return &whoamiClient{cc}
}
func (c *whoamiClient) Whoami(ctx context.Context, in *WhoamiRequest, opts ...grpc.CallOption) (*WhoamiReply, error) {
cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
out := new(WhoamiReply)
err := c.cc.Invoke(ctx, Whoami_Whoami_FullMethodName, in, out, cOpts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *whoamiClient) Bench(ctx context.Context, in *BenchRequest, opts ...grpc.CallOption) (*BenchReply, error) {
cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
out := new(BenchReply)
err := c.cc.Invoke(ctx, Whoami_Bench_FullMethodName, in, out, cOpts...)
if err != nil {
return nil, err
}
return out, nil
}
// WhoamiServer is the server API for Whoami service.
// All implementations must embed UnimplementedWhoamiServer
// for forward compatibility.
type WhoamiServer interface {
Whoami(context.Context, *WhoamiRequest) (*WhoamiReply, error)
Bench(context.Context, *BenchRequest) (*BenchReply, error)
mustEmbedUnimplementedWhoamiServer()
}
// UnimplementedWhoamiServer must be embedded to have
// forward compatible implementations.
//
// NOTE: this should be embedded by value instead of pointer to avoid a nil
// pointer dereference when methods are called.
type UnimplementedWhoamiServer struct{}
func (UnimplementedWhoamiServer) Whoami(context.Context, *WhoamiRequest) (*WhoamiReply, error) {
return nil, status.Errorf(codes.Unimplemented, "method Whoami not implemented")
}
func (UnimplementedWhoamiServer) Bench(context.Context, *BenchRequest) (*BenchReply, error) {
return nil, status.Errorf(codes.Unimplemented, "method Bench not implemented")
}
func (UnimplementedWhoamiServer) mustEmbedUnimplementedWhoamiServer() {}
func (UnimplementedWhoamiServer) testEmbeddedByValue() {}
// UnsafeWhoamiServer may be embedded to opt out of forward compatibility for this service.
// Use of this interface is not recommended, as added methods to WhoamiServer will
// result in compilation errors.
type UnsafeWhoamiServer interface {
mustEmbedUnimplementedWhoamiServer()
}
func RegisterWhoamiServer(s grpc.ServiceRegistrar, srv WhoamiServer) {
// If the following call pancis, it indicates UnimplementedWhoamiServer was
// embedded by pointer and is nil. This will cause panics if an
// unimplemented method is ever invoked, so we test this at initialization
// time to prevent it from happening at runtime later due to I/O.
if t, ok := srv.(interface{ testEmbeddedByValue() }); ok {
t.testEmbeddedByValue()
}
s.RegisterService(&Whoami_ServiceDesc, srv)
}
func _Whoami_Whoami_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(WhoamiRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(WhoamiServer).Whoami(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: Whoami_Whoami_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(WhoamiServer).Whoami(ctx, req.(*WhoamiRequest))
}
return interceptor(ctx, in, info, handler)
}
func _Whoami_Bench_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(BenchRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(WhoamiServer).Bench(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: Whoami_Bench_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(WhoamiServer).Bench(ctx, req.(*BenchRequest))
}
return interceptor(ctx, in, info, handler)
}
// Whoami_ServiceDesc is the grpc.ServiceDesc for Whoami service.
// It's only intended for direct use with grpc.RegisterService,
// and not to be introspected or modified (even as a copy)
var Whoami_ServiceDesc = grpc.ServiceDesc{
ServiceName: "whoami.Whoami",
HandlerType: (*WhoamiServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "Whoami",
Handler: _Whoami_Whoami_Handler,
},
{
MethodName: "Bench",
Handler: _Whoami_Bench_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "grpc.proto",
}

View File

@ -1,17 +1,25 @@
# 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/*
# syntax=docker/dockerfile:1.2 WORKDIR /go/whoami
# 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 whoami / COPY --from=builder /go/whoami/whoami .
ENTRYPOINT ["/whoami"] ENTRYPOINT ["/whoami"]
EXPOSE 80 EXPOSE 80