E2E Tests version 1.0

.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+	"name": "Python 3",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
+	"runArgs": ["--name", "OAPL-DEV"],
+	"features": {
+		"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {}
+
+	},
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "/bin/bash .devcontainer/setup.sh",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.devcontainer/setup.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+if [ -d ".venv" ]; then
+  echo "Virtual environment already exists"
+else
+  python3 -m venv .venv
+fi
+source .venv/bin/activate
+
+apt-get update && apt-get install -y git
+
+pip install --upgrade pip
+pip3 install --user -r requirements.txt
+
+cd tests
+pip3 install --user -r requirements.txt
+
+pip install pre-commit
+pre-commit install
+pre-commit run --all-files

.github/workflows/e2e_tests.yml

@@ -0,0 +1,44 @@
+name: E2E Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  workflow_run:
+    workflows: ["Tests"]
+    types:
+      - completed
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    # Checkout the repository
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    # Set up Python
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'  # Adjust the version as needed
+
+    # Install opal dependencies
+    - name: Install opal dependencies
+      run: pip install -r requirements.txt
+
+    # Ensure Docker is installed and running
+    - name: Set up Docker
+      uses: docker/setup-buildx-action@v2
+
+    # Install test dependencies
+    - name: Install test dependencies
+      run: cd ./tests && pip install -r requirements.txt
+
+    # Run the tests using the script
+    - name: Run tests
+      run: cd ./tests && ./run.sh

.gitignore

@@ -1,15 +1,29 @@
-# Byte-compiled / optimized / DLL files
+# OPAL specific
+.env
+*.env
+opal-example-policy-repo/*
+
+
+# Temporary and Python cache files
+**/*.pyc
 __pycache__/
 *.py[cod]
 *$py.class
 
 # C extensions
 *.so
 
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+env.bak/
+venv.bak/
+
 # Distribution / packaging
 .Python
 build/
-develop-eggs/
 dist/
 downloads/
 eggs/
@@ -18,7 +32,6 @@ lib/
 lib64/
 parts/
 sdist/
-var/
 wheels/
 pip-wheel-metadata/
 share/python-wheels/
@@ -27,16 +40,14 @@ share/python-wheels/
 *.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
 
+# PyInstaller
+*.manifest
+*.spec
+
 # Unit test / coverage reports
 htmlcov/
 .tox/
@@ -55,17 +66,17 @@ coverage.xml
 *.mo
 *.pot
 
-# Django stuff:
+# Django
 *.log
 local_settings.py
 db.sqlite3
 db.sqlite3-journal
 
-# Flask stuff:
+# Flask
 instance/
 .webassets-cache
 
-# Scrapy stuff:
+# Scrapy
 .scrapy
 
 # Sphinx documentation
@@ -84,53 +95,41 @@ ipython_config.py
 # pyenv
 .python-version
 
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
+# Pipenv
 #Pipfile.lock
 
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+# PEP 582
 __pypackages__/
 
-# Celery stuff
+# Celery
 celerybeat-schedule
 celerybeat.pid
 
-# SageMath parsed files
+# SageMath
 *.sage.py
 
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
+# Editors
+.vscode/
+.idea
+*.iml
 
-# Spyder project settings
+# Spyder
 .spyderproject
 .spyproject
 
-# Rope project settings
+# Rope
 .ropeproject
 
-# mkdocs documentation
-/site
+# mkdocs
+docs/_build/
 
 # mypy
 .mypy_cache/
 .dmypy.json
 dmypy.json
 
-# Pyre type checker
+# Pyre
 .pyre/
 
-# editors
-.vscode/
-.idea
-*.iml
-
+# System files
 .DS_Store

.vscode/launch.json

@@ -0,0 +1,40 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Remote to local",
+      "type": "debugpy",
+      "request": "attach",
+      "justMyCode": false,
+      "subProcess": true,
+      "connect": {
+        "host": "localhost",
+        "port": 5678
+      },
+      "pathMappings": [
+        {
+          "localRoot": "${workspaceFolder}",
+          "remoteRoot": "${cwd}"
+        }
+      ]
+    },
+    {
+      "name": "Python Debugger: Current File",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${file}",
+      "console": "integratedTerminal"
+    },
+    {
+      "name": "Python: Debug with Args",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${file}",
+      "args": [
+        "--deploy",
+        "--with_broadcast",
+      ],
+      "console": "integratedTerminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "cmake.ignoreCMakeListsMissing": true,
+    "makefile.configureOnOpen": false,
+    "python.analysis.extraPaths": [
+        "./packages/opal-common",
+        "./packages/opal-server"
+    ]
+}

