feat: Replace data fillcontent with custom reader

Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>

.github/workflows/go-cross.yml

@@ -0,0 +1,54 @@
+name: Go Matrix
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  cross:
+    name: Go
+    runs-on: ${{ matrix.os }}
+    env:
+      CGO_ENABLED: 0
+
+    strategy:
+      matrix:
+        go-version: [ 1.17, 1.x ]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      # https://github.com/marketplace/actions/setup-go-environment
+      - name: Set up Go ${{ matrix.go-version }}
+        uses: actions/setup-go@v2
+        with:
+          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:
+          # 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
+          key: ${{ runner.os }}-${{ matrix.go-version }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.go-version }}-go-
+
+      - name: Test
+        run: go test -v -cover ./...
+
+      - name: Build
+        run: go build -v -ldflags "-s -w" -trimpath

.github/workflows/main.yml

@@ -0,0 +1,58 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  main:
+    name: Main Process
+    runs-on: ubuntu-latest
+    env:
+      GO_VERSION: 1.17
+      GOLANGCI_LINT_VERSION: v1.46.2
+      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
+
+      # 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

.github/workflows/release.yml

@@ -0,0 +1,44 @@
+name: "Release a tag"
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    name: Release Process
+    runs-on: ubuntu-latest
+    env:
+      GO_VERSION: 1.17
+      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
+
+      # Install Docker image multi-arch builder
+      - name: Install seihon ${{ env.SEIHON_VERSION }}
+        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
+        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)
+        run: make publish-images

.gitignore

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

.golangci.toml

@@ -1,43 +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",
-    "goerr113",
-    "testpackage",
-  ]
-
-[issues]
-  exclude-use-default = false
-  max-per-linter = 0
-  max-same-issues = 0
-  exclude = []

.golangci.yml

@@ -0,0 +1,48 @@
+run:
+  deadline: 2m
+  skip-files: []
+linters-settings:
+  govet:
+    check-shadowing: true
+  gocyclo:
+    min-complexity: 12
+  goconst:
+    min-len: 3
+    min-occurrences: 3
+  misspell:
+    locale: US
+
+linters:
+  enable-all: true
+  disable:
+    - golint # deprecated
+    - scopelint # deprecated
+    - interfacer # deprecated
+    - maligned # deprecated
+    - lll
+    - gosec
+    - dupl
+    - prealloc
+    - gochecknoglobals
+    - gochecknoinits
+    - gomnd
+    - wsl
+    - nlreturn
+    - testpackage
+    - paralleltest
+    - tparallel
+    - goerr113
+    - wrapcheck
+    - exhaustive
+    - exhaustivestruct
+    - forbidigo
+    - varnamelen
+    - nilnil
+    - ifshort
+    - exhaustruct
+
+issues:
+  exclude-use-default: false
+  max-per-linter: 0
+  max-same-issues: 0
+  exclude: []

.travis.yml

@@ -1,53 +0,0 @@
-language: go
-
-go:
-  - "1.x"
-
-cache:
-  directories:
-    - $GOPATH/pkg/mod
-
-branches:
-  only:
-    - master
-    - /^v\d+\.\d+(\.\d+)?(-\S*)?$/
-
-notifications:
-  email:
-    on_success: never
-    on_failure: change
-
-env:
-  - GO111MODULE=on
-
-before_install:
-  # Install linters and misspell
-  - curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | bash -s -- -b $GOPATH/bin ${GOLANGCI_LINT_VERSION}
-  - golangci-lint --version
-  # Install Docker image multi-arch builder
-  - curl -sfL https://raw.githubusercontent.com/ldez/seihon/master/godownloader.sh | bash -s -- -b "${GOPATH}/bin" ${SEIHON_VERSION}
-  - seihon --version
-
-install:
-  - go mod tidy
-  - git diff --exit-code go.mod
-  - git diff --exit-code go.sum
-  - go mod download
-
-script:
-  - make
-  - make image
-
-before_deploy:
-  - >
-    if ! [ "$BEFORE_DEPLOY_RUN" ]; then
-      export BEFORE_DEPLOY_RUN=1;
-      echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}" --password-stdin
-    fi
-
-deploy:
-  - provider: script
-    skip_cleanup: true
-    script: make publish-images
-    on:
-      tags: true

LICENSE

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

Makefile

@@ -2,19 +2,21 @@
 
 TAG_NAME := $(shell git tag -l --contains HEAD)
 
+IMAGE_NAME := traefik/whoami
+
 default: check test build
 
