feat: updated to current state of extension development

- liveness/readiness probes
- helm-chart
- updated dependencies
- linting / auditing in ci

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+ directory: "/"
+ schedule:
+ interval: "weekly"

.github/workflows/ci.yml

@@ -11,27 +11,59 @@ on:
  - 'main'
 
 env:
+ REGISTRY: ghcr.io
  IMAGE_NAME: ${{ github.repository }}
 
 jobs:
- build:
+ audit:
+ name: Audit
  runs-on: ubuntu-latest
- permissions:
- contents: read
- packages: write
-
  steps:
  - name: Checkout repository
  uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
 
- - uses: actions/setup-go@v3
+ - uses: actions/setup-go@v4
  with:
- go-version: '^1.18.0'
+ go-version: '^1.20.0'
 
- - name: Execute go tests
+ - name: Audit
  run: |
  go mod download
- go test ./...
+ make audit
+
+ - name: Check Sonar Token
+ id: check-sonar
+ shell: bash
+ run: |
+ if [ "${{ secrets.SONAR_TOKEN }}" != '' ]; then
+ echo "available=true" >> $GITHUB_OUTPUT;
+ else
+ echo "available=false" >> $GITHUB_OUTPUT;
+ fi
+
+ - name: SonarCloud Scan
+ if: ${{ steps.check-sonar.outputs.available == 'true' }}
+ uses: SonarSource/sonarcloud-github-action@master
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
+ build-images:
+ name: Build Docker Images
+ needs:
+ - audit
+ runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ packages: write
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
 
  - name: Set up QEMU
  uses: docker/setup-qemu-action@v2
@@ -43,17 +75,18 @@ jobs:
  if: github.event_name != 'pull_request'
  uses: docker/login-action@v2
  with:
- username: ${{ secrets.DOCKER_USERNAME }}
- password: ${{ secrets.DOCKER_PASSWORD }}
+ registry: ${{ env.REGISTRY }}
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
 
  - name: Extract metadata (tags, labels) for Docker
  id: meta
  uses: docker/metadata-action@v4
  with:
- images: steadybit/extension-kong
+ images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
  - name: Build and push Docker image
- uses: docker/build-push-action@v3
+ uses: docker/build-push-action@v4
  with:
  context: ./
  push: ${{ github.event_name != 'pull_request' }}
@@ -64,3 +97,93 @@ jobs:
  NAME=${{ github.repository }}
  VERSION=${{ steps.meta.outputs.version }}
  REVISION=${{ github.sha }}
+
+ test-helm-charts:
+ name: "Test Helm Charts"
+ runs-on: ubuntu-latest
+ needs:
+ - build-images
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+
+ - name: Set up Helm
+ uses: azure/setup-helm@v3
+ with:
+ version: v3.9.0
+
+ - name: Add dependency chart repos
+ run: |
+ helm repo add steadybit https://steadybit.github.io/helm-charts
+
+ - uses: actions/setup-python@v4
+ with:
+ python-version: "3.10"
+
+ - name: Add unit testing plugin
+ run: |
+ helm plugin install https:/quintush/helm-unittest
+
+ - name: Run unit tests
+ run: make charttesting
+
+ - name: Set up chart-testing
+ uses: helm/[email protected]
+
+ - name: Run chart-testing (lint)
+ run: ct lint --config chartTesting.yaml
+
+ - name: Run chart-testing (list-changed)
+ id: list-changed
+ run: |
+ changed=$(ct list-changed --config chartTesting.yaml)
+ if [[ -n "$changed" ]]; then
+ echo "::set-output name=changed::true"
+ fi
+
+ - name: Create kind cluster
+ uses: helm/[email protected]
+ if: steps.list-changed.outputs.changed == 'true'
+
+ - name: Run chart-testing (install)
+ run: ct install --config chartTesting.yaml
+
+
+ release-helm-chart:
+ name: "Release Helm Chart"
+ runs-on: ubuntu-latest
+ needs:
+ - test-helm-charts
+ if: github.ref == 'refs/heads/main'
+
+ permissions:
+ contents: write
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+
+ - name: Configure Git
+ run: |
+ git config user.name "$GITHUB_ACTOR"
+ git config user.email "[email protected]"
+
+ - name: Install Helm
+ uses: azure/setup-helm@v3
+ with:
+ version: v3.8.1
+
+ - name: Add dependency chart repos
+ run: |
+ helm repo add steadybit https://steadybit.github.io/helm-charts
+
+ - name: Run chart-releaser
+ uses: helm/[email protected]
+ with:
+ charts_dir: charts
+ env:
+ CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.gitignore

@@ -1,3 +1,4 @@
 extension-kong
 
 *.iml
+/coverage.out

Dockerfile

@@ -3,7 +3,7 @@
 ##
 ## Build
 ##
-FROM golang:1.18-alpine AS build
+FROM golang:1.20-alpine AS build
 
 ARG NAME
 ARG VERSION
@@ -18,11 +18,11 @@ RUN go mod download
 COPY . .
 
 RUN go build \
