Pep plugin

.github/workflows/it.yaml

@@ -0,0 +1,99 @@
+name: Integration tests
+
+on:
+  push
+
+env:
+  KONG_VERSION: 2.8.1
+
+jobs:
+
+  prepare-and-run:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-java@v1
+        with:
+          java-version: '17'
+          java-package: jdk
+
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '>=1.17.0'
+
+      - name: Build pep-plugin 
+        run: |
+          cd ./kong-pep-plugin 
+          docker run -v $(pwd):/temp/ --workdir="/temp" kong/go-plugin-tool:2.0.4-alpine-latest go build -ldflags "-X pep-plugin.Version=${{ needs.generate-version.outputs.version }}" -o pep-plugin .
+          cd ..
+          mkdir ./go-plugins/
+          cp ./kong-pep-plugin/pep-plugin ./go-plugins/pep-plugin
+
+
+      - name: Prepare values
+        run: | 
+          echo GITHUB_ORGANISATION: fiware >> values.yaml
+          echo GITHUB_REPO: kong-plugins-fiware >> values.yaml
+          echo VERSION: 0.0.1 >> values.yaml
+
+
+      - name: Parse rockspec
+        run: |
+          go install github.com/cbroglie/mustache/cmd/mustache@v1.3.1
+          ~/go/bin/mustache values.yaml kong-plugin-auth-endpoint-config-ishare/rockspec.mustache > kong-plugin-auth-endpoint-config-ishare/kong-plugin-auth-endpoint-config-ishare-0.0.1-1.rockspec
+          ~/go/bin/mustache values.yaml kong-plugin-ngsi-ishare-policies/rockspec.mustache > kong-plugin-ngsi-ishare-policies/kong-plugin-ngsi-ishare-policies-0.0.1-1.rockspec
+
+      - uses: leafo/gh-actions-lua@v9
+      - uses: leafo/gh-actions-luarocks@v4
+
+      - name: Make rock
+        run: |
+          cd kong-plugin-auth-endpoint-config-ishare
+          luarocks make
+          luarocks pack kong-plugin-auth-endpoint-config-ishare 0.0.1-1
+          cd ..
+          cd kong-plugin-ngsi-ishare-policies
+          luarocks make 
+          luarocks pack kong-plugin-ngsi-ishare-policies 0.0.1-1
+          cd ..
+          mkdir plugin-dir
+          cp -r kong-plugin-auth-endpoint-config-ishare/.  plugin-dir/
+          cp -r kong-plugin-ngsi-ishare-policies/.  plugin-dir/
+          cd plugin-dir/
+          luarocks install lua-fiware-lib
+          luarocks pack lua-fiware-lib 
+          luarocks install lua-resty-jwt
+          luarocks pack lua-resty-jwt
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Get dockerfiles
+        run: |
+          wget https://raw.githubusercontent.com/Kong/docker-kong/master/customize/Dockerfile
+          wget https://raw.githubusercontent.com/Kong/docker-kong/master/customize/empty_file
+          wget https://raw.githubusercontent.com/Kong/docker-kong/master/customize/packer.lua
+
+      - name: Add plugins
+        run: | 
+          echo "USER root" >> Dockerfile
+          echo "COPY ./go-plugins /kong/go-plugins" >> Dockerfile
+          echo "RUN chmod -R 777 /kong/go-plugins/" >> Dockerfile
+          echo "USER kong" >> Dockerfile
+
+      - name: Build image
+        run: |
+          docker build --build-arg KONG_BASE="kong:${{ env.KONG_VERSION }}-alpine" --build-arg PLUGINS="lua-fiware-lib,kong-plugin-auth-endpoint-config-ishare,kong-plugin-ngsi-ishare-policies" --build-arg ROCKS_DIR="./plugin-dir" . -t fiware/kong:0.0.1
+
+      - name: Execute test
+        run: |
+          cd it/
+          mvn integration-test

.github/workflows/pre-release.yml

@@ -42,21 +42,49 @@ jobs:
           echo "::set-output name=version::$(echo ${VERSION}-PRE-${{ steps.pr_number.outputs.nr }})"
           echo "::set-output name=plain-version::$(echo ${VERSION})"
 
-  git-release:
+  build-pep-plugin:
     needs: ["generate-version"]
     runs-on: ubuntu-latest
 
     steps:
 
       - uses: actions/checkout@v2
 
+      - name: Build pep-plugin 
+        run: |
+          cd ./kong-pep-plugin 
+          docker run -v $(pwd):/temp/ --workdir="/temp" kong/go-plugin-tool:2.0.4-alpine-latest go build -ldflags "-X pep-plugin.Version=${{ needs.generate-version.outputs.version }}" -o pep-plugin .
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: pep-plugin
+          path: ./kong-pep-plugin/pep-plugin
+
+
+  git-release:
+    needs: ["generate-version", "build-pep-plugin"]
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - uses: actions/checkout@v2
+
+      - uses: actions/download-artifact@v2
+        with:
+          name: pep-plugin
+          path: ./go-plugins/
+
+
       - uses: "marvinpinto/action-automatic-releases@latest"
         with:
           repo_token: "${{ secrets.GITHUB_TOKEN }}"
           automatic_release_tag: ${{ needs.generate-version.outputs.version }}
           prerelease: true
           title: ${{ needs.generate-version.outputs.version }}
