tests(api): adding OTEL log tests [KAG-4828] (#9748)

* tests(api): adding otel log tests * remove package-lock file * tests(api): address otel-log pr comments * tests(api): change file split logic to newline
Kong · Aug 7, 2024 · 612a5e2 · 612a5e2
1 parent caad36c
commit 612a5e2
Show file tree

Hide file tree

Showing 11 changed files with 506 additions and 109 deletions.
diff --git a/.github/workflows/gateway-api-tests-matrix.yml b/.github/workflows/gateway-api-tests-matrix.yml
@@ -239,8 +239,8 @@ jobs:
           username: ${{ secrets.GHA_DOCKERHUB_PULL_USER }}
           password: ${{ secrets.GHA_KONG_ORG_DOCKERHUB_PULL_TOKEN }}
 
-      - name: Add domain.test to hostnames for ACME Plugin tests
-        run: echo "127.0.0.1 domain.test" | sudo tee -a /etc/hosts
+      - name: Set domain.test to hostnames for ACME and otel file permissions
+        run: echo "127.0.0.1 domain.test" | sudo tee -a /etc/hosts && cd gateway-docker-compose-generator/otel && chmod 666 file_exporter.json
 
       - name: Setup tmate session
         if: ${{ inputs.enable_verbose_response_logging == 'true' }}
@@ -285,6 +285,7 @@ jobs:
           # set CUSTOM_PLUGIN to false in case of amazonlinux-2 image
           CUSTOM_PLUGIN: ${{ endsWith(env.GW_IMAGE, 'amazonlinux-2') && 'false' || env.CUSTOM_PLUGIN_VAR }}
           ACME: true
+          OTEL: true
 
       - name: Logs from Gateway Start
         if: failure()
@@ -431,9 +432,9 @@ jobs:
         with:
           username: ${{ secrets.GHA_DOCKERHUB_PULL_USER }}
           password: ${{ secrets.GHA_KONG_ORG_DOCKERHUB_PULL_TOKEN }}
-
-      - name: Add domain.test to hostnames for ACME Plugin tests
-        run: echo "127.0.0.1 domain.test" | sudo tee -a /etc/hosts
+      
+      - name: Set domain.test to hostnames for ACME and otel file permissions
+        run: echo "127.0.0.1 domain.test" | sudo tee -a /etc/hosts && cd gateway-docker-compose-generator/otel && chmod 666 file_exporter.json
 
       - name: Setup tmate session
         if: ${{ inputs.enable_verbose_response_logging == 'true' }}
@@ -477,6 +478,7 @@ jobs:
           # set CUSTOM_PLUGIN to false in case of amazonlinux-2 image
           CUSTOM_PLUGIN: ${{ endsWith(env.GW_IMAGE, 'amazonlinux-2') && 'false' || env.CUSTOM_PLUGIN_VAR }}
           ACME: true
+          OTEL: true
 
       - name: Logs from Gateway Start
         if: failure()
@@ -606,9 +608,9 @@ jobs:
         with:
           username: ${{ secrets.GHA_DOCKERHUB_PULL_USER }}
           password: ${{ secrets.GHA_KONG_ORG_DOCKERHUB_PULL_TOKEN }}
-
-      - name: Add domain.test to hostnames for ACME Plugin tests
-        run: echo "127.0.0.1 domain.test" | sudo tee -a /etc/hosts
+      
+      - name: Set domain.test to hostnames for ACME and otel file permissions
+        run: echo "127.0.0.1 domain.test" | sudo tee -a /etc/hosts && cd gateway-docker-compose-generator/otel && chmod 666 file_exporter.json
 
       - name: Setup tmate session
         if: ${{ inputs.enable_verbose_response_logging == 'true' }}
@@ -664,6 +666,7 @@ jobs:
           AZURE_CLIENT_SECRET: ${{ secrets.TEST_API_AZURE_CLIENT_SECRET }}
           ACME: true
           CUSTOM_PLUGIN: ${{ env.CUSTOM_PLUGIN_VAR }}
+          OTEL: true
 
       - name: Logs from Gateway Start
         if: failure()

diff --git a/.github/workflows/gateway-api-tests.yml b/.github/workflows/gateway-api-tests.yml
@@ -110,8 +110,8 @@ jobs:
           username: ${{ secrets.GHA_DOCKERHUB_PULL_USER }}
           password: ${{ secrets.GHA_KONG_ORG_DOCKERHUB_PULL_TOKEN }}
 
-      - name: Add domain.test to hostnames for ACME Plugin tests
-        run: echo "127.0.0.1 domain.test" | sudo tee -a /etc/hosts
+      - name: Set domain.test to hostnames for ACME and otel file permissions
+        run: echo "127.0.0.1 domain.test" | sudo tee -a /etc/hosts && cd gateway-docker-compose-generator/otel && chmod 666 file_exporter.json
 
       - name: Check for FIPS image
         run: |
@@ -151,6 +151,7 @@ jobs:
           # set CUSTOM_PLUGIN to false in case of amazonlinux-2 image
           CUSTOM_PLUGIN: ${{ endsWith(env.GW_IMAGE, 'amazonlinux-2') && 'false' || env.CUSTOM_PLUGIN_VAR }}
           ACME: true
+          OTEL: true
 
       - name: Logs from Gateway Start
         if: failure()

diff --git a/spec-ee/kong-api-tests/README.md b/spec-ee/kong-api-tests/README.md
@@ -87,7 +87,8 @@ Make sure to enable these services using [gateway-docker-compose-generator](http
 - All tests relying in upstream service or sending requests to upstream use [httpbin-service](https://github.com/Kong/gateway-docker-compose-generator/blob/ce44aa5d508b7210336a58975285ea8e2e6b6bee/docker-compose.yml.sh#L211) which needs to run in the same docker network as kong. 
 - `1_vitals-influxdb` test requires [INFLUXDB](https://github.com/Kong/gateway-docker-compose-generator/blob/d9ee692675d4efdb14d0e1b8376b20a290f72b34/docker-compose.yml.sh#L32)
 - `aws-lambda-secret-reference` and `rla-secret-reference` tests require [HCV](https://github.com/Kong/gateway-docker-compose-generator/blob/d9ee692675d4efdb14d0e1b8376b20a290f72b34/docker-compose.yml.sh#L40)
-- `opentelemtry` test requires [JAEGER](https://github.com/Kong/gateway-docker-compose-generator/blob/d9ee692675d4efdb14d0e1b8376b20a290f72b34/docker-compose.yml.sh#L54)
+- `opentelemetry` test requires [JAEGER](https://github.com/Kong/gateway-docker-compose-generator/blob/d9ee692675d4efdb14d0e1b8376b20a290f72b34/docker-compose.yml.sh#L54)
+- `otel-logs` test requires [opentelemetry-collector](https://github.com/Kong/gateway-docker-compose-generator/blob/main/docker-compose.yml.sh#L108)
 - `rate-limiting-advanced` test requires [REDIS (standalone)](https://github.com/Kong/gateway-docker-compose-generator/blob/d9ee692675d4efdb14d0e1b8376b20a290f72b34/docker-compose.yml.sh#L29)
 - `oas-validation` test requires [SWAGGER](https://github.com/Kong/gateway-docker-compose-generator/blob/main/docker-compose.yml.sh#L36)
 - `acme` test requires [Pebble](https://github.com/Kong/gateway-docker-compose-generator/blob/main/docker-compose.yml.sh#L1022) which will be automatically enabled when [ACME](https://github.com/Kong/gateway-docker-compose-generator/blob/main/docker-compose.yml.sh#L126) is set to `true`