Bump package (#25)

Author: liranbg

.github/workflows/ci.yaml

@@ -1,3 +1,17 @@
+# Copyright 2019 Iguazio
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 name: CI
 
 on:
@@ -16,11 +30,12 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - uses: actions/setup-go@v2
+    - uses: actions/setup-go@v3
       with:
-        go-version: "1.13"
+        cache: true
+        go-version-file: "go.mod"
 
     - name: Run lint
       run: make lint
@@ -29,10 +44,7 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - uses: actions/setup-go@v2
-      with:
-        go-version: "1.13"
     - name: Run build
       run: make build

.github/workflows/release.yaml

@@ -0,0 +1,56 @@
+# Copyright 2019 Iguazio
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+name: Release
+
+on:
+  release:
+    types:
+      - created
+
+  # Run Release on push to development for unstable
+  push:
+    branches:
+      - development
+
+jobs:
+  release:
+    name: Release Docker Images
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Set unstable
+        if: github.event_name == 'push'
+        run: |
+          echo "LABEL=unstable" >> $GITHUB_ENV
+
+      - name: Set release
+        if: github.event_name == 'release'
+        run: |
+          echo "LABEL=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
+          cat $GITHUB_ENV
+
+      - uses: actions/checkout@v3
+
+      - name: Login to GCR
+        run: |
+          echo "$GCR_JSON_KEY" | docker login -u _json_key --password-stdin https://gcr.io
+        env:
+          GCR_JSON_KEY: ${{ secrets.GCR_IGUAZIO_JSON_KEY }}
+
+      - name: Build image
+        run: make build
+
+      - name: Push image
+        run: make push

.gitignore

@@ -14,5 +14,7 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
+.github/.act
+
 # ignore all logs
 log/

.golangci.yml

@@ -2,35 +2,53 @@ linters:
   disable-all: true
   enable:
     - deadcode
+    - goconst
     - gofmt
-    - golint
+    - revive
     - gosimple
     - ineffassign
-    - interfacer
     - misspell
     - staticcheck
     - unconvert
     - varcheck
     - vet
     - vetshadow
     - errcheck
+    - govet
+    - structcheck
+    - typecheck
+    - gocritic
 
 run:
 
   # timeout for analysis
-  timeout: 10m
-
-  # include test files or not, default is true
-  tests: false
+  timeout: 5m
 
   skip-dirs:
     - hack
-    - docs
+
+linters-settings:
+  revive:
+    rules:
+
+      # avoid  errorf: should replace errors.New(fmt.Sprintf(...)) with fmt.Errorf(...)  messages
+      - name: errorf
+        disabled: true
+
+  gocritic:
+    disabled-checks:
+      - commentFormatting # we dont want to enforce space before the comment text
 
 issues:
 
   # List of regexps of issue texts to exclude
   exclude:
     - "comment on"
     - "error should be the last"
-    - "should have comment"
+
+  exclude-rules:
+
+    # list of excluded linters applied on test files
+    - path: _test\.go
+      linters:
+        - goconst

Jenkinsfile

@@ -1,29 +1,27 @@
-PROXY_PATH ?= src/github.com/v3io/proxy
-PROXY_TAG ?= latest
-PROXY_REPOSITORY ?= v3io/
-PROXY_BUILD_COMMAND ?= GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -a -installsuffix cgo -ldflags="-s -w" -o $(GOPATH)/bin/proxy_server $(GOPATH)/$(PROXY_PATH)/main.go
-
-.PHONY: all
-all: lint build
-	@echo Done.
+LABEL ?= unstable
+REPOSITORY ?= gcr.io/iguazio
+IMAGE = $(REPOSITORY)/sidecar-proxy:$(LABEL)
 
 .PHONY: build
 build:
-	docker build -f cmd/sidecarproxy/Dockerfile --tag=$(PROXY_REPOSITORY)sidecar-proxy:$(PROXY_TAG) .
+	@docker build \
+		--file cmd/sidecarproxy/Dockerfile \
+		--tag=$(IMAGE) \
+		.
 
-.PHONY: bin
-bin:
-	$(PROXY_BUILD_COMMAND)
+.PHONY: push
+push:
+	docker push $(IMAGE)
 
 .PHONY: lint
 lint:
 	./hack/lint/install.sh
 	./hack/lint/run.sh
 
-.PHONY: vet
-vet:
-	go vet ./app/...
+.PHONY: fmt
+fmt:
+	@go fmt $(shell go list ./... | grep -v /vendor/)
 
 .PHONY: test
 test:
-	go test -v ./app/...
+	go test -p1 -v ./pkg/...

Makefile

@@ -1,4 +1,5 @@
-# Sidecar proxy
+# Sidecar Proxy
+
 A containerized proxy meant to run alongside a service (in the same pod) in order to serve Prometheus metrics, and
 facilitate scale-to-zero flows.
 
@@ -14,12 +15,11 @@ The container includes a server that serves Prometheus metrics through the `/met
 
 All metrics contain these labels: `namespace`, `service_name`, `instance_name`.
 
-The code was built so it will be easy to extend it and add new metrics. This is performed by creating a new metric 
+The code was built, so it will be easy to extend it and add new metrics. This is performed by creating a new metric 
 handlers that implement the `MetricsHandler` interface.
 
 When starting the container the `--metric-name` flag (can be defined multiple times) is used to set which metrics 
 handlers to run (`num_of_requests` is mandatory).
 
 An example helm chart that adds this container alongside a Jupyter service can be found 
 [here](https://github.com/v3io/helm-charts/tree/development/stable/jupyter)
-

README.md

@@ -1,19 +1,41 @@
-FROM golang:1.13 as builder
+# Copyright 2019 Iguazio
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+FROM gcr.io/iguazio/golang:1.19 as builder
 
 # copy source tree
-WORKDIR /go/src/github.com/v3io/sidecar-proxy
+WORKDIR /sidecar-proxy
+
+COPY go.mod go.sum ./
+
+RUN go mod download
+
 COPY . .
 
 # build the app
-RUN GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -a -installsuffix cgo -ldflags="-s -w" -o proxy_server cmd/sidecarproxy/main.go
+RUN GOOS=linux \
+    GOARCH=amd64 \
+    CGO_ENABLED=0 \
+    go build -a -installsuffix cgo -ldflags="-s -w" -o proxy_server cmd/sidecarproxy/main.go
 
 #
 # Output stage: Copies binary to an alpine based image
 #
 
-FROM alpine:3.7
+FROM gcr.io/iguazio/alpine:3.17
 
 # copy app binary from build stage
-COPY --from=builder go/src/github.com/v3io/sidecar-proxy/proxy_server /usr/local/bin
+COPY --from=builder /sidecar-proxy/proxy_server /usr/local/bin
 
 CMD [ "proxy_server" ]

cmd/sidecarproxy/Dockerfile

@@ -1,3 +1,16 @@
+// Copyright 2019 Iguazio
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 package main
 
 import (

cmd/sidecarproxy/main.go

@@ -1,15 +1,24 @@
 module github.com/v3io/sidecar-proxy
 
-go 1.13
+go 1.19
 
 require (
-	github.com/alecthomas/units v0.0.0-20190924025748-f65c72e2690d // indirect
-	github.com/google/shlex v0.0.0-20181106134648-c34317bd91bf // indirect
-	github.com/nuclio/errors v0.0.1
+	github.com/nuclio/errors v0.0.4
 	github.com/nuclio/logger v0.0.1
-	github.com/nuclio/loggerus v0.0.1
-	github.com/prometheus/client_golang v1.2.1
-	github.com/sirupsen/logrus v1.4.2
-	gopkg.in/alecthomas/gometalinter.v2 v2.0.12 // indirect
-	gopkg.in/alecthomas/kingpin.v3-unstable v3.0.0-20180810215634-df19058c872c // indirect
+	github.com/nuclio/loggerus v0.0.6
+	github.com/prometheus/client_golang v1.14.0
+	github.com/sirupsen/logrus v1.9.0
+)
+
+require (
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.1.2 // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/logrusorgru/aurora/v3 v3.0.0 // indirect
+	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
+	github.com/prometheus/client_model v0.3.0 // indirect
+	github.com/prometheus/common v0.37.0 // indirect
+	github.com/prometheus/procfs v0.8.0 // indirect
+	golang.org/x/sys v0.4.0 // indirect
+	google.golang.org/protobuf v1.28.1 // indirect
 )