diff --git a/.github/workflows/check-oas.yml b/.github/workflows/check-oas.yml new file mode 100644 index 00000000..15e4a8e3 --- /dev/null +++ b/.github/workflows/check-oas.yml @@ -0,0 +1,23 @@ +name: check-oas + +on: + push: + paths: + - "src/objecttypes/api/*/openapi.yaml" + - .github/workflows/oas-check.yml + branches: + - '**' + workflow_dispatch: + +jobs: + open-api-workflow-check-oas: + uses: maykinmedia/open-api-workflows/.github/workflows/oas-check.yml@v1 + strategy: + matrix: + version: + - v2 + with: + schema-path: 'src/objecttypes/api/${{ matrix.version }}/openapi.yaml' + python-version: '3.11' + django-settings-module: 'objecttypes.conf.ci' + apt-packages: 'libgdal-dev gdal-bin' diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 636161e5..5036b9aa 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -13,9 +13,36 @@ env: IMAGE_NAME: maykinmedia/objecttypes-api jobs: + changed-files: + runs-on: ubuntu-latest + name: Determine changed files + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 2 + + - name: Get changed PY files + id: changed-py-files + uses: tj-actions/changed-files@v45 + with: + files: src/{,**/}*.py + + - name: Get changed requirements files + id: changed-requirements + uses: tj-actions/changed-files@v45 + with: + files: requirements/*.txt + + outputs: + changed-py-files: ${{ steps.changed-py-files.outputs.any_changed }} + changed-requirements: ${{ steps.changed-requirements.outputs.any_changed }} + tests: name: Run the Django test suite runs-on: ubuntu-latest + needs: + - changed-files + if: ${{ needs.changed-files.outputs.changed-py-files == 'true'|| needs.changed-files.outputs.changed-requirements == 'true'|| github.event_name == 'push' }} services: postgres: @@ -29,26 +56,12 @@ jobs: steps: - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - name: Set up backend environment + uses: maykinmedia/setup-django-backend@v1.3 with: + apt-packages: 'libgdal-dev gdal-bin' python-version: '3.11' - - uses: actions/setup-node@v4 - with: - node-version: '18' - - - name: Install system packages - run: | - sudo apt-get update \ - && sudo apt-get install -y --no-install-recommends \ - libgdal-dev \ - gdal-bin - - - name: Install dependencies - run: pip install -r requirements/ci.txt - - name: Build frontend - run: | - npm ci - npm run build + setup-node: true - name: Run tests run: | @@ -63,81 +76,35 @@ jobs: - name: Publish coverage report uses: codecov/codecov-action@v4 - docker: - needs: tests - - name: Build Docker image + store-reusable-workflow-vars: + name: create values which can be passed through a reusable workflow runs-on: ubuntu-latest + outputs: + image-name: ${{ steps.image-name.outputs.image-name }} steps: - - uses: actions/checkout@v4 - - - name: Set tag - id: vars - run: | - # Strip git ref prefix from version - VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,') - - # Strip "v" prefix from tag name (if present at all) - [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//') - - # Use Docker `latest` tag convention - [ "$VERSION" == "master" ] && VERSION=latest - - echo ::set-output name=tag::${VERSION} + - run: echo "image-name=$IMAGE_NAME" >> $GITHUB_OUTPUT + name: 'Store the docker image name' + id: image-name - - name: Build the Docker image - env: - RELEASE_VERSION: ${{ steps.vars.outputs.tag }} - run: docker build . --tag $IMAGE_NAME:$RELEASE_VERSION - - - run: docker image save -o image.tar $IMAGE_NAME:${{ steps.vars.outputs.tag }} - - - name: Store image artifact - uses: actions/upload-artifact@v3 - with: - name: docker-image - path: image.tar - retention-days: 1 - - publish: + open-api-ci: + uses: maykinmedia/open-api-workflows/.github/workflows/ci.yml@v1 + needs: + - store-reusable-workflow-vars + with: + main-branch: 'master' + python-version: '3.11' + docker-image-name: ${{ needs.store-reusable-workflow-vars.outputs.image-name }} + + open-api-publish: + uses: maykinmedia/open-api-workflows/.github/workflows/publish.yml@v1 needs: + - store-reusable-workflow-vars + - open-api-ci - tests - - docker - - name: Push Docker image - runs-on: ubuntu-latest - if: github.event_name == 'push' # exclude PRs - - steps: - - uses: actions/checkout@v4 - - name: Download built image - uses: actions/download-artifact@v3 - with: - name: docker-image - - - name: Determine tag - id: vars - run: | - # Strip git ref prefix from version - VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,') - - # Strip "v" prefix from tag name (if present at all) - [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//') - - # Use Docker `latest` tag convention - [ "$VERSION" == "master" ] && VERSION=latest - - echo ::set-output name=tag::${VERSION} - - - name: Load image - run: | - docker image load -i image.tar - - - name: Log into registry - run: echo "${{ secrets.DOCKER_TOKEN }}" | docker login -u ${{ secrets.DOCKER_USERNAME }} --password-stdin - - - name: Push the Docker image - env: - RELEASE_VERSION: ${{ steps.vars.outputs.tag }} - run: docker push $IMAGE_NAME:$RELEASE_VERSION + with: + docker-image-name: ${{ needs.store-reusable-workflow-vars.outputs.image-name }} + repository-owner: 'maykinmedia' + secrets: + docker-username: ${{ secrets.DOCKER_USERNAME }} + docker-token: ${{ secrets.DOCKER_TOKEN }} diff --git a/.github/workflows/code-quality.yml b/.github/workflows/code-quality.yml index 4364b671..5931aa5e 100644 --- a/.github/workflows/code-quality.yml +++ b/.github/workflows/code-quality.yml @@ -1,74 +1,28 @@ name: code-quality -on: [push] +on: + push: + branches: + - main + paths: + - '**.py' + - '**.yml' + pull_request: + paths: + - '**.py' + - '**.yml' + workflow_dispatch: jobs: - isort: - name: Check import sorting - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: '3.11' - - uses: isort/isort-action@v1 - with: - requirementsFiles: requirements/dev.txt - sortPaths: "src" - configuration: '--check-only --diff' - - black: - name: Check code formatting with black - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: '3.11' - - name: Install dependencies - run: | - pip install -r requirements/dev.txt - - name: Run black - run: | - black --check src - - oas-up-to-date: - name: Check for unexpected OAS changes - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: '3.11' - - uses: actions/setup-node@v4 - with: - node-version: '18' - - - name: Install system packages - run: | - sudo apt-get update \ - && sudo apt-get install -y --no-install-recommends \ - libgdal-dev \ - gdal-bin - - - name: Install dependencies - run: pip install -r requirements/ci.txt - - - name: Generate OAS files - run: ./bin/generate_schema.sh openapi.yaml - env: - DJANGO_SETTINGS_MODULE: objecttypes.conf.ci - - - name: Check for OAS changes - run: | - diff openapi.yaml src/objecttypes/api/v2/openapi.yaml - - name: Write failure markdown - if: ${{ failure() }} - run: | - echo 'Run the following command locally and commit the changes' >> $GITHUB_STEP_SUMMARY - echo '' >> $GITHUB_STEP_SUMMARY - echo '```bash' >> $GITHUB_STEP_SUMMARY - echo './bin/generate_schema.sh' >> $GITHUB_STEP_SUMMARY - echo '```' >> $GITHUB_STEP_SUMMARY + open-api-workflow-code-quality: + uses: maykinmedia/open-api-workflows/.github/workflows/code-quality.yml@v1 + with: + apt-packages: 'libgdal-dev gdal-bin' + python-version: '3.11' + node-version: '18' + postgres-image: 'postgres:12' + + black-src-pattern: 'src' + + django-settings-module: 'objecttypes.conf.ci' + django-secret-key: dummy diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 7175c8f8..5efcea6d 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -4,11 +4,6 @@ # You may wish to alter this file to override the set of languages analyzed, # or to provide custom queries or build logic. # -# ******** NOTE ******** -# We have attempted to detect the languages in your repository. Please check -# the `language` matrix defined below to confirm you have the correct set of -# supported CodeQL languages. -# name: "CodeQL" on: @@ -21,52 +16,5 @@ on: - cron: '36 0 * * 0' jobs: - analyze: - name: Analyze - runs-on: ubuntu-latest - permissions: - actions: read - contents: read - security-events: write - - strategy: - fail-fast: false - matrix: - language: [ 'javascript', 'python' ] - # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] - # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support - - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@v3 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - - # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs - # queries: security-extended,security-and-quality - - - # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift). - # If this step fails, then you should remove it and run the build manually (see below) - - name: Autobuild - uses: github/codeql-action/autobuild@v3 - - # ℹī¸ Command-line programs to run using the OS shell. - # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun - - # If the Autobuild fails above, remove it and uncomment the following three lines. - # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. - - # - run: | - # echo "Run, Build Application using script" - # ./location_of_script_within_repo/buildscript.sh - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v3 + open-api-workflow-code-analysis: + uses: maykinmedia/open-api-workflows/.github/workflows/code-analysis.yml@v1 diff --git a/.github/workflows/generate-postman-collection.yml b/.github/workflows/generate-postman-collection.yml index 080b73d9..e256edea 100644 --- a/.github/workflows/generate-postman-collection.yml +++ b/.github/workflows/generate-postman-collection.yml @@ -10,19 +10,12 @@ on: workflow_dispatch: jobs: - run: - runs-on: ubuntu-latest - name: Generate Postman collection - - steps: - - uses: actions/checkout@v4 - - name: Use Node.js - uses: actions/setup-node@v4 - with: - node-version: '18' - - name: Install dependencies - run: npm install -g openapi-to-postmanv2 - - name: Create tests folder - run: mkdir -p ./tests/postman - - name: Generate Postman collection - run: openapi2postmanv2 -s ./src/objecttypes/api/v2/openapi.yaml -o ./tests/postman/collection.json --pretty + open-api-workflow-generate-postman-collection: + uses: maykinmedia/open-api-workflows/.github/workflows/generate-postman-collection.yml@v1 + strategy: + matrix: + version: + - v2 + with: + node-version: '18' + schema-path: 'src/objecttypes/api/${{ matrix.version }}/openapi.yaml' diff --git a/.github/workflows/generate-sdks.yml b/.github/workflows/generate-sdks.yml index 9753f333..6a75f44c 100644 --- a/.github/workflows/generate-sdks.yml +++ b/.github/workflows/generate-sdks.yml @@ -10,32 +10,12 @@ on: workflow_dispatch: jobs: - run: - runs-on: ubuntu-latest - name: Generate SDK - - steps: - - uses: actions/checkout@v4 - - name: Use Node.js - uses: actions/setup-node@v4 - with: - node-version: '18' - - name: Install dependencies - run: npm install -g @openapitools/openapi-generator-cli - - name: Determing oas path - id: vars - run: echo ::set-output name=oas::./src/objecttypes/api/v2/openapi.yaml - - name: Validate schema - run: openapi-generator-cli validate -i ${{ steps.vars.outputs.oas }} - - name: Generate Java client - run: openapi-generator-cli generate -i ${{ steps.vars.outputs.oas }} --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false \ - -o ./sdks/java -g java --additional-properties=dateLibrary=java8,java8=true,optionalProjectFile=false,optionalAssemblyInfo=false -# - name: Generate .NET Core client -# run: openapi-generator-cli generate -i ${{ steps.vars.outputs.oas }} --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false \ -# -o ./sdks/netcore -g csharp-netcore --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false -# - name: Generate .NET Full Framework client -# run: openapi-generator-cli generate -i ${{ steps.vars.outputs.oas }} --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false \ -# -o ./sdks/net -g csharp --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false - - name: Generate Python client - run: openapi-generator-cli generate -i ${{ steps.vars.outputs.oas }} --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false \ - -o ./sdks/python -g python --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false+ + open-api-workflow-generate-sdks: + uses: maykinmedia/open-api-workflows/.github/workflows/generate-sdks.yml@v1 + strategy: + matrix: + version: + - v2 + with: + node-version: '18' + schema-path: 'src/objecttypes/api/${{ matrix.version }}/openapi.yaml' diff --git a/.github/workflows/lint-oas.yml b/.github/workflows/lint-oas.yml index 4a867c8b..c3f397ef 100644 --- a/.github/workflows/lint-oas.yml +++ b/.github/workflows/lint-oas.yml @@ -10,16 +10,12 @@ on: workflow_dispatch: jobs: - run: - runs-on: ubuntu-latest - name: Lint OAS - steps: - - uses: actions/checkout@v4 - - name: Use Node.js - uses: actions/setup-node@v4 - with: - node-version: '18' - - name: Install spectral - run: npm install -g @stoplight/spectral@5 - - name: Run OAS linter - run: spectral lint ./src/objecttypes/api/v2/openapi.yaml + open-api-workflow-lint-oas: + uses: maykinmedia/open-api-workflows/.github/workflows/lint-oas.yml@v1 + strategy: + matrix: + version: + - v2 + with: + node-version: '18' + schema-path: 'src/objecttypes/api/${{ matrix.version }}/openapi.yaml' diff --git a/bin/compile_dependencies.bat b/bin/compile_dependencies.bat index ece1920f..c8065f29 100644 --- a/bin/compile_dependencies.bat +++ b/bin/compile_dependencies.bat @@ -10,18 +10,20 @@ pip-compile^ %*^ requirements/base.in -REM Dependencies for testing +REM Dependencies for ci pip-compile^ --no-emit-index-url^ --output-file requirements/ci.txt^ %*^ requirements/base.txt^ - requirements/test-tools.in + requirements/test-tools.in^ + requirements/ci.in -REM Dev depedencies - exact same set as CI + some extra tooling +REM Dependencies for development pip-compile^ --no-emit-index-url^ --output-file requirements/dev.txt^ %*^ - requirements/ci.txt^ + requirements/base.txt^ + requirements/test-tools.in^ requirements/dev.in diff --git a/bin/compile_dependencies.sh b/bin/compile_dependencies.sh index 099f1254..b3380017 100755 --- a/bin/compile_dependencies.sh +++ b/bin/compile_dependencies.sh @@ -25,18 +25,20 @@ pip-compile \ "$@" \ requirements/base.in -# Dependencies for testing +# Dependencies for CI pip-compile \ --no-emit-index-url \ --output-file requirements/ci.txt \ "$@" \ requirements/base.txt \ - requirements/test-tools.in + requirements/test-tools.in \ + requirements/ci.in -# Dev dependencies - exact same set as CI + some extra tooling +# Dependencies for development pip-compile \ --no-emit-index-url \ --output-file requirements/dev.txt \ "$@" \ - requirements/ci.txt \ + requirements/base.txt \ + requirements/test-tools.in \ requirements/dev.in diff --git a/requirements/ci.in b/requirements/ci.in new file mode 100644 index 00000000..ec8ac8ab --- /dev/null +++ b/requirements/ci.in @@ -0,0 +1,2 @@ +codecov +coverage diff --git a/requirements/ci.txt b/requirements/ci.txt index 874079ab..0c5266eb 100644 --- a/requirements/ci.txt +++ b/requirements/ci.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile with Python 3.11 # by the following command: # -# pip-compile --no-emit-index-url --output-file=requirements/ci.txt requirements/base.txt requirements/test-tools.in +# pip-compile --no-emit-index-url --output-file=requirements/ci.txt requirements/base.txt requirements/ci.in requirements/test-tools.in # amqp==5.1.1 # via @@ -33,6 +33,8 @@ billiard==4.2.0 # via # -r requirements/base.txt # celery +black==24.8.0 + # via -r requirements/test-tools.in bleach==6.1.0 # via # -r requirements/base.txt @@ -69,6 +71,7 @@ charset-normalizer==3.1.0 click==8.1.3 # via # -r requirements/base.txt + # black # celery # click-didyoumean # click-plugins @@ -85,6 +88,8 @@ click-repl==0.2.0 # via # -r requirements/base.txt # celery +codecov==2.1.13 + # via -r requirements/ci.in commonground-api-common==1.13.0 # via # -r requirements/base.txt @@ -98,7 +103,9 @@ coreschema==0.0.4 # -r requirements/base.txt # coreapi coverage==4.5.4 - # via -r requirements/test-tools.in + # via + # -r requirements/ci.in + # codecov cryptography==42.0.7 # via # -r requirements/base.txt @@ -120,7 +127,6 @@ django==4.2.15 # django-csp # django-filter # django-formtools - # django-jenkins # django-jsonform # django-jsonsuit # django-log-outgoing-requests @@ -178,8 +184,6 @@ django-formtools==2.4.1 # via # -r requirements/base.txt # django-two-factor-auth -django-jenkins==0.110.0 - # via -r requirements/test-tools.in django-jsonform==2.22.0 # via # -r requirements/base.txt @@ -308,6 +312,8 @@ factory-boy==3.2.1 # via -r requirements/test-tools.in faker==18.9.0 # via factory-boy +flake8==7.1.1 + # via -r requirements/test-tools.in flower==2.0.1 # via # -r requirements/base.txt @@ -349,6 +355,8 @@ isodate==0.6.1 # via # -r requirements/base.txt # commonground-api-common +isort==5.13.2 + # via -r requirements/test-tools.in itypes==1.2.0 # via # -r requirements/base.txt @@ -379,6 +387,8 @@ maykin-2fa==1.0.1 # via # -r requirements/base.txt # open-api-framework +mccabe==0.7.0 + # via flake8 mozilla-django-oidc==4.0.0 # via # -r requirements/base.txt @@ -389,6 +399,8 @@ mozilla-django-oidc-db==0.19.0 # open-api-framework multidict==6.0.5 # via yarl +mypy-extensions==1.0.0 + # via black notifications-api-common==0.2.2 # via # -r requirements/base.txt @@ -406,11 +418,16 @@ oyaml==1.0 packaging==23.1 # via # -r requirements/base.txt + # black # drf-yasg +pathspec==0.12.1 + # via black phonenumberslite==8.13.30 # via # -r requirements/base.txt # django-two-factor-auth +platformdirs==4.3.6 + # via black prometheus-client==0.20.0 # via # -r requirements/base.txt @@ -423,10 +440,14 @@ psycopg2==2.9.9 # via # -r requirements/base.txt # open-api-framework +pycodestyle==2.12.1 + # via flake8 pycparser==2.21 # via # -r requirements/base.txt # cffi +pyflakes==3.2.0 + # via flake8 pyjwt==2.7.0 # via # -r requirements/base.txt @@ -484,6 +505,7 @@ requests==2.32.3 # via # -r requirements/base.txt # ape-pie + # codecov # commonground-api-common # coreapi # django-log-outgoing-requests diff --git a/requirements/dev.in b/requirements/dev.in index cfdb7f45..ad0e948a 100644 --- a/requirements/dev.in +++ b/requirements/dev.in @@ -2,11 +2,6 @@ pip-tools bumpversion -# Code formatting -black -isort -flake8 - # Debug tooling django-debug-toolbar django-extensions diff --git a/requirements/dev.txt b/requirements/dev.txt index f407513a..84f1d88b 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -2,52 +2,50 @@ # This file is autogenerated by pip-compile with Python 3.11 # by the following command: # -# pip-compile --no-emit-index-url --output-file=requirements/dev.txt requirements/ci.txt requirements/dev.in +# pip-compile --no-emit-index-url --output-file=requirements/dev.txt requirements/base.txt requirements/dev.in requirements/test-tools.in # alabaster==0.7.13 # via sphinx amqp==5.1.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # kombu ape-pie==0.1.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # zgw-consumers asgiref==3.6.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django # django-axes # django-cors-headers asn1crypto==1.5.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # webauthn attrs==23.1.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # glom # jsonschema babel==2.12.1 # via sphinx beautifulsoup4==4.12.2 - # via - # -r requirements/ci.txt - # webtest + # via webtest billiard==4.2.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # celery black==24.4.2 - # via -r requirements/dev.in + # via -r requirements/test-tools.in bleach==6.1.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework boltons==23.0.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # face # glom build==0.10.0 @@ -58,31 +56,31 @@ bumpversion==0.6.0 # via -r requirements/dev.in cbor2==5.6.3 # via - # -r requirements/ci.txt + # -r requirements/base.txt # webauthn celery==5.4.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # flower # notifications-api-common # open-api-framework certifi==2024.7.4 # via - # -r requirements/ci.txt + # -r requirements/base.txt # elastic-apm # requests # sentry-sdk cffi==1.15.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # cryptography charset-normalizer==3.1.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # requests click==8.1.3 # via - # -r requirements/ci.txt + # -r requirements/base.txt # black # celery # click-didyoumean @@ -91,45 +89,41 @@ click==8.1.3 # pip-tools click-didyoumean==0.3.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # celery click-plugins==1.1.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # celery click-repl==0.2.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # celery commonground-api-common==1.13.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework coreapi==2.3.3 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common coreschema==0.0.4 # via - # -r requirements/ci.txt + # -r requirements/base.txt # coreapi -coverage==4.5.4 - # via -r requirements/ci.txt cryptography==42.0.7 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-simple-certmanager # josepy # mozilla-django-oidc # pyopenssl # webauthn cssselect==1.2.0 - # via - # -r requirements/ci.txt - # pyquery + # via pyquery django==4.2.15 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common # django-admin-index # django-appconf @@ -140,7 +134,6 @@ django==4.2.15 # django-extensions # django-filter # django-formtools - # django-jenkins # django-jsonform # django-jsonsuit # django-log-outgoing-requests @@ -171,23 +164,23 @@ django==4.2.15 # zgw-consumers django-admin-index==3.1.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework django-appconf==1.0.6 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-log-outgoing-requests django-axes==6.5.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework django-cors-headers==4.4.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework django-csp==3.8 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework django-debug-toolbar==4.1.0 # via -r requirements/dev.in @@ -195,73 +188,71 @@ django-extensions==3.2.1 # via -r requirements/dev.in django-filter==24.2 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common # open-api-framework django-formtools==2.4.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-two-factor-auth -django-jenkins==0.110.0 - # via -r requirements/ci.txt django-jsonform==2.22.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # mozilla-django-oidc-db # open-api-framework django-jsonsuit==0.5.0 - # via -r requirements/ci.txt + # via -r requirements/base.txt django-log-outgoing-requests==0.6.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework django-markup==1.8.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework django-ordered-model==3.7.4 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-admin-index django-otp==1.2.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-two-factor-auth django-phonenumber-field==5.2.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-two-factor-auth django-privates==2.0.0.post0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-simple-certmanager django-redis==5.4.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework django-relativedelta==2.0.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # zgw-consumers django-rest-framework-condition==0.1.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common django-sendfile2==0.7.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-privates django-setup-configuration==0.1.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework django-simple-certmanager==2.0.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # zgw-consumers django-solo==2.0.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common # django-log-outgoing-requests # mozilla-django-oidc-db @@ -270,14 +261,14 @@ django-solo==2.0.0 # zgw-consumers django-two-factor-auth[phonenumberslite,webauthn]==1.16.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-two-factor-auth # maykin-2fa django-webtest==1.9.10 - # via -r requirements/ci.txt + # via -r requirements/test-tools.in djangorestframework==3.15.2 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common # djangorestframework-gis # djangorestframework-inclusions @@ -288,16 +279,16 @@ djangorestframework==3.15.2 # open-api-framework djangorestframework-camel-case==1.4.2 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common # notifications-api-common djangorestframework-gis==1.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework djangorestframework-inclusions==1.2.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework docutils==0.18.1 # via @@ -305,11 +296,11 @@ docutils==0.18.1 # sphinx-rtd-theme drf-nested-routers==0.93.4 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common drf-spectacular[sidecar]==0.27.2 # via - # -r requirements/ci.txt + # -r requirements/base.txt # drf-spectacular # open-api-framework drf-spectacular-sidecar==2024.7.1 @@ -318,139 +309,133 @@ drf-spectacular-sidecar==2024.7.1 # drf-spectacular drf-yasg==1.21.7 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common ecs-logging==2.1.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # elastic-apm elastic-apm==6.22.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework face==20.1.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # glom factory-boy==3.2.1 - # via -r requirements/ci.txt + # via -r requirements/test-tools.in faker==18.9.0 - # via - # -r requirements/ci.txt - # factory-boy + # via factory-boy flake8==6.0.0 - # via -r requirements/dev.in + # via -r requirements/test-tools.in flower==2.0.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework freezegun==1.2.2 - # via -r requirements/ci.txt + # via -r requirements/test-tools.in furl==2.1.3 # via - # -r requirements/ci.txt + # -r requirements/base.txt # ape-pie gemma-zds-client==1.0.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common # notifications-api-common glom==23.3.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # mozilla-django-oidc-db humanize==4.9.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # flower idna==3.7 # via - # -r requirements/ci.txt + # -r requirements/base.txt # requests # yarl imagesize==1.4.1 # via sphinx inflection==0.5.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # drf-spectacular # drf-yasg iso-639==0.4.5 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common isodate==0.6.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common isort==5.12.0 - # via -r requirements/dev.in + # via -r requirements/test-tools.in itypes==1.2.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # coreapi jinja2==3.1.4 # via - # -r requirements/ci.txt + # -r requirements/base.txt # coreschema # sphinx josepy==1.13.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # mozilla-django-oidc jsonschema==4.17.3 # via - # -r requirements/ci.txt + # -r requirements/base.txt # drf-spectacular kombu==5.3.5 # via - # -r requirements/ci.txt + # -r requirements/base.txt # celery lxml==4.9.2 - # via - # -r requirements/ci.txt - # pyquery + # via pyquery markupsafe==2.1.2 # via - # -r requirements/ci.txt + # -r requirements/base.txt # jinja2 maykin-2fa==1.0.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework mccabe==0.7.0 # via flake8 mozilla-django-oidc==4.0.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # mozilla-django-oidc-db mozilla-django-oidc-db==0.19.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework multidict==6.0.5 - # via - # -r requirements/ci.txt - # yarl + # via yarl mypy-extensions==1.0.0 # via black notifications-api-common==0.2.2 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common open-api-framework==0.8.1 - # via -r requirements/ci.txt + # via -r requirements/base.txt orderedmultidict==1.0.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # furl oyaml==1.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common packaging==23.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # black # build # drf-yasg @@ -459,7 +444,7 @@ pathspec==0.11.1 # via black phonenumberslite==8.13.30 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-two-factor-auth pip-tools==7.3.0 # via -r requirements/dev.in @@ -467,21 +452,21 @@ platformdirs==3.5.1 # via black prometheus-client==0.20.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # flower prompt-toolkit==3.0.38 # via - # -r requirements/ci.txt + # -r requirements/base.txt # click-repl psycopg2==2.9.9 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework pycodestyle==2.10.0 # via flake8 pycparser==2.21 # via - # -r requirements/ci.txt + # -r requirements/base.txt # cffi pyflakes==3.0.1 # via flake8 @@ -489,46 +474,46 @@ pygments==2.15.1 # via sphinx pyjwt==2.7.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # commonground-api-common # gemma-zds-client # zgw-consumers pyopenssl==24.0.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # josepy # webauthn pyproject-hooks==1.0.0 # via build pyquery==2.0.0 - # via -r requirements/ci.txt + # via -r requirements/test-tools.in pyrsistent==0.19.3 # via - # -r requirements/ci.txt + # -r requirements/base.txt # jsonschema python-dateutil==2.8.2 # via - # -r requirements/ci.txt + # -r requirements/base.txt # celery # django-relativedelta # faker # freezegun python-decouple==3.8 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework python-dotenv==1.0.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework pytz==2023.3 # via - # -r requirements/ci.txt + # -r requirements/base.txt # drf-yasg # flower pyyaml==6.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # drf-spectacular # drf-yasg # gemma-zds-client @@ -536,15 +521,15 @@ pyyaml==6.0 # vcrpy qrcode==6.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-two-factor-auth redis==4.5.5 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-redis requests==2.32.3 # via - # -r requirements/ci.txt + # -r requirements/base.txt # ape-pie # commonground-api-common # coreapi @@ -557,16 +542,16 @@ requests==2.32.3 # sphinx # zgw-consumers requests-mock==1.10.0 - # via -r requirements/ci.txt + # via -r requirements/test-tools.in sentry-sdk==2.12.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework sharing-configs==0.1.2 - # via -r requirements/ci.txt + # via -r requirements/base.txt six==1.16.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # bleach # click-repl # furl @@ -578,9 +563,7 @@ six==1.16.0 snowballstemmer==2.2.0 # via sphinx soupsieve==2.4.1 - # via - # -r requirements/ci.txt - # beautifulsoup4 + # via beautifulsoup4 sphinx==6.2.1 # via # -r requirements/dev.in @@ -604,86 +587,78 @@ sphinxcontrib-serializinghtml==1.1.5 # via sphinx sqlparse==0.5.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django # django-debug-toolbar tblib==1.7.0 - # via -r requirements/ci.txt + # via -r requirements/test-tools.in tornado==6.4.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # flower typing-extensions==4.11.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # mozilla-django-oidc-db # zgw-consumers tzdata==2024.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # celery uritemplate==4.1.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # coreapi # drf-spectacular # drf-yasg urllib3==2.2.2 # via - # -r requirements/ci.txt + # -r requirements/base.txt # elastic-apm # requests # sentry-sdk uwsgi==2.0.24 # via - # -r requirements/ci.txt + # -r requirements/base.txt # open-api-framework vcrpy==6.0.1 - # via -r requirements/ci.txt + # via -r requirements/test-tools.in vine==5.1.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # amqp # celery # kombu waitress==2.1.2 - # via - # -r requirements/ci.txt - # webtest + # via webtest wcwidth==0.2.6 # via - # -r requirements/ci.txt + # -r requirements/base.txt # prompt-toolkit webauthn==2.0.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # django-two-factor-auth webencodings==0.5.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # bleach webob==1.8.8 - # via - # -r requirements/ci.txt - # webtest + # via webtest webtest==3.0.0 - # via - # -r requirements/ci.txt - # django-webtest + # via django-webtest wheel==0.40.0 # via pip-tools wrapt==1.14.1 # via - # -r requirements/ci.txt + # -r requirements/base.txt # elastic-apm # vcrpy yarl==1.9.4 - # via - # -r requirements/ci.txt - # vcrpy + # via vcrpy zgw-consumers==0.33.0 # via - # -r requirements/ci.txt + # -r requirements/base.txt # notifications-api-common # open-api-framework diff --git a/requirements/test-tools.in b/requirements/test-tools.in index 37839e73..850fe83d 100644 --- a/requirements/test-tools.in +++ b/requirements/test-tools.in @@ -1,6 +1,4 @@ # Dependencies only relevant for (unit) testing -coverage < 5.0 -django-jenkins django-webtest factory-boy freezegun @@ -8,3 +6,8 @@ pyquery # integrates with webtest requests-mock tblib vcrpy + +# Code formatting +black +isort +flake8 diff --git a/setup.cfg b/setup.cfg index 1bd47879..2177fd96 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,15 +1,22 @@ -[pycodestyle] -ignore=W293,W291,E501,E261 -max-line-length=88 -exclude=migrations,static,media - [isort] profile = black combine_as_imports = true -skip = - env - node_modules +skip = env,node_modules skip_glob = **/migrations/** -known_django=django -known_first_party=objecttypes -sections=FUTURE,STDLIB,DJANGO,THIRDPARTY,FIRSTPARTY,LOCALFOLDER +known_django = django +known_first_party = objecttypes +sections = FUTURE,STDLIB,DJANGO,THIRDPARTY,FIRSTPARTY,LOCALFOLDER +ensure_newline_before_comments = true + +; black compatible settings +[flake8] +; absolute maximum - more lenient than black's 88 +max-line-length = 119 +ignore = E121,E123,E126,E226,E24,E704,W503,W504,E231,F405,E203 +exclude = migrations,static,media + +[coverage:run] +branch = True +source = src +omit = + */test_*.py diff --git a/src/objecttypes/conf/dev.py b/src/objecttypes/conf/dev.py index 5d38a3cb..a7a837af 100644 --- a/src/objecttypes/conf/dev.py +++ b/src/objecttypes/conf/dev.py @@ -1,5 +1,4 @@ import os -import sys import warnings os.environ.setdefault("DEBUG", "yes") diff --git a/src/objecttypes/tests/test_objecttype_admin.py b/src/objecttypes/tests/test_objecttype_admin.py index 3d24f1f4..5f41b4dc 100644 --- a/src/objecttypes/tests/test_objecttype_admin.py +++ b/src/objecttypes/tests/test_objecttype_admin.py @@ -21,7 +21,10 @@ "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "title": "Tree", - "description": "A woody plant (deciduous or coniferous) with a root system and a single, sturdy, woody stem, branching above the ground.", + "description": ( + "A woody plant (deciduous or coniferous) with a root system and a " + "single, sturdy, woody stem, branching above the ground." + ), "required": ["diameter"], "properties": {"diameter": {"type": "integer", "description": "size in cm."}}, } diff --git a/src/objecttypes/tests/test_widgets.py b/src/objecttypes/tests/test_widgets.py index fc88b4b6..ea786073 100644 --- a/src/objecttypes/tests/test_widgets.py +++ b/src/objecttypes/tests/test_widgets.py @@ -1,5 +1,3 @@ -import json - from django.test import TestCase from bs4 import BeautifulSoup diff --git a/src/objecttypes/tests/v2/test_auth.py b/src/objecttypes/tests/v2/test_auth.py index 47aac43a..0f7ef698 100644 --- a/src/objecttypes/tests/v2/test_auth.py +++ b/src/objecttypes/tests/v2/test_auth.py @@ -25,7 +25,7 @@ def test_invalid_token(self): TokenAuth.objects.create(contact_person="John Smith", email="smith@bomen.nl") for url in self.urls: with self.subTest(url=url): - response = self.client.get(url, HTTP_AUTHORIZATION=f"Token 12345") + response = self.client.get(url, HTTP_AUTHORIZATION="Token 12345") self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) def test_valid_token(self): diff --git a/src/objecttypes/tests/v2/test_filters.py b/src/objecttypes/tests/v2/test_filters.py index 4c71a476..acc2abf9 100644 --- a/src/objecttypes/tests/v2/test_filters.py +++ b/src/objecttypes/tests/v2/test_filters.py @@ -15,9 +15,7 @@ def test_filter_public_data(self): object_type_1 = ObjectTypeFactory.create( data_classification=DataClassificationChoices.open ) - object_type_2 = ObjectTypeFactory.create( - data_classification=DataClassificationChoices.intern - ) + ObjectTypeFactory.create(data_classification=DataClassificationChoices.intern) response = self.client.get( self.url, {"dataClassification": DataClassificationChoices.open} diff --git a/src/objecttypes/tests/v2/test_objecttype_api.py b/src/objecttypes/tests/v2/test_objecttype_api.py index 0e1761a5..639d648d 100644 --- a/src/objecttypes/tests/v2/test_objecttype_api.py +++ b/src/objecttypes/tests/v2/test_objecttype_api.py @@ -44,7 +44,12 @@ def test_get_objecttypes(self): "modifiedAt": "2020-01-01", "allowGeometry": object_type.allow_geometry, "versions": [ - f"http://testserver{reverse('objectversion-detail', args=[object_type.uuid, object_version.version])}" + "http://testserver{url}".format( + url=reverse( + "objectversion-detail", + args=[object_type.uuid, object_version.version], + ) + ), ], }, ) @@ -68,7 +73,12 @@ def test_get_objecttypes_with_versions(self): self.assertEqual( data["versions"], [ - f"http://testserver{reverse('objectversion-detail', args=[object_type.uuid, object_versions[i].version])}" + "http://testserver{url}".format( + url=reverse( + "objectversion-detail", + args=[object_type.uuid, object_versions[i].version], + ) + ), ], ) diff --git a/src/objecttypes/tests/v2/test_objectversion_api.py b/src/objecttypes/tests/v2/test_objectversion_api.py index e18d58ba..a74c6f3e 100644 --- a/src/objecttypes/tests/v2/test_objectversion_api.py +++ b/src/objecttypes/tests/v2/test_objectversion_api.py @@ -38,9 +38,19 @@ def test_get_versions(self): "previous": None, "results": [ { - "url": f"http://testserver{reverse('objectversion-detail', args=[object_type.uuid, object_version.version])}", + "url": "http://testserver{url}".format( + url=reverse( + "objectversion-detail", + args=[object_type.uuid, object_version.version], + ), + ), "version": object_version.version, - "objectType": f"http://testserver{reverse('objecttype-detail', args=[object_version.object_type.uuid])}", + "objectType": "http://testserver{url}".format( + url=reverse( + "objecttype-detail", + args=[object_version.object_type.uuid], + ) + ), "status": object_version.status, "createdAt": "2020-01-01", "modifiedAt": "2020-01-01", diff --git a/src/objecttypes/utils/oas_extensions/__init__.py b/src/objecttypes/utils/oas_extensions/__init__.py index 14a4ec4b..4f3e7592 100644 --- a/src/objecttypes/utils/oas_extensions/__init__.py +++ b/src/objecttypes/utils/oas_extensions/__init__.py @@ -1,2 +1,4 @@ from .fields import HyperlinkedIdentityFieldExtension from .query import DjangoFilterExtension + +__all__ = ["HyperlinkedIdentityFieldExtension", "DjangoFilterExtension"] diff --git a/src/objecttypes/wsgi.py b/src/objecttypes/wsgi.py index 9dd3c921..93f786e6 100644 --- a/src/objecttypes/wsgi.py +++ b/src/objecttypes/wsgi.py @@ -7,8 +7,6 @@ https://docs.djangoproject.com/en/3.0/howto/deployment/wsgi/ """ -import os - from django.core.wsgi import get_wsgi_application from objecttypes.setup import setup_env