diff --git a/.eslintrc.json b/.eslintrc.json deleted file mode 100644 index e279789..0000000 --- a/.eslintrc.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "env": { - "browser": true, - "commonjs": true, - "es6": true, - "jquery": true - }, - "extends": "eslint:recommended", - "parserOptions": { - "ecmaVersion": "latest", - "ecmaFeatures": { - "impliedStrict": true - } - }, - "rules": { - "indent": [ - "error", - 4 - ], - "quotes": [ - "error", - "single", - { - "avoidEscape": true, - "allowTemplateLiterals": true - } - ], - "semi": [ - 2, - "always" - ] - } -} diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 56b0bce..dce118e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -15,8 +15,8 @@ A clear and concise description of what the bug is. Steps to reproduce the behavior: 1. Go to '...' -2. Click on '....' -3. Scroll down to '....' +2. Click on '...' +3. Scroll down to '...' 4. See error diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5fa500b..c7eeaf6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,6 +15,6 @@ Fixes # (issue) ## Checklist: - [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code +- [ ] I have performed a self-review of my code - [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have checked my code and corrected any misspellings diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 8cae055..ab16d0d 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,4 +6,24 @@ updates: directory: "/" target-branch: "master" schedule: - interval: "daily" + interval: "monthly" + commit-message: + # Prefix all commit messages with "[github-actions] " + prefix: "[github-actions] " + labels: + - "github-actions" + - "dependencies" + + # Maintain dependencies for npm + - package-ecosystem: "npm" + directory: "/" + target-branch: "master" + versioning-strategy: increase + schedule: + interval: "monthly" + commit-message: + # Prefix all commit messages with "[npm] " + prefix: "[npm] " + labels: + - "npm" + - "dependencies" diff --git a/.github/workflows/automated-checks.yml b/.github/workflows/automated-checks.yml index 0e2c82b..25dd7ef 100644 --- a/.github/workflows/automated-checks.yml +++ b/.github/workflows/automated-checks.yml @@ -16,39 +16,47 @@ on: - '**' jobs: - # pre-commit Checks + # Run pre-commit Checks pre-commit: name: Pre Commit Checks runs-on: ubuntu-latest steps: + # Checkout the repository - name: Checkout uses: actions/checkout@v4 + # Set up Python - name: Set up Python uses: actions/setup-python@v5 with: python-version-file: 'pyproject.toml' # Read the Python version from the pyproject.toml file + # Set up Node.js + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + - run: npm install + - name: Run Pre Commit Checks uses: pre-commit/action@v3.0.1 # Run Test Coverage - test-coverage-aa-stable: + test-coverage: needs: [pre-commit] - name: AA Latest (Python ${{ matrix.python-version }}, Django ${{ matrix.django-version }} with ${{ matrix.database }}) + name: AA Latest (Python ${{ matrix.python-version }} with ${{ matrix.database }}) runs-on: ubuntu-latest strategy: - # Set Python and Django version to test for the stable release of AllianceAuth + # Set Python versions to test against matrix: python-version: - '3.8' - '3.9' - '3.10' - '3.11' - django-version: - - '4.0' + - '3.12' # MySQL versions to test against database: # https://endoflife.date/mysql @@ -58,13 +66,13 @@ jobs: - mariadb:10.4 # Maintained until: 18 June 2024 - mariadb:10.5 # Maintained until: 24 June 2025 - mariadb:10.6 # [LTS] Maintained until: July 2026 - - mariadb:10.10 # Maintained until: November 2023 - mariadb:10.11 # [LTS] Maintained until: February 2028 - mariadb:11.0 # Maintained until: June 2024 - mariadb:11.1 # Maintained until: August 2024 -# continue-on-error: ${{ matrix.python-version == '3.11-dev' }} +# continue-on-error: ${{ matrix.python-version == '3.12' }} + # Set up services services: database: image: ${{ matrix.database }} @@ -76,157 +84,95 @@ jobs: options: --tmpfs /var/lib/mysql steps: + # Checkout the repository - name: Checkout uses: actions/checkout@v4 + # Install redis - name: Install redis run: sudo apt-get install -y redis-tools redis-server + # Verify that redis is up - name: Verify that redis is up run: redis-cli ping + # Set up Python - name: Setup Python ${{ matrix.python-version }} uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + # Install Tox and any other packages - name: Install Tox and any other packages run: | python -m pip install --upgrade pip python -m pip install --upgrade tox tox-gh-actions + # Run Tox with the specified environment - name: Run Tox env: - TOX_ENV: allianceauth-stable + TOX_ENV: allianceauth-latest DB_HOST: 127.0.0.1 DB_USER: root DB_PASSWORD: temp_password_aa_tox_tests - # Run tox using the version of Python in `PATH` run: tox -v -e ${{ env.TOX_ENV }} + # Upload coverage to Codecov - name: Upload Coverage if: ${{ ( - github.event_name == 'pull_request' || - ( - github.event_name == 'push' && - github.ref == 'refs/heads/master' + github.event_name == 'pull_request' + || ( + github.event_name == 'push' + && github.ref == 'refs/heads/master' ) - ) && - ( - matrix.python-version == '3.10' && - matrix.database == 'mariadb:10.11' && - matrix.django-version == '4.0' + ) + && ( + matrix.python-version == '3.10' + && matrix.database == 'mariadb:10.11' ) }} uses: codecov/codecov-action@v4 with: - token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos + token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml # optional # flags: unittests # optional # name: codecov-umbrella # optional # fail_ci_if_error: true # optional (default = false) verbose: true # optional (default = false) -# test-coverage-aa-dev: -# needs: [ test-coverage-aa-stable ] -# name: AA Dev (Python ${{ matrix.python-version }}, Django ${{ matrix.django-version }} with ${{ matrix.database }}) -# runs-on: ubuntu-latest -# -# strategy: -# # Set Python and Django version to test for the alpha/beta release of AllianceAuth -# matrix: -# # Python versions -# python-version: -# - '3.8' -# - '3.9' -# - '3.10' -# - '3.11' -# # Django versions -# django-version: -# - '4.0' -# # MySQL versions to test against -# database: -# - mysql:5.7 -# - mysql:8.0 -# - mariadb:10.3 -# - mariadb:10.4 -# - mariadb:10.5 -# - mariadb:10.6 -# - mariadb:10.7 -# - mariadb:10.8 -# - mariadb:10.9 -# -# continue-on-error: ${{ matrix.python-version == '3.11' }} -# -# services: -# database: -# image: ${{ matrix.database }} -# env: -# MYSQL_ROOT_PASSWORD: foobar -# MYSQL_DATABASE: tox_allianceauth -# ports: -# - 3306:3306 -# options: --tmpfs /var/lib/mysql -# -# steps: -# - name: Checkout -# uses: actions/checkout@v4 -# -# - name: Install redis -# run: sudo apt-get install -y redis-tools redis-server -# -# - name: Verify that redis is up -# run: redis-cli ping -# -# - name: Setup Python ${{ matrix.python-version }} -# uses: actions/setup-python@v5 -# with: -# python-version: ${{ matrix.python-version }} -# -# - name: Install Tox and any other packages -# run: | -# python -m pip install --upgrade pip -# python -m pip install --upgrade tox tox-gh-actions -# -# - name: Run Tox -# # Run tox using the version of Python in `PATH` -# run: tox -v -# env: -# DJANGO: ${{ matrix.django-version }} -# ALLIANCEAUTH: testing -# DB_HOST: 127.0.0.1 -# DB_USER: root -# DB_PASSWORD: temp_password_aa_tox_tests - - # Pypi Build Test + # Run PyPi Build Test pypi-build-test: - needs: [ test-coverage-aa-stable ] -# needs: [ test-coverage-aa-stable, test-coverage-aa-dev ] + needs: [ test-coverage ] name: PyPi Build Test runs-on: ubuntu-latest steps: + # Checkout the repository - name: Checkout uses: actions/checkout@v4 + # Set up Python - name: Set up Python uses: actions/setup-python@v5 with: python-version-file: 'pyproject.toml' # Read the Python version from the pyproject.toml file + # Install Tools - name: Install Tools run: | python -m pip install --upgrade pip python -m pip install --upgrade build python -m pip install --upgrade setuptools wheel + # Build Package - name: Package Build env: STACKMANAGER_VERSION: 9999 run: | python -m build + # Upload Build Artifacts - name: Upload Build Artifacts uses: actions/upload-artifact@v4 with: diff --git a/.github/workflows/potential-duplicates.yml b/.github/workflows/potential-duplicates.yml index 3ee4c8e..19514e4 100644 --- a/.github/workflows/potential-duplicates.yml +++ b/.github/workflows/potential-duplicates.yml @@ -1,3 +1,5 @@ +# Check potential duplicates when an issue is opened or edited. +# # https://github.com/wow-actions/potential-duplicates name: Potential Duplicates @@ -9,6 +11,7 @@ on: jobs: run: runs-on: ubuntu-latest + steps: - uses: wow-actions/potential-duplicates@v1 with: @@ -25,7 +28,7 @@ jobs: state: all # If similarity is higher than this threshold([0,1]), issue will be marked as duplicate. threshold: 0.6 - # Reactions to be add to comment when potential duplicates are detected. + # Reactions to be added to comment when potential duplicates are detected. # Available reactions: "-1", "+1", "confused", "laugh", "heart", "hooray", "rocket", "eyes" reactions: 'eyes, confused' # Comment to post when potential duplicates are detected. diff --git a/.github/workflows/pypi-release.yml b/.github/workflows/pypi-release.yml index cbb5dc2..7182b37 100644 --- a/.github/workflows/pypi-release.yml +++ b/.github/workflows/pypi-release.yml @@ -7,24 +7,29 @@ on: jobs: release: + # Release to PyPI name: Release on Pypi runs-on: ubuntu-latest steps: + # Checkout the repository - name: Checkout uses: actions/checkout@v4 + # Set up Python - name: Set up Python uses: actions/setup-python@v5 with: python-version-file: 'pyproject.toml' # Read the Python version from the pyproject.toml file + # Install Tools - name: Install Tools run: | python -m pip install --upgrade pip python -m pip install --upgrade build python -m pip install --upgrade setuptools wheel twine + # Package and Upload - name: Package and Upload env: STACKMANAGER_VERSION: ${{ github.event.release.tag_name }} diff --git a/.gitignore b/.gitignore index 8ae1f82..3201ead 100644 --- a/.gitignore +++ b/.gitignore @@ -2,14 +2,15 @@ /dist/ /*.egg-info/ .idea/ +.tox/ +htmlcov/ +node_modules/ *.log *.tmp *.bak *.old __pycache__ - -/.coverage -/htmlcov/ -/.tox/ +.coverage /coverage.xml +alliance_auth.sqlite3 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 48babdf..4fcaf83 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -17,7 +17,8 @@ ci: autoupdate_branch: '' autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate' autoupdate_schedule: monthly - skip: [] + skip: + - eslint # Fails due to missing node environment in CI submodules: false # pre-commit setup @@ -206,7 +207,7 @@ repos: name: Django upgrade description: "Upgrade Django code to a target version." args: - - --target-version=4.0 # Minimum supported Django version for AA. Update as needed. + - --target-version=4.2 # Minimum supported Django version for AA. Update as needed. - repo: https://github.com/asottile/pyupgrade rev: v3.15.0 @@ -232,7 +233,7 @@ repos: description: "Check for extraneous `# noqa` comments." - repo: https://github.com/PyCQA/isort - rev: 5.13.2 + rev: 5.12.0 hooks: - id: isort name: Isort @@ -307,7 +308,7 @@ repos: description: "Validate the pyproject.toml file." - repo: https://github.com/pylint-dev/pylint - rev: v3.0.3 + rev: v3.0.1 hooks: - id: pylint name: Pylint diff --git a/.stylelintrc.json b/.stylelintrc.json index dd675b0..80ea591 100644 --- a/.stylelintrc.json +++ b/.stylelintrc.json @@ -2,6 +2,18 @@ "extends": "stylelint-config-standard", "rules": { "color-no-hex": true, + "at-rule-empty-line-before": [ + "always", + { + "except": [ + "blockless-after-same-name-blockless", + "first-nested" + ], + "ignore": [ + "after-comment" + ] + } + ], "number-max-precision": 5, "no-descending-specificity": null, "media-feature-range-notation": "prefix", diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f6d869..b710098 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,70 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). + + ## \[In Development\] - Unreleased + + +## \[2.0.0-beta.2\] - 2024-03-08 + +> \[!NOTE\] +> +> **This version needs at least Alliance Auth v4.0.0b2!** +> +> Please make sure to update your Alliance Auth instance before +> you install this version, otherwise, an update to Alliance Auth will +> be pulled in unsupervised. + +### Added + +- Dashboard widget for administrative users + +## \[2.0.0-beta.1\] - 2024-02-18 + +> \[!NOTE\] +> +> **This version needs at least Alliance Auth v4.0.0b1!** +> +> Please make sure to update your Alliance Auth instance before +> you install this version, otherwise, an update to Alliance Auth will +> be pulled in unsupervised. + +### Added + +- Compatibility to Alliance Auth v4 + - Bootstrap 5 + - Django 4.2 + +### Removed + +- Compatibility to Alliance Auth v3 + ## \[1.14.2\] - 2023-09-26 ### Added @@ -137,7 +199,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Fixed -- Category with names containing a space couldn't be opened (e.g. Faction Warfare) +- Category with names containing a space couldn't be opened (e.g., Faction Warfare) ### Changed @@ -242,7 +304,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Added -- Warning when ESI status couldn't be loaded, for what ever reason +- Warning when ESI status couldn't be loaded, for whatever reason ## \[0.1.0-alpha.2\] - 2020-10-11 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c8fac1..bc7919a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,23 +24,23 @@ ______________________________________________________________________ ## Development Environment -To develop and test your change you will need a development environment on your +To develop and test your change, you will need a development environment on your local machine. There are many different options to choose from. But please make sure that you can run pre-commit checks and tox tests on your local machine. -If you are on Windows or Linux you can use the [AA guide for setting up a dev +If you are on Windows or Linux, you can use the [AA guide for setting up a dev environment][aa guide for setting up a dev environment]. ## Code Formatting and Linting ### Python -This app is utilizing the [Black code style]. Every commit has to adhere to it. +This app is using the [Black code style]. Every commit has to adhere to it. -When making changes to the source code, please always reformat the changed files in -order to ensure consistent formatting across the code base. +When making changes to the source code, please always reformat the changed files +to ensure consistent formatting across the code base. -To reformat run the following from the app's root directory: +To reformat, run the following from the app's root directory: ```shell pre-commit run black @@ -77,7 +77,7 @@ uglifyjs script.js -o script.min.js --source-map "url='script.min.js.map'" --com ### CSS -The CSS should be written in a modern manner. Colour definitions should be in +The CSS should be written in a modern manner. Color definitions should be in modern RGB(A) (`rgb(255 255 255)`, `rgba(255 255 255 / 50%)`) for example. A linter configuration is declared as `.stylelintrc.json` in the app's root @@ -105,9 +105,9 @@ csso -i styles.css -o styles.min.css -s file This repository uses [pre-commit] to verify compliance with formatting / linting rules. To use: -1. Install `pre-commit` to your system. -1. Run' pre-commit install' inside the app's root directory. -1. You're all done! Code will be checked automatically using git hooks. +- Install `pre-commit` to your system. +- Run' pre-commit install' inside the app's root directory. +- You're all done! Code will be checked automatically using git hooks. You can check if your code to commit adheres to the given style by simply running: @@ -143,7 +143,7 @@ The following will be checked by `pre-commit` (among others): To contribute code via pull request, make sure that you fork the repository and branch your changes from the `master` branch. -We strongly recommend to create a new branch for every new feature or change you +We strongly recommend creating a new branch for every new feature or change you plan to be submitting as merge request. Please make sure to keep the `master` branch of your fork in sync with the main repository to avoid conflicts. @@ -152,7 +152,7 @@ Request) and start a discussion if your idea is generally wanted and considered good addition to the app in general. Please feel free to create your merge request early and while you are still not -finished developing to flag that you are working on a specific topic. Merge request +finished developing to flag that you are working on a specific topic. Merge requests that are not yet ready to review should be marked as DRAFT. You can signal others that your merge request is ready for review by removing the DRAFT flag again. @@ -162,12 +162,12 @@ Please update existing or provide additional unit tests for your changes. Note t your merge request might fail if it reduces the current level of test coverage. We are using [Python unittest] with the Django `TestCase` class for all tests. In -addition we are using some following 3rd party test tools: +addition, we are using some following third party test tools: - django-webtest / [WebTest] - testing the web UI -- [request-mock] - testing requests with the requests library -- [tox] - Running the test suite -- [coverage] - Measuring the test coverage +- [request-mock] — testing requests with the `requests` library +- [tox] — Running the test suite +- [coverage] — Measuring the test coverage ### Checklist @@ -182,7 +182,7 @@ Before you submit a pull request, please make sure that: ## Translation This app is fully translation-ready and translations are handled via [Weblate]. If -you like to contribute to the app's translation or simply improve it, feel free to +you like to contribute to the app's translation or improve it, feel free to register on my [Weblate] instance and start translating. diff --git a/Makefile b/Makefile index 31e2e5d..bd5344f 100644 --- a/Makefile +++ b/Makefile @@ -47,5 +47,10 @@ build_test: tox_tests: export USE_MYSQL=False; \ - tox -v -e allianceauth-stable; \ + tox -v -e allianceauth-latest; \ + rm -rf .tox/ + +tox_tests_testing: + export USE_MYSQL=False; \ + tox -v -e allianceauth-testing; \ rm -rf .tox/ diff --git a/README.md b/README.md index 90099ca..7bdc4a1 100644 --- a/README.md +++ b/README.md @@ -36,19 +36,23 @@ ______________________________________________________________________ ______________________________________________________________________ -![AA ESI Status](https://raw.githubusercontent.com/ppfeufer/aa-esi-status/master/docs/images/aa-esi-status.jpg) +![AA ESI Status](https://raw.githubusercontent.com/ppfeufer/aa-esi-status/master/docs/images/aa-esi-status.jpg "AA ESI Status") ## Installation -> **Note** +> \[!NOTE\] +> +> **AA ESI Status >= 2.0.0 needs at least Alliance Auth v4.0.0!** > -> This app is a plugin for Alliance Auth. If you don't have Alliance Auth running -> already, please install it first before proceeding. (See the official [AA -> installation guide](https://allianceauth.readthedocs.io/en/latest/installation/allianceauth.html) for details) +> Please make sure to update your Alliance Auth instance _before_ you install this +> module or update to the latest version, otherwise an update to Alliance Auth will +> be pulled in unsupervised. > -> AA ESI Status needs at least **Alliance Auth v3.6.1**. Please make sure to meet -> this condition _before_ installing this app, otherwise an update to Alliance Auth -> will be pulled in unsupervised. +> The last version of AA ESI Status that supports Alliance Auth v3 is 1.14.2 + +This app is a plugin for Alliance Auth. If you don't have Alliance Auth running +already, please install it first before proceeding. +(See the official [AA installation guide](https://allianceauth.readthedocs.io/en/latest/installation/allianceauth.html) for details) ### Step 1: Install the App diff --git a/codecov.yml b/codecov.yml index 1b9c96c..db4725c 100644 --- a/codecov.yml +++ b/codecov.yml @@ -1,19 +1,21 @@ codecov: - require_ci_to_pass: yes + require_ci_to_pass: true + +comment: + layout: header, reach, changes, diff, files, footer + require_changes: false coverage: precision: 2 + range: + - 70.0 + - 100.0 round: up - range: "70...100" parsers: gcov: branch_detection: - conditional: yes - loop: yes - method: no - macro: no - -comment: - layout: header, reach, changes, diff, files, footer - require_changes: no + conditional: true + loop: true + macro: false + method: false diff --git a/docs/images/aa-esi-status.jpg b/docs/images/aa-esi-status.jpg index 8fd1808..dfc126e 100644 Binary files a/docs/images/aa-esi-status.jpg and b/docs/images/aa-esi-status.jpg differ diff --git a/docs/images/weblate/aa-esi-status_app-name.jpg b/docs/images/weblate/aa-esi-status_app-name.jpg new file mode 100644 index 0000000..51516bb Binary files /dev/null and b/docs/images/weblate/aa-esi-status_app-name.jpg differ diff --git a/docs/images/weblate/aa-esi-status_app-translation-footer.jpg b/docs/images/weblate/aa-esi-status_app-translation-footer.jpg new file mode 100644 index 0000000..17e01d3 Binary files /dev/null and b/docs/images/weblate/aa-esi-status_app-translation-footer.jpg differ diff --git a/docs/images/weblate/aa-esi-status_green-endpoints.jpg b/docs/images/weblate/aa-esi-status_green-endpoints.jpg new file mode 100644 index 0000000..467a672 Binary files /dev/null and b/docs/images/weblate/aa-esi-status_green-endpoints.jpg differ diff --git a/docs/images/weblate/aa-esi-status_red-endpoints.jpg b/docs/images/weblate/aa-esi-status_red-endpoints.jpg new file mode 100644 index 0000000..62499bb Binary files /dev/null and b/docs/images/weblate/aa-esi-status_red-endpoints.jpg differ diff --git a/docs/images/weblate/aa-esi-status_yellow-endpoints.jpg b/docs/images/weblate/aa-esi-status_yellow-endpoints.jpg new file mode 100644 index 0000000..df3493d Binary files /dev/null and b/docs/images/weblate/aa-esi-status_yellow-endpoints.jpg differ diff --git a/esistatus/__init__.py b/esistatus/__init__.py index 71d8fca..2330b64 100644 --- a/esistatus/__init__.py +++ b/esistatus/__init__.py @@ -2,10 +2,8 @@ A couple of variables to use throughout the app """ -# Standard Library -from importlib import metadata +# Django +from django.utils.translation import gettext_lazy as _ -__version__ = metadata.version("aa-esi-status") -__title__ = "ESI Status" - -del metadata +__version__ = "2.0.0-beta.2" +__title__ = _("ESI Status") diff --git a/esistatus/auth_hooks.py b/esistatus/auth_hooks.py index 85b84e1..5b18464 100644 --- a/esistatus/auth_hooks.py +++ b/esistatus/auth_hooks.py @@ -2,15 +2,14 @@ Hook into AA """ -# Django -from django.utils.translation import gettext_lazy as _ - # Alliance Auth from allianceauth import hooks +from allianceauth.hooks import DashboardItemHook from allianceauth.services.hooks import MenuItemHook, UrlHook # AA ESI Status from esistatus import __title__, urls +from esistatus.views import dashboard_widget class AaEsiStatusMenuItem(MenuItemHook): # pylint: disable=too-few-public-methods @@ -22,27 +21,42 @@ def __init__(self): # Setup menu entry for sidebar MenuItemHook.__init__( self, - _(__title__), - "fas fa-signal fa-fw", - "esistatus:index", + text=__title__, + classes="fa-solid fa-signal", + url_name="esistatus:index", navactive=["esistatus:"], ) def render(self, request): """ Check if the user has the permission to view this app + :param request: + :type request: :return: + :rtype: """ return MenuItemHook.render(self, request) +class AaEsiStatusDashboardHook(DashboardItemHook): + """ + This class adds the widget to the dashboard + """ + + def __init__(self): + # Setup dashboard widget + DashboardItemHook.__init__(self=self, view_function=dashboard_widget, order=1) + + @hooks.register("menu_item_hook") def register_menu(): """ Register our menu item - :return: + + :return: The hook + :rtype: AaEsiStatusMenuItem """ return AaEsiStatusMenuItem() @@ -52,7 +66,9 @@ def register_menu(): def register_urls(): """ Register our base url - :return: + + :return: The hook + :rtype: UrlHook """ return UrlHook( @@ -61,3 +77,15 @@ def register_urls(): base_url=r"^esi-status/", excluded_views=["esistatus.views.index"], ) + + +@hooks.register("dashboard_hook") +def register_esi_hook(): + """ + Register our dashboard hook + + :return: The hook + :rtype: AaEsiStatusDashboardHook + """ + + return AaEsiStatusDashboardHook() diff --git a/esistatus/constants.py b/esistatus/constants.py index fee93be..925f8d1 100644 --- a/esistatus/constants.py +++ b/esistatus/constants.py @@ -10,7 +10,7 @@ VERBOSE_NAME = "AA ESI Status for Alliance Auth" -slugified_name: str = slugify(VERBOSE_NAME, allow_unicode=True) +slugified_name: str = slugify(value=VERBOSE_NAME, allow_unicode=True) github_url: str = "https://github.com/ppfeufer/aa-esi-status" USER_AGENT = f"{slugified_name} v{__version__} {github_url}" diff --git a/esistatus/static/esistatus/css/aa-bootstrap-fix.css b/esistatus/static/esistatus/css/aa-bootstrap-fix.css deleted file mode 100644 index 3b8d73e..0000000 --- a/esistatus/static/esistatus/css/aa-bootstrap-fix.css +++ /dev/null @@ -1,13 +0,0 @@ -/* Attempting to fix AA's wrong usage of bootstrap classes -------------------------------------------------------------------------------------- */ -@media all { - #site-body-wrapper.row { - margin-left: 0; - } -} - -@media all and (min-width: 768px) { - #site-body-wrapper.row { - margin-left: -15px; - } -} diff --git a/esistatus/static/esistatus/css/aa-bootstrap-fix.min.css b/esistatus/static/esistatus/css/aa-bootstrap-fix.min.css deleted file mode 100644 index d9ec3d3..0000000 --- a/esistatus/static/esistatus/css/aa-bootstrap-fix.min.css +++ /dev/null @@ -1,2 +0,0 @@ -@media all{#site-body-wrapper.row{margin-left:0}}@media all and (min-width:768px){#site-body-wrapper.row{margin-left:-15px}} -/*# sourceMappingURL=aa-bootstrap-fix.min.css.map */ \ No newline at end of file diff --git a/esistatus/static/esistatus/css/aa-bootstrap-fix.min.css.map b/esistatus/static/esistatus/css/aa-bootstrap-fix.min.css.map deleted file mode 100644 index b168ade..0000000 --- a/esistatus/static/esistatus/css/aa-bootstrap-fix.min.css.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"sources":["aa-bootstrap-fix.css"],"names":[],"mappings":"AAEA,A,WACI,sB,CACI,eAIR,A,iCACI,sB,CACI,mB","file":"aa-bootstrap-fix.css","sourcesContent":["/* Attempting to fix AA's wrong usage of bootstrap classes\n------------------------------------------------------------------------------------- */\n@media all {\n #site-body-wrapper.row {\n margin-left: 0;\n }\n}\n\n@media all and (min-width: 768px) {\n #site-body-wrapper.row {\n margin-left: -15px;\n }\n}\n"]} \ No newline at end of file diff --git a/esistatus/static/esistatus/css/esistatus.css b/esistatus/static/esistatus/css/esistatus.css index 6ad3864..ecea2f5 100644 --- a/esistatus/static/esistatus/css/esistatus.css +++ b/esistatus/static/esistatus/css/esistatus.css @@ -1,25 +1,6 @@ @media all { - .aa-esistatus-header-addition { - display: block; - } - - .aa-esistatus .panel-footer .panel-heading { - cursor: pointer; - } - - .aa-esistatus .panel-footer .panel-default, - .aa-esistatus .panel-footer .panel-default .panel-body p:last-child { + .aa-esistatus .card-footer .card-default, + .aa-esistatus .card-footer .card-default .card-body p:last-child { margin-bottom: 0; } - - .aa-esistatus-footer { - border-top: 1px solid rgb(236 240 241); - font-size: 85%; - margin-top: 1rem; - padding-top: 1rem; - } - - .template-dark-mode .aa-esistatus-footer { - border-color: rgb(70 69 69); - } } diff --git a/esistatus/static/esistatus/css/esistatus.min.css b/esistatus/static/esistatus/css/esistatus.min.css index f859f1d..6ccb2bb 100644 --- a/esistatus/static/esistatus/css/esistatus.min.css +++ b/esistatus/static/esistatus/css/esistatus.min.css @@ -1,2 +1,2 @@ -@media all{.aa-esistatus-header-addition{display:block}.aa-esistatus .panel-footer .panel-heading{cursor:pointer}.aa-esistatus .panel-footer .panel-default,.aa-esistatus .panel-footer .panel-default .panel-body p:last-child{margin-bottom:0}.aa-esistatus-footer{border-top:1px solid rgb(236 240 241);font-size:85%;margin-top:1rem;padding-top:1rem}.template-dark-mode .aa-esistatus-footer{border-color:rgb(70 69 69)}} +@media all{.aa-esistatus .card-footer .card-default,.aa-esistatus .card-footer .card-default .card-body p:last-child{margin-bottom:0}} /*# sourceMappingURL=esistatus.min.css.map */ \ No newline at end of file diff --git a/esistatus/static/esistatus/css/esistatus.min.css.map b/esistatus/static/esistatus/css/esistatus.min.css.map index 842666b..1516242 100644 --- a/esistatus/static/esistatus/css/esistatus.min.css.map +++ b/esistatus/static/esistatus/css/esistatus.min.css.map @@ -1 +1 @@ -{"version":3,"sources":["esistatus.css"],"names":[],"mappings":"AAAA,A,WACI,6B,CACI,a,CAGJ,0C,CACI,c,CAGJ,0C,CACA,mE,CACI,e,CAGJ,oB,CACI,qC,CACA,a,CACA,e,CACA,gB,CAGJ,wC,CACI,4B","file":"esistatus.css","sourcesContent":["@media all {\n .aa-esistatus-header-addition {\n display: block;\n }\n\n .aa-esistatus .panel-footer .panel-heading {\n cursor: pointer;\n }\n\n .aa-esistatus .panel-footer .panel-default,\n .aa-esistatus .panel-footer .panel-default .panel-body p:last-child {\n margin-bottom: 0;\n }\n\n .aa-esistatus-footer {\n border-top: 1px solid rgb(236 240 241);\n font-size: 85%;\n margin-top: 1rem;\n padding-top: 1rem;\n }\n\n .template-dark-mode .aa-esistatus-footer {\n border-color: rgb(70 69 69);\n }\n}\n"]} \ No newline at end of file +{"version":3,"sources":["esistatus.css"],"names":[],"mappings":"AAAA,A,WACI,wC,CACA,gE,CACI,iB","file":"esistatus.css","sourcesContent":["@media all {\n .aa-esistatus .card-footer .card-default,\n .aa-esistatus .card-footer .card-default .card-body p:last-child {\n margin-bottom: 0;\n }\n}\n"]} \ No newline at end of file diff --git a/esistatus/templates/esistatus/base.html b/esistatus/templates/esistatus/base.html index 53e9fc5..6687404 100644 --- a/esistatus/templates/esistatus/base.html +++ b/esistatus/templates/esistatus/base.html @@ -1,20 +1,28 @@ -{% extends "allianceauth/base.html" %} +{% extends "allianceauth/base-bs5.html" %} {% load i18n %} -{% block page_title %}{% translate "ESI Status" %}{% endblock %} +{% block page_title %} + {% translate "ESI Status" %} +{% endblock %} + +{% block header_nav_brand %} + {% translate "ESI Status" %} +{% endblock header_nav_brand %} {% block content %}
-
- {% block aa_esistatus_header %}{% endblock %} -
+ {% if not user.is_authenticated %} +
+ {% block aa_esistatus_header %}{% endblock %} +
+ {% endif %}
{% block aa_esistatus_body %}{% endblock %}
-
+
{% include "esistatus/partials/footer/app-translation-footer.html" %}
diff --git a/esistatus/templates/esistatus/dashboard-widget.html b/esistatus/templates/esistatus/dashboard-widget.html new file mode 100644 index 0000000..2cc6be7 --- /dev/null +++ b/esistatus/templates/esistatus/dashboard-widget.html @@ -0,0 +1,26 @@ +
+ + diff --git a/esistatus/templates/esistatus/index.html b/esistatus/templates/esistatus/index.html index 845bf5b..5a9dbd4 100644 --- a/esistatus/templates/esistatus/index.html +++ b/esistatus/templates/esistatus/index.html @@ -1,7 +1,7 @@ {% extends "esistatus/base.html" %} {% load i18n %} -{% load esistatus_versioned_static %} +{% load esistatus %} {% block aa_esistatus_header %} {% translate "ESI Status" as translated_header %} @@ -20,14 +20,15 @@ {% translate "Green Endpoints" as translated_header_green %} {% include 'esistatus/partials/endpoints.html' with title=translated_header_green status="green" data=esi_endpoint_status.green %} {% else %} -

