Compare commits
19 Commits
Author | SHA1 | Date | |
---|---|---|---|
6516f0ace6 | |||
9378a1e1d2 | |||
1ef68230de | |||
b112c2640e | |||
90425015d5 | |||
c4809bbe21 | |||
741a054a0c | |||
9bf5b44f24 | |||
bf0a64d4c2 | |||
99174922cb | |||
c88b974352 | |||
affedf56a2 | |||
c0fd58d016 | |||
e5a3e4f79d | |||
245b477e37 | |||
3e0740e194 | |||
d8aeedd011 | |||
510476dca9 | |||
fa9f921632 |
45
.github/workflows/go-cross.yml
vendored
Normal file
45
.github/workflows/go-cross.yml
vendored
Normal 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
81
.github/workflows/main.yml
vendored
Normal 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
|
49
.golangci.toml
Normal file
49
.golangci.toml
Normal file
@ -0,0 +1,49 @@
|
||||
[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",
|
||||
"nlreturn",
|
||||
"testpackage",
|
||||
"paralleltest",
|
||||
"tparallel",
|
||||
"goerr113",
|
||||
"wrapcheck",
|
||||
"exhaustive",
|
||||
"exhaustivestruct",
|
||||
]
|
||||
|
||||
[issues]
|
||||
exclude-use-default = false
|
||||
max-per-linter = 0
|
||||
max-same-issues = 0
|
||||
exclude = []
|
18
Dockerfile
18
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
|
||||
|
1
LICENSE
1
LICENSE
@ -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.
|
||||
|
22
Makefile
22
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
|
||||
|
53
README.md
53
README.md
@ -1,13 +1,38 @@
|
||||
# whoami
|
||||
|
||||
[](https://hub.docker.com/r/containous/whoami/)
|
||||
[](https://hub.docker.com/r/traefik/whoami/)
|
||||
[](https://github.com/traefik/whoami/actions)
|
||||
|
||||
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
|
||||
- `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)
|
||||
|
||||
## 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 +44,27 @@ 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/cert.cer --key /certs/key.key
|
||||
```
|
||||
|
36
app.go
36
app.go
@ -19,6 +19,7 @@ import (
|
||||
"github.com/gorilla/websocket"
|
||||
)
|
||||
|
||||
// Units.
|
||||
const (
|
||||
_ = iota
|
||||
KB int64 = 1 << (10 * iota)
|
||||
@ -27,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{
|
||||
@ -110,13 +115,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 +132,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 +153,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 +193,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 +201,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 +222,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 +233,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 +261,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)]
|
||||
|
6
go.mod
6
go.mod
@ -1,5 +1,5 @@
|
||||
module github.com/containous/whoami
|
||||
module github.com/traefik/whoami
|
||||
|
||||
go 1.12
|
||||
go 1.13
|
||||
|
||||
require github.com/gorilla/websocket v1.2.0
|
||||
require github.com/gorilla/websocket v1.4.2
|
||||
|
4
go.sum
4
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=
|
||||
|
25
tmpl.Dockerfile
Normal file
25
tmpl.Dockerfile
Normal file
@ -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
|
Reference in New Issue
Block a user