feat: add issue template

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

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,72 @@
+name: Bug Report
+description: Create a report to help us improve.
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Welcome!
+      description: |
+        The issue tracker is for reporting bugs and feature requests only.
+
+        All new/updated issues are triaged regularly by the maintainers.
+        All issues closed by a bot are subsequently double-checked by the maintainers.
+
+        DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
+
+      options:
+        - label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/whoami/issues) and didn't find any.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: What did you do?
+      description: |
+        How to write a good bug report?
+
+        - Respect the issue template as much as possible.
+        - The title should be short and descriptive.
+        - Explain the conditions which led you to report this issue: the context.
+        - The context should lead to something, an idea or a problem that you’re facing.
+        - Remain clear and concise.
+        - Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
+      placeholder: What did you do?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What were you expecting?
+      placeholder: What were you expecting?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What version are you using?
+      description: |
+        `latest` is not considered as a valid version.
+      placeholder: Paste your output here.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What is your environment & configuration?
+      description: arguments, toml, provider, platform, ...
+      placeholder: Add information here.
+      value: |
+        ```yaml
+        # (paste your configuration here)
+        ```
+
+        Add more configuration information here.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: If applicable, please paste the log output in DEBUG level
+      description: "`--log.level=DEBUG` switch."
+      placeholder: Paste your output here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Traefik Community Support
+    url: https://community.traefik.io/
+    about: If you have a question, or are looking for advice, please post on our Discuss forum! The community loves to chime in to help. Happy Coding!

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,30 @@
+name: Feature Request
+description: Suggest an idea for this project.
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Welcome!
+      description: |
+        The issue tracker is for reporting bugs and feature requests only.
+
+        DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
+      options:
+        - label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/whoami/issues) and didn't find any.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: What did you expect to see?
+      description: |
+        How to write a good issue?
+
+        - Respect the issue template as much as possible.
+        - The title should be short and descriptive.
+        - Explain the conditions which led you to report this issue: the context.
+        - The context should lead to something, an idea or a problem that you’re facing.
+        - Remain clear and concise.
+        - Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
+      placeholder: What did you expect to see?
+    validations:
+      required: true

.github/workflows/ci.yml

@@ -12,32 +12,23 @@ jobs:
     name: Main Process
     runs-on: ubuntu-latest
     env:
-      GO_VERSION: 1.19
-      GOLANGCI_LINT_VERSION: v1.50.0
+      GO_VERSION: stable
+      GOLANGCI_LINT_VERSION: v1.63.4
       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
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      # https://github.com/marketplace/actions/cache
-      - name: Cache Go modules
-        uses: actions/cache@v3
+      # https://github.com/marketplace/actions/setup-go-environment
+      - name: Set up Go ${{ env.GO_VERSION }}
+        uses: actions/setup-go@v5
         with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-
+          go-version: ${{ env.GO_VERSION }}
 
       - name: Check and get dependencies
         run: |

.github/workflows/go-cross.yml

@@ -15,37 +15,19 @@ jobs:
 
     strategy:
       matrix:
-        go-version: [ 1.19, 1.x ]
+        go-version: [ stable, oldstable ]
         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
+        uses: actions/checkout@v4
 
-      # https://github.com/marketplace/actions/cache
-      - name: Cache Go modules
-        uses: actions/cache@v3
+      # https://github.com/marketplace/actions/setup-go-environment
+      - name: Set up Go ${{ matrix.go-version }}
+        uses: actions/setup-go@v5
         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-
+          go-version: ${{ matrix.go-version }}
 
       - name: Test
         run: go test -v -cover ./...

.github/workflows/release.yml

@@ -9,47 +9,47 @@ jobs:
     name: Release Process
     runs-on: ubuntu-latest
     env:
-      GO_VERSION: 1.19
+      GO_VERSION: stable
       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
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
+      # https://github.com/marketplace/actions/setup-go-environment
+      - name: Set up Go ${{ env.GO_VERSION }}
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
       - name: dockerhub-login
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: ghcr-login
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: traefiker
           password: ${{ secrets.GHCR_TOKEN }}
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       # https://goreleaser.com/ci/actions/
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v2
+        uses: goreleaser/goreleaser-action@v5
         with:
           version: latest
-          args: release --rm-dist
+          args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN_REPO }}

.golangci.yml

@@ -1,6 +1,5 @@
 run:
   timeout: 2m
-  skip-files: []
 
 linters-settings:
   govet:
@@ -20,10 +19,13 @@ linters-settings:
   gofumpt:
     extra-rules: true
   depguard:
-    list-type: blacklist
-    include-go-root: false
-    packages:
-      - github.com/pkg/errors
+    rules:
+      main:
+        deny:
+          - pkg: "github.com/instana/testify"
+            desc: not allowed
+          - pkg: "github.com/pkg/errors"
+            desc: Should be replaced by standard lib errors package
   godox:
     keywords:
       - FIXME
@@ -50,29 +52,18 @@ linters-settings:
 linters:
   enable-all: true
   disable:
-    - deadcode # deprecated
-    - exhaustivestruct # deprecated
-    - golint # deprecated
-    - ifshort # deprecated
-    - interfacer # deprecated
-    - maligned # deprecated
-    - nosnakecase # deprecated
-    - scopelint # deprecated
-    - scopelint # deprecated
-    - structcheck # deprecated
-    - varcheck # deprecated
-    - execinquery # not relevant (SQL)
     - rowserrcheck # not relevant (SQL)
     - sqlclosecheck # not relevant (SQL)
     - cyclop # duplicate of gocyclo
     - dupl
     - exhaustive
     - exhaustruct
+    - exportloopref
     - forbidigo
     - gochecknoglobals
     - gochecknoinits
-    - goerr113
-    - gomnd
+    - err113
+    - mnd
     - gosec
     - lll
     - nilnil
@@ -87,7 +78,7 @@ linters:
 
 issues:
   exclude-use-default: false
-  max-per-linter: 0
+  max-issues-per-linter: 0
   max-same-issues: 0
   exclude:
     - 'package-comments: should have a package comment'

README.md

@@ -16,9 +16,13 @@ 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).
 
+The optional `env` query parameter can be set to `true` to add the environment variables to the response.
+
 #### `/api`
 
-Returns the whoami information as JSON.
+Returns the whoami information (and some extra information) as JSON.
+
+The optional `env` query parameter can be set to `true` to add the environment variables to the response.
 
 #### `/bench`
 

app.go

