Merge pull request #2 from lukaszbudnik/go-modules-gorilla-tests-json

go modules, gorilla web toolkit, changed responses to json

.github/workflows/go.yml

@@ -0,0 +1,25 @@
+name: Go
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.15
+
+    - name: Build
+      run: go build -v ./...
+
+    - name: Test
+      run: go test -v ./...

.gitignore

@@ -0,0 +1,2 @@
+debug.test
+yosoy

Dockerfile

@@ -1,13 +1,13 @@
-FROM golang:1.13.5-alpine3.10 as builder
+FROM golang:1.15.7-alpine3.13 as builder
 
 LABEL maintainer="Łukasz Budnik lukasz.budnik@gmail.com"
 
 # build yosoy
-RUN apk add git
+RUN apk --update add git
 RUN git clone https://github.com/lukaszbudnik/yosoy.git
 RUN cd /go/yosoy && go build
 
-FROM alpine:3.10
+FROM alpine:3.13
 COPY --from=builder /go/yosoy/yosoy /bin
 
 # register entrypoint

README.md

@@ -11,19 +11,24 @@ Typical use cases include:
 * testing HTTP caching
 * stubbing and prototyping distributed applications
 
-yosoy will provide information like:
-
-* Request URI
-* Hostname
-* Remote IP
-* How many times it was called
-* HTTP headers
-* Env variables if `YOSOY_SHOW_ENVS` is set to `true`, `yes`, `on`, or `1`
-* Files' contents if `YOSOY_SHOW_FILES` is set to a comma-separated list of (valid) files
+## API
+
+yosoy responds to all requests with a JSON containing the information about:
+
+* HTTP request:
+  * Host
+  * Request URI
+  * Remote IP
+  * HTTP headers
+  * HTTP proxy headers
+* host:
+  * Hostname
+  * How many times it was called
+  * Env variables if `YOSOY_SHOW_ENVS` is set to `true`, `yes`, `on`, or `1`
+  * Files' contents if `YOSOY_SHOW_FILES` is set to a comma-separated list of (valid) files
 
 See [Kubernetes example](#kubernetes-example) below.
 
-
 ## Docker image
 
 The docker image is available on docker hub:
@@ -36,116 +41,58 @@ It exposes HTTP service on port 80.
 
 ## Kubernetes example
 
-Let's take a look at a sample Kubernetes deployment file. It uses both `YOSOY_SHOW_ENVS` and `YOSOY_SHOW_FILES`.
-
-> To illustrate `YOSOY_SHOW_FILES` functionality Kubernetes Downward API is used to expose labels and annotations as volume files which are then returned by yosoy.
-
-```
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: camarero
-  labels:
-    app.kubernetes.io/name: camarero
-spec:
-  replicas: 2
-  selector:
-    matchLabels:
-      app.kubernetes.io/name: camarero
-  template:
-    metadata:
-      labels:
-        app.kubernetes.io/name: camarero
-    spec:
-      containers:
-      - name: yosoy
-        image: lukasz/yosoy
-        env:
-          - name: YOSOY_SHOW_ENVS
-            value: "true"
-          - name: YOSOY_SHOW_FILES
-            value: "/etc/podinfo/labels,/etc/podinfo/annotations"
-        ports:
-        - containerPort: 80
-        volumeMounts:
-        - name: podinfo
-          mountPath: /etc/podinfo
-      volumes:
-        - name: podinfo
-          downwardAPI:
-            items:
-              - path: "labels"
-                fieldRef:
-                  fieldPath: metadata.labels
-              - path: "annotations"
-                fieldRef:
-                  fieldPath: metadata.annotations
----
-apiVersion: v1
-kind: Service
-metadata:
-  name: camarero
-  labels:
-    app.kubernetes.io/name: camarero
-spec:
-  type: NodePort
-  selector:
-    app.kubernetes.io/name: camarero
-  ports:
-    - protocol: TCP
-      port: 80
-```
-
-Deploy above service (with 2 replicas) and execute curl to the service a couple of times:
-
-```
-kubectl apply -f test-deployment.yaml
-export NODE_PORT=$(kubectl get services/camarero -o go-template='{{(index .spec.ports 0).nodePort}}')
-curl $(minikube ip):$NODE_PORT
-curl $(minikube ip):$NODE_PORT
-curl $(minikube ip):$NODE_PORT
-curl $(minikube ip):$NODE_PORT
+There is a sample Kubernetes deployment file in the `test` folder. It uses both `YOSOY_SHOW_ENVS` and `YOSOY_SHOW_FILES`. The deployment uses Kubernetes Downward API to expose labels and annotations as volume files which are then returned by yosoy.
+
+Deploy it to minikube and execute curl to the service a couple of times:
+
+```bash
+# start minikube
+minikube start
+# deploy test service
+kubectl apply -f test/deployment.yaml
+# tunnel to it and copy the URL as $URL variable
+minikube service --url camarero
+# call it a few times
+curl $URL
+curl $URL
+curl $URL
+curl $URL
 ```
 
 A sample response looks like this:
 
-```
-Request URI: /
-Hostname: camarero-859d7c6d6b-kb5s5
-Remote IP: 172.18.0.1
-Called: 2
-
-HTTP headers:
-Accept: */*
-User-Agent: curl/7.64.1
-
-Env variables:
-PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
-HOSTNAME=camarero-859d7c6d6b-kb5s5
-YOSOY_SHOW_ENVS=true
-YOSOY_SHOW_FILES=/etc/podinfo/labels,/etc/podinfo/annotations
-CAMARERO_PORT_80_TCP_PORT=80
-CAMARERO_PORT_80_TCP_ADDR=10.105.203.131
-KUBERNETES_PORT=tcp://10.96.0.1:443
-KUBERNETES_PORT_443_TCP_PORT=443
-CAMARERO_SERVICE_HOST=10.105.203.131
-KUBERNETES_PORT_443_TCP_PROTO=tcp
-KUBERNETES_SERVICE_HOST=10.96.0.1
-KUBERNETES_SERVICE_PORT=443
-KUBERNETES_SERVICE_PORT_HTTPS=443
-KUBERNETES_PORT_443_TCP=tcp://10.96.0.1:443
-KUBERNETES_PORT_443_TCP_ADDR=10.96.0.1
-CAMARERO_PORT=tcp://10.105.203.131:80
-CAMARERO_SERVICE_PORT=80
-CAMARERO_PORT_80_TCP=tcp://10.105.203.131:80
-CAMARERO_PORT_80_TCP_PROTO=tcp
-HOME=/root
-
-File /etc/podinfo/labels:
-app.kubernetes.io/name="camarero"
-pod-template-hash="859d7c6d6b"
-
-File /etc/podinfo/annotations:
-kubernetes.io/config.seen="2020-11-17T07:38:15.374049163Z"
-kubernetes.io/config.source="api"
+```json
+{
+  "host": "127.0.0.1:53366",
+  "requestUri": "/",
+  "remoteAddr": "172.17.0.1",
+  "counter": 4,
+  "headers": {
+    "Accept": [
+      "*/*"
+    ],
+    "User-Agent": [
+      "curl/7.64.1"
+    ]
+  },
+  "hostname": "camarero-77787464ff-hjdkq",
+  "envVariables": [
+    "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
+    "HOSTNAME=camarero-77787464ff-hjdkq",
+    "YOSOY_SHOW_ENVS=true",
+    "YOSOY_SHOW_FILES=/etc/podinfo/labels,/etc/podinfo/annotations",
+    "CAMARERO_SERVICE_HOST=10.97.113.33",
+    "CAMARERO_PORT=tcp://10.97.113.33:80",
+    "CAMARERO_PORT_80_TCP=tcp://10.97.113.33:80",
+    "CAMARERO_PORT_80_TCP_ADDR=10.97.113.33",
+    "CAMARERO_SERVICE_PORT=80",
+    "CAMARERO_PORT_80_TCP_PROTO=tcp",
+    "CAMARERO_PORT_80_TCP_PORT=80",
+    "HOME=/root"
+  ],
+  "files": {
+    "/etc/podinfo/annotations": "kubernetes.io/config.seen=\"2021-02-03T13:18:34.563751030Z\"\nkubernetes.io/config.source=\"api\"",
+    "/etc/podinfo/labels": "app.kubernetes.io/name=\"camarero\"\npod-template-hash=\"77787464ff\""
+  }
+}
 ```

TestDockerfile

@@ -0,0 +1,15 @@
+FROM golang:1.15.7-alpine3.13 as builder
+
+LABEL maintainer="Łukasz Budnik lukasz.budnik@gmail.com"
+
+# build yosoy
+ADD . /go/yosoy
+RUN cd /go/yosoy && go build
+
+FROM alpine:3.13
+COPY --from=builder /go/yosoy/yosoy /bin
+
+# register entrypoint
+ENTRYPOINT ["yosoy"]
+
+EXPOSE 80

go.mod

@@ -0,0 +1,9 @@
+module github.com/lukaszbudnik/yosoy
+
+go 1.15
+
+require (
+	github.com/gorilla/handlers v1.5.1
+	github.com/gorilla/mux v1.8.0
+	github.com/stretchr/testify v1.7.0
+)

go.sum

@@ -0,0 +1,16 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/felixge/httpsnoop v1.0.1 h1:lvB5Jl89CsZtGIWuTcDM1E/vkVs49/Ml7JJe07l8SPQ=
+github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
+github.com/gorilla/handlers v1.5.1 h1:9lRY6j8DEeeBT10CvO9hGW0gmky0BprnvDI5vfhUHH4=
+github.com/gorilla/handlers v1.5.1/go.mod h1:t8XrUpc4KVXb7HGyJ4/cEnwQiaxrX/hz1Zv/4g96P1Q=
+github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
+github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=