chore: clean workflow

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

.github/workflows/go-cross.yml

@@ -0,0 +1,50 @@
+name: Go Matrix
+on: [push, 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.44.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
+
+      # 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.yml

@@ -0,0 +1,47 @@
+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
+
+issues:
+  exclude-use-default: false
+  max-per-linter: 0
+  max-same-issues: 0
+  exclude: []

Dockerfile

@@ -1,10 +1,26 @@
-FROM golang:1.12 as builder
+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/*
+
 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 make build
 
 # Create a minimal container to run a Golang static binary
 FROM scratch
+
+COPY --from=builder /usr/share/zoneinfo /usr/share/zoneinfo
+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
 COPY --from=builder /go/whoami/whoami .
+
 ENTRYPOINT ["/whoami"]
 EXPOSE 80

LICENSE

@@ -186,7 +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-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

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

README.md

@@ -1,13 +1,65 @@
 # whoami
 
-[![Docker Pulls](https://img.shields.io/docker/pulls/containous/whoami.svg)](https://hub.docker.com/r/containous/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)
 
-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.
+
+### 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.                 |
+
+## Examples
 
 ```console
-$ docker run -d -P --name iamfoo containous/whoami
+$ docker run -d -P --name iamfoo traefik/whoami
+
 $ docker inspect --format '{{ .NetworkSettings.Ports }}'  iamfoo
 map[80/tcp:[{0.0.0.0 32769}]]
+
 $ curl "http://0.0.0.0:32769"
 Hostname :  6e0030e67d6a
 IP :  127.0.0.1
@@ -19,3 +71,39 @@ Host: 0.0.0.0:32769
 User-Agent: curl/7.35.0
 Accept: */*
 ```
+
+```console
+# updates health check status
+$ curl -X POST -d '500' http://localhost:80/health
+
+# calls the health check
+$ curl -v http://localhost:80/health
+*   Trying ::1:80...
+* TCP_NODELAY set
+* Connected to localhost (::1) port 80 (#0)
+> GET /health HTTP/1.1
+> Host: localhost:80
+> User-Agent: curl/7.65.3
+> Accept: */*
+> 
+* Mark bundle as not supporting multiuse
+< HTTP/1.1 500 Internal Server Error
+< Date: Mon, 16 Sep 2019 22:52:40 GMT
+< Content-Length: 0
+```
+
+```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
+```

app.go

@@ -2,10 +2,13 @@ package main
 
 import (
 	"bytes"
+	"crypto/tls"
+	"crypto/x509"
 	"encoding/json"
 	"flag"
 	"fmt"
 	"io"
+	"io/ioutil"
 	"log"
 	"net"
 	"net/http"
@@ -19,6 +22,7 @@ import (
 	"github.com/gorilla/websocket"
 )
 
+// Units.
 const (
 	_        = iota
 	KB int64 = 1 << (10 * iota)
@@ -27,14 +31,22 @@ const (
 	TB
 )
 
-var cert string
-var key string
-var port 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")
 }
 
 var upgrader = websocket.Upgrader{
@@ -45,19 +57,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) {
@@ -110,13 +167,13 @@ func dataHandler(w http.ResponseWriter, r *http.Request) {
 	unit := queryParams.Get("unit")
 	switch strings.ToLower(unit) {
 	case "kb":
-		size = size * KB
+		size *= KB
 	case "mb":
-		size = size * MB
+		size *= MB
 	case "gb":
-		size = size * GB
+		size *= GB
 	case "tb":
-		size = size * TB
+		size *= TB
 	}
 
 	attachment, err := strconv.ParseBool(queryParams.Get("attachment"))
@@ -127,7 +184,7 @@ func dataHandler(w http.ResponseWriter, r *http.Request) {
 	content := fillContent(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
 	}
@@ -148,6 +205,10 @@ func whoamiHandler(w http.ResponseWriter, req *http.Request) {
 		}
 	}
 
+	if name != "" {
+		_, _ = fmt.Fprintln(w, "Name:", name)
+	}
+
 	hostname, _ := os.Hostname()
 	_, _ = fmt.Fprintln(w, "Hostname:", hostname)
 
@@ -184,6 +245,7 @@ func apiHandler(w http.ResponseWriter, req *http.Request) {
 		URL      string      `json:"url,omitempty"`
 		Host     string      `json:"host,omitempty"`
 		Method   string      `json:"method,omitempty"`
+		Name     string      `json:"name,omitempty"`
 	}{
 		Hostname: hostname,
 		IP:       []string{},
@@ -191,6 +253,7 @@ func apiHandler(w http.ResponseWriter, req *http.Request) {
 		URL:      req.URL.RequestURI(),
 		Host:     req.Host,
 		Method:   req.Method,
+		Name:     name,
 	}
 
 	ifaces, _ := net.Interfaces()
@@ -211,6 +274,7 @@ func apiHandler(w http.ResponseWriter, req *http.Request) {
 		}
 	}
 
+	w.Header().Set("Content-Type", "application/json")
 	if err := json.NewEncoder(w).Encode(data); err != nil {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 		return
@@ -221,8 +285,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 {
@@ -247,7 +313,7 @@ func healthHandler(w http.ResponseWriter, req *http.Request) {
 
 func fillContent(length int64) io.ReadSeeker {
 	charset := "-ABCDEFGHIJKLMNOPQRSTUVWXYZ"
-	b := make([]byte, length, length)
+	b := make([]byte, length)
 
 	for i := range b {
 		b[i] = charset[i%len(charset)]
@@ -260,3 +326,11 @@ func fillContent(length int64) io.ReadSeeker {
 
 	return bytes.NewReader(b)
 }
+
+func getEnv(key, fallback string) string {
+	value := os.Getenv(key)
+	if len(value) == 0 {
+		return fallback
+	}
+	return value
+}

go.mod

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

go.sum

@@ -1,2 +1,2 @@
-github.com/gorilla/websocket v1.2.0 h1:VJtLvh6VQym50czpZzx07z/kw9EgAxI3x1ZB8taTMQQ=
-github.com/gorilla/websocket v1.2.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
+github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc=
+github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=

tmpl.Dockerfile

@@ -0,0 +1,25 @@
+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/*
+
+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 --from=builder /go/whoami/whoami .
+
+ENTRYPOINT ["/whoami"]
+EXPOSE 80