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
15 changed files with 141 additions and 520 deletions

View File

@ -1,9 +1,5 @@
name: Go Matrix
on:
push:
branches:
- master
pull_request:
on: [push, pull_request]
jobs:
@ -15,7 +11,7 @@ jobs:
strategy:
matrix:
go-version: [ 1.19, 1.x ]
go-version: [ 1.14, 1.15, 1.x ]
os: [ubuntu-latest, macos-latest, windows-latest]
steps:
@ -33,16 +29,11 @@ jobs:
- name: Cache Go modules
uses: actions/cache@v2
with:
# In order:
# * Module download cache
# * Build cache (Linux)
# * Build cache (Mac)
# * Build cache (Windows)
path: |
~/go/pkg/mod
~/.cache/go-build
~/Library/Caches/go-build
%LocalAppData%\go-build
~/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-

View File

@ -4,6 +4,8 @@ on:
push:
branches:
- master
tags:
- v*
pull_request:
jobs:
@ -12,8 +14,9 @@ jobs:
name: Main Process
runs-on: ubuntu-latest
env:
GO_VERSION: 1.19
GOLANGCI_LINT_VERSION: v1.49.0
GO_VERSION: 1.15
GOLANGCI_LINT_VERSION: v1.33.0
SEIHON_VERSION: v0.5.1
CGO_ENABLED: 0
steps:
@ -44,6 +47,7 @@ jobs:
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 }}
@ -56,3 +60,22 @@ jobs:
- 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,47 +0,0 @@
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 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
View File

@ -1,4 +1,3 @@
.idea
vendor/
/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,93 +0,0 @@
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'

View File

@ -1,81 +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'
- 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.created={{.Date}}'
- '--label=org.opencontainers.image.title={{.ProjectName}}'
- '--label=org.opencontainers.image.revision={{.FullCommit}}'
- '--label=org.opencontainers.image.version={{.Version}}'
- 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.created={{.Date}}'
- '--label=org.opencontainers.image.title={{.ProjectName}}'
- '--label=org.opencontainers.image.revision={{.FullCommit}}'
- '--label=org.opencontainers.image.version={{.Version}}'

View File

@ -186,8 +186,8 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [2015-2019] [Containous]
Copyright [2020-2022] [Traefik Labs]
Copyright [2015-2018] [Containous]
Copyright [2020] [Traefik Labs]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

View File

@ -1,4 +1,4 @@
.PHONY: default check test build image publish-images
.PHONY: default build image check publish-images
TAG_NAME := $(shell git tag -l --contains HEAD)

View File

@ -3,54 +3,27 @@
[![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)
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
### Paths
#### `/[?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.
#### `/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.
- `/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.
- `/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).
- `/api`: returns the whoami information as JSON.
- `/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
| Flag | Env var | Description |
|-----------|----------------------|-----------------------------------------|
| `cert` | | Give me a certificate. |
| `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. |
- `cert`: give me a certificate.
- `key`: give me a key.
- `port`: give me a port number. (default: 80)
- `name`: give me a name. (it can be also defined with `WHOAMI_NAME` environment variable)
## Examples
@ -93,17 +66,5 @@ $ curl -v http://localhost:80/health
```
```console
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
docker run -d -P -v ./certs:/certs --name iamfoo traefik/whoami --cert /certs/cert.cer --key /certs/key.key
```

103
app.go
View File

@ -1,8 +1,7 @@
package main
import (
"crypto/tls"
"crypto/x509"
"bytes"
"encoding/json"
"flag"
"fmt"
@ -30,20 +29,16 @@ const (
)
var (
cert string
key string
ca string
port string
name string
verbose bool
cert string
key string
port string
name string
)
func init() {
flag.BoolVar(&verbose, "verbose", false, "Enable verbose logging")
flag.StringVar(&cert, "cert", "", "give me a certificate")
flag.StringVar(&key, "key", "", "give me a key")
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(&port, "port", "80", "give me a port number")
flag.StringVar(&name, "name", os.Getenv("WHOAMI_NAME"), "give me a name")
}
@ -55,64 +50,20 @@ var upgrader = websocket.Upgrader{
func main() {
flag.Parse()
mux := http.NewServeMux()
mux.Handle("/data", handle(dataHandler, verbose))
mux.Handle("/echo", handle(echoHandler, verbose))
mux.Handle("/bench", handle(benchHandler, verbose))
mux.Handle("/api", handle(apiHandler, verbose))
mux.Handle("/health", handle(healthHandler, verbose))
mux.Handle("/", handle(whoamiHandler, verbose))
http.HandleFunc("/data", dataHandler)
http.HandleFunc("/echo", echoHandler)
http.HandleFunc("/bench", benchHandler)
http.HandleFunc("/bench/", benchHandler)
http.HandleFunc("/", whoamiHandler)
http.HandleFunc("/api", apiHandler)
http.HandleFunc("/health", healthHandler)
if cert == "" || key == "" {
log.Printf("Starting up on port %s", port)
fmt.Println("Starting up on port " + port)
log.Fatal(http.ListenAndServe(":"+port, mux))
if len(cert) > 0 && len(key) > 0 {
log.Fatal(http.ListenAndServeTLS(":"+port, cert, key, 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)
})
log.Fatal(http.ListenAndServe(":"+port, nil))
}
func benchHandler(w http.ResponseWriter, _ *http.Request) {
@ -179,7 +130,7 @@ func dataHandler(w http.ResponseWriter, r *http.Request) {
attachment = false
}
content := &contentReader{size: size}
content := fillContent(size)
if attachment {
w.Header().Set("Content-Disposition", "Attachment")
@ -309,10 +260,18 @@ func healthHandler(w http.ResponseWriter, req *http.Request) {
}
}
func getEnv(key, fallback string) string {
value := os.Getenv(key)
if value == "" {
return fallback
func fillContent(length int64) io.ReadSeeker {
charset := "-ABCDEFGHIJKLMNOPQRSTUVWXYZ"
b := make([]byte, length)
for i := range b {
b[i] = charset[i%len(charset)]
}
return value
if length > 0 {
b[0] = '|'
b[length-1] = '|'
}
return bytes.NewReader(b)
}

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,82 +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 {
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)
}
})
}
}

2
go.mod
View File

@ -1,5 +1,5 @@
module github.com/traefik/whoami
go 1.19
go 1.13
require github.com/gorilla/websocket v1.4.2

View File

@ -1,17 +1,25 @@
# syntax=docker/dockerfile:1.2
FROM golang:1-alpine as builder
RUN apk --no-cache --no-progress add git ca-certificates tzdata make \
&& update-ca-certificates \
&& rm -rf /var/cache/apk/*
# syntax=docker/dockerfile:1.2
# Create a minimal container to run a Golang static binary
WORKDIR /go/whoami
# 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
COPY --from=builder /usr/share/zoneinfo /usr/share/zoneinfo
COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
COPY whoami /
COPY --from=builder /go/whoami/whoami .
ENTRYPOINT ["/whoami"]
EXPOSE 80