Fetch upstream

.circleci/config.yml

@@ -0,0 +1,111 @@
+version: 2.1
+
+orbs:
+  codecov: codecov/codecov@3.3.0
+
+workflows:
+  ci:
+    jobs:
+      - lint
+      - test:
+          name:  Python (<< matrix.python_version >>) - ArangoDB (<< matrix.arangodb_license >>, << matrix.arangodb_version >> << matrix.arangodb_config >>)
+          matrix:
+            parameters:
+              python_version: ["3.9", "3.10", "3.11", "3.12"]
+              arangodb_config: ["single", "cluster"]
+              arangodb_license: ["community", "enterprise"]
+              arangodb_version: ["3.11", "latest"]
+
+jobs:
+  lint:
+    docker:
+      - image: python:latest
+    steps:
+      - checkout
+      - run:
+          name: Install Dependencies
+          command: pip install .[dev]
+
+      - run:
+          name: Run black
+          command: black --check --verbose --diff --color --config=pyproject.toml ./arango ./tests/
+
+      - run:
+          name: Run flake8
+          command: flake8 ./arango ./tests
+
+      - run:
+          name: Run isort
+          command: isort --check ./arango ./tests
+
+      - run:
+          name: Run mypy
+          command: mypy ./arango
+
+  test:
+    parameters:
+      python_version:
+        type: string
+      arangodb_config:
+        type: string
+      arangodb_license:
+        type: string
+      arangodb_version:
+        type: string
+    # TODO: Reconsider using a docker image instead of a machine
+    # i.e cimg/python:<< parameters.python_version >>
+    machine:
+      image: ubuntu-2204:current
+    steps:
+      - checkout
+
+      - run:
+          name: Set Up ArangoDB
+          command: |
+            chmod +x starter.sh
+            ./starter.sh << parameters.arangodb_config >> << parameters.arangodb_license >> << parameters.arangodb_version >>
+
+      - restore_cache:
+          key: pip-and-local-cache
+
+      # TODO: Revisit this bottleneck
+      - run:
+          name: Setup Python
+          command: |
+            pyenv --version
+            pyenv install -f << parameters.python_version >>
+            pyenv global << parameters.python_version >>
+
+      - run:
+          name: "Install Dependencies"
+          command: pip install -e .[dev]
+
+      - run: docker ps -a
+
+      - run: docker logs arango
+
+      - run:
+          name: "Run pytest"
+          command: |
+            mkdir test-results
+
+            args=("--junitxml=test-results/junit.xml" "--log-cli-level=DEBUG" "--host" "localhost" "--port=8529")
+            if [ << parameters.arangodb_config >> = "cluster" ]; then
+              args+=("--cluster" "--port=8539" "--port=8549")
+            fi
+
+            if [ << parameters.arangodb_license >> = "enterprise" ]; then
+              args+=("--enterprise")
+            fi
+
+            echo "Running pytest with args: ${args[@]}"
+            pytest --cov=arango --cov-report=xml --cov-report term-missing --color=yes --code-highlight=yes "${args[@]}"
+
+      - store_artifacts:
+          path: test-results
+
+      - store_test_results:
+          path: test-results
+
+      - codecov/upload:
+        file: coverage.xml

.github/workflows/codeql.yaml

@@ -1,22 +1,25 @@
 name: CodeQL
+
 on:
-  push:
-    branches: [ main, dev ]
   pull_request:
-    branches: [ main, dev ]
+    branches: [main]
   schedule:
     - cron: '21 2 * * 3'
 
 jobs:
   analyze:
     name: Analyze
     runs-on: ubuntu-latest
+
+    permissions:
+      security-events: write
+
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: 'python'
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/docs.yaml

