Merge pull request #157 from bcgov/feature/kong3-compatibility

Support Kong 3 configuration (regex paths), warn and downgrade

Author: rustyjux

.github/workflows/dev.yml

@@ -60,8 +60,16 @@ jobs:
           poetry run coverage run --branch -m pytest -s -v
           poetry run coverage xml
 
+      - name: Test coverage for Compatibility API
+        run: |
+          export PATH=/root/.local/bin:$PATH
+          cd microservices/compatibilityApi
+          poetry install --no-root
+          poetry run coverage run --branch -m pytest -s -v
+          poetry run coverage xml
+
       - name: SonarCloud Scan
-        uses: sonarsource/sonarcloud-github-action@master
+        uses: sonarsource/sonarqube-scan-action@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
@@ -164,3 +172,22 @@ jobs:
           tag_with_sha: false
           add_git_labels: true
           push: true
+
+  gwa-compatibility-api:
+    needs: sonar-scan
+    name: Docker Image for gwa-compatibility-api
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: docker/build-push-action@v1
+        with:
+          registry: docker.pkg.github.com
+          username: $GITHUB_ACTOR
+          password: ${{ secrets.GITHUB_TOKEN }}
+          repository: bcgov/gwa-api/gwa-compatibility-api
+          path: microservices/compatibilityApi
+          dockerfile: microservices/compatibilityApi/Dockerfile
+          tag_with_ref: true
+          tag_with_sha: false
+          add_git_labels: true
+          push: true

microservices/compatibilityApi/.gitignore

@@ -0,0 +1,209 @@
+# General Ignore
+#bin/
+.idea
+.DS_Store
+
+# Golang Ignore
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+
+# Node Ignore
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless
+
+
+# Python Ignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+config/default.json
+
+LOCAL.md
+_tmp

microservices/compatibilityApi/Dockerfile

@@ -0,0 +1,34 @@
+FROM python:3.12.9-alpine3.21
+
+WORKDIR /app
+
+RUN apk add build-base libffi-dev openssl curl
+
+# Install deck
+RUN curl -sL https://github.com/kong/deck/releases/download/v1.35.0/deck_1.35.0_linux_amd64.tar.gz -o deck.tar.gz && \
+    tar -xf deck.tar.gz -C /tmp && \
+    mv /tmp/deck /usr/local/bin/ && \
+    rm deck.tar.gz
+
+RUN python -m pip install --upgrade pip
+
+RUN cd /tmp && \
+    curl -sSL https://install.python-poetry.org > get-poetry.py && \
+    POETRY_HOME=/opt/poetry python get-poetry.py --version 1.8.2 && \
+    cd /usr/local/bin && \
+    ln -s /opt/poetry/bin/poetry && \
+    poetry config virtualenvs.create false
+
+COPY pyproject.toml /tmp/
+
+COPY poetry.lock /tmp/
+
+RUN cd /tmp && poetry install --no-root --no-dev
+
+COPY . /app
+
+RUN chmod +x /app/entrypoint.sh
+
+EXPOSE 8080
+
+ENTRYPOINT ["./entrypoint.sh"] 

microservices/compatibilityApi/README.md

@@ -0,0 +1,80 @@
+# GWA Compatibility API
+
+## Description
+
+This API validates Kong Gateway configuration files.
+
+## Getting Started
+
+### Dependencies
+
+- Docker
+- Python 3.12
+
+### Installation
+
+#### Poetry
+
+```bash
+brew update
+brew install pyenv
+pyenv install 3.12
+pyenv global 3.12
+curl -sSL https://install.python-poetry.org | python3 -
+```
+
+#### Requirements
+
+```bash
+poetry env use 3.12 # (optional)
+poetry install
+```
+
+#### Docker
+
+```bash
+docker build --tag compatibilityapi .
+
+docker run -ti --rm \
+  -p 8080:8080 \
+  -e LOG_LEVEL=DEBUG \
+  compatibilityapi
+```
+
+### Development
+
+Locally running:
+
+```sh
+poetry run uvicorn main:app --host 0.0.0.0 --port 8080 --reload
+```
+
+Testing:
+
+```sh
+poetry run coverage run --branch -m pytest -s
+poetry run coverage xml
+``` 
+
+Test with a local file:
+
+```sh
+curl -X POST http://localhost:8080/configs \
+  -H "Content-Type: application/json" \
+  -d "$(cat test.yaml | python3 -c 'import sys, yaml, json; print(json.dumps(yaml.safe_load(sys.stdin)))')"
+```
+
+Test with json content:
+
+```sh
+curl -X POST http://localhost:8080/configs \
+  -H "Content-Type: application/json" \
+  -d '{
+    "services": [
+      {
+        "name": "example-service",
+        "url": "http://example.com"
+      }
+    ]
+  }'
+```