app-tests/docker-compose-app-tests.yml

@@ -1,4 +1,6 @@
+
 services:
+
   broadcast_channel:
     image: postgres:alpine
     environment:
@@ -7,15 +9,19 @@ services:
       - POSTGRES_PASSWORD=postgres
 
   opal_server:
-    image: permitio/opal-server:${OPAL_IMAGE_TAG:-latest}
+    #image: permitio/opal-server:${OPAL_IMAGE_TAG:-latest}
+    build:
+      context: ../  # Point to the directory containing your Dockerfile
+      dockerfile: ./docker/Dockerfile.server  # Specify your Dockerfile if it's not named 'Dockerfile'
     deploy:
       mode: replicated
-      replicas: 2
+      replicas: 1
       endpoint_mode: vip
     environment:
       - OPAL_BROADCAST_URI=postgres://postgres:postgres@broadcast_channel:5432/postgres
-      - UVICORN_NUM_WORKERS=4
-      - OPAL_POLICY_REPO_URL=${OPAL_POLICY_REPO_URL:[email protected]:permitio/opal-tests-policy-repo.git}
+      - UVICORN_NUM_WORKERS=0
+      #- OPAL_POLICY_REPO_URL=${OPAL_POLICY_REPO_URL:[email protected]:permitio/opal-tests-policy-repo.git}
+      - OPAL_POLICY_REPO_URL=${OPAL_POLICY_REPO_URL:[email protected]:permitio/opal-example-policy-repo.git}
       - OPAL_POLICY_REPO_MAIN_BRANCH=${POLICY_REPO_BRANCH}
       - OPAL_POLICY_REPO_SSH_KEY=${OPAL_POLICY_REPO_SSH_KEY}
       - OPAL_DATA_CONFIG_SOURCES={"config":{"entries":[{"url":"http://opal_server:7002/policy-data","config":{"headers":{"Authorization":"Bearer ${OPAL_CLIENT_TOKEN}"}},"topics":["policy_data"],"dst_path":"/static"}]}}
@@ -35,6 +41,7 @@ services:
 
   opal_client:
     image: permitio/opal-client:${OPAL_IMAGE_TAG:-latest}
+    scale: 2
     deploy:
       mode: replicated
       replicas: 2

app-tests/jwks_dir/jwks.json

@@ -0,0 +1 @@
+{"keys": [{"kty": "RSA", "key_ops": ["verify"], "n": "zQSk0F8jfU3KR9w-7-aq5n7Elh34Vhi1pzQsKG7VVoJgzqHqhXP1JsbSo-4ntAZ77fCWKMd25y4gOmNpur_0sOErRtSGwdlwVRxef-wztDD0ecqksMF7c2ZNwdq3hXxJ9NrDpcg8ORmIt6q-T5ZtbvoYhVy37LKw5dr0ry-SxfTeUuadFin4wTMQAwuiYKNQMGjuW8eEGi_ZEjziXjhQhEWfIIhH1v_jcWnW-_cjx7fvJ_Jau98vs40KKLawnvueiRdi8KWNQpA4b6480b0KfC0U7qbr61-fyL8u0L7aotTxmMzCfRabBRQ53sR5zYvvhV4Y-OZM_82RAFleIFsNfjrkbN5Sq7NEStE3b_yLMYu_uW5IoewOt7X3MgICq0jiXrbvExuJ0pq7DGlax5uhBt316Gt_HY8yqWAnCaa766_0av8IVZstRlCPOjhaM4liEneNdlzGheQlxoi6SxvQFhy4jbcG4tAmbvRIWpAbYaaXyB0H_PMPN7uPzo9lQNv1N6jMHlUq9GOGMy83qy6iQ2aA_NouCwDUKh5WUDePZwpwNFd5Fs6EiBcESG0SJkTwyuFPM6iYl6H2S7Knf8CYJMmixr_Ezm0id0Ltm0_FAwoEUqbltSmaGDZeI5T29732eFr9lK0Fw5R8_2X6uIRaIljCMSkbrRQcsm8gUZ_H9ms", "e": "AQAB"}]}