- -ldflags="\
- -X 'github.com/steadybit/extension-kit/extbuild.ExtensionName=${NAME}' \
- -X 'github.com/steadybit/extension-kit/extbuild.Version=${VERSION}' \
- -X 'github.com/steadybit/extension-kit/extbuild.Revision=${REVISION}'" \
- -o /extension-kong
+ -ldflags="\
+ -X 'github.com/steadybit/extension-kit/extbuild.ExtensionName=${NAME}' \
+ -X 'github.com/steadybit/extension-kit/extbuild.Version=${VERSION}' \
+ -X 'github.com/steadybit/extension-kit/extbuild.Revision=${REVISION}'" \
+ -o ./extension
 
 ##
 ## Runtime
@@ -38,8 +38,9 @@ USER $USERNAME
 
 WORKDIR /
 
-COPY --from=build /extension-kong /extension-kong
+COPY --from=build /app/extension /extension
 
 EXPOSE 8084
+EXPOSE 8085
 
-ENTRYPOINT ["/extension-kong"]
+ENTRYPOINT ["/extension"]

Makefile

@@ -0,0 +1,61 @@
+# ==================================================================================== #
+# HELPERS
+# ==================================================================================== #
+
+## help: print this help message
+.PHONY: help
+help:
+ @echo 'Usage:'
+ @sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /'
+
+
+# ==================================================================================== #
+# QUALITY CONTROL
+# ==================================================================================== #
+
+## tidy: format code and tidy modfile
+.PHONY: tidy
+tidy:
+ go fmt ./...
+ go mod tidy -v
+
+## audit: run quality control checks
+.PHONY: audit
+audit:
+ go vet ./...
+ go run honnef.co/go/tools/cmd/staticcheck@latest -checks=all,-ST1000,-U1000,-ST1003 ./...
+ go test -race -vet=off -coverprofile=coverage.out ./...
+ go mod verify
+
+## charttesting: Run Helm chart unit tests
+.PHONY: charttesting
+charttesting:
+ for dir in charts/steadybit-extension-*; do \
+ echo "Unit Testing $$dir"; \
+ helm unittest $$dir; \
+ done
+
+## chartlint: Lint charts
+.PHONY: chartlint
+chartlint:
+ ct lint --config chartTesting.yaml
+
+# ==================================================================================== #
+# BUILD
+# ==================================================================================== #
+
+## build: build the extension
+.PHONY: build
+build:
+ go mod verify
+ go build -o=./extension
+
+## run: run the extension
+.PHONY: run
+run: tidy build
+ ./extension
+
+## container: build the container image
+.PHONY: container
+container:
+ docker build -t extension-kong:latest .

README.md

@@ -21,7 +21,7 @@ A [Steadybit](https://www.steadybit.com/) attack implementation to inject HTTP f
 
 ## Deployment
 
-We recommend that you deploy the extension with our [official Helm chart](https:/steadybit/helm-charts/tree/main/charts/steadybit-extension-kong).
+We recommend that you deploy the extension with our [official Helm chart](https:/steadybit/extension-kong/tree/main/charts/steadybit-extension-kong).
 
 ## Agent Configuration
 

chartTesting.yaml

@@ -0,0 +1,8 @@
+# See https:/helm/chart-testing#configuration
+remote: origin
+target-branch: main
+chart-dirs:
+ - charts
+chart-repos:
+ - steadybit=https://steadybit.github.io/helm-charts
+helm-extra-args: --timeout 600s

charts/steadybit-extension-kong/.helmignore

@@ -0,0 +1,24 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
+tests/

charts/steadybit-extension-kong/Chart.lock

@@ -0,0 +1,6 @@
+dependencies:
+- name: extensionlib
+ repository: https://steadybit.github.io/helm-charts
+ version: 1.1.0
+digest: sha256:50f7816a312812729400e1ead5cfe1a89de8aabcc66ff2cc6eac262d0952912b
+generated: "2023-04-24T10:21:31.14342+02:00"

charts/steadybit-extension-kong/Chart.yaml

@@ -0,0 +1,25 @@
+apiVersion: v2
+name: steadybit-extension-kong
+description: Steadybit Kong extension Helm chart for Kubernetes.
+version: 1.6.4
+appVersion: latest
+home: https://www.steadybit.com/
+icon: https://steadybit-website-assets.s3.amazonaws.com/logo-symbol-transparent.png
+maintainers:
+ - email: [email protected]
+ name: reuda
+sources:
+ - https:/steadybit/extension-kong
+annotations:
+ artifacthub.io/images: |
+ - name: logo
+ image: https://steadybit-website-assets.s3.amazonaws.com/logo-symbol-transparent.png
+ artifacthub.io/links: |-
+ - name: Steadybit website
+ url: https://www.steadybit.com
+ - name: Steadybit reliability hub
+ url: https://hub.steadybit.com
+dependencies:
+ - name: extensionlib
+ version: 1.1.0
+ repository: https://steadybit.github.io/helm-charts

charts/steadybit-extension-kong/README.md

@@ -0,0 +1 @@
+For documentation, please refer to the repository's [main documentation](../../README.md).