Port API to FastAPI #133

.flake8

@@ -3,8 +3,10 @@
 select = A,B,B9,BLK,C,E,F,I,N,S,W
 ignore = E501,W503
 max-complexity = 17
-max-line-length = 80
+max-line-length = 120
 application-import-names = scigateway_auth,test
 import-order-style = google
-per-file-ignores = test/testutils.py:S105,B950,test/test_authenticationHandler.py:S105,scigateway_auth/wsgi.py:E402,F401
+per-file-ignores =
+    test/**.py:S101
+    test/mock_data.py:S105
 enable-extensions=G

.github/workflows/ci-build.yml

@@ -1,128 +1,99 @@
 name: CI
 on:
   workflow_dispatch:
+    inputs:
+      push-docker-image-to-harbor:
+        description: 'Push Docker Image to Harbor'
+        type: boolean
+        default: false
+
   pull_request:
   push:
     branches:
       - main
 jobs:
   tests:
-    runs-on: ubuntu-20.04
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ['3.6', '3.7', '3.8', '3.9']
-    name: Python ${{ matrix.python-version }} Build & Tests
+    runs-on: ubuntu-latest
+    name: Unit Tests
     steps:
-    - name: Add apt repo
-      run: sudo add-apt-repository universe
+    - name: Checkout repo
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
-    # Setup Python
-    - name: Setup Python
-      uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0
-      with:
-        python-version: ${{ matrix.python-version }}
-        architecture: x64
+    - name: Run tests
+      run: |
+        docker build -f Dockerfile -t scigateway-auth:test --target test .
+        docker run --name scigateway-auth-container scigateway-auth:test pytest --config-file test/pytest.ini --cov scigateway_auth --cov-report xml
+        docker cp scigateway-auth-container:/app/coverage.xml coverage.xml
 
-    # Checkout repo
-    - name: Checkout repo
-      uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
-
-    # Prep for the tests
-    - name: Create log file
-      run: touch logs.log
-    - name: Configure log file location
-      run: echo "`jq -r --arg REPO_DIR "$GITHUB_WORKSPACE/logs.log" \
-        '.log_location=$REPO_DIR' scigateway_auth/config.json.example`" > scigateway_auth/config.json.example
-    - name: Create config.json
-      run: cp scigateway_auth/config.json.example scigateway_auth/config.json
-
-    # Install Nox, Poetry and API's dependencies
-    - name: Install Nox
-      run: pip install nox==2020.8.22
-    - name: Install Poetry
-      run: pip install poetry==1.1.9
-    # This fixes the issue with cachecontrol (https://github.com/psf/cachecontrol/issues/292).
-    # We will not be facing this issue when we upgrade to a newer Poetry version.
-    - name: Install Requests
-      run: pip install 'requests<2.30'
-    - name: Install dependencies
-      run: poetry install
-
-    # Run Nox tests session, saves and uploads a coverage report to codecov
-    - name: Run Nox tests session
-      run: nox -s tests -- --cov=scigateway_auth --cov-report=xml
     - name: Upload code coverage report
-      if: matrix.python-version == '3.6'
       uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3.1.4
 
   linting:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     name: Linting
     steps:
+    - name: Checkout repo
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
     - name: Setup Python
-      uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0
+      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
-        python-version: '3.6'
-        architecture: x64
-    - name: Checkout repo
-      uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+        python-version: '3.11'
 
     - name: Install Nox
-      run: pip install nox==2020.8.22
+      run: pip install nox==2024.10.9
+
     - name: Install Poetry
-      run: pip install poetry==1.1.9
+      run: pip install poetry==1.8.4
 
     - name: Run Nox lint session
       run: nox -s lint
 
   formatting:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     name: Code Formatting
     steps:
+    - name: Checkout repo
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
     - name: Setup Python
-      uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0
+      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
-        python-version: '3.6'
-        architecture: x64
-    - name: Checkout repo
-      uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+        python-version: '3.11'
 
     - name: Install Nox
-      run: pip install nox==2020.8.22
+      run: pip install nox==2024.10.9
+
     - name: Install Poetry
-      run: pip install poetry==1.1.9
+      run: pip install poetry==1.8.4
 
     - name: Run Nox black session
       run: nox -s black
 
   safety:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     name: Dependency Safety
     steps:
+    - name: Checkout repo
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
     - name: Setup Python
-      uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0
+      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
-        python-version: '3.6'
-        architecture: x64
-    - name: Checkout repo
-      uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+        python-version: '3.11'
 
     - name: Install Nox
-      run: pip install nox==2020.8.22
-    - name: Install Poetry
-      run: pip install poetry==1.1.9
+      run: pip install nox==2024.10.9
 
     - name: Run Nox safety session
       run: nox -s safety
 
   docker:
-    # This job triggers only if all the other jobs succeed and does different things depending on the context.
-    # The job builds the Docker image in all cases and also pushes the image to Harbor only if something is
-    # pushed to the main branch.
     needs: [tests, linting, formatting, safety]
     name: Docker
     runs-on: ubuntu-20.04
+    env:
+      PUSH_DOCKER_IMAGE_TO_HARBOR: ${{ inputs.push-docker-image-to-harbor != null && inputs.push-docker-image-to-harbor || 'false' }}
     steps:
     - name: Check out repo
       uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.5.2
@@ -140,10 +111,11 @@ jobs:
       with:
         images: harbor.stfc.ac.uk/datagateway/scigateway-auth
 
-    - name: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' && 'Build and push Docker image to Harbor' || 'Build Docker image' }}
+    - name: ${{ fromJSON(env.PUSH_DOCKER_IMAGE_TO_HARBOR) && 'Build and push Docker image to Harbor' || 'Build Docker image' }}
       uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671 # v4.0.0
       with:
         context: .
-        push: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        push: ${{ fromJSON(env.PUSH_DOCKER_IMAGE_TO_HARBOR) }}
         tags: ${{ steps.meta.outputs.tags }}
         labels: ${{ steps.meta.outputs.labels }}
+        target: prod

.gitignore

@@ -1,14 +1,172 @@
-.idea/
-venv/
+scigateway_auth/logging.ini
+keys/*
+!keys/.keep
 *.pyc
 config.json
 logs.log
-keys/
-.vscode/
+.python-version
+
+# 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/
+share/python-wheels/
 *.egg-info/
-.python-version
+.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/
 .nox/
 .coverage
+.coverage.*
+.cache
+nosetests.xml
 coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+*.log.*
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Visual Studio Code
+.vscode/