@@ -0,0 +1,103 @@
+name: Docs
+
+on:
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: Debug with tmate
+        required: false
+        default: false
+
+jobs:
+  # This has been migrated to CircleCI
+  # test:
+  #   runs-on: ubuntu-latest
+
+  #   strategy:
+  #     fail-fast: false
+  #     matrix:
+  #       python_version: ["3.10"] #["3.8", "3.9", "3.10", "3.11", "3.12"]
+  #       arangodb_config: ["single", "cluster"]
+  #       arangodb_license: ["community", "enterprise"]
+  #       arangodb_version: ["3.10.10", "3.11.4", "latest"]
+
+  #   name: Test (${{ matrix.python_version }}:${{ matrix.arangodb_config }}:${{ matrix.arangodb_license }}:${{ matrix.arangodb_version }})
+
+  #   steps:
+  #     - name: Checkout code
+  #       uses: actions/checkout@v4
+
+  #     - name: Set up Python
+  #       uses: actions/setup-python@v4
+  #       with:
+  #         python-version: ${{ matrix.python_version }}
+
+  #     - name: Setup ArangoDB
+  #       run: |
+  #         chmod +x starter.sh
+  #         ./starter.sh ${{ matrix.arangodb_config }} ${{ matrix.arangodb_license }} ${{ matrix.arangodb_version }}
+
+  #     - name: Install Dependencies
+  #       run: pip install -e .[dev]
+
+  #     - name: List Docker Containers
+  #       run: docker ps -a
+
+  #     - name: Pytest
+  #       run: |
+  #         args=("--host" "localhost" "--port=8529")
+
+  #         if [ ${{ matrix.arangodb_config }} = "cluster" ]; then
+  #           args+=("--cluster" "--port=8539" "--port=8549")
+  #         fi
+
+  #         if [ ${{ matrix.arangodb_license }} = "enterprise" ]; then
+  #           args+=("--enterprise")
+  #         fi
+
+  #         echo "Running pytest with args: ${args[@]}"
+  #         pytest --cov=arango --cov-report=xml "${args[@]}"
+
+  docs:
+    runs-on: ubuntu-latest
+
+    name: Docs
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Fetch all tags and branches
+        run: git fetch --prune --unshallow
+
+      - name: Create ArangoDB Docker container
+        run: >
+          docker create --name arango -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd -v "$(pwd)/tests/static/":/tests/static
+          arangodb/arangodb:latest --server.jwt-secret-keyfile=/tests/static/keyfile
+
+      - name: Start ArangoDB Docker container
+        run: docker start arango
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Debug with tmate
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+
+      - name: Run pre-commit checks
+        uses: pre-commit/action@v3.0.0
+
+      - name: Install dependencies
+        run: pip install .[dev]
+
+      - name: Run Sphinx doctest
+        run: python -m sphinx -b doctest docs docs/_build
+
+      # No longer needed as this is handled by Read the Docs
+      #- name: Generate Sphinx HTML
+      #  run: python -m sphinx -b html -W docs docs/_build

.github/workflows/pypi.yaml

@@ -1,31 +1,52 @@
 name: Upload to PyPI
+
 on:
   release:
-    types: [created]
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: Debug with tmate
+        required: false
+        default: false
+
 jobs:
   upload:
     runs-on: ubuntu-latest
+
     steps:
-    - uses: actions/checkout@v2
-    - name: Fetch complete history for all tags and branches
-      run: git fetch --prune --unshallow
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine setuptools-scm[toml]
-    - name: Build distribution
-      run: python setup.py sdist bdist_wheel
-    - name: Publish to PyPI Test
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_TEST_TOKEN }}
-      run: twine upload --repository testpypi dist/*
-    - name: Publish to PyPI
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
-      run: twine upload --repository pypi dist/*
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Fetch all tags and branches
+        run: git fetch --prune --unshallow
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Debug with tmate
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build distribution
+        run: python -m build
+
+      - name: Publish to PyPI Test
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TEST_TOKEN }}
+        run: twine upload --repository testpypi dist/*
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: twine upload --repository pypi dist/*