@@ -10,7 +10,6 @@ import (
 	"log"
 	"net"
 	"net/http"
-	"net/url"
 	"os"
 	"strconv"
 	"strings"
@@ -29,6 +28,14 @@ const (
 	TB
 )
 
+var upgrader = websocket.Upgrader{
+	ReadBufferSize:  1024,
+	WriteBufferSize: 1024,
+	CheckOrigin: func(_ *http.Request) bool {
+		return true
+	},
+}
+
 var (
 	cert    string
 	key     string
@@ -47,12 +54,17 @@ func init() {
 	flag.StringVar(&name, "name", os.Getenv("WHOAMI_NAME"), "give me a name")
 }
 
-var upgrader = websocket.Upgrader{
-	ReadBufferSize:  1024,
-	WriteBufferSize: 1024,
-	CheckOrigin: func(r *http.Request) bool {
-		return true
-	},
+// Data whoami information.
+type Data struct {
+	Hostname   string            `json:"hostname,omitempty"`
+	IP         []string          `json:"ip,omitempty"`
+	Headers    http.Header       `json:"headers,omitempty"`
+	URL        string            `json:"url,omitempty"`
+	Host       string            `json:"host,omitempty"`
+	Method     string            `json:"method,omitempty"`
+	Name       string            `json:"name,omitempty"`
+	RemoteAddr string            `json:"remoteAddr,omitempty"`
+	Environ    map[string]string `json:"environ,omitempty"`
 }
 
 func main() {
@@ -77,7 +89,7 @@ func main() {
 		Handler: mux,
 	}
 
-	if len(ca) > 0 {
+	if ca != "" {
 		server.TLSConfig = setupMutualTLS(ca)
 	}
 
@@ -147,15 +159,14 @@ func echoHandler(w http.ResponseWriter, r *http.Request) {
 
 func printBinary(s []byte) {
 	fmt.Printf("Received b:")
-	for n := 0; n < len(s); n++ {
+	for n := range s {
 		fmt.Printf("%d,", s[n])
 	}
 	fmt.Printf("\n")
 }
 
 func dataHandler(w http.ResponseWriter, r *http.Request) {
-	u, _ := url.Parse(r.URL.String())
-	queryParams := u.Query()
+	queryParams := r.URL.Query()
 
 	size, err := strconv.ParseInt(queryParams.Get("size"), 10, 64)
 	if err != nil {
@@ -196,10 +207,11 @@ func dataHandler(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
-func whoamiHandler(w http.ResponseWriter, req *http.Request) {
-	u, _ := url.Parse(req.URL.String())
-	wait := u.Query().Get("wait")
-	if len(wait) > 0 {
+func whoamiHandler(w http.ResponseWriter, r *http.Request) {
+	queryParams := r.URL.Query()
+
+	wait := queryParams.Get("wait")
+	if wait != "" {
 		duration, err := time.ParseDuration(wait)
 		if err == nil {
 			time.Sleep(duration)
@@ -213,66 +225,47 @@ func whoamiHandler(w http.ResponseWriter, req *http.Request) {
 	hostname, _ := os.Hostname()
 	_, _ = fmt.Fprintln(w, "Hostname:", hostname)
 
-	ifaces, _ := net.Interfaces()
-	for _, i := range ifaces {
-		addrs, _ := i.Addrs()
-		// handle err
-		for _, addr := range addrs {
-			var ip net.IP
-			switch v := addr.(type) {
-			case *net.IPNet:
-				ip = v.IP
-			case *net.IPAddr:
-				ip = v.IP
-			}
-			_, _ = fmt.Fprintln(w, "IP:", ip)
-		}
+	for _, ip := range getIPs() {
+		_, _ = fmt.Fprintln(w, "IP:", ip)
 	}
 
-	_, _ = fmt.Fprintln(w, "RemoteAddr:", req.RemoteAddr)
-	if err := req.Write(w); err != nil {
+	_, _ = fmt.Fprintln(w, "RemoteAddr:", r.RemoteAddr)
+	if err := r.Write(w); err != nil {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 		return
 	}
+
+	if ok, _ := strconv.ParseBool(queryParams.Get("env")); ok {
+		for _, env := range os.Environ() {
+			_, _ = fmt.Fprintln(w, env)
+		}
+	}
 }
 
-func apiHandler(w http.ResponseWriter, req *http.Request) {
+func apiHandler(w http.ResponseWriter, r *http.Request) {
+	queryParams := r.URL.Query()
+
 	hostname, _ := os.Hostname()
 
-	data := struct {
-		Hostname string      `json:"hostname,omitempty"`
-		IP       []string    `json:"ip,omitempty"`
-		Headers  http.Header `json:"headers,omitempty"`
-		URL      string      `json:"url,omitempty"`
-		Host     string      `json:"host,omitempty"`
-		Method   string      `json:"method,omitempty"`
-		Name     string      `json:"name,omitempty"`
-	}{
-		Hostname: hostname,
-		IP:       []string{},
-		Headers:  req.Header,
-		URL:      req.URL.RequestURI(),
-		Host:     req.Host,
-		Method:   req.Method,
-		Name:     name,
+	environ := make(map[string]string)
+
+	if ok, _ := strconv.ParseBool(queryParams.Get("env")); ok {
+		for _, env := range os.Environ() {
+			before, after, _ := strings.Cut(env, "=")
+			environ[before] = after
+		}
 	}
 
-	ifaces, _ := net.Interfaces()
-	for _, i := range ifaces {
-		addrs, _ := i.Addrs()
-		// handle err
-		for _, addr := range addrs {
-			var ip net.IP
-			switch v := addr.(type) {
-			case *net.IPNet:
-				ip = v.IP
-			case *net.IPAddr:
-				ip = v.IP
-			}
-			if ip != nil {
-				data.IP = append(data.IP, ip.String())
-			}
-		}
+	data := Data{
+		Hostname:   hostname,
+		IP:         getIPs(),
+		Headers:    r.Header,
+		URL:        r.URL.RequestURI(),
+		Host:       r.Host,
+		Method:     r.Method,
+		Name:       name,
+		RemoteAddr: r.RemoteAddr,
+		Environ:    environ,
 	}
 
 	w.Header().Set("Content-Type", "application/json")
@@ -319,3 +312,27 @@ func getEnv(key, fallback string) string {
 	}
 	return value
 }
+
+func getIPs() []string {
+	var ips []string
+
+	ifaces, _ := net.Interfaces()
+	for _, i := range ifaces {
+		addrs, _ := i.Addrs()
+		// handle err
+		for _, addr := range addrs {
+			var ip net.IP
+			switch v := addr.(type) {
+			case *net.IPNet:
+				ip = v.IP
+			case *net.IPAddr:
+				ip = v.IP
+			}
+			if ip != nil {
+				ips = append(ips, ip.String())
+			}
+		}
+	}
+
+	return ips
+}

content_test.go

@@ -19,7 +19,6 @@ func Test_contentReader_Read(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		test := test
 		t.Run(test.name, func(t *testing.T) {
 			t.Parallel()
 
@@ -56,7 +55,6 @@ func Test_contentReader_ReadSeek(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		test := test
 		t.Run(test.name, func(t *testing.T) {
 			t.Parallel()
 

go.mod

@@ -1,5 +1,5 @@
 module github.com/traefik/whoami
 
-go 1.19
+go 1.23
 
-require github.com/gorilla/websocket v1.4.2
+require github.com/gorilla/websocket v1.5.3

go.sum

@@ -1,2 +1,2 @@
-github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc=
-github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
+github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
+github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=