5 Commits

10 changed files with 242 additions and 115 deletions

50
.github/workflows/go-cross.yml vendored Normal file
View File

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

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

@ -0,0 +1,80 @@
name: Main
on:
push:
branches:
- master
tags:
- v*
pull_request:
jobs:
main:
name: Main Process
runs-on: ubuntu-latest
env:
GO_VERSION: 1.17
GOLANGCI_LINT_VERSION: v1.43.0
SEIHON_VERSION: v0.8.5
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
# 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,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 = []

46
.golangci.yml Normal file
View File

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

View File

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

View File

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

View File

@ -1,7 +1,7 @@
# whoami # whoami
[![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://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
@ -22,7 +22,7 @@ Tiny Go webserver that prints os information and HTTP request to output
- `cert`: give me a certificate. - `cert`: give me a certificate.
- `key`: give me a key. - `key`: give me a key.
- `port`: give me a port number. (default: 80) - `port`: give me a port number. (it can be also defined with `WHOAMI_PORT` environment variable) (default: 80)
- `name`: give me a name. (it can be also defined with `WHOAMI_NAME` environment variable) - `name`: give me a name. (it can be also defined with `WHOAMI_NAME` environment variable)
## Examples ## Examples

62
app.go
View File

@ -2,10 +2,13 @@ package main
import ( import (
"bytes" "bytes"
"crypto/tls"
"crypto/x509"
"encoding/json" "encoding/json"
"flag" "flag"
"fmt" "fmt"
"io" "io"
"io/ioutil"
"log" "log"
"net" "net"
"net/http" "net/http"
@ -28,15 +31,19 @@ const (
TB TB
) )
var cert string var (
var key string cert string
var port string key string
var name string ca string
port string
name string
)
func init() { func init() {
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(&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", "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")
} }
@ -58,11 +65,38 @@ func main() {
fmt.Println("Starting up on port " + port) fmt.Println("Starting up on port " + port)
if len(cert) > 0 && len(key) > 0 { if len(cert) > 0 && len(key) > 0 {
log.Fatal(http.ListenAndServeTLS(":"+port, cert, key, nil)) server := &http.Server{
Addr: ":" + port,
}
if len(ca) > 0 {
server.TLSConfig = setupMutualTLS(ca)
}
log.Fatal(server.ListenAndServeTLS(cert, key))
} }
log.Fatal(http.ListenAndServe(":"+port, nil)) log.Fatal(http.ListenAndServe(":"+port, nil))
} }
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 benchHandler(w http.ResponseWriter, _ *http.Request) { func benchHandler(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Connection", "keep-alive") w.Header().Set("Connection", "keep-alive")
w.Header().Set("Content-Type", "text/plain") w.Header().Set("Content-Type", "text/plain")
@ -130,7 +164,7 @@ func dataHandler(w http.ResponseWriter, r *http.Request) {
content := fillContent(size) content := fillContent(size)
if attachment { if attachment {
w.Header().Add("Content-Disposition", "Attachment") w.Header().Set("Content-Disposition", "Attachment")
http.ServeContent(w, r, "data.txt", time.Now(), content) http.ServeContent(w, r, "data.txt", time.Now(), content)
return return
} }
@ -231,8 +265,10 @@ type healthState struct {
StatusCode int StatusCode int
} }
var currentHealthState = healthState{http.StatusOK} var (
var mutexHealthState = &sync.RWMutex{} currentHealthState = healthState{http.StatusOK}
mutexHealthState = &sync.RWMutex{}
)
func healthHandler(w http.ResponseWriter, req *http.Request) { func healthHandler(w http.ResponseWriter, req *http.Request) {
if req.Method == http.MethodPost { if req.Method == http.MethodPost {
@ -270,3 +306,11 @@ func fillContent(length int64) io.ReadSeeker {
return bytes.NewReader(b) return bytes.NewReader(b)
} }
func getEnv(key, fallback string) string {
value := os.Getenv(key)
if len(value) == 0 {
return fallback
}
return value
}

2
go.mod
View File

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

View File

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