- {% translate "Couldn't read the ESI status. Please try and reload the page. If that doesn't help, it is possible that ESI might be down entirely." %} -

+
+

+ {% translate "Couldn't read the ESI status. Please try and reload the page. If that doesn't help, it is possible that ESI might be down entirely." %} +

+
{% endif %}
{% endblock %} {% block extra_css %} - - + {% endblock %} diff --git a/esistatus/templates/esistatus/partials/dashboard-widget/esi-status.html b/esistatus/templates/esistatus/partials/dashboard-widget/esi-status.html new file mode 100644 index 0000000..428057d --- /dev/null +++ b/esistatus/templates/esistatus/partials/dashboard-widget/esi-status.html @@ -0,0 +1,30 @@ +{% load i18n %} + +
+
+
+ {% translate "ESI Status" %} +
+
+ +
+
+ {% translate "Red Endpoints" as translated_header_red %} + {% include 'esistatus/partials/endpoints.html' with title=translated_header_red status="red" data=esi_endpoint_status.red with_details=False %} + + {% translate "Yellow Endpoints" as translated_header_yellow %} + {% include 'esistatus/partials/endpoints.html' with title=translated_header_yellow status="yellow" data=esi_endpoint_status.yellow with_details=False %} + + {% translate "Green Endpoints" as translated_header_green %} + {% include 'esistatus/partials/endpoints.html' with title=translated_header_green status="green" data=esi_endpoint_status.green with_details=False %} +
+ +
+