-
+          files: |
+            ./go-plugins/pep-plugin
+
+
   pre-release-kong:
     needs: ["git-release", "generate-version"]
     runs-on: ubuntu-latest
@@ -69,6 +97,12 @@ jobs:
         with:
           go-version: '>=1.17.0'
 
+      - uses: actions/download-artifact@v2
+        with:
+          name: pep-plugin
+          path: ./go-plugins/
+
+
       - name: Prepare values
         run: | 
           echo GITHUB_ORGANISATION: fiware >> values.yaml
@@ -100,7 +134,7 @@ jobs:
           cp -r kong-plugin-ngsi-ishare-policies/.  plugin-dir/
           cd plugin-dir/
           luarocks install lua-fiware-lib
-          luarocks pack lua-fiware-lib 
+          luarocks pack lua-fiware-lib
           luarocks install lua-resty-jwt
           luarocks pack lua-resty-jwt
 
@@ -119,9 +153,15 @@ jobs:
           wget https://raw.githubusercontent.com/Kong/docker-kong/master/customize/empty_file
           wget https://raw.githubusercontent.com/Kong/docker-kong/master/customize/packer.lua
 
+      - name: Insert go plugins
+        run: |
+          echo "USER root" >> Dockerfile
+          echo "COPY ./go-plugins /kong/go-plugins" >> Dockerfile
+          echo "RUN chmod -R 777 /kong/go-plugins/" >> Dockerfile
+          echo "USER kong" >> Dockerfile
+
       - name: Build and push
         run: |
           docker build --build-arg KONG_BASE="kong:2.8.1-alpine" --build-arg PLUGINS="lua-fiware-lib,kong-plugin-auth-endpoint-config-ishare,kong-plugin-ngsi-ishare-policies" --build-arg ROCKS_DIR="./plugin-dir" --tag quay.io/fiware/kong:${{ needs.generate-version.outputs.version }} .
-
-          docker push quay.io/fiware/kong:${{ needs.generate-version.outputs.version }}
-
+
+          docker push quay.io/fiware/kong:${{ needs.generate-version.outputs.version }}

.github/workflows/release.yml

@@ -31,22 +31,47 @@ jobs:
       - name: Set version output
         id: out
         run: echo "::set-output name=version::$(echo ${VERSION})"
+
+  build-pep-plugin:
+    needs: ["generate-version"]
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - uses: actions/checkout@v2
 
+      - name: Build pep-plugin 
+        run: |
+          cd ./kong-pep-plugin 
+          docker run -v $(pwd):/temp/ --workdir="/temp" kong/go-plugin-tool:2.0.4-alpine-latest go build -ldflags "-X pep-plugin.Version=${{ needs.generate-version.outputs.version }}" -o pep-plugin .
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: pep-plugin
+          path: ./kong-pep-plugin/pep-plugin
 
   git-release:
-    needs: ["generate-version"]
+    needs: ["generate-version", "build-pep-plugin"]
     runs-on: ubuntu-latest
 
     steps:
 
       - uses: actions/checkout@v2
 
+
+      - uses: actions/download-artifact@v2
+        with:
+          name: pep-plugin
+          path: ./go-plugins/
+
       - uses: "marvinpinto/action-automatic-releases@latest"
         with:
           repo_token: "${{ secrets.GITHUB_TOKEN }}"
           automatic_release_tag: ${{ needs.generate-version.outputs.version }}
           title: ${{ needs.generate-version.outputs.version }}
           prerelease: false
+          files: |
+            ./go-plugins/pep-plugin
 
   auth-endpoint-config-ishare:
 

.github/workflows/test.yml

@@ -39,8 +39,6 @@ jobs:
         with:
           name: test-image
           path: /tmp/test-image.tar
-
-
 
   ngsi-ishare-policies:
 
@@ -124,3 +122,19 @@ jobs:
 
       - name: Run tests
         run: ./pongo/pongo-docker.sh run
+
+  pep-plugin: 
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.17.3
+
+    - name: Go test
+      run: |
+        cd kong-pep-plugin/
+        go test -v -covermode=count -coverprofile=coverage.out

README.md

@@ -58,3 +58,12 @@ KONG_VERSION=2.8.1
 # Run pongo
 PONGO_PLUGIN_SOURCE=./kong-plugin-ngsi-ishare-policies ./pongo/pongo-docker.sh run
 ```
+
+## Integration tests
+
+Some plugins connect kong to external components. In order to assure them working in real environments, an integration-test framework based on [k3s](https://k3s.io/) is provided. The tests are executed using the [k3s-maven-plugin](https://github.com/kokuwaio/k3s-maven-plugin). 
+The tests itself are written using [Junit5](https://junit.org/junit5/docs/current/user-guide/). 
+
+### Usage
+
+The tests use the local docker-image "fiware/kong:0.0.1". If a different one should be used, either provide it with that tag or change it inside the [kong.yaml](./it/src/test/k3s/kong.yaml). The tests can be executed via ```mvn integration-test```. For local development, a k3s-setup can be started with ```mvn k3s:create k3s:start k3s:image k3s:kubectl```. Tear down afterwards is executed via ```mvn k3s:rm```.