feat: Replace data fillcontent with custom reader

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

.github/workflows/go-cross.yml

@@ -1,5 +1,9 @@
 name: Go Matrix
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
 

.github/workflows/main.yml

@@ -4,8 +4,6 @@ on:
   push:
     branches:
       - master
-    tags:
-      - v*
   pull_request:
 
 jobs:
@@ -15,8 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       GO_VERSION: 1.17
-      GOLANGCI_LINT_VERSION: v1.43.0
+      GOLANGCI_LINT_VERSION: v1.46.2
-      SEIHON_VERSION: v0.8.5
       CGO_ENABLED: 0
 
     steps:
@@ -59,22 +56,3 @@ 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

.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.yml

@@ -38,6 +38,8 @@ linters:
     - forbidigo
     - varnamelen
     - nilnil
+    - ifshort
+    - exhaustruct
 
 issues:
   exclude-use-default: false

LICENSE

@@ -186,8 +186,8 @@
       same "printed page" as the copyright notice for easier
       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");
    you may not use this file except in compliance with the License.

README.md

@@ -3,27 +3,54 @@
 [![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
 
-- `/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`
 - `POST`: changes the status code of the `GET` (`HEAD`, ...) response.
 
 ### Flags
 
-- `cert`: give me a certificate.
+| Flag      | Env var              | Description                             |
-- `key`: give me a key.
+|-----------|----------------------|-----------------------------------------|
-- `port`: give me a port number. (it can be also defined with `WHOAMI_PORT_NUMBER` environment variable) (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
 
@@ -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,7 +1,6 @@
 package main
 
 import (
-	"bytes"
 	"crypto/tls"
 	"crypto/x509"
 	"encoding/json"
@@ -37,9 +36,11 @@ var (
 	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(&ca, "cacert", "", "give me a CA chain, enforces mutual TLS")
@@ -56,12 +57,12 @@ func main() {
 	flag.Parse()
 
 	mux := http.NewServeMux()
-	mux.HandleFunc("/data", dataHandler)
+	mux.Handle("/data", handle(dataHandler, verbose))
-	mux.HandleFunc("/echo", echoHandler)
+	mux.Handle("/echo", handle(echoHandler, verbose))
-	mux.HandleFunc("/bench", benchHandler)
+	mux.Handle("/bench", handle(benchHandler, verbose))
-	mux.HandleFunc("/", whoamiHandler)
+	mux.Handle("/api", handle(apiHandler, verbose))
-	mux.HandleFunc("/api", apiHandler)
+	mux.Handle("/health", handle(healthHandler, verbose))
-	mux.HandleFunc("/health", healthHandler)
+	mux.Handle("/", handle(whoamiHandler, verbose))
 
 	if cert == "" || key == "" {
 		log.Printf("Starting up on port %s", port)
@@ -102,6 +103,19 @@ func setupMutualTLS(ca string) *tls.Config {
 	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) {
 	w.Header().Set("Connection", "keep-alive")
 	w.Header().Set("Content-Type", "text/plain")
@@ -166,7 +180,7 @@ func dataHandler(w http.ResponseWriter, r *http.Request) {
 		attachment = false
 	}
 
-	content := fillContent(size)
+	content := &contentReader{size: size}
 
 	if attachment {
 		w.Header().Set("Content-Disposition", "Attachment")
@@ -296,22 +310,6 @@ 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)]
-	}
-
-	if length > 0 {
-		b[0] = '|'
-		b[length-1] = '|'
-	}
-
-	return bytes.NewReader(b)
-}
-
 func getEnv(key, fallback string) string {
 	value := os.Getenv(key)
 	if len(value) == 0 {

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