+ {% translate "Detailed ESI status" %} + | + {% translate "EVE Online status" %} +

+
+
+
diff --git a/esistatus/templates/esistatus/partials/endpoints.html b/esistatus/templates/esistatus/partials/endpoints.html index e636151..c88c03f 100644 --- a/esistatus/templates/esistatus/partials/endpoints.html +++ b/esistatus/templates/esistatus/partials/endpoints.html @@ -1,40 +1,41 @@ - -
-
-
-

+
+
+
+
{{ title }} -

+
-
- {{ data.count }}
+
+ {{ data.count }}
{{ data.percentage }}
-
- {% if data.count > 0 %} - {% for category, endpoints in data.endpoints.items %} -
- - -
- {% for endpoint in endpoints %} -

- {{ endpoint.method }} - {{ endpoint.route }} + {% if with_details is not False %} +

+ {% if data.count > 0 %} + {% for category, endpoints in data.endpoints.items %} +
+ + +
+ {% for endpoint in endpoints %} +

+ {{ endpoint.method }} + {{ endpoint.route }} +

+ {% endfor %} +
-
- {% endfor %} - {% endif %} -
+ {% endfor %} + {% endif %} +
+ {% endif %}
diff --git a/esistatus/templates/esistatus/partials/footer/app-translation-footer.html b/esistatus/templates/esistatus/partials/footer/app-translation-footer.html index 2070b47..8dfbecc 100644 --- a/esistatus/templates/esistatus/partials/footer/app-translation-footer.html +++ b/esistatus/templates/esistatus/partials/footer/app-translation-footer.html @@ -1,7 +1,7 @@ {% load i18n %}
-