+build:
+	CGO_ENABLED=0 go build -a --trimpath --installsuffix cgo --ldflags="-s" -o whoami
+
 test:
 	go test -v -cover ./...
 
-build:
-	CGO_ENABLED=0 go build -a --installsuffix cgo --ldflags="-s" -o whoami
-
-image:
-	docker build -t traefik/whoami .
-
 check:
 	golangci-lint run
 
+image:
+	docker build -t $(IMAGE_NAME) .
+
 publish-images:
-	seihon publish -v "$(TAG_NAME)" -v "latest" --image-name traefik/whoami --dry-run=false
+	seihon publish -v "$(TAG_NAME)" -v "latest" --image-name $(IMAGE_NAME) --dry-run=false

README.md

@@ -1,29 +1,56 @@
 # whoami
 
 [![Docker Pulls](https://img.shields.io/docker/pulls/traefik/whoami.svg)](https://hub.docker.com/r/traefik/whoami/)
-[![Build Status](https://travis-ci.com/traefik/whoami.svg?branch=master)](https://travis-ci.com/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
 
-- `/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
+#### `/[?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.
 
 ### Flags
 
-- `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)
+| 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.                 |
 
 ## Examples
 
@@ -66,5 +93,17 @@ $ curl -v http://localhost:80/health
 ```
 
 ```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
 ```

app.go

@@ -1,11 +1,13 @@
 package main
 
 import (
-	"bytes"
+	"crypto/tls"
+	"crypto/x509"
 	"encoding/json"
 	"flag"
 	"fmt"
 	"io"
+	"io/ioutil"
 	"log"
 	"net"
 	"net/http"
@@ -28,15 +30,21 @@ const (
 	TB
 )
 
-var cert string
-var key string
-var port string
-var name string
+var (
+	cert    string
+	key     string
+	ca      string
+	port    string
+	name    string
+	verbose bool
+)
 
 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(&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")
 }
 
@@ -48,19 +56,64 @@ var upgrader = websocket.Upgrader{
 func main() {
 	flag.Parse()
 
-	http.HandleFunc("/data", dataHandler)
-	http.HandleFunc("/echo", echoHandler)
-	http.HandleFunc("/bench", benchHandler)
-	http.HandleFunc("/", whoamiHandler)
-	http.HandleFunc("/api", apiHandler)
-	http.HandleFunc("/health", healthHandler)
+	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))
 
-	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.ListenAndServeTLS(":"+port, cert, key, nil))
+		log.Fatal(http.ListenAndServe(":"+port, mux))
 	}
-	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 := ioutil.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) {
@@ -127,10 +180,10 @@ func dataHandler(w http.ResponseWriter, r *http.Request) {
 		attachment = false
 	}
 
-	content := fillContent(size)
+	content := &contentReader{size: size}
 
 	if attachment {
-		w.Header().Add("Content-Disposition", "Attachment")
+		w.Header().Set("Content-Disposition", "Attachment")
 		http.ServeContent(w, r, "data.txt", time.Now(), content)
 		return
 	}
@@ -231,8 +284,10 @@ type healthState struct {
 	StatusCode int
 }
 
-var currentHealthState = healthState{http.StatusOK}
-var mutexHealthState = &sync.RWMutex{}
+var (
+	currentHealthState = healthState{http.StatusOK}
+	mutexHealthState   = &sync.RWMutex{}
+)
 
 func healthHandler(w http.ResponseWriter, req *http.Request) {
 	if req.Method == http.MethodPost {
@@ -255,18 +310,10 @@ func healthHandler(w http.ResponseWriter, req *http.Request) {
 	}
 }
 
-func fillContent(length int64) io.ReadSeeker {
-	charset := "-ABCDEFGHIJKLMNOPQRSTUVWXYZ"
-	b := make([]byte, length)
-
-	for i := range b {
-		b[i] = charset[i%len(charset)]
+func getEnv(key, fallback string) string {
+	value := os.Getenv(key)
+	if len(value) == 0 {
+		return fallback
 	}
-
-	if length > 0 {
-		b[0] = '|'
-		b[length-1] = '|'
-	}
-
-	return bytes.NewReader(b)
+	return value
 }

content.go

@@ -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
+}

content_test.go

@@ -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)
+			}
+		})
+	}
+}

go.mod

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

tmpl.Dockerfile

@@ -12,6 +12,7 @@ COPY go.sum .
 RUN GO111MODULE=on GOPROXY=https://proxy.golang.org go mod download
 
 COPY . .
+
 RUN GOARCH={{ .GoARCH }} GOARM={{ .GoARM }} make build
 
 FROM scratch