From 93b275ec4217afe129a09ae2d0ac9061f69cdace Mon Sep 17 00:00:00 2001 From: Tit Petric Date: Sat, 28 Dec 2024 09:50:33 +0100 Subject: [PATCH] [TT-13769] Extend plugin compiler test with arm64 cross build (#6813) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### **PR Type** tests ___ ### **Description** - Extended the plugin compiler test script to include a cross-compilation step for the `arm64` architecture. - Added a Docker command with the `GOARCH=arm64` environment variable to enable arm64 builds. - Ensures compatibility and testing for arm64 architecture in the plugin compiler. ___ ### **Changes walkthrough** 📝
Relevant files
Tests
test.sh
Add arm64 cross-compilation to plugin compiler test script
ci/tests/plugin-compiler/test.sh
  • Added a cross-compilation step for building the plugin for the arm64
    architecture.
  • Introduced the use of the GOARCH=arm64 environment variable in the
    Docker command.
    		•  +3/-0     
    ___ > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull request to receive relevant information --------- Co-authored-by: Tit Petric (cherry picked from commit f2ff583a6b9700e7cb24fb2235ee63504443b8d6) --- ci/tests/plugin-compiler/README.md | 6 +++ ci/tests/plugin-compiler/Taskfile.yml | 17 +++++++- ci/tests/plugin-compiler/test.sh | 3 ++ .../testdata/qa-plugin/README.md | 6 +++ .../testdata/qa-plugin/main.go | 40 +++++++++++++++++++ 5 files changed, 70 insertions(+), 2 deletions(-) create mode 100644 ci/tests/plugin-compiler/testdata/qa-plugin/README.md create mode 100644 ci/tests/plugin-compiler/testdata/qa-plugin/main.go diff --git a/ci/tests/plugin-compiler/README.md b/ci/tests/plugin-compiler/README.md index b2aa02579fd..488f22da15a 100644 --- a/ci/tests/plugin-compiler/README.md +++ b/ci/tests/plugin-compiler/README.md @@ -38,6 +38,12 @@ The following variables are set as defaults: Use `task -l` to list available targets, or read on. +Example: Run a plugin subtest against a release image. + +``` +task test:qa-plugin image=tykio/tyk-plugin-compiler:v5.3.9-rc4 +``` + ## Building and testing plugin compiler locally In order to build the plugin compiler images locally from source, diff --git a/ci/tests/plugin-compiler/Taskfile.yml b/ci/tests/plugin-compiler/Taskfile.yml index 0e0fe1c0ed5..c9f0b64c3af 100644 --- a/ci/tests/plugin-compiler/Taskfile.yml +++ b/ci/tests/plugin-compiler/Taskfile.yml @@ -1,3 +1,4 @@ +# yamllint disable rule:line-length --- version: "3" @@ -82,7 +83,6 @@ tasks: internal: true cmds: - test:basic-plugin: desc: "Test plugin compiler (basic-plugin)" vars: @@ -96,6 +96,20 @@ tasks: - docker run {{.args}} --entrypoint=/usr/local/bin/tyk {{.image}} plugin load -f plugin.so -s {{.symbol}} - strings {{.plugin_path}}/plugin.so | grep test_goplugin.go + test:qa-plugin: + desc: "Test plugin compiler (qa-plugin) amd64 e2e + arm64 build" + vars: + plugin_path: '{{.root}}/ci/tests/plugin-compiler/testdata/qa-plugin' + symbol: AuthCheck + args: --rm -e DEBUG=1 -v {{.plugin_path}}:/plugin-source -w /plugin-source + cmds: + - rm -f {{.plugin_path}}/*.so + - docker run {{.args}} {{.image}} plugin.so + - cp -f {{.plugin_path}}/*.so {{.plugin_path}}/plugin.so + - docker run -e GOARCH=arm64 {{.args}} {{.image}} plugin.so + - docker run {{.args}} --entrypoint=/usr/local/bin/tyk {{.image}} plugin load -f plugin.so -s {{.symbol}} + - strings {{.plugin_path}}/plugin.so | grep test_goplugin.go + test:basic-plugin-id: desc: "Test plugin compiler (basic-plugin)" vars: @@ -136,4 +150,3 @@ tasks: - cp -f {{.plugin_path}}/*.so {{.plugin_path}}/plugin.so - docker run {{.args}} --entrypoint=/usr/local/bin/tyk {{.image}} plugin load -f plugin.so -s {{.symbol}} - strings {{.plugin_path}}/plugin.so | grep main.go - diff --git a/ci/tests/plugin-compiler/test.sh b/ci/tests/plugin-compiler/test.sh index a872de329e5..f889d5debaf 100755 --- a/ci/tests/plugin-compiler/test.sh +++ b/ci/tests/plugin-compiler/test.sh @@ -22,6 +22,9 @@ rm -fv $PLUGIN_SOURCE_PATH/*.so || true docker run --rm -v $PLUGIN_SOURCE_PATH:/plugin-source $PLUGIN_COMPILER_IMAGE plugin.so cp $PLUGIN_SOURCE_PATH/*.so $PLUGIN_SOURCE_PATH/plugin.so +# Cross compile to arm64 +docker run --rm -e GOARCH=arm64 -v $PLUGIN_SOURCE_PATH:/plugin-source $PLUGIN_COMPILER_IMAGE plugin.so + docker compose up -d --wait --force-recreate || { docker compose logs gw; exit 1; } curl http://localhost:8080/goplugin/headers | jq -e '.headers.Foo == "Bar"' || { docker compose logs gw; exit 1; } diff --git a/ci/tests/plugin-compiler/testdata/qa-plugin/README.md b/ci/tests/plugin-compiler/testdata/qa-plugin/README.md new file mode 100644 index 00000000000..ca3790e1bd9 --- /dev/null +++ b/ci/tests/plugin-compiler/testdata/qa-plugin/README.md @@ -0,0 +1,6 @@ +# QA Plugin + +The only difference between this and other plugins is that this one does +not provide a go.mod. This means a slightly different build path is +tested for the plugin compiler, ensuring coverage for when no go.mod is +provided. diff --git a/ci/tests/plugin-compiler/testdata/qa-plugin/main.go b/ci/tests/plugin-compiler/testdata/qa-plugin/main.go new file mode 100644 index 00000000000..11bea5f5059 --- /dev/null +++ b/ci/tests/plugin-compiler/testdata/qa-plugin/main.go @@ -0,0 +1,40 @@ +package main + +import ( + "net/http" + + "github.com/TykTechnologies/tyk/ctx" + "github.com/TykTechnologies/tyk/log" + "github.com/TykTechnologies/tyk/user" +) + +var logger = log.Get() + +// AddFooBarHeader adds custom "Foo: Bar" header to the request +func AddFooBarHeader(rw http.ResponseWriter, r *http.Request) { + r.Header.Add("Foo", "Bar") +} + +// Custom Auth, applies a rate limit of +// 2 per 10 given a token of "abc" +func AuthCheck(rw http.ResponseWriter, r *http.Request) { + token := r.Header.Get("Authorization") + if token != "d3fd1a57-94ce-4a36-9dfe-679a8f493b49" && token != "3be61aa4-2490-4637-93b9-105001aa88a5" { + rw.WriteHeader(http.StatusUnauthorized) + return + } + session := &user.SessionState{ + Alias: token, + Rate: 2, + Per: 10, + MetaData: map[string]interface{}{ + token: token, + }, + KeyID: token, + } + ctx.SetSession(r, session, true) +} +func main() {} +func init() { + logger.Info("--- Go custom plugin v4 init success! ---- ") +}