10 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
6516f0ace6 chore: use GitHub Actions. 2020-12-05 16:51:32 +01:00
9378a1e1d2 Refactor: rebranding (#34) 2020-09-16 09:53:35 +02:00
1ef68230de feat: display name in /api endpoint. 2020-06-20 19:55:29 +02:00
b112c2640e chore: update dependencies. 2020-05-09 17:31:09 +02:00
90425015d5 chore: update linter. 2020-05-09 17:30:12 +02:00
c4809bbe21 feat: add a name to be more human friendly. (#29) 2020-03-11 13:11:36 +01:00
741a054a0c chore: update golangci-lint. 2020-02-28 01:09:42 +01:00
9bf5b44f24 Fix typo in default unit for data size (#24) 2019-10-20 23:53:38 +02:00
bf0a64d4c2 Document the 'wait' and 'unit' query params (#23) 2019-10-16 09:18:17 +02:00
11 changed files with 182 additions and 77 deletions

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

@ -0,0 +1,45 @@
name: Go Matrix
on: [push, pull_request]
jobs:
cross:
name: Go
runs-on: ${{ matrix.os }}
env:
CGO_ENABLED: 0
strategy:
matrix:
go-version: [ 1.14, 1.15, 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:
path: |
~/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-
- name: Test
run: go test -v -cover ./...
- name: Build
run: go build -v -ldflags "-s -w" -trimpath

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

@ -0,0 +1,81 @@
name: Main
on:
push:
branches:
- master
tags:
- v*
pull_request:
jobs:
main:
name: Main Process
runs-on: ubuntu-latest
env:
GO_VERSION: 1.15
GOLANGCI_LINT_VERSION: v1.33.0
SEIHON_VERSION: v0.5.1
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
go mod download
# 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

@ -25,11 +25,21 @@
disable = [
"maligned",
"lll",
"gas",
"gosec",
"dupl",
"prealloc",
"gochecknoglobals",
"gochecknoinits",
"gomnd",
"wsl",
"nlreturn",
"testpackage",
"paralleltest",
"tparallel",
"goerr113",
"wrapcheck",
"exhaustive",
"exhaustivestruct",
]
[issues]

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

@ -187,6 +187,7 @@
identification within third-party archives.
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

@ -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 containous/whoami .
check:
golangci-lint run
image:
docker build -t $(IMAGE_NAME) .
publish-images:
seihon publish -v "$(TAG_NAME)" -v "latest" --image-name containous/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
[![Docker Pulls](https://img.shields.io/docker/pulls/containous/whoami.svg)](https://hub.docker.com/r/containous/whoami/)
[![Build Status](https://travis-ci.com/containous/whoami.svg?branch=master)](https://travis-ci.com/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
@ -9,10 +9,10 @@ Tiny Go webserver that prints os information and HTTP request to output
### Paths
- `/data?size=n`: creates a response with a size `n`.
- `/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`).
- `/`: 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.
- `/health`: heath check
- `GET`, `HEAD`, ...: returns a response with the status code defined by the `POST`
@ -23,11 +23,12 @@ Tiny Go webserver that prints os information and HTTP request to output
- `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
```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}]]
@ -63,3 +64,7 @@ $ curl -v http://localhost:80/health
< 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/cert.cer --key /certs/key.key
```

27
app.go
View File

@ -19,7 +19,7 @@ import (
"github.com/gorilla/websocket"
)
// Units
// Units.
const (
_ = iota
KB int64 = 1 << (10 * iota)
@ -28,14 +28,18 @@ const (
TB
)
var cert string
var key string
var port string
var (
cert string
key string
port string
name string
)
func init() {
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(&name, "name", os.Getenv("WHOAMI_NAME"), "give me a name")
}
var upgrader = websocket.Upgrader{
@ -49,6 +53,7 @@ func main() {
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)
@ -128,7 +133,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
}
@ -149,6 +154,10 @@ func whoamiHandler(w http.ResponseWriter, req *http.Request) {
}
}
if name != "" {
_, _ = fmt.Fprintln(w, "Name:", name)
}
hostname, _ := os.Hostname()
_, _ = fmt.Fprintln(w, "Hostname:", hostname)
@ -185,6 +194,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{},
@ -192,6 +202,7 @@ func apiHandler(w http.ResponseWriter, req *http.Request) {
URL: req.URL.RequestURI(),
Host: req.Host,
Method: req.Method,
Name: name,
}
ifaces, _ := net.Interfaces()
@ -223,8 +234,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 {

4
go.mod
View File

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

4
go.sum
View File

@ -1,2 +1,2 @@
github.com/gorilla/websocket v1.4.1 h1:q7AeDBpnBk8AogcD4DSag/Ukw/KV+YhzLj2bP5HvKCM=
github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc=
github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=

View File

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