+

{% translate "Do you want to help translate this app into your language or improve the existing translation?" %} - diff --git a/esistatus/templates/esistatus/partials/header/page-header.html b/esistatus/templates/esistatus/partials/header/page-header.html index 99c7f67..c1e8e27 100644 --- a/esistatus/templates/esistatus/partials/header/page-header.html +++ b/esistatus/templates/esistatus/partials/header/page-header.html @@ -1,9 +1,9 @@

-

+

{{ header_text }} {% if addition %} - {{ addition }} + {{ addition }} {% endif %}

diff --git a/esistatus/templatetags/esistatus_versioned_static.py b/esistatus/templatetags/esistatus.py similarity index 83% rename from esistatus/templatetags/esistatus_versioned_static.py rename to esistatus/templatetags/esistatus.py index 8992ab9..7ed3100 100644 --- a/esistatus/templatetags/esistatus_versioned_static.py +++ b/esistatus/templatetags/esistatus.py @@ -20,7 +20,7 @@ def esistatus_static(path: str) -> str: :rtype: """ - static_url = static(path) - versioned_url = static_url + "?v=" + __version__ + static_url = static(path=path) + versioned_url = f"{static_url}?v={__version__}" return versioned_url diff --git a/esistatus/tests/test_access.py b/esistatus/tests/test_access.py index eb10ace..d57af82 100644 --- a/esistatus/tests/test_access.py +++ b/esistatus/tests/test_access.py @@ -29,31 +29,80 @@ def setUpClass(cls) -> None: cls.group = Group.objects.create(name="Superhero") - cls.user_1001 = create_fake_user(1001, "Peter Parker") + cls.user_1001 = create_fake_user( + character_id=1001, character_name="Peter Parker" + ) + cls.user_1002 = create_fake_user(character_id=1002, character_name="Clark Kent") + cls.user_1002.is_superuser = True + cls.user_1003 = create_fake_user( + character_id=1003, character_name="Bruce Wayne" + ) + cls.user_1003.is_staff = True def test_has_access(self): """ - Test that a user without access get a 302 - :return: + Test that a user without access gets a 302 """ # when - res = self.client.get(reverse("esistatus:index")) + res = self.client.get(path=reverse(viewname="esistatus:index")) # then - self.assertEqual(res.status_code, HTTPStatus.OK) + self.assertEqual(first=res.status_code, second=HTTPStatus.OK) def test_logged_in_has_access(self): """ - Test that a user with access get to see it - :return: + Test that a user with access gets to see it """ # given - self.client.force_login(self.user_1001) + self.client.force_login(user=self.user_1001) # when - res = self.client.get(reverse("esistatus:index")) + res = self.client.get(path=reverse(viewname="esistatus:index")) # then - self.assertEqual(res.status_code, HTTPStatus.OK) + self.assertEqual(first=res.status_code, second=HTTPStatus.OK) + + def test_superuser_has_access(self): + """ + Test that a superuser has access + """ + + # given + self.client.force_login(user=self.user_1002) + + # when + res = self.client.get(path=reverse(viewname="esistatus:index")) + + # then + self.assertEqual(first=res.status_code, second=HTTPStatus.OK) + + def test_staff_user_has_access(self): + """ + Test that a staff user has access + """ + + # given + self.client.force_login(user=self.user_1003) + + # when + res = self.client.get(path=reverse(viewname="esistatus:index")) + + # then + self.assertEqual(first=res.status_code, second=HTTPStatus.OK) + + def test_response_content(self): + """ + Test that the response contains the expected content + """ + + # given + self.client.force_login(user=self.user_1001) + + # when + res = self.client.get(path=reverse(viewname="esistatus:index")) + + # then + self.assertEqual(first=res.status_code, second=HTTPStatus.OK) + self.assertContains(response=res, text="ESI Status") diff --git a/esistatus/tests/test_auth_hooks.py b/esistatus/tests/test_auth_hooks.py index fa58c0b..1f87f4d 100644 --- a/esistatus/tests/test_auth_hooks.py +++ b/esistatus/tests/test_auth_hooks.py @@ -26,12 +26,14 @@ def setUpClass(cls) -> None: super().setUpClass() - cls.user_1001 = create_fake_user(1001, "Peter Parker") + cls.user_1001 = create_fake_user( + character_id=1001, character_name="Peter Parker" + ) cls.html_menu = f""" -
  • - - +
  • + + ESI Status
    • @@ -40,7 +42,7 @@ def setUpClass(cls) -> None: cls.html_header = """
    -

    +

    ESI Status

    @@ -50,17 +52,17 @@ def setUpClass(cls) -> None: def test_render_hook_success(self): """ Test should show the link to the app in the navigation to user with access + :return: :rtype: """ - self.client.force_login(self.user_1001) + self.client.force_login(user=self.user_1001) response = self.client.get(path=reverse(viewname="esistatus:index")) - self.assertEqual(response.status_code, HTTPStatus.OK) - self.assertContains(response, self.html_menu, html=True) - self.assertContains(response=response, text=self.html_header, html=True) + self.assertEqual(first=response.status_code, second=HTTPStatus.OK) + self.assertContains(response=response, text=self.html_menu, html=True) def test_render_hook_with_public_page(self): """ diff --git a/esistatus/tests/test_templatetags.py b/esistatus/tests/test_templatetags.py index b0c3833..7698fb8 100644 --- a/esistatus/tests/test_templatetags.py +++ b/esistatus/tests/test_templatetags.py @@ -12,25 +12,28 @@ class TestVersionedStatic(TestCase): """ - Test the esistatus_versioned_static template tag + Test the esistatus_static template tag """ def test_versioned_static(self): """ Test should return a versioned static file + :return: :rtype: """ - context = Context({"version": __version__}) + context = Context(dict_={"version": __version__}) template_to_render = Template( - "{% load esistatus_versioned_static %}" - "{% esistatus_static 'esistatus/css/esistatus.min.css' %}" + template_string=( + "{% load esistatus %}" + "{% esistatus_static 'esistatus/css/esistatus.min.css' %}" + ) ) - rendered_template = template_to_render.render(context) + rendered_template = template_to_render.render(context=context) self.assertInHTML( - f'/static/esistatus/css/esistatus.min.css?v={context["version"]}', - rendered_template, + needle=f'/static/esistatus/css/esistatus.min.css?v={context["version"]}', + haystack=rendered_template, ) diff --git a/esistatus/tests/test_views.py b/esistatus/tests/test_views.py new file mode 100644 index 0000000..a3e32ab --- /dev/null +++ b/esistatus/tests/test_views.py @@ -0,0 +1,241 @@ +""" +Test the apps' views +""" + +# Standard Library +import json +from http import HTTPStatus +from unittest.mock import patch + +# Third Party +from requests import RequestException + +# Django +from django.test import TestCase +from django.urls import reverse + +# Alliance Auth (External Libs) +from app_utils.testing import create_fake_user + +# AA ESI Status +from esistatus import views + + +class TestDashboardWidget(TestCase): + """ + Test the dashboard widget + """ + + def setUp(self): + """ + Set up users + + :return: + :rtype: + """ + + self.superuser = create_fake_user( + character_id=1002, character_name="Clark Kent" + ) + self.superuser.is_superuser = True + self.superuser.is_staff = True + + self.normal_user = create_fake_user( + character_id=1001, character_name="Peter Parker" + ) + + # def test_dashboard_widget_with_superuser(self): + # self.client.force_login(self.superuser) + # response = self.client.get(path=reverse(viewname="authentication:dashboard")) + # self.assertContains( + # response, + # '
    ESI Status
    ', + # html=True, + # ) + + def test_dashboard_widget_with_normal_user(self): + """ + Test that a normal user does not see the ESI status widget + + :return: + :rtype: + """ + + self.client.force_login(user=self.normal_user) + response = self.client.get(path=reverse(viewname="authentication:dashboard")) + self.assertNotContains( + response=response, + text='
    ESI Status
    ', + html=True, + ) + + +class TestAjaxEsiStatus(TestCase): + """ + Test the AJAX ESI Status view + """ + + def setUp(self): + """ + Set up users + + :return: + :rtype: + """ + + self.superuser = create_fake_user( + character_id=1002, character_name="Clark Kent" + ) + self.superuser.is_superuser = True + + self.client.force_login(user=self.superuser) + + @patch("esistatus.views._esi_status") + def test_ajax_esi_status_with_status_result(self, mock_esi_status): + """ + Test the AJAX ESI Status view with HTTPStatus.OK + + :param mock_esi_status: + :type mock_esi_status: + :return: + :rtype: + """ + + mock_esi_status.return_value = (True, {}) + response = self.client.get(path=reverse(viewname="esistatus:ajax_esi_status")) + self.assertEqual(first=response.status_code, second=HTTPStatus.OK) + + @patch("esistatus.views._esi_status") + def test_ajax_esi_status_without_status_result(self, mock_esi_status): + """ + Test the AJAX ESI Status view with HTTPStatus.NO_CONTENT + + :param mock_esi_status: + :type mock_esi_status: + :return: + :rtype: + """ + + mock_esi_status.return_value = (False, {}) + response = self.client.get(path=reverse(viewname="esistatus:ajax_esi_status")) + self.assertEqual(first=response.status_code, second=HTTPStatus.NO_CONTENT) + + +class TestIndex(TestCase): + """ + Test the index view + """ + + def setUp(self): + """ + Set up users + + :return: + :rtype: + """ + + self.superuser = create_fake_user( + character_id=1002, character_name="Clark Kent" + ) + self.superuser.is_superuser = True + + self.client.force_login(user=self.superuser) + + @patch("esistatus.views._esi_status") + def test_index_with_status_result(self, mock_esi_status): + """ + Test the index view with a status result + + :param mock_esi_status: + :type mock_esi_status: + :return: + :rtype: + """ + + mock_esi_status.return_value = (True, {}) + response = self.client.get(path=reverse(viewname="esistatus:index")) + + self.assertEqual(first=response.status_code, second=HTTPStatus.OK) + + @patch("esistatus.views._esi_status") + def test_index_without_status_result(self, mock_esi_status): + """ + Test the index view without a status result + + :param mock_esi_status: + :type mock_esi_status: + :return: + :rtype: + """ + + mock_esi_status.return_value = (False, {}) + response = self.client.get(path=reverse(viewname="esistatus:index")) + + self.assertEqual(first=response.status_code, second=HTTPStatus.OK) + + +class TestEsiStatus(TestCase): + """ + Test the _esi_status function + """ + + @patch("requests.get") + def test_esi_status_with_valid_response(self, mock_get): + """ + Test the _esi_status function with a valid response + + :param mock_get: + :type mock_get: + :return: + :rtype: + """ + + mock_get.return_value.json.return_value = [] + mock_get.return_value.raise_for_status.return_value = None + has_status_result, esi_endpoint_status = views._esi_status() + + self.assertTrue(has_status_result) + self.assertEqual( + first=esi_endpoint_status, + second={ + "green": {"endpoints": {}, "count": 0, "percentage": "0.00%"}, + "yellow": {"endpoints": {}, "count": 0, "percentage": "0.00%"}, + "red": {"endpoints": {}, "count": 0, "percentage": "0.00%"}, + }, + ) + + @patch("requests.get") + def test_esi_status_with_request_exception(self, mock_get): + """ + Test the _esi_status function with a request exception + + :param mock_get: + :type mock_get: + :return: + :rtype: + """ + + mock_get.side_effect = RequestException("Request Exception") + has_status_result, esi_endpoint_status = views._esi_status() + + self.assertFalse(expr=has_status_result) + self.assertEqual(first=esi_endpoint_status, second={}) + + @patch("requests.get") + def test_esi_status_with_json_decode_error(self, mock_get): + """ + Test the _esi_status function with a JSON decode error + + :param mock_get: + :type mock_get: + :return: + :rtype: + """ + + mock_get.return_value.json.side_effect = json.JSONDecodeError( + msg="Expecting property name enclosed in double quotes", doc="{}", pos=0 + ) + has_status_result, esi_endpoint_status = views._esi_status() + + self.assertFalse(expr=has_status_result) + self.assertEqual(first=esi_endpoint_status, second={}) diff --git a/esistatus/tests/utils.py b/esistatus/tests/utils.py index 7332085..20100fc 100644 --- a/esistatus/tests/utils.py +++ b/esistatus/tests/utils.py @@ -24,10 +24,10 @@ def create_fake_user( permissions: List[str] = None, ) -> User: """ - Create a fake user incl. main character and (optional) permissions. + Create a fake user incl. Main character and (optional) permissions. """ - username = re.sub(r"[^\w\d@\.\+-]", "_", character_name) + username = re.sub(pattern=r"[^\w\d@\.\+-]", repl="_", string=character_name) user = AuthUtils.create_user(username) if not corporation_id: @@ -51,7 +51,9 @@ def create_fake_user( ) if permissions: - perm_objs = [AuthUtils.get_permission_by_name(perm) for perm in permissions] + perm_objs = [ + AuthUtils.get_permission_by_name(perm=perm) for perm in permissions + ] user = AuthUtils.add_permissions_to_user(perms=perm_objs, user=user) return user diff --git a/esistatus/urls.py b/esistatus/urls.py index e18f8bc..a202c6f 100644 --- a/esistatus/urls.py +++ b/esistatus/urls.py @@ -11,5 +11,6 @@ app_name: str = "esistatus" urlpatterns = [ - path("", views.index, name="index"), + path(route="", view=views.index, name="index"), + path(route="ajax/esi_status/", view=views.ajax_esi_status, name="ajax_esi_status"), ] diff --git a/esistatus/views.py b/esistatus/views.py index 69f2db3..785f34f 100644 --- a/esistatus/views.py +++ b/esistatus/views.py @@ -10,8 +10,10 @@ import requests # Django +from django.core.handlers.wsgi import WSGIRequest from django.http import HttpResponse from django.shortcuts import render +from django.template.loader import render_to_string # Alliance Auth from allianceauth.services.hooks import get_extension_logger @@ -28,11 +30,16 @@ def _append_value(dict_obj: Dict, key: str, value: Any) -> None: """ - Appending values to dicts - :param dict_obj: - :param key: - :param value: - :return: + Append a value to a key in a dictionary + + :param dict_obj: The dictionary + :type dict_obj: Dict + :param key: The key + :type key: str + :param value: The value + :type value: Any + :return: None + :rtype: None """ # Check if key exists in the dict or not @@ -46,21 +53,24 @@ def _append_value(dict_obj: Dict, key: str, value: Any) -> None: # Append the value in a list dict_obj[key].append(value) else: - # Is the key is not in the dict, add a key-value pair + # If the key is not in the dict, add a key-value pair dict_obj[key] = [value] -def _esi_endpoint_status(esi_endpoint_json: json) -> Tuple: +def _esi_endpoint_status_from_json(esi_endpoint_json: json) -> Tuple: """ Get the ESI endpoint status from the ESI json - :param esi_endpoint_json: - :return: + + :param esi_endpoint_json: The ESI endpoint json + :type esi_endpoint_json: json + :return: The ESI endpoint status + :rtype: Tuple[(bool) Has Status Results, (dict) Endpoint Status] """ esi_endpoint_status = { - "green": {"endpoints": {}, "count": 0, "percentage": ""}, - "yellow": {"endpoints": {}, "count": 0, "percentage": ""}, - "red": {"endpoints": {}, "count": 0, "percentage": ""}, + "green": {"endpoints": {}, "count": 0, "percentage": "0.00%"}, + "yellow": {"endpoints": {}, "count": 0, "percentage": "0.00%"}, + "red": {"endpoints": {}, "count": 0, "percentage": "0.00%"}, } for esi_endpoint in esi_endpoint_json: @@ -83,66 +93,135 @@ def _esi_endpoint_status(esi_endpoint_json: json) -> Tuple: # Calculate percentages - Green endpoints green_percentage_calc = ( - esi_endpoint_status["green"]["count"] / endpoints_total * 100 + (esi_endpoint_status["green"]["count"] / endpoints_total * 100) + if esi_endpoint_status["green"]["count"] > 0 + else 0 ) esi_endpoint_status["green"]["percentage"] = f"{green_percentage_calc:.2f}%" # Calculate percentages - Yellow endpoints yellow_percentage_calc = ( - esi_endpoint_status["yellow"]["count"] / endpoints_total * 100 + (esi_endpoint_status["yellow"]["count"] / endpoints_total * 100) + if esi_endpoint_status["yellow"]["count"] > 0 + else 0 ) esi_endpoint_status["yellow"]["percentage"] = f"{yellow_percentage_calc:.2f}%" # Calculate percentages - Red endpoints - red_percentage_calc = esi_endpoint_status["red"]["count"] / endpoints_total * 100 + red_percentage_calc = ( + (esi_endpoint_status["red"]["count"] / endpoints_total * 100) + if esi_endpoint_status["red"]["count"] > 0 + else 0 + ) esi_endpoint_status["red"]["percentage"] = f"{red_percentage_calc:.2f}%" - # Return the whole jazz (Tuple[(dict) Endpoint Status, (bool) Has Status Results]) - return esi_endpoint_status, True + # Return the whole jazz (Tuple[(bool) Has Status Results, (dict) Endpoint Status]) + return True, esi_endpoint_status -def index(request) -> HttpResponse: +def _esi_status() -> Tuple: """ - Index view + Get the ESI status + + :return: The ESI status + :rtype: Tuple (Tuple[(bool) Has Status Results, (dict) Endpoint Status]) """ - esi_endpoint_status = {} has_status_result = False request_headers = {"User-Agent": USER_AGENT} esi_status_json_url = "https://esi.evetech.net/status.json?version=latest" - esi_endpoint_status_result = requests.get( - url=esi_status_json_url, headers=request_headers, timeout=10 - ) + esi_endpoint_status = {} try: + esi_endpoint_status_result = requests.get( + url=esi_status_json_url, headers=request_headers, timeout=10 + ) esi_endpoint_status_result.raise_for_status() + esi_endpoint_json = esi_endpoint_status_result.json() except requests.exceptions.RequestException as exc: error_str = str(exc) logger.info(msg=f"Unable to get ESI status. Error: {error_str}") - context = {"has_status_result": has_status_result} - else: - try: - esi_endpoint_json = esi_endpoint_status_result.json() - except requests.exceptions.JSONDecodeError: - has_status_result = False - - logger.info( - msg=( - "Unable to get ESI status. ESI returning gibberish, I can't understand …" - ) - ) - else: - esi_endpoint_status, has_status_result = _esi_endpoint_status( - esi_endpoint_json=esi_endpoint_json + return has_status_result, esi_endpoint_status + except json.JSONDecodeError: + logger.info( + msg=( + "Unable to get ESI status. ESI returning gibberish, I can't understand …" ) + ) + + return has_status_result, esi_endpoint_status + + has_status_result, esi_endpoint_status = _esi_endpoint_status_from_json( + esi_endpoint_json=esi_endpoint_json + ) + + return has_status_result, esi_endpoint_status + + +def index(request: WSGIRequest) -> HttpResponse: + """ + Index view + + :param request: The request + :type request: WSGIRequest + :return: The response + :rtype: HttpResponse + """ + + has_status_result, esi_endpoint_status = _esi_status() + + context = { + "has_status_result": has_status_result, + "esi_endpoint_status": esi_endpoint_status, + } + return render( + request=request, template_name="esistatus/index.html", context=context + ) + + +def ajax_esi_status(request: WSGIRequest) -> HttpResponse: + """ + AJAX ESI Status view + + :param request: The request + :type request: WSGIRequest + :return: The response + :rtype: HttpResponse + """ + + has_status_result, esi_endpoint_status = _esi_status() + + if has_status_result: context = { "has_status_result": has_status_result, "esi_endpoint_status": esi_endpoint_status, } - return render( - request=request, template_name="esistatus/index.html", context=context - ) + return render( + request=request, + template_name="esistatus/partials/dashboard-widget/esi-status.html", + context=context, + ) + + return HttpResponse(status=204) + + +def dashboard_widget(request: WSGIRequest) -> str: + """ + Dashboard widget + + :param request: The request + :type request: WSGIRequest + :return: The widget + :rtype: str + """ + + if request.user.is_superuser: + return render_to_string( + template_name="esistatus/dashboard-widget.html", request=request + ) + + return "" diff --git a/eslint.config.js b/eslint.config.js new file mode 100644 index 0000000..f6e7c5e --- /dev/null +++ b/eslint.config.js @@ -0,0 +1,33 @@ +import globals from 'globals'; +import js from '@eslint/js'; + +/** @type {import('eslint').Linter.FlatConfig[]} */ + +export default [ + { + languageOptions: { + globals: { + ...globals.browser, + ...globals.commonjs, + ...globals.jquery, + }, + parserOptions: { + ...js.configs.recommended.parserOptions, + ecmaVersion: 'latest', + ecmaFeatures: { + impliedStrict: true, + }, + sourceType: 'module', + }, + }, + rules: { + ...js.configs.recommended.rules, + indent: ['error', 4], + quotes: ['error', 'single', { + avoidEscape: true, + allowTemplateLiterals: true + }], + semi: [2, 'always'], + }, + } +]; diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..ef83cb5 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,1132 @@ +{ + "name": "aa-bulletin-board", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "devDependencies": { + "eslint": "^8.56.0", + "globals": "^13.24.0" + } + }, + "node_modules/@aashutoshrathi/word-wrap": { + "version": "1.2.6", + "resolved": "https://registry.npmjs.org/@aashutoshrathi/word-wrap/-/word-wrap-1.2.6.tgz", + "integrity": "sha512-1Yjs2SvM8TflER/OD3cOjhWWOZb58A2t7wpE2S9XfBYTiIl+XFhQG2bjy4Pu1I+EAlCNUzRDYDdFwFYUKvXcIA==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/@eslint-community/eslint-utils": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz", + "integrity": "sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^3.3.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "peerDependencies": { + "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" + } + }, + "node_modules/@eslint-community/regexpp": { + "version": "4.10.0", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.10.0.tgz", + "integrity": "sha512-Cu96Sd2By9mCNTx2iyKOmq10v22jUVQv0lQnlGNy16oE9589yE+QADPbrMGCkA51cKZSg3Pu/aTJVTGfL/qjUA==", + "dev": true, + "engines": { + "node": "^12.0.0 || ^14.0.0 || >=16.0.0" + } + }, + "node_modules/@eslint/eslintrc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.4.tgz", + "integrity": "sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==", + "dev": true, + "dependencies": { + "ajv": "^6.12.4", + "debug": "^4.3.2", + "espree": "^9.6.0", + "globals": "^13.19.0", + "ignore": "^5.2.0", + "import-fresh": "^3.2.1", + "js-yaml": "^4.1.0", + "minimatch": "^3.1.2", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/@eslint/js": { + "version": "8.56.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.56.0.tgz", + "integrity": "sha512-gMsVel9D7f2HLkBma9VbtzZRehRogVRfbr++f06nL2vnCGCNlzOD+/MUov/F4p8myyAHspEhVobgjpX64q5m6A==", + "dev": true, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, + "node_modules/@humanwhocodes/config-array": { + "version": "0.11.14", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.14.tgz", + "integrity": "sha512-3T8LkOmg45BV5FICb15QQMsyUSWrQ8AygVfC7ZG32zOalnqrilm018ZVCw0eapXux8FtA33q8PSRSstjee3jSg==", + "dev": true, + "dependencies": { + "@humanwhocodes/object-schema": "^2.0.2", + "debug": "^4.3.1", + "minimatch": "^3.0.5" + }, + "engines": { + "node": ">=10.10.0" + } + }, + "node_modules/@humanwhocodes/module-importer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", + "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", + "dev": true, + "engines": { + "node": ">=12.22" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/nzakas" + } + }, + "node_modules/@humanwhocodes/object-schema": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-2.0.2.tgz", + "integrity": "sha512-6EwiSjwWYP7pTckG6I5eyFANjPhmPjUX9JRLUSfNPC7FX7zK9gyZAfUEaECL6ALTpGX5AjnBq3C9XmVWPitNpw==", + "dev": true + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@ungap/structured-clone": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.2.0.tgz", + "integrity": "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==", + "dev": true + }, + "node_modules/acorn": { + "version": "8.11.3", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz", + "integrity": "sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==", + "dev": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "dev": true, + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "dev": true + }, + "node_modules/cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/debug": { + "version": "4.3.4", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", + "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/deep-is": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", + "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", + "dev": true + }, + "node_modules/doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "dev": true, + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint": { + "version": "8.56.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.56.0.tgz", + "integrity": "sha512-Go19xM6T9puCOWntie1/P997aXxFsOi37JIHRWI514Hc6ZnaHGKY9xFhrU65RT6CcBEzZoGG1e6Nq+DT04ZtZQ==", + "dev": true, + "dependencies": { + "@eslint-community/eslint-utils": "^4.2.0", + "@eslint-community/regexpp": "^4.6.1", + "@eslint/eslintrc": "^2.1.4", + "@eslint/js": "8.56.0", + "@humanwhocodes/config-array": "^0.11.13", + "@humanwhocodes/module-importer": "^1.0.1", + "@nodelib/fs.walk": "^1.2.8", + "@ungap/structured-clone": "^1.2.0", + "ajv": "^6.12.4", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.3.2", + "doctrine": "^3.0.0", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^7.2.2", + "eslint-visitor-keys": "^3.4.3", + "espree": "^9.6.1", + "esquery": "^1.4.2", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "find-up": "^5.0.0", + "glob-parent": "^6.0.2", + "globals": "^13.19.0", + "graphemer": "^1.4.0", + "ignore": "^5.2.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "is-path-inside": "^3.0.3", + "js-yaml": "^4.1.0", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.1.2", + "natural-compare": "^1.4.0", + "optionator": "^0.9.3", + "strip-ansi": "^6.0.1", + "text-table": "^0.2.0" + }, + "bin": { + "eslint": "bin/eslint.js" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint-scope": { + "version": "7.2.2", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-7.2.2.tgz", + "integrity": "sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg==", + "dev": true, + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^5.2.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/espree": { + "version": "9.6.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-9.6.1.tgz", + "integrity": "sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==", + "dev": true, + "dependencies": { + "acorn": "^8.9.0", + "acorn-jsx": "^5.3.2", + "eslint-visitor-keys": "^3.4.1" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/esquery": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.5.0.tgz", + "integrity": "sha512-YQLXUplAwJgCydQ78IMJywZCceoqk1oH01OERdSAJc/7U2AylwjhSCLDEtqwg811idIS/9fIU5GjG73IgjKMVg==", + "dev": true, + "dependencies": { + "estraverse": "^5.1.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true + }, + "node_modules/fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", + "dev": true + }, + "node_modules/fastq": { + "version": "1.17.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", + "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==", + "dev": true, + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "dependencies": { + "flat-cache": "^3.0.4" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/find-up": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", + "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", + "dev": true, + "dependencies": { + "locate-path": "^6.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/flat-cache": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.2.0.tgz", + "integrity": "sha512-CYcENa+FtcUKLmhhqyctpclsq7QF38pKjZHsGNiSQF5r4FtoKDWabFDl3hzaEQMvT1LHEysw5twgLvpYYb4vbw==", + "dev": true, + "dependencies": { + "flatted": "^3.2.9", + "keyv": "^4.5.3", + "rimraf": "^3.0.2" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/flatted": { + "version": "3.2.9", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.9.tgz", + "integrity": "sha512-36yxDn5H7OFZQla0/jFJmbIKTdZAQHngCedGxiMmpNfEZM0sdEeT+WczLQrjK6D7o2aiyLYDnkw0R3JK0Qv1RQ==", + "dev": true + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", + "dev": true + }, + "node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", + "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", + "dev": true, + "dependencies": { + "is-glob": "^4.0.3" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/globals": { + "version": "13.24.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", + "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", + "dev": true, + "dependencies": { + "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/graphemer": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", + "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", + "dev": true + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/ignore": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", + "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "dev": true, + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "dev": true, + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dev": true, + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-path-inside": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", + "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "dev": true + }, + "node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/json-buffer": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", + "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", + "dev": true + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "node_modules/json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", + "dev": true + }, + "node_modules/keyv": { + "version": "4.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", + "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", + "dev": true, + "dependencies": { + "json-buffer": "3.0.1" + } + }, + "node_modules/levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "dependencies": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/locate-path": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", + "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", + "dev": true, + "dependencies": { + "p-locate": "^5.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true + }, + "node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", + "dev": true + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/optionator": { + "version": "0.9.3", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.3.tgz", + "integrity": "sha512-JjCoypp+jKn1ttEFExxhetCKeJt9zhAgAve5FXHixTvFDW/5aEktX9bufBKLRRMdU7bNtpLfcGu94B3cdEJgjg==", + "dev": true, + "dependencies": { + "@aashutoshrathi/word-wrap": "^1.2.3", + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", + "dev": true, + "dependencies": { + "yocto-queue": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", + "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", + "dev": true, + "dependencies": { + "p-limit": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/punycode": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", + "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true, + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "dev": true, + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==", + "dev": true + }, + "node_modules/type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "dependencies": { + "prelude-ls": "^1.2.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "dev": true + }, + "node_modules/yocto-queue": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", + "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..87b64fd --- /dev/null +++ b/package.json @@ -0,0 +1,7 @@ +{ + "type": "module", + "devDependencies": { + "eslint": "^8.56.0", + "globals": "^13.24.0" + } +} diff --git a/pyproject.toml b/pyproject.toml index c59070a..8f7168e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,6 @@ requires = [ [project] name = "aa-esi-status" -version = "1.14.2" description = "A simple status monitor for ESI" readme = "README.md" keywords = [ @@ -23,7 +22,7 @@ requires-python = ">=3.8" classifiers = [ "Environment :: Web Environment", "Framework :: Django", - "Framework :: Django :: 4.0", + "Framework :: Django :: 4.2", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", @@ -33,15 +32,19 @@ classifiers = [ "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", ] +dynamic = [ + "version", +] dependencies = [ - "allianceauth>=3.6.1", + "allianceauth>=4.0.0b2", "allianceauth-app-utils>=1.12", ] [project.optional-dependencies] -tests-allianceauth-stable = [ +tests-allianceauth-latest = [ "coverage", "django-webtest", ] @@ -57,3 +60,6 @@ Tracker = "https://github.com/ppfeufer/aa-esi-status/issues" include = [ "/esistatus", ] + +[tool.hatch.version] +path = "esistatus/__init__.py" diff --git a/testauth/base.py b/testauth/settings/base.py similarity index 94% rename from testauth/base.py rename to testauth/settings/base.py index 701ead9..0b2d7b1 100644 --- a/testauth/base.py +++ b/testauth/settings/base.py @@ -15,7 +15,6 @@ # Django from django.contrib import messages -# pylint: disable=line-too-long INSTALLED_APPS = [ "allianceauth", # needs to be on top of this list to support favicons in Django admin (see https://gitlab.com/allianceauth/allianceauth/-/issues/1301) "django.contrib.admin", @@ -27,8 +26,10 @@ "django.contrib.humanize", "django_celery_beat", "bootstrapform", + "django_bootstrap5", # https://github.com/zostera/django-bootstrap5 "sortedm2m", "esi", + "allianceauth.framework", "allianceauth.authentication", "allianceauth.services", "allianceauth.eveonline", @@ -36,6 +37,11 @@ "allianceauth.notifications", "allianceauth.thirdparty.navhelper", "allianceauth.analytics", + "allianceauth.menu", + "allianceauth.theme", + "allianceauth.theme.darkly", + "allianceauth.theme.flatly", + "allianceauth.theme.materia", ] SECRET_KEY = "wow I'm a really bad default secret key" @@ -80,7 +86,6 @@ "django.contrib.auth.middleware.AuthenticationMiddleware", "django.contrib.messages.middleware.MessageMiddleware", "django.middleware.clickjacking.XFrameOptionsMiddleware", - "allianceauth.analytics.middleware.AnalyticsMiddleware", ] ROOT_URLCONF = "allianceauth.urls" @@ -173,7 +178,7 @@ CACHES = { "default": { "BACKEND": "django_redis.cache.RedisCache", - "LOCATION": "redis://127.0.0.1:6379/1", # change the 1 here to change the database used + "LOCATION": "redis://127.0.0.1:6379/1", # change the 1 here for the DB used } } @@ -190,6 +195,9 @@ SITE_NAME = "Alliance Auth" +DEFAULT_THEME = "allianceauth.theme.flatly.auth_hooks.FlatlyThemeHook" +DEFAULT_THEME_DARK = "allianceauth.theme.darkly.auth_hooks.DarklyThemeHook" # Legacy AAv3 user.profile.night_mode=1 + LOGIN_URL = "auth_login_user" # view that handles login logic LOGIN_REDIRECT_URL = "authentication:dashboard" # default destination when logging in if no redirect specified @@ -203,6 +211,8 @@ # scopes required on new tokens when logging in. Cannot be blank. LOGIN_TOKEN_SCOPES = ["publicData"] +EMAIL_TIMEOUT = 15 + # number of days email verification links are valid for ACCOUNT_ACTIVATION_DAYS = 1 diff --git a/testauth/local.py b/testauth/settings/local.py similarity index 94% rename from testauth/local.py rename to testauth/settings/local.py index 9f82401..0537676 100644 --- a/testauth/local.py +++ b/testauth/settings/local.py @@ -14,11 +14,17 @@ # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.10/howto/static-files/ -STATICFILES_DIRS = [os.path.join(PROJECT_DIR, f"{PACKAGE}/static")] +# STATICFILES_DIRS = [os.path.join(PROJECT_DIR, f"{PACKAGE}/static")] +STATICFILES_DIRS = [ + f"{PACKAGE}/static", +] SITE_URL = "https://example.com" CSRF_TRUSTED_ORIGINS = [SITE_URL] +# Override this variable until #1386 is fixed +DEFAULT_THEME = "allianceauth.theme.flatly.auth_hooks.FlatlyThemeHook" + DISCORD_BOT_TOKEN = "My_Dummy_Token" # These are required for Django to function properly. Don't touch. ROOT_URLCONF = "testauth.urls" diff --git a/testauth/settings/testing/base.py b/testauth/settings/testing/base.py new file mode 100644 index 0000000..0b2d7b1 --- /dev/null +++ b/testauth/settings/testing/base.py @@ -0,0 +1,279 @@ +""" +DO NOT EDIT THIS FILE + +This settings file contains everything needed for Alliance Auth projects to function. +It gets overwritten by the 'allianceauth update' command. +If you wish to make changes, overload the setting in your project's settings file (local.py). +""" + +# Standard Library +import os + +# Third Party +from celery.schedules import crontab + +# Django +from django.contrib import messages + +INSTALLED_APPS = [ + "allianceauth", # needs to be on top of this list to support favicons in Django admin (see https://gitlab.com/allianceauth/allianceauth/-/issues/1301) + "django.contrib.admin", + "django.contrib.auth", + "django.contrib.contenttypes", + "django.contrib.sessions", + "django.contrib.messages", + "django.contrib.staticfiles", + "django.contrib.humanize", + "django_celery_beat", + "bootstrapform", + "django_bootstrap5", # https://github.com/zostera/django-bootstrap5 + "sortedm2m", + "esi", + "allianceauth.framework", + "allianceauth.authentication", + "allianceauth.services", + "allianceauth.eveonline", + "allianceauth.groupmanagement", + "allianceauth.notifications", + "allianceauth.thirdparty.navhelper", + "allianceauth.analytics", + "allianceauth.menu", + "allianceauth.theme", + "allianceauth.theme.darkly", + "allianceauth.theme.flatly", + "allianceauth.theme.materia", +] + +SECRET_KEY = "wow I'm a really bad default secret key" + +# Celery configuration +BROKER_URL = "redis://localhost:6379/0" +CELERYBEAT_SCHEDULER = "django_celery_beat.schedulers.DatabaseScheduler" +CELERYBEAT_SCHEDULE = { + "esi_cleanup_callbackredirect": { + "task": "esi.tasks.cleanup_callbackredirect", + "schedule": crontab(minute="0", hour="*/4"), + }, + "esi_cleanup_token": { + "task": "esi.tasks.cleanup_token", + "schedule": crontab(minute="0", hour="0"), + }, + "run_model_update": { + "task": "allianceauth.eveonline.tasks.run_model_update", + "schedule": crontab(minute="0", hour="*/6"), + }, + "check_all_character_ownership": { + "task": "allianceauth.authentication.tasks.check_all_character_ownership", + "schedule": crontab(minute="0", hour="*/4"), + }, + "analytics_daily_stats": { + "task": "allianceauth.analytics.tasks.analytics_daily_stats", + "schedule": crontab(minute="0", hour="2"), + }, +} + +# Build paths inside the project like this: os.path.join(BASE_DIR, ...) +PROJECT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +BASE_DIR = os.path.dirname(PROJECT_DIR) + +MIDDLEWARE = [ + "django.middleware.security.SecurityMiddleware", + "django.contrib.sessions.middleware.SessionMiddleware", + "allianceauth.authentication.middleware.UserSettingsMiddleware", + "django.middleware.locale.LocaleMiddleware", + "django.middleware.common.CommonMiddleware", + "django.middleware.csrf.CsrfViewMiddleware", + "django.contrib.auth.middleware.AuthenticationMiddleware", + "django.contrib.messages.middleware.MessageMiddleware", + "django.middleware.clickjacking.XFrameOptionsMiddleware", +] + +ROOT_URLCONF = "allianceauth.urls" + +LOCALE_PATHS = (os.path.join(BASE_DIR, "locale/"),) + +LANGUAGES = ( + ("en", "English"), + ("de", "German"), + ("es", "Spanish"), + ("zh-hans", "Chinese Simplified"), + ("ru", "Russian"), + ("ko", "Korean"), + ("fr", "French"), + ("ja", "Japanese"), + ("it", "Italian"), + ("uk", "Ukrainian"), +) + +TEMPLATES = [ + { + "BACKEND": "django.template.backends.django.DjangoTemplates", + "DIRS": [os.path.join(PROJECT_DIR, "templates")], + "APP_DIRS": True, + "OPTIONS": { + "context_processors": [ + "django.template.context_processors.debug", + "django.template.context_processors.request", + "django.contrib.auth.context_processors.auth", + "django.contrib.messages.context_processors.messages", + "django.template.context_processors.i18n", + "django.template.context_processors.media", + "django.template.context_processors.static", + "django.template.context_processors.tz", + "allianceauth.context_processors.auth_settings", + ], + }, + }, +] + +WSGI_APPLICATION = "allianceauth.wsgi.application" + +# Password validation +# https://docs.djangoproject.com/en/1.10/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator", + }, + { + "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator", + }, + { + "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator", + }, + { + "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator", + }, +] + +AUTHENTICATION_BACKENDS = [ + "allianceauth.authentication.backends.StateBackend", + "django.contrib.auth.backends.ModelBackend", +] + +# Internationalization +# https://docs.djangoproject.com/en/1.10/topics/i18n/ + +LANGUAGE_CODE = "en-us" + +LANGUAGE_COOKIE_AGE = 1209600 + +TIME_ZONE = "UTC" + +USE_I18N = True + +USE_TZ = True + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/1.10/howto/static-files/ +STATIC_URL = "/static/" +STATICFILES_DIRS = [ + os.path.join(PROJECT_DIR, "static"), +] +STATIC_ROOT = os.path.join(BASE_DIR, "static") + +# Bootstrap messaging css workaround +MESSAGE_TAGS = {messages.ERROR: "danger error"} + +CACHES = { + "default": { + "BACKEND": "django_redis.cache.RedisCache", + "LOCATION": "redis://127.0.0.1:6379/1", # change the 1 here for the DB used + } +} + +SESSION_ENGINE = "django.contrib.sessions.backends.cached_db" + +DEBUG = True +ALLOWED_HOSTS = ["*"] +DATABASES = { + "default": { + "ENGINE": "django.db.backends.sqlite3", + "NAME": str(os.path.join(BASE_DIR, "alliance_auth.sqlite3")), + }, +} + +SITE_NAME = "Alliance Auth" + +DEFAULT_THEME = "allianceauth.theme.flatly.auth_hooks.FlatlyThemeHook" +DEFAULT_THEME_DARK = "allianceauth.theme.darkly.auth_hooks.DarklyThemeHook" # Legacy AAv3 user.profile.night_mode=1 + +LOGIN_URL = "auth_login_user" # view that handles login logic + +LOGIN_REDIRECT_URL = "authentication:dashboard" # default destination when logging in if no redirect specified +LOGOUT_REDIRECT_URL = "authentication:dashboard" # destination after logging out +# Both of these redirects accept values as per the django redirect shortcut +# https://docs.djangoproject.com/en/1.11/topics/http/shortcuts/#redirect +# - url names eg 'authentication:dashboard' +# - relative urls eg '/dashboard' +# - absolute urls eg 'http://example.com/dashboard' + +# scopes required on new tokens when logging in. Cannot be blank. +LOGIN_TOKEN_SCOPES = ["publicData"] + +EMAIL_TIMEOUT = 15 + +# number of days email verification links are valid for +ACCOUNT_ACTIVATION_DAYS = 1 + +ESI_API_URL = "https://esi.evetech.net/" + +LOGGING = { + "version": 1, + "disable_existing_loggers": False, + "formatters": { + "verbose": { + "format": "[%(asctime)s] %(levelname)s [%(name)s:%(lineno)s] %(message)s", + "datefmt": "%d/%b/%Y %H:%M:%S", + }, + "simple": {"format": "%(levelname)s %(message)s"}, + }, + "handlers": { + "log_file": { + "level": "INFO", # edit this line to change logging level to file + "class": "logging.handlers.RotatingFileHandler", + "filename": os.path.join(BASE_DIR, "log/allianceauth.log"), + "formatter": "verbose", + "maxBytes": 1024 * 1024 * 5, # edit this line to change max log file size + "backupCount": 5, # edit this line to change number of log backups + }, + "extension_file": { + "level": "INFO", + "class": "logging.handlers.RotatingFileHandler", + "filename": os.path.join(BASE_DIR, "log/extensions.log"), + "formatter": "verbose", + "maxBytes": 1024 * 1024 * 5, # edit this line to change max log file size + "backupCount": 5, # edit this line to change number of log backups + }, + "console": { + "level": "DEBUG", # edit this line to change logging level to console + "class": "logging.StreamHandler", + "formatter": "verbose", + }, + "notifications": { # creates notifications for users with logging_notifications permission + "level": "ERROR", # edit this line to change logging level to notifications + "class": "allianceauth.notifications.handlers.NotificationHandler", + "formatter": "verbose", + }, + }, + "loggers": { + "allianceauth": { + "handlers": ["log_file", "console", "notifications"], + "level": "DEBUG", + }, + "extensions": { + "handlers": ["extension_file", "console"], + "level": "DEBUG", + }, + "django": { + "handlers": ["log_file", "console"], + "level": "ERROR", + }, + "esi": { + "handlers": ["log_file", "console"], + "level": "DEBUG", + }, + }, +} + +DEFAULT_AUTO_FIELD = "django.db.models.AutoField" diff --git a/testauth/settings/testing/local.py b/testauth/settings/testing/local.py new file mode 100644 index 0000000..0537676 --- /dev/null +++ b/testauth/settings/testing/local.py @@ -0,0 +1,120 @@ +""" +Test settings +""" + +# flake8: noqa + +######################################################## +# local.py settings +# Every setting in base.py can be overloaded by redefining it here. + +from .base import * + +PACKAGE = "esistatus" + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/1.10/howto/static-files/ +# STATICFILES_DIRS = [os.path.join(PROJECT_DIR, f"{PACKAGE}/static")] +STATICFILES_DIRS = [ + f"{PACKAGE}/static", +] + +SITE_URL = "https://example.com" +CSRF_TRUSTED_ORIGINS = [SITE_URL] + +# Override this variable until #1386 is fixed +DEFAULT_THEME = "allianceauth.theme.flatly.auth_hooks.FlatlyThemeHook" + +DISCORD_BOT_TOKEN = "My_Dummy_Token" +# These are required for Django to function properly. Don't touch. +ROOT_URLCONF = "testauth.urls" +WSGI_APPLICATION = "testauth.wsgi.application" +SECRET_KEY = "t$@h+j#yqhmuy$x7$fkhytd&drajgfsb-6+j9pqn*vj0)gq&-2" + +# This is where css/images will be placed for your webserver to read +STATIC_ROOT = "/var/www/testauth/static/" + +# Change this to change the name of the auth site displayed +# in page titles and the site header. +SITE_NAME = "testauth" + +# Change this to enable/disable debug mode, which displays +# useful error messages but can leak sensitive data. +DEBUG = False + +if os.environ.get("USE_MYSQL", True) is True: + DATABASES["default"] = { + "ENGINE": "django.db.backends.mysql", + "NAME": "tox_allianceauth", + "USER": os.environ.get("DB_USER", "user"), + "PASSWORD": os.environ.get("DB_PASSWORD", "password"), + "HOST": os.environ.get("DB_HOST", ""), + "PORT": os.environ.get("DB_PORT", ""), + "OPTIONS": {"charset": "utf8mb4"}, + "TEST": { + "CHARSET": "utf8mb4", + "NAME": "test_tox_allianceauth", + }, + } + +# Add any additional apps to this list. +INSTALLED_APPS += [PACKAGE] + +# By default, apps are prevented from having public views for security reasons. +# If you want to allow specific apps to have public views, +# you can put their names here (same name as in INSTALLED_APPS). +# +# Note: +# » The format is the same as in INSTALLED_APPS +# » The app developer must explicitly allow public views for his app +APPS_WITH_PUBLIC_VIEWS = [PACKAGE] + +# ------------------------------------------------------------------------------------ # +# +# ESI Settings +# +# ------------------------------------------------------------------------------------ # +# Register an application at +# https://developers.eveonline.com for Authentication +# & API Access and fill out these settings. +# Be sure to set the callback URL +# to https://example.com/sso/callback +# substituting your domain for example.com +# Logging in to auth requires the publicData +# scope (can be overridden through the +# LOGIN_TOKEN_SCOPES setting). +# Other apps may require more (see their docs). +ESI_SSO_CLIENT_ID = "dummy" +ESI_SSO_CLIENT_SECRET = "dummy" +ESI_SSO_CALLBACK_URL = "http://localhost:8000" + + +# ------------------------------------------------------------------------------------ # +# +# E-Mail Settings +# +# ------------------------------------------------------------------------------------ # +# By default, emails are validated before new users can log in. +# It's recommended to use a free service like SparkPost +# or Elastic Email to send email. +# Https://www.sparkpost.com/docs/integrations/django/ +# https://elasticemail.com/resources/settings/smtp-api/ +# Set the default from email to something like 'noreply@example.com' +# Email validation can be turned off by uncommenting the line below. +# This can break some services. +REGISTRATION_VERIFY_EMAIL = False +EMAIL_HOST = "" +EMAIL_PORT = 587 +EMAIL_HOST_USER = "" +EMAIL_HOST_PASSWORD = "" +EMAIL_USE_TLS = True +DEFAULT_FROM_EMAIL = "" + +####################################### +# Add any custom settings below here. # +####################################### + +LOGGING = False + +NOTIFICATIONS_REFRESH_TIME = 30 +NOTIFICATIONS_MAX_PER_USER = 50 diff --git a/tox.ini b/tox.ini index a801654..5498af1 100644 --- a/tox.ini +++ b/tox.ini @@ -2,8 +2,8 @@ requires = tox>=4.2 env_list = - allianceauth-{stable, testing} - py{311, 310, 39, 38} + allianceauth-{latest, testing} + py{312, 311, 310, 39, 38} no_package = true usedevelop = True @@ -21,14 +21,14 @@ commands = coverage report -m coverage xml -[testenv:allianceauth-stable] +[testenv:allianceauth-latest] set_env = - DJANGO_SETTINGS_MODULE = testauth.local + DJANGO_SETTINGS_MODULE = testauth.settings.local install_command = - python -m pip install -e ".[tests-allianceauth-stable]" -U {opts} {packages} + python -m pip install -e ".[tests-allianceauth-latest]" -U {opts} {packages} [testenv:allianceauth-testing] set_env = - DJANGO_SETTINGS_MODULE = testauth.local + DJANGO_SETTINGS_MODULE = testauth.settings.testing.local install_command = python -m pip install -e ".[tests-allianceauth-testing]" -U {opts} {packages}