diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 48a2914f3..ce1c37d3c 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,18 +1,20 @@ { - "name": "Ubuntu", - "build": { - "dockerfile": "Dockerfile", - "args": { "VARIANT": "ubuntu-22.04" } - }, - "remoteUser": "vscode", - "customizations": { - "vscode": { - "extensions": [ - "ms-python.python" - ] - } - }, - "features": { - "ghcr.io/devcontainers/features/docker-in-docker:2": {} - } + "build": { + "args": { + "VARIANT": "ubuntu-22.04" + }, + "dockerfile": "Dockerfile" + }, + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python" + ] + } + }, + "features": { + "ghcr.io/devcontainers/features/docker-in-docker:2": {} + }, + "name": "Ubuntu", + "remoteUser": "vscode" } diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 152a39858..c6ac0148b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,6 +2,6 @@ To view our [Getting Started] guide for developers and [Contribution Requirements], please refer to the official [documentation]. -[Contribution Requirements]: https://docs.onica.com/projects/runway/page/developers/contributing.html -[Getting Started]: https://docs.onica.com/projects/runway/page/developers/getting_started.html +[contribution requirements]: https://docs.onica.com/projects/runway/page/developers/contributing.html [documentation]: https://docs.onica.com/projects/runway +[getting started]: https://docs.onica.com/projects/runway/page/developers/getting_started.html diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 433e735e6..8ed73f25d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,13 +1,12 @@ --- name: Feature request about: Suggest an idea for this project -title: "[REQUEST] feature" +title: '[REQUEST] feature' labels: feature, priority:low, status:review_needed - --- **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +A clear and concise description of what the problem is. Ex. I'm always frustrated when ... **Describe the solution you'd like** A clear and concise description of what you want to happen. diff --git a/.github/ISSUE_TEMPLATE/general_question.md b/.github/ISSUE_TEMPLATE/general_question.md index 10e2e5fb8..677763637 100644 --- a/.github/ISSUE_TEMPLATE/general_question.md +++ b/.github/ISSUE_TEMPLATE/general_question.md @@ -1,9 +1,8 @@ --- name: General Question about: General question about the project, usage, design, etc. -title: "[QUESTION]" +title: '[QUESTION]' labels: priority:low, status:review_needed, question - --- **Question** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0b3065c6c..286daf76c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -37,6 +37,7 @@ # Checklist + - [ ] Have you followed the guidelines in our [Contribution Requirements](https://docs.onica.com/projects/runway/page/developers/contributing.html)? - [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? - [ ] Does your submission pass tests? diff --git a/.github/scripts/urlshortener/Makefile b/.github/scripts/urlshortener/Makefile index d6b804bb6..4234def39 100644 --- a/.github/scripts/urlshortener/Makefile +++ b/.github/scripts/urlshortener/Makefile @@ -1,14 +1,8 @@ install: @poetry install -lint: lint-flake8 lint-pylint - -lint-flake8: - @poetry run flake8 update_urls.py - -lint-pylint: - @poetry run pylint update_urls.py \ - --rcfile=./../../../pyproject.toml +lint: + @echo "no linters configured currently" test: @poetry run pytest ./test_update_urls.py \ diff --git a/.github/scripts/urlshortener/test_update_urls.py b/.github/scripts/urlshortener/test_update_urls.py index d61ba85cf..67dc10381 100644 --- a/.github/scripts/urlshortener/test_update_urls.py +++ b/.github/scripts/urlshortener/test_update_urls.py @@ -1,18 +1,21 @@ -"""Tests for update_urls.""" +"""Tests for update_urls.""" # noqa: INP001 -# pylint: disable=no-member +# ruff: noqa: S101 +from typing import TYPE_CHECKING from unittest.mock import ANY, Mock, call, patch import boto3 import pytest from botocore.stub import Stubber from click.testing import CliRunner -from mypy_boto3_dynamodb.service_resource import Table from update_urls import command, handler, put_item, sanitize_version +if TYPE_CHECKING: + from mypy_boto3_dynamodb.service_resource import Table -def test_sanitize_version(): + +def test_sanitize_version() -> None: """Test sanitize_version.""" assert sanitize_version(None, None, "1.0.0") == "1.0.0" assert sanitize_version(None, None, "v1.0.0") == "1.0.0" @@ -20,11 +23,11 @@ def test_sanitize_version(): assert sanitize_version(None, None, "refs/tags/v1.0.0") == "1.0.0" assert sanitize_version(None, None, "refs/tags/v1.0.0-dev1") == "1.0.0-dev1" - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 assert not sanitize_version(None, None, "refs/tags/stable") -def test_put_item(): +def test_put_item() -> None: """Test put_item.""" table_name = "test-table" id_val = "my_id" @@ -32,16 +35,14 @@ def test_put_item(): table: Table = boto3.resource("dynamodb").Table(table_name) stubber = Stubber(table.meta.client) - stubber.add_response( - "put_item", {"Attributes": {"id": {"S": id_val}, "target": {"S": target}}} - ) + stubber.add_response("put_item", {"Attributes": {"id": {"S": id_val}, "target": {"S": target}}}) with stubber: assert not put_item(table, id_val, target) @patch("update_urls.put_item") -def test_handler(mock_put_item: Mock): +def test_handler(mock_put_item: Mock) -> None: """Test handler.""" table = Mock() assert not handler(table, "test-bucket", "us-west-2", "1.0.0", True) @@ -49,26 +50,22 @@ def test_handler(mock_put_item: Mock): call( table=table, id_val="runway/latest/linux", - target="https://test-bucket.s3-us-west-2.amazonaws.com/" - "runway/1.0.0/linux/runway", + target="https://test-bucket.s3-us-west-2.amazonaws.com/runway/1.0.0/linux/runway", ), call( table=table, id_val="runway/1.0.0/linux", - target="https://test-bucket.s3-us-west-2.amazonaws.com/" - "runway/1.0.0/linux/runway", + target="https://test-bucket.s3-us-west-2.amazonaws.com/runway/1.0.0/linux/runway", ), call( table=table, id_val="runway/latest/osx", - target="https://test-bucket.s3-us-west-2.amazonaws.com/" - "runway/1.0.0/osx/runway", + target="https://test-bucket.s3-us-west-2.amazonaws.com/runway/1.0.0/osx/runway", ), call( table=table, id_val="runway/1.0.0/osx", - target="https://test-bucket.s3-us-west-2.amazonaws.com/" - "runway/1.0.0/osx/runway", + target="https://test-bucket.s3-us-west-2.amazonaws.com/runway/1.0.0/osx/runway", ), call( table=table, @@ -89,16 +86,14 @@ def test_handler(mock_put_item: Mock): call( table=table, id_val="runway/1.1.0/linux", - target="https://test-bucket.s3-us-east-1.amazonaws.com/" - "runway/1.1.0/linux/runway", + target="https://test-bucket.s3-us-east-1.amazonaws.com/runway/1.1.0/linux/runway", ) ) calls.append( call( table=table, id_val="runway/1.1.0/osx", - target="https://test-bucket.s3-us-east-1.amazonaws.com/" - "runway/1.1.0/osx/runway", + target="https://test-bucket.s3-us-east-1.amazonaws.com/runway/1.1.0/osx/runway", ) ) calls.append( @@ -114,7 +109,7 @@ def test_handler(mock_put_item: Mock): @patch("update_urls.handler") -def test_command(mock_handler: Mock): +def test_command(mock_handler: Mock) -> None: """Test command.""" runner = CliRunner() result = runner.invoke( diff --git a/.github/scripts/urlshortener/update_urls.py b/.github/scripts/urlshortener/update_urls.py index 6db7e8b60..bdc78460d 100755 --- a/.github/scripts/urlshortener/update_urls.py +++ b/.github/scripts/urlshortener/update_urls.py @@ -1,10 +1,9 @@ -"""Update Runway release URLs.""" +"""Update Runway release URLs.""" # noqa: INP001 -# pylint: disable=no-member from __future__ import annotations import logging -from typing import TYPE_CHECKING, Optional, Union +from typing import TYPE_CHECKING import boto3 import click @@ -18,16 +17,14 @@ HDLR.setFormatter(logging.Formatter(logging.BASIC_FORMAT)) ID_TEMPLATE = "runway/{release}/{os}" -TARGET_TEMPLATE = ( - "https://{bucket_name}.s3-{region}.amazonaws.com/runway/{version}/{os}/runway" -) +TARGET_TEMPLATE = "https://{bucket_name}.s3-{region}.amazonaws.com/runway/{version}/{os}/runway" OS_NAMES = ["linux", "osx", "windows"] def sanitize_version( - _ctx: Optional[click.Context], - _param: Optional[Union[click.Option, click.Parameter]], + _ctx: click.Context | None, + _param: click.Option | click.Parameter | None, value: str, ) -> str: """Sanitize a version number by stripping git tag ref and leading "v". @@ -67,7 +64,7 @@ def handler( """Handle the command. Core logic executed by the command aside from boto3 session/resource - initializeion and logging setup. + initialization and logging setup. Args: table: DynamoDB table resource. @@ -122,7 +119,7 @@ def handler( "table_name", metavar="", required=True, - help="Name of the DynamoDB table containing entries for the URL " "shortener.", + help="Name of the DynamoDB table containing entries for the URL shortener.", ) @click.option( "--version", @@ -156,4 +153,4 @@ def command( if __name__ == "__main__": - command() # pylint: disable=E + command() diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b43487cbb..9194daa8f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,11 +1,19 @@ -minimum_pre_commit_version: 2.6.0 +default_language_version: + node: system + +exclude: | + (?x)^( + (.*/)?package-lock\.json| + (.*/)?poetry\.lock + )$ repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.3.0 + rev: v4.6.0 hooks: - id: check-json - id: check-merge-conflict + - id: check-toml - id: check-yaml args: - --unsafe # needed for parsing CFN @@ -14,56 +22,47 @@ repos: - id: file-contents-sorter files: | (?x)^( + \.dockerignore| \.gitignore| \.vscode/dictionaries/.*\.txt| - MANIFEST.in )$ - id: pretty-format-json args: [--autofix, --indent, '4'] - files: | + exclude: | (?x)^( - \.vscode/.*\.json + (.*)?(angular|cdk|package|tsconfig(\.spec)?|tslint)\.json )$ - id: pretty-format-json args: [--autofix, --indent, '2'] files: | (?x)^( - (.*)?(cdk|tsconfig|tslint).json + (.*)?(angular|cdk|package|tsconfig(\.spec)?|tslint)\.json )$ - id: trailing-whitespace + - repo: https://github.com/pappasam/toml-sort + rev: v0.23.1 + hooks: + - id: toml-sort-fix - repo: https://github.com/ITProKyle/pre-commit-hook-yamlfmt - rev: v0.2.0 + rev: v0.3.0 hooks: - id: yamlfmt args: [--mapping, '2', --offset, '2', --sequence, '4'] - files: | + exclude: | (?x)^( - \.github/(?!dependabot).*\.(yaml|yml)| - \.markdownlint.yml| - \.pre-commit-config.yaml| - \.readthedocs.yml| - buildspec.yml + tests/unit/module/staticsite/fixtures/expected_yaml/.*\.(yaml|yml)| + docs/runway-example\.yml )$ - - repo: https://github.com/timothycrosley/isort - rev: 5.12.0 - hooks: - - id: isort - - repo: https://github.com/psf/black - rev: 24.1.1 - hooks: - - id: black - args: - - --color - - repo: https://github.com/pycqa/flake8 - rev: 4.0.1 + - repo: https://github.com/executablebooks/mdformat + rev: 0.7.17 hooks: - - id: flake8 + - id: mdformat additional_dependencies: - - flake8-bugbear - - flake8-docstrings - - flake8-print==5.0.0 - - flake8-use-fstring + - mdformat-frontmatter + - mdformat-gfm + - mdformat-gfm-alerts + - mdformat-tables - repo: https://github.com/igorshubovych/markdownlint-cli - rev: v0.31.1 + rev: v0.41.0 hooks: - id: markdownlint diff --git a/.vscode/cspell.json b/.vscode/cspell.json index d06031501..6a7acece2 100644 --- a/.vscode/cspell.json +++ b/.vscode/cspell.json @@ -59,164 +59,170 @@ "maxNumberOfProblems": 100, "version": "0.2", "words": [ + "absolutepath", "abstractmethod", + "accesspoint", + "addoption", "ALGS", + "appendleft", + "arcname", + "argparsing", + "assumerole", + "authmap", "autoattribute", + "autobuild", + "autodetected", + "autofind", + "autoloaded", + "autoscale", + "autoscaler", + "autouse", + "awslogbucket", + "backported", + "barfoo", + "blogpost", + "caplog", "certifi", + "certificatemanager", + "chunksize", + "classdir", + "classmethods", + "clienterror", "cmds", "codecov", + "configvars", + "copydir", "devel", + "dockerized", + "domparator", + "downstreams", + "dryrun", + "dunder", + "edgelambda", + "ekscluster", + "eksservicerole", "EOCD", + "excinfo", + "execglobals", + "Fakhreddine", + "filedes", + "filedir", + "filehandle", + "fileinfo", + "fileinfos", + "fileout", + "foobarfoo", "FQDNs", + "frontmatter", "fstring", + "getgid", + "getpreferredencoding", "getuid", + "graphviz", "hashextra", + "hashfile", "hashicorp", + "htmlhelp", + "humanreadable", + "identless", "igittigitt", + "indentless", + "instancerole", + "intersphinx", + "invalidtestkey", + "keylist", "kwoa", "libltdl", "libmysqlclient", "libxmlsec", + "lintfix", + "locallocal", "ltdl", "lxml", + "managementpolicy", "markexpr", + "maxsplit", + "mdformat", + "mynamespace", + "mystack", + "nameextra", + "nameserver", + "nestedkey", + "nestedval", + "newdir", + "newfile", "Ngin", + "nitpicky", + "nodegroup", + "nodeinstanceprofile", + "nodeinstancerole", + "nodelaunchtemplate", + "nodesecuritygroup", + "nonbool", + "noninteractive", + "nonseekable", + "nosetests", + "onezone", "openid", + "outputquery", + "paravirtual", + "partitionkey", "Pipefile", + "prehook", + "prepad", + "prevdir", "PYXMLSEC", + "readacl", + "refreshable", "rglob", + "rootdir", "runtimes", - "tomap", - "tomli", - "typeshed", - "unsubscriptable", - "xmlsec", - "intersphinx", - "viewcode", - "nitpicky", - "htmlhelp", + "runwayconfig", "runwaydoc", - "typehints", - "templatedir", - "getpreferredencoding", - "execglobals", - "refreshable", - "nodeinstancerole", - "nodeinstanceprofile", - "autoscaler", - "thisfile", - "eksservicerole", - "ekscluster", - "nodegroup", - "nodesecuritygroup", - "blogpost", - "awslogbucket", - "edgelambda", - "terraformlocktable", - "terraformstatebucket", - "managementpolicy", - "graphviz", - "classdir", - "configvars", - "nosetests", - "noninteractive", - "downstreams", - "appendleft", - "dockerized", - "certificatemanager", - "copydir", - "maxsplit", - "getpreferredencoding", - "absolutepath", - "getgid", - "assumerole", - "excinfo", - "caplog", - "classmethods", - "autoloaded", - "autouse", - "accesspoint", - "readacl", - "writeacl", - "nonseekable", - "chunksize", - "fileinfo", - "fileinfos", - "dryrun", + "safehaven", + "savingsplans", + "searchpath", + "shasums", + "shelloutexc", + "shouldraise", "sourcebucket", "sourcekey", - "locallocal", - "rootdir", - "onezone", - "backported", - "usefixtures", + "SPHINXAUTOBUILD", + "SPHINXAUTOBUILDPORT", + "ssmstore", + "ssword", + "subclasscheck", "tagset", - "testtemplate", - "safehaven", - "barfoo", - "dunder", - "testval", + "tempdirectory", + "templatedir", + "temppath", + "terraformlocktable", + "terraformstatebucket", "testkey", - "invalidtestkey", - "subclasscheck", - "paravirtual", - "autouse", - "nonbool", - "ssword", "teststack", - "mynamespace", - "foobarfoo", - "unittests", - "outputquery", - "clienterror", - "autofind", - "mystack", - "shouldraise", - "tempdirectory", - "nameextra", - "argparsing", - "hashfile", - "newdir", - "prevdir", - "identless", - "humanreadable", - "runwayconfig", - "instancerole", - "authmap", - "tmpdirname", - "shelloutexc", - "nestedkey", - "nestedval", - "fileout", - "lintfix", - "autoscale", - "shasums", + "testtemplate", + "testval", + "thisfile", "threadsafe", - "nameserver", - "keylist", - "filehandle", - "prepad", - "newfile", - "filedir", - "temppath", - "prehook", - "nodelaunchtemplate", - "indentless", - "arcname", - "searchpath", - "savingsplans", - "topdown", - "partitionkey", - "timestnonce", "timestampamp", - "filedes", - "autodetected", - "addoption", - "domparator", - "Fakhreddine", - "SPHINXAUTOBUILD", - "autobuild", - "SPHINXAUTOBUILDPORT", - "ssmstore" + "timestnonce", + "tmpdirname", + "tomap", + "tomli", + "topdown", + "typehints", + "typeshed", + "unittests", + "unsubscriptable", + "usefixtures", + "viewcode", + "writeacl", + "xmlsec", + "troyready", + "tomlsort", + "pyupgrade", + "tryceratops", + "errmsg", + "datetimez" ] } diff --git a/.vscode/dictionaries/pypi.txt b/.vscode/dictionaries/pypi.txt index 128d093b8..b8df9ffc3 100644 --- a/.vscode/dictionaries/pypi.txt +++ b/.vscode/dictionaries/pypi.txt @@ -10,7 +10,6 @@ ctypes distutils dunamai gitpython -isort moto numpy pefile @@ -22,7 +21,6 @@ pydantic pydocstyle pyhcl pyinstaller -pylint pywin pyyaml runpy diff --git a/.vscode/settings.json b/.vscode/settings.json index 0fb3e52a8..149f8b2ed 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,10 @@ { "[python]": { + "editor.codeActionsOnSave": { + "source.fixAll.ruff": "explicit", + "source.organizeImports": "always" + }, + "editor.defaultFormatter": "ms-python.black-formatter", "editor.detectIndentation": false, "editor.formatOnSave": true, "editor.insertSpaces": true, @@ -35,17 +40,7 @@ "**/__pycache__": true }, "files.insertFinalNewline": true, - "python.analysis.typeCheckingMode": "strict", - "python.formatting.provider": "black", - "python.linting.flake8Args": [ - "--docstring-convention=all" - ], - "python.linting.flake8Enabled": true, - "python.linting.mypyEnabled": false, - "python.linting.pylintArgs": [ - "--rcfile=pyproject.toml" - ], - "python.linting.pylintEnabled": true, + "python.analysis.typeCheckingMode": "off", "python.pythonPath": "${workspaceFolder}/.venv/", "python.testing.pytestArgs": [ "tests", diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 1f34d15f2..0cc59f1d4 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the +- Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or +- The use of sexualized language or imagery, and sexual attention or advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -59,8 +59,7 @@ representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -opensource@onica.com. +reported to the community leaders responsible for enforcement at . All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the @@ -121,8 +120,8 @@ version 2.0, available at Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). -[homepage]: https://www.contributor-covenant.org - For answers to common questions about this code of conduct, see the FAQ at . Translations are available at . + +[homepage]: https://www.contributor-covenant.org diff --git a/Makefile b/Makefile index 0b977b583..e00bbb94d 100644 --- a/Makefile +++ b/Makefile @@ -30,14 +30,13 @@ build-pyinstaller-folder: clean create-tfenv-ver-file version ## build Pyinstall bash ./.github/scripts/cicd/build_pyinstaller.sh folder clean: ## remove generated file from the project directory - rm -rf build/ - rm -rf dist/ - rm -rf runway.egg-info/ - rm -rf tmp/ - rm -rf src/ - rm -rf postinstall.js preuninstall.js .coverage .npmignore - find . -name ".runway" -type d -prune -exec rm -rf '{}' + - @make -C docs clean + rm -rf ./build/ ./dist/ ./src/ ./tmp/ ./runway.egg-info/; + rm -rf ./.pytest_cache + find . -type d -name "node_modules" -prune -exec rm -rf '{}' +; + find . -type d -name ".runway" -prune -exec rm -rf '{}' +; + find . -type f -name "*.py[co]" -delete; + find . -type d -name "__pycache__" -prune -exec rm -rf '{}' +; + @$(MAKE) --no-print-directory -C docs clean; cov-report: ## display a report in the terminal of files missing coverage @poetry run coverage report \ @@ -59,42 +58,40 @@ create-tfenv-ver-file: ## create a tfenv version file using the latest version curl --silent https://releases.hashicorp.com/index.json | jq -r '.terraform.versions | to_entries | map(select(.key | contains ("-") | not)) | sort_by(.key | split(".") | map(tonumber))[-1].key' | egrep -o '^[0-9]*\.[0-9]*\.[0-9]*' > runway/templates/terraform/.terraform-version docs: ## delete current HTML docs & build fresh HTML docs - @make -C docs docs + @$(MAKE) --no-print-directory -C docs docs docs-changes: ## build HTML docs; only builds changes detected by Sphinx - @make -C docs html + @$(MAKE) --no-print-directory -C docs html + +fix: fix-ruff fix-black run-pre-commit ## run all automatic fixes fix-black: ## automatically fix all black errors @poetry run black . -fix-isort: ## automatically fix all isort errors - @poetry run isort . +fix-imports: ## automatically fix all import sorting errors + @poetry run ruff check . --fix-only --fixable I001 + +fix-ruff: ## automatically fix everything ruff can fix (implies fix-imports) + @poetry run ruff check . --fix-only + +fix-ruff-tests: + @poetry run ruff check ./tests --fix-only --unsafe-fixes -lint: lint-isort lint-black lint-pyright lint-flake8 lint-pylint ## run all linters +lint: lint-black lint-ruff lint-pyright ## run all linters lint-black: ## run black @echo "Running black... If this fails, run 'make fix-black' to resolve." @poetry run black . --check --color --diff @echo "" -lint-flake8: ## run flake8 - @echo "Running flake8..." - @poetry run flake8 --config=setup.cfg - @echo "" - -lint-isort: ## run isort - @echo "Running isort... If this fails, run 'make fix-isort' to resolve." - @poetry run isort . --check-only - @echo "" - -lint-pylint: ## run pylint - @echo "Running pylint..." - @poetry run pylint runway tests --rcfile=pyproject.toml - @echo "" - lint-pyright: ## run pyright @echo "Running pyright..." - @npm run-script py-type-check + @npm exec --no -- pyright --venv-path ./ + @echo "" + +lint-ruff: ## run ruff + @echo "Running ruff... If this fails, run 'make fix-ruff' to resolve some error automatically, other require manual action." + @poetry run ruff check . @echo "" npm-ci: ## run "npm ci" with the option to ignore scripts - required to succeed for this project diff --git a/README.md b/README.md index bc0223f7e..cfbaff764 100644 --- a/README.md +++ b/README.md @@ -12,25 +12,23 @@ Runway is a lightweight integration app designed to ease management of infrastru Its main goals are to encourage GitOps best-practices, avoid convoluted Makefiles/scripts (enabling identical deployments from a workstation or CI job), and enable developers/admins to use the best tool for any given job. - ## Features -* Centralized environment-specific configuration -* Automatic environment identification from git branches -* Automatic linting/verification -* Support of IAM roles to assume for each deployment -* Terraform backend/workspace config management w/per-environment tfvars -* Automatic kubectl/terraform version management per-environment +- Centralized environment-specific configuration +- Automatic environment identification from git branches +- Automatic linting/verification +- Support of IAM roles to assume for each deployment +- Terraform backend/workspace config management w/per-environment tfvars +- Automatic kubectl/terraform version management per-environment ### Supported Deployment Tools -* AWS CDK -* Kubectl -* Serverless Framework -* CFNgin (CloudFormation) -* Static websites (build & deploy to S3+CloudFront) -* Terraform - +- AWS CDK +- Kubectl +- Serverless Framework +- CFNgin (CloudFormation) +- Static websites (build & deploy to S3+CloudFront) +- Terraform ## Example @@ -51,7 +49,6 @@ deployments: The example above contains enough information for Runway to deploy all resources, lambda functions and a static website backed by S3 and Cloudfront in either dev or prod environments - ## Install Runway is available via any of the following installation methods. Use whatever works best for your project/team (it's the same application no matter how you obtain it). @@ -61,7 +58,7 @@ Runway is available via any of the following installation methods. Use whatever Use one of the endpoints below to download a single-binary executable version of Runway based on your operating system. | Operating System | Endpoint | -|------------------|----------------------------------------| +| ---------------- | -------------------------------------- | | Linux | | | macOS | | | Windows | | @@ -74,7 +71,6 @@ $ ./runway new **Suggested use:** CloudFormation or Terraform projects - ### npm ```shell @@ -84,7 +80,6 @@ $ npx runway new **Suggested use:** Serverless or AWS CDK projects - ### pip (or poetry, etc) ```shell @@ -97,7 +92,6 @@ $ poetry run runway new **Suggested use:** Python projects - ## Documentation See the [doc site](https://docs.onica.com/projects/runway) for full documentation. diff --git a/docs/README.md b/docs/README.md index 91be77776..c5edb8201 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,7 +14,7 @@ To record or render a new gif, terminalizer must be installed (globally is fine) ### Caveats -- node <= 10 is required due to dependency requirements (`nvm install 10` or `nvm use 10`) +- node \<= 10 is required due to dependency requirements (`nvm install 10` or `nvm use 10`) - `terminalizer@0.6.1` must be used (`npm i -g terminalizer@0.6.1`) - 0.7 changed the resolution of the GIF which increases the size 3x @@ -41,4 +41,4 @@ To render a new copy of the gif, just run `terminalizer render runway-example.ym This will take some time to complete. We need to reduce the size of the rendered GIF so it can be served from GitHub to be viewable on PyPi. -To do this, the GIF must be compressed ([GIF Compressor](https://gifcompressor.com/) was used) to achieve the <5MB size required (GitHub restriction). +To do this, the GIF must be compressed ([GIF Compressor](https://gifcompressor.com/) was used) to achieve the \<5MB size required (GitHub restriction). diff --git a/docs/source/conf.py b/docs/source/conf.py index 2c28c6fcc..290fc2d3b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -2,9 +2,8 @@ https://www.sphinx-doc.org/en/master/usage/configuration.html -""" +""" # noqa: INP001 -# pylint: skip-file import os from pathlib import Path @@ -18,7 +17,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "Runway" -copyright = "2021, Onica Group" +copyright = "2021, Onica Group" # noqa: A001 author = "Onica Group" release = Version.from_git().serialize(metadata=False, style=Style.SemVer) version = ".".join(release.split(".")[:2]) # short X.Y version @@ -52,7 +51,7 @@ master_doc = "index" needs_extensions = {} needs_sphinx = "3.5" -nitpicky = False # TODO enable nitpicky +nitpicky = False # TODO (kyle): enable nitpicky primary_domain = "py" pygments_style = "material" # syntax highlighting style # Appended to the end of each rendered file diff --git a/infrastructure/blueprints/admin_role.py b/infrastructure/blueprints/admin_role.py index d98cbf31b..caf91209d 100644 --- a/infrastructure/blueprints/admin_role.py +++ b/infrastructure/blueprints/admin_role.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict, Optional +from typing import TYPE_CHECKING, ClassVar, Optional import awacs.sts from awacs.aws import Allow, AWSPrincipal, PolicyDocument, Statement @@ -19,7 +19,7 @@ class AdminRole(Blueprint): """Blueprint for an admin role.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "CrossAccountAccessAccountIds": {"type": list, "default": []}, "PermissionsBoundary": {"type": str}, "RoleName": {"type": str, "default": ""}, @@ -34,9 +34,7 @@ def assume_role_policy(self) -> PolicyDocument: Statement( Action=[awacs.sts.AssumeRole], Effect=Allow, - Principal=AWSPrincipal( - self.variables["CrossAccountAccessAccountIds"] - ), + Principal=AWSPrincipal(self.variables["CrossAccountAccessAccountIds"]), ) ) return policy_doc diff --git a/infrastructure/blueprints/admin_user.py b/infrastructure/blueprints/admin_user.py index cecd3bb9a..c3c8315b9 100644 --- a/infrastructure/blueprints/admin_user.py +++ b/infrastructure/blueprints/admin_user.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict, Optional +from typing import TYPE_CHECKING, ClassVar from troposphere import NoValue from troposphere.iam import User @@ -17,7 +17,7 @@ class AdminUser(Blueprint): """Blueprint for an admin user.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "PermissionsBoundary": {"type": str}, "UserName": {"type": str, "default": ""}, } @@ -42,7 +42,7 @@ def user(self) -> User: return user @cached_property - def username(self) -> Optional[str]: + def username(self) -> str | None: """Name of the user being created.""" val = self.variables["UserName"] if val == "": @@ -53,4 +53,4 @@ def create_template(self) -> None: """Create a template from the Blueprint.""" self.template.set_description("Admin user") self.template.set_version("2010-09-09") - self.user # pylint: disable=pointless-statement + self.user # noqa: B018 diff --git a/infrastructure/blueprints/cfngin_bucket.py b/infrastructure/blueprints/cfngin_bucket.py index 20718958c..ce41af817 100644 --- a/infrastructure/blueprints/cfngin_bucket.py +++ b/infrastructure/blueprints/cfngin_bucket.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict +from typing import TYPE_CHECKING, ClassVar from troposphere import And, Equals, If, Not, NoValue, s3 @@ -17,7 +17,7 @@ class CfnginBucket(Blueprint): """Blueprint for a CFNgin Bucket.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "BucketName": { "type": CFNString, "description": "Name for the S3 bucket", @@ -63,11 +63,7 @@ def create_template(self) -> None: BucketName=self.bucket_name, DeletionPolicy=self.variables["DeletionPolicy"], LifecycleConfiguration=s3.LifecycleConfiguration( - Rules=[ - s3.LifecycleRule( - NoncurrentVersionExpirationInDays=30, Status="Enabled" - ) - ] + Rules=[s3.LifecycleRule(NoncurrentVersionExpirationInDays=30, Status="Enabled")] ), VersioningConfiguration=s3.VersioningConfiguration(Status="Enabled"), ) diff --git a/infrastructure/blueprints/prevent_privilege_escalation.py b/infrastructure/blueprints/prevent_privilege_escalation.py index 5cd3420e6..b806a2158 100644 --- a/infrastructure/blueprints/prevent_privilege_escalation.py +++ b/infrastructure/blueprints/prevent_privilege_escalation.py @@ -6,7 +6,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict, List, Union +from typing import TYPE_CHECKING, ClassVar, Union import awacs.iam import awacs.sts @@ -35,7 +35,7 @@ class AdminPreventPrivilegeEscalation(Blueprint): DESCRIPTION: ClassVar[str] = "Permission boundary for admin users." POLICY_NAME: ClassVar[str] = "AdminPreventPrivilegeEscalation" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "ApprovedPermissionBoundaries": { "default": [], "description": "List of policy names (not ARNs) that are approved to " @@ -55,42 +55,34 @@ def namespace(self) -> str: return self.context.namespace @cached_property - def approved_boundary_policies(self) -> List[Sub]: + def approved_boundary_policies(self) -> list[Sub]: """List of approved permission boundary policies.""" - tmp = [self.policy_arn] - for policy_name in self.variables["ApprovedPermissionBoundaries"]: - tmp.append( - Sub( - f"arn:${{AWS::Partition}}:iam::${{AWS::AccountId}}:policy/{policy_name}" - ) - ) - return tmp + return [ + self.policy_arn, + *[ + Sub(f"arn:${{AWS::Partition}}:iam::${{AWS::AccountId}}:policy/{policy_name}") + for policy_name in self.variables["ApprovedPermissionBoundaries"] + ], + ] @cached_property - def deny_assume_role_not_resources(self) -> List[Union[str, Sub]]: + def deny_assume_role_not_resources(self) -> list[Union[str, Sub]]: """List of IAM Role ARNs that can be assumed.""" - tmp: List[Union[str, Sub]] = [ - Sub( - f"arn:${{AWS::Partition}}:iam::${{AWS::AccountId}}:role/{self.namespace}-*" - ) + tmp: list[Union[str, Sub]] = [ + Sub(f"arn:${{AWS::Partition}}:iam::${{AWS::AccountId}}:role/{self.namespace}-*") ] - for arn in self.variables["DenyAssumeRoleNotResources"]: - tmp.append(arn) + tmp.extend(self.variables["DenyAssumeRoleNotResources"]) return tmp @property def policy_arn(self) -> Sub: """ARN of the IAM policy that will be created.""" - return Sub( - f"arn:${{AWS::Partition}}:iam::${{AWS::AccountId}}:policy/{self.POLICY_NAME}" - ) + return Sub(f"arn:${{AWS::Partition}}:iam::${{AWS::AccountId}}:policy/{self.POLICY_NAME}") @cached_property def statement_allow_admin_access(self) -> Statement: """Statement to allow admin access.""" - return Statement( - Action=[Action("*")], Effect=Allow, Resource=["*"], Sid="AllowAdminAccess" - ) + return Statement(Action=[Action("*")], Effect=Allow, Resource=["*"], Sid="AllowAdminAccess") @cached_property def statement_deny_alter_boundary_policy(self) -> Statement: @@ -143,9 +135,7 @@ def statement_deny_create_without_boundary(self) -> Statement: return Statement( Action=[awacs.iam.CreateRole, awacs.iam.CreateUser], Condition=Condition( - StringNotEquals( - {"iam:PermissionsBoundary": self.approved_boundary_policies} - ) + StringNotEquals({"iam:PermissionsBoundary": self.approved_boundary_policies}) ), Effect=Deny, Resource=[ @@ -162,14 +152,8 @@ def statement_deny_onica_sso(self) -> Statement: Action=[Action("*")], Effect=Deny, Resource=[ - Sub( - "arn:${AWS::Partition}:cloudformation:*:${AWS::AccountId}:stack/" - "onica-sso" - ), - Sub( - "arn:${AWS::Partition}:cloudformation:*:${AWS::AccountId}:stack/" - "onica-sso-*" - ), + Sub("arn:${AWS::Partition}:cloudformation:*:${AWS::AccountId}:stack/onica-sso"), + Sub("arn:${AWS::Partition}:cloudformation:*:${AWS::AccountId}:stack/onica-sso-*"), Sub("arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/onica-sso"), Sub("arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/onica-sso-*"), Sub("arn:${AWS::Partition}:iam::${AWS::AccountId}:role/onica-sso"), @@ -186,9 +170,7 @@ def statement_deny_put_boundary(self) -> Statement: awacs.iam.PutUserPermissionsBoundary, ], Condition=Condition( - StringNotEquals( - {"iam:PermissionsBoundary": self.approved_boundary_policies} - ) + StringNotEquals({"iam:PermissionsBoundary": self.approved_boundary_policies}) ), Effect=Deny, Resource=[ @@ -206,16 +188,14 @@ def statement_deny_remove_boundary_policy(self) -> Statement: awacs.iam.DeleteRolePermissionsBoundary, awacs.iam.DeleteUserPermissionsBoundary, ], - Condition=Condition( - StringEquals({"iam:PermissionsBoundary": self.policy_arn}) - ), + Condition=Condition(StringEquals({"iam:PermissionsBoundary": self.policy_arn})), Effect=Deny, Resource=["*"], Sid="DenyRemovalOfBoundaryFromUserOrRole", ) @cached_property - def statements(self) -> List[Statement]: + def statements(self) -> list[Statement]: """List of statements to add to the policy.""" return [ self.statement_allow_admin_access, diff --git a/infrastructure/blueprints/test_runner_boundary.py b/infrastructure/blueprints/test_runner_boundary.py index 4c774e461..d1c811931 100644 --- a/infrastructure/blueprints/test_runner_boundary.py +++ b/infrastructure/blueprints/test_runner_boundary.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import ClassVar, List +from typing import ClassVar import awacs.iam import awacs.s3 @@ -123,10 +123,7 @@ def statement_deny_namespace(self) -> Statement: Action("cloudformation", "List*"), ], Resource=[ - Sub( - "arn:aws:cloudformation:*:${AWS::AccountId}:stack/" - f"{self.namespace}-*" - ), + Sub(f"arn:aws:cloudformation:*:${{AWS::AccountId}}:stack/{self.namespace}-*"), f"arn:aws:s3:::{self.namespace}", f"arn:aws:s3:::{self.namespace}/*", f"arn:aws:s3:::{self.namespace}-*", @@ -135,9 +132,10 @@ def statement_deny_namespace(self) -> Statement: ) @cached_property - def statements(self) -> List[Statement]: + def statements(self) -> list[Statement]: """List of statements to add to the policy.""" - return super().statements + [ + return [ + *super().statements, self.statement_deny_change_cfngin_bucket, self.statement_deny_cloudtrail, self.statement_deny_iam, diff --git a/infrastructure/blueprints/test_runner_user.py b/infrastructure/blueprints/test_runner_user.py index abf6ee80b..0d8e81779 100644 --- a/infrastructure/blueprints/test_runner_user.py +++ b/infrastructure/blueprints/test_runner_user.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict +from typing import TYPE_CHECKING, ClassVar import awacs.sts from awacs.aws import Deny, PolicyDocument, Statement @@ -17,7 +17,7 @@ class TestRunnerUser(AdminUser): """Blueprint for a test runner user.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "DenyAssumeRoleNotResources": {"type": list, "default": []}, "PermissionsBoundary": {"type": str}, "UserName": {"type": str, "default": ""}, @@ -34,8 +34,7 @@ def create_template(self) -> None: Statement( Action=[awacs.sts.AssumeRole], Effect=Deny, - NotResource=self.variables["DenyAssumeRoleNotResources"] - or ["*"], + NotResource=self.variables["DenyAssumeRoleNotResources"] or ["*"], ) ], Version="2012-10-17", diff --git a/infrastructure/public/common/bucket-and-user.cdk/package.json b/infrastructure/public/common/bucket-and-user.cdk/package.json index b883231ef..7e24b9189 100644 --- a/infrastructure/public/common/bucket-and-user.cdk/package.json +++ b/infrastructure/public/common/bucket-and-user.cdk/package.json @@ -1,26 +1,26 @@ { - "name": "myapp", - "version": "1.0.0", - "scripts": { - "build": "tsc", - "lint": "tslint -c tslint.json 'bin/**/*.ts' 'lib/**/*.ts'", - "watch": "tsc -w", - "cdk": "cdk" - }, - "devDependencies": { - "@types/node": "8.10.40", - "@types/source-map-support": "^0.5.0", - "aws-cdk": "^2.101.1", - "aws-sdk": "^2.1511.0", - "prompt": "^1.0.0", - "ts-node": "^8.1.0", - "tslint": "^5.20.0", - "typescript": "^3.3.3333" - }, - "dependencies": { - "@aws-cdk/aws-iam": "^1.204.0", - "@aws-cdk/aws-s3": "^1.204.0", - "@aws-cdk/core": "^1.15.0", - "source-map-support": "^0.5.9" - } + "dependencies": { + "@aws-cdk/aws-iam": "^1.204.0", + "@aws-cdk/aws-s3": "^1.204.0", + "@aws-cdk/core": "^1.15.0", + "source-map-support": "^0.5.9" + }, + "devDependencies": { + "@types/node": "8.10.40", + "@types/source-map-support": "^0.5.0", + "aws-cdk": "^2.101.1", + "aws-sdk": "^2.1511.0", + "prompt": "^1.0.0", + "ts-node": "^8.1.0", + "tslint": "^5.20.0", + "typescript": "^3.3.3333" + }, + "name": "myapp", + "scripts": { + "build": "tsc", + "cdk": "cdk", + "lint": "tslint -c tslint.json 'bin/**/*.ts' 'lib/**/*.ts'", + "watch": "tsc -w" + }, + "version": "1.0.0" } diff --git a/package.json b/package.json index 02ba66bf1..f833534a6 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,19 @@ { - "name": "runway", + "author": { + "email": "opensource@onica.com", + "name": "Onica Group LLC", + "url": "https://onica.com" + }, + "bugs": { + "url": "https://github.com/onicagroup/runway/issues" + }, + "dependencies": { + "tar": "^7.2.0" + }, "description": "Simplify infrastructure/app testing/deployment", - "main": "NA", - "scripts": { - "postinstall": "node ./postinstall.js", - "preuninstall": "node ./preuninstall.js", - "py-type-check": "pyright --venv-path ./" + "devDependencies": { + "cspell": "^8.11.0", + "pyright": "^1.1.223" }, "files": [ "src/osx/*", @@ -14,10 +22,7 @@ "postinstall.js", "preuninstall.js" ], - "repository": { - "type": "git", - "url": "https://github.com/onicagroup/runway" - }, + "homepage": "https://github.com/onicagroup/runway", "keywords": [ "aws", "ci", @@ -30,11 +35,6 @@ "cloudformation", "cdk" ], - "author": { - "name": "Onica Group LLC", - "email": "opensource@onica.com", - "url": "https://onica.com" - }, "license": "Apache-2.0", "licenses": [ { @@ -42,24 +42,18 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" } ], - "bugs": { - "url": "https://github.com/onicagroup/runway/issues" - }, - "homepage": "https://github.com/onicagroup/runway", + "main": "NA", + "name": "runway", "os": [ "darwin", "linux", "win32" ], - "version": "2.0.0-dev", - "dependencies": { - "tar": "^7.2.0" - }, "publishConfig": { "access": "public" }, - "devDependencies": { - "cspell": "^8.11.0", - "pyright": "^1.1.223" + "scripts": { + "postinstall": "node ./postinstall.js", + "preuninstall": "node ./preuninstall.js" } } diff --git a/poetry.lock b/poetry.lock index a70c80f7b..681a69d05 100644 --- a/poetry.lock +++ b/poetry.lock @@ -22,25 +22,6 @@ files = [ {file = "altgraph-0.17.4.tar.gz", hash = "sha256:1b5afbb98f6c4dcadb2e2ae6ab9fa994bbb8c1d75f4fa96d340f9437ae454406"}, ] -[[package]] -name = "astroid" -version = "2.15.5" -description = "An abstract syntax tree for Python with inference support." -optional = false -python-versions = ">=3.7.2" -files = [ - {file = "astroid-2.15.5-py3-none-any.whl", hash = "sha256:078e5212f9885fa85fbb0cf0101978a336190aadea6e13305409d099f71b2324"}, - {file = "astroid-2.15.5.tar.gz", hash = "sha256:1039262575027b441137ab4a62a793a9b43defb42c32d5670f38686207cd780f"}, -] - -[package.dependencies] -lazy-object-proxy = ">=1.4.0" -typing-extensions = {version = ">=4.0.0", markers = "python_version < \"3.11\""} -wrapt = [ - {version = ">=1.11,<2", markers = "python_version < \"3.11\""}, - {version = ">=1.14,<2", markers = "python_version >= \"3.11\""}, -] - [[package]] name = "attrs" version = "22.2.0" @@ -1034,20 +1015,6 @@ ssh = ["bcrypt (>=3.1.5)"] test = ["certifi", "pretend", "pytest (>=6.2.0)", "pytest-benchmark", "pytest-cov", "pytest-xdist"] test-randomorder = ["pytest-randomly"] -[[package]] -name = "dill" -version = "0.3.6" -description = "serialize all of python" -optional = false -python-versions = ">=3.7" -files = [ - {file = "dill-0.3.6-py3-none-any.whl", hash = "sha256:a07ffd2351b8c678dfc4a856a3005f8067aea51d6ba6c700796a4d9e280f39f0"}, - {file = "dill-0.3.6.tar.gz", hash = "sha256:e5db55f3687856d8fbdab002ed78544e1c4559a130302693d839dfe8f93f2373"}, -] - -[package.extras] -graph = ["objgraph (>=1.7.2)"] - [[package]] name = "distlib" version = "0.3.6" @@ -1184,102 +1151,6 @@ files = [ docs = ["furo (>=2022.12.7)", "sphinx (>=6.1.3)", "sphinx-autodoc-typehints (>=1.22,!=1.23.4)"] testing = ["covdefaults (>=2.3)", "coverage (>=7.2.1)", "pytest (>=7.2.2)", "pytest-cov (>=4)", "pytest-timeout (>=2.1)"] -[[package]] -name = "flake8" -version = "7.1.0" -description = "the modular source code checker: pep8 pyflakes and co" -optional = false -python-versions = ">=3.8.1" -files = [ - {file = "flake8-7.1.0-py2.py3-none-any.whl", hash = "sha256:2e416edcc62471a64cea09353f4e7bdba32aeb079b6e360554c659a122b1bc6a"}, - {file = "flake8-7.1.0.tar.gz", hash = "sha256:48a07b626b55236e0fb4784ee69a465fbf59d79eec1f5b4785c3d3bc57d17aa5"}, -] - -[package.dependencies] -mccabe = ">=0.7.0,<0.8.0" -pycodestyle = ">=2.12.0,<2.13.0" -pyflakes = ">=3.2.0,<3.3.0" - -[[package]] -name = "flake8-bugbear" -version = "24.4.26" -description = "A plugin for flake8 finding likely bugs and design problems in your program. Contains warnings that don't belong in pyflakes and pycodestyle." -optional = false -python-versions = ">=3.8.1" -files = [ - {file = "flake8_bugbear-24.4.26-py3-none-any.whl", hash = "sha256:cb430dd86bc821d79ccc0b030789a9c87a47a369667f12ba06e80f11305e8258"}, - {file = "flake8_bugbear-24.4.26.tar.gz", hash = "sha256:ff8d4ba5719019ebf98e754624c30c05cef0dadcf18a65d91c7567300e52a130"}, -] - -[package.dependencies] -attrs = ">=19.2.0" -flake8 = ">=6.0.0" - -[package.extras] -dev = ["coverage", "hypothesis", "hypothesmith (>=0.2)", "pre-commit", "pytest", "tox"] - -[[package]] -name = "flake8-comprehensions" -version = "3.14.0" -description = "A flake8 plugin to help you write better list/set/dict comprehensions." -optional = false -python-versions = ">=3.8" -files = [ - {file = "flake8_comprehensions-3.14.0-py3-none-any.whl", hash = "sha256:7b9d07d94aa88e62099a6d1931ddf16c344d4157deedf90fe0d8ee2846f30e97"}, - {file = "flake8_comprehensions-3.14.0.tar.gz", hash = "sha256:81768c61bfc064e1a06222df08a2580d97de10cb388694becaf987c331c6c0cf"}, -] - -[package.dependencies] -flake8 = ">=3.0,<3.2.0 || >3.2.0" - -[[package]] -name = "flake8-docstrings" -version = "1.7.0" -description = "Extension for flake8 which uses pydocstyle to check docstrings" -optional = false -python-versions = ">=3.7" -files = [ - {file = "flake8_docstrings-1.7.0-py2.py3-none-any.whl", hash = "sha256:51f2344026da083fc084166a9353f5082b01f72901df422f74b4d953ae88ac75"}, - {file = "flake8_docstrings-1.7.0.tar.gz", hash = "sha256:4c8cc748dc16e6869728699e5d0d685da9a10b0ea718e090b1ba088e67a941af"}, -] - -[package.dependencies] -flake8 = ">=3" -pydocstyle = ">=2.1" - -[[package]] -name = "flake8-print" -version = "5.0.0" -description = "print statement checker plugin for flake8" -optional = false -python-versions = ">=3.7" -files = [ - {file = "flake8-print-5.0.0.tar.gz", hash = "sha256:76915a2a389cc1c0879636c219eb909c38501d3a43cc8dae542081c9ba48bdf9"}, - {file = "flake8_print-5.0.0-py3-none-any.whl", hash = "sha256:84a1a6ea10d7056b804221ac5e62b1cee1aefc897ce16f2e5c42d3046068f5d8"}, -] - -[package.dependencies] -flake8 = ">=3.0" -pycodestyle = "*" - -[[package]] -name = "flake8-use-fstring" -version = "1.4" -description = "Flake8 plugin for string formatting style." -optional = false -python-versions = ">=3.6" -files = [ - {file = "flake8-use-fstring-1.4.tar.gz", hash = "sha256:6550bf722585eb97dffa8343b0f1c372101f5c4ab5b07ebf0edd1c79880cdd39"}, -] - -[package.dependencies] -flake8 = ">=3" - -[package.extras] -ci = ["coverage (==4.*)", "coveralls", "flake8-builtins", "flake8-commas", "flake8-fixme", "flake8-print", "flake8-quotes", "flake8-todo", "pytest (>=4)", "pytest-cov (>=2)"] -dev = ["coverage (==4.*)", "flake8-builtins", "flake8-commas", "flake8-fixme", "flake8-print", "flake8-quotes", "flake8-todo", "pytest (>=4)", "pytest-cov (>=2)"] -test = ["coverage (==4.*)", "flake8-builtins", "flake8-commas", "flake8-fixme", "flake8-print", "flake8-quotes", "flake8-todo", "pytest (>=4)", "pytest-cov (>=2)"] - [[package]] name = "formic2" version = "1.0.3" @@ -1425,20 +1296,6 @@ files = [ {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, ] -[[package]] -name = "isort" -version = "5.13.2" -description = "A Python utility / library to sort Python imports." -optional = false -python-versions = ">=3.8.0" -files = [ - {file = "isort-5.13.2-py3-none-any.whl", hash = "sha256:8ca5e72a8d85860d5a3fa69b8745237f2939afe12dbf656afbcb47fe72d947a6"}, - {file = "isort-5.13.2.tar.gz", hash = "sha256:48fdfcb9face5d58a4f6dde2e72a1fb8dcaf8ab26f95ab49fab84c2ddefb0109"}, -] - -[package.extras] -colors = ["colorama (>=0.4.6)"] - [[package]] name = "jinja2" version = "3.1.4" @@ -1587,51 +1444,6 @@ atomic-cache = ["atomicwrites"] nearley = ["js2py"] regex = ["regex"] -[[package]] -name = "lazy-object-proxy" -version = "1.9.0" -description = "A fast and thorough lazy object proxy." -optional = false -python-versions = ">=3.7" -files = [ - {file = "lazy-object-proxy-1.9.0.tar.gz", hash = "sha256:659fb5809fa4629b8a1ac5106f669cfc7bef26fbb389dda53b3e010d1ac4ebae"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:b40387277b0ed2d0602b8293b94d7257e17d1479e257b4de114ea11a8cb7f2d7"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e8c6cfb338b133fbdbc5cfaa10fe3c6aeea827db80c978dbd13bc9dd8526b7d4"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:721532711daa7db0d8b779b0bb0318fa87af1c10d7fe5e52ef30f8eff254d0cd"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:66a3de4a3ec06cd8af3f61b8e1ec67614fbb7c995d02fa224813cb7afefee701"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:1aa3de4088c89a1b69f8ec0dcc169aa725b0ff017899ac568fe44ddc1396df46"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-win32.whl", hash = "sha256:f0705c376533ed2a9e5e97aacdbfe04cecd71e0aa84c7c0595d02ef93b6e4455"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-win_amd64.whl", hash = "sha256:ea806fd4c37bf7e7ad82537b0757999264d5f70c45468447bb2b91afdbe73a6e"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:946d27deaff6cf8452ed0dba83ba38839a87f4f7a9732e8f9fd4107b21e6ff07"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:79a31b086e7e68b24b99b23d57723ef7e2c6d81ed21007b6281ebcd1688acb0a"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f699ac1c768270c9e384e4cbd268d6e67aebcfae6cd623b4d7c3bfde5a35db59"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:bfb38f9ffb53b942f2b5954e0f610f1e721ccebe9cce9025a38c8ccf4a5183a4"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:189bbd5d41ae7a498397287c408617fe5c48633e7755287b21d741f7db2706a9"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-win32.whl", hash = "sha256:81fc4d08b062b535d95c9ea70dbe8a335c45c04029878e62d744bdced5141586"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-win_amd64.whl", hash = "sha256:f2457189d8257dd41ae9b434ba33298aec198e30adf2dcdaaa3a28b9994f6adb"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:d9e25ef10a39e8afe59a5c348a4dbf29b4868ab76269f81ce1674494e2565a6e"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cbf9b082426036e19c6924a9ce90c740a9861e2bdc27a4834fd0a910742ac1e8"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9f5fa4a61ce2438267163891961cfd5e32ec97a2c444e5b842d574251ade27d2"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:8fa02eaab317b1e9e03f69aab1f91e120e7899b392c4fc19807a8278a07a97e8"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:e7c21c95cae3c05c14aafffe2865bbd5e377cfc1348c4f7751d9dc9a48ca4bda"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-win32.whl", hash = "sha256:f12ad7126ae0c98d601a7ee504c1122bcef553d1d5e0c3bfa77b16b3968d2734"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-win_amd64.whl", hash = "sha256:edd20c5a55acb67c7ed471fa2b5fb66cb17f61430b7a6b9c3b4a1e40293b1671"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:2d0daa332786cf3bb49e10dc6a17a52f6a8f9601b4cf5c295a4f85854d61de63"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9cd077f3d04a58e83d04b20e334f678c2b0ff9879b9375ed107d5d07ff160171"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:660c94ea760b3ce47d1855a30984c78327500493d396eac4dfd8bd82041b22be"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:212774e4dfa851e74d393a2370871e174d7ff0ebc980907723bb67d25c8a7c30"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:f0117049dd1d5635bbff65444496c90e0baa48ea405125c088e93d9cf4525b11"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-win32.whl", hash = "sha256:0a891e4e41b54fd5b8313b96399f8b0e173bbbfc03c7631f01efbe29bb0bcf82"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-win_amd64.whl", hash = "sha256:9990d8e71b9f6488e91ad25f322898c136b008d87bf852ff65391b004da5e17b"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9e7551208b2aded9c1447453ee366f1c4070602b3d932ace044715d89666899b"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5f83ac4d83ef0ab017683d715ed356e30dd48a93746309c8f3517e1287523ef4"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7322c3d6f1766d4ef1e51a465f47955f1e8123caee67dd641e67d539a534d006"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:18b78ec83edbbeb69efdc0e9c1cb41a3b1b1ed11ddd8ded602464c3fc6020494"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:09763491ce220c0299688940f8dc2c5d05fd1f45af1e42e636b2e8b2303e4382"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-win32.whl", hash = "sha256:9090d8e53235aa280fc9239a86ae3ea8ac58eff66a705fa6aa2ec4968b95c821"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-win_amd64.whl", hash = "sha256:db1c1722726f47e10e0b5fdbf15ac3b8adb58c091d12b3ab713965795036985f"}, -] - [[package]] name = "lib-detect-testenv" version = "2.0.3" @@ -1720,17 +1532,6 @@ files = [ {file = "MarkupSafe-2.1.2.tar.gz", hash = "sha256:abcabc8c2b26036d62d4c746381a6f7cf60aafcc653198ad678306986b09450d"}, ] -[[package]] -name = "mccabe" -version = "0.7.0" -description = "McCabe checker, plugin for flake8" -optional = false -python-versions = ">=3.6" -files = [ - {file = "mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e"}, - {file = "mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325"}, -] - [[package]] name = "mock" version = "5.1.0" @@ -2123,20 +1924,6 @@ files = [ {file = "pefile-2023.2.7.tar.gz", hash = "sha256:82e6114004b3d6911c77c3953e3838654b04511b8b66e8583db70c65998017dc"}, ] -[[package]] -name = "pep8-naming" -version = "0.14.1" -description = "Check PEP-8 naming conventions, plugin for flake8" -optional = false -python-versions = ">=3.8" -files = [ - {file = "pep8-naming-0.14.1.tar.gz", hash = "sha256:1ef228ae80875557eb6c1549deafed4dabbf3261cfcafa12f773fe0db9be8a36"}, - {file = "pep8_naming-0.14.1-py3-none-any.whl", hash = "sha256:63f514fc777d715f935faf185dedd679ab99526a7f2f503abb61587877f7b1c5"}, -] - -[package.dependencies] -flake8 = ">=5.0.0" - [[package]] name = "pip" version = "23.3.1" @@ -2218,17 +2005,6 @@ nodeenv = ">=0.11.1" pyyaml = ">=5.1" virtualenv = ">=20.10.0" -[[package]] -name = "pycodestyle" -version = "2.12.0" -description = "Python style guide checker" -optional = false -python-versions = ">=3.8" -files = [ - {file = "pycodestyle-2.12.0-py2.py3-none-any.whl", hash = "sha256:949a39f6b86c3e1515ba1787c2022131d165a8ad271b11370a8819aa070269e4"}, - {file = "pycodestyle-2.12.0.tar.gz", hash = "sha256:442f950141b4f43df752dd303511ffded3a04c2b6fb7f65980574f0c31e6e79c"}, -] - [[package]] name = "pycparser" version = "2.21" @@ -2292,34 +2068,6 @@ typing-extensions = ">=4.2.0" dotenv = ["python-dotenv (>=0.10.4)"] email = ["email-validator (>=1.0.3)"] -[[package]] -name = "pydocstyle" -version = "6.3.0" -description = "Python docstring style checker" -optional = false -python-versions = ">=3.6" -files = [ - {file = "pydocstyle-6.3.0-py3-none-any.whl", hash = "sha256:118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019"}, - {file = "pydocstyle-6.3.0.tar.gz", hash = "sha256:7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1"}, -] - -[package.dependencies] -snowballstemmer = ">=2.2.0" - -[package.extras] -toml = ["tomli (>=1.2.3)"] - -[[package]] -name = "pyflakes" -version = "3.2.0" -description = "passive checker of Python programs" -optional = false -python-versions = ">=3.8" -files = [ - {file = "pyflakes-3.2.0-py2.py3-none-any.whl", hash = "sha256:84b5be138a2dfbb40689ca07e2152deb896a65c3a3e24c251c5c62489568074a"}, - {file = "pyflakes-3.2.0.tar.gz", hash = "sha256:1c61603ff154621fb2a9172037d84dca3500def8c8b630657d1701f026f8af3f"}, -] - [[package]] name = "pygments" version = "2.17.2" @@ -2397,35 +2145,6 @@ importlib-metadata = {version = ">=4.6", markers = "python_version < \"3.10\""} packaging = ">=22.0" setuptools = ">=42.0.0" -[[package]] -name = "pylint" -version = "2.17.4" -description = "python code static checker" -optional = false -python-versions = ">=3.7.2" -files = [ - {file = "pylint-2.17.4-py3-none-any.whl", hash = "sha256:7a1145fb08c251bdb5cca11739722ce64a63db479283d10ce718b2460e54123c"}, - {file = "pylint-2.17.4.tar.gz", hash = "sha256:5dcf1d9e19f41f38e4e85d10f511e5b9c35e1aa74251bf95cdd8cb23584e2db1"}, -] - -[package.dependencies] -astroid = ">=2.15.4,<=2.17.0-dev0" -colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""} -dill = [ - {version = ">=0.2", markers = "python_version < \"3.11\""}, - {version = ">=0.3.6", markers = "python_version >= \"3.11\""}, -] -isort = ">=4.2.5,<6" -mccabe = ">=0.6,<0.8" -platformdirs = ">=2.2.0" -tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} -tomlkit = ">=0.10.1" -typing-extensions = {version = ">=3.10.0", markers = "python_version < \"3.10\""} - -[package.extras] -spelling = ["pyenchant (>=3.2,<4.0)"] -testutils = ["gitpython (>3)"] - [[package]] name = "pyopenssl" version = "24.1.0" @@ -2907,6 +2626,33 @@ files = [ [package.dependencies] docutils = ">=0.11,<1.0" +[[package]] +name = "ruff" +version = "0.5.4" +description = "An extremely fast Python linter and code formatter, written in Rust." +optional = false +python-versions = ">=3.7" +files = [ + {file = "ruff-0.5.4-py3-none-linux_armv6l.whl", hash = "sha256:82acef724fc639699b4d3177ed5cc14c2a5aacd92edd578a9e846d5b5ec18ddf"}, + {file = "ruff-0.5.4-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:da62e87637c8838b325e65beee485f71eb36202ce8e3cdbc24b9fcb8b99a37be"}, + {file = "ruff-0.5.4-py3-none-macosx_11_0_arm64.whl", hash = "sha256:e98ad088edfe2f3b85a925ee96da652028f093d6b9b56b76fc242d8abb8e2059"}, + {file = "ruff-0.5.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4c55efbecc3152d614cfe6c2247a3054cfe358cefbf794f8c79c8575456efe19"}, + {file = "ruff-0.5.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:f9b85eaa1f653abd0a70603b8b7008d9e00c9fa1bbd0bf40dad3f0c0bdd06793"}, + {file = "ruff-0.5.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0cf497a47751be8c883059c4613ba2f50dd06ec672692de2811f039432875278"}, + {file = "ruff-0.5.4-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:09c14ed6a72af9ccc8d2e313d7acf7037f0faff43cde4b507e66f14e812e37f7"}, + {file = "ruff-0.5.4-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:628f6b8f97b8bad2490240aa84f3e68f390e13fabc9af5c0d3b96b485921cd60"}, + {file = "ruff-0.5.4-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3520a00c0563d7a7a7c324ad7e2cde2355733dafa9592c671fb2e9e3cd8194c1"}, + {file = "ruff-0.5.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:93789f14ca2244fb91ed481456f6d0bb8af1f75a330e133b67d08f06ad85b516"}, + {file = "ruff-0.5.4-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:029454e2824eafa25b9df46882f7f7844d36fd8ce51c1b7f6d97e2615a57bbcc"}, + {file = "ruff-0.5.4-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:9492320eed573a13a0bc09a2957f17aa733fff9ce5bf00e66e6d4a88ec33813f"}, + {file = "ruff-0.5.4-py3-none-musllinux_1_2_i686.whl", hash = "sha256:a6e1f62a92c645e2919b65c02e79d1f61e78a58eddaebca6c23659e7c7cb4ac7"}, + {file = "ruff-0.5.4-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:768fa9208df2bec4b2ce61dbc7c2ddd6b1be9fb48f1f8d3b78b3332c7d71c1ff"}, + {file = "ruff-0.5.4-py3-none-win32.whl", hash = "sha256:e1e7393e9c56128e870b233c82ceb42164966f25b30f68acbb24ed69ce9c3a4e"}, + {file = "ruff-0.5.4-py3-none-win_amd64.whl", hash = "sha256:58b54459221fd3f661a7329f177f091eb35cf7a603f01d9eb3eb11cc348d38c4"}, + {file = "ruff-0.5.4-py3-none-win_arm64.whl", hash = "sha256:bd53da65f1085fb5b307c38fd3c0829e76acf7b2a912d8d79cadcdb4875c1eb7"}, + {file = "ruff-0.5.4.tar.gz", hash = "sha256:2795726d5f71c4f4e70653273d1c23a8182f07dd8e48c12de5d867bfb7557eed"}, +] + [[package]] name = "s3transfer" version = "0.10.0" @@ -3335,17 +3081,6 @@ files = [ {file = "tomli_w-1.0.0.tar.gz", hash = "sha256:f463434305e0336248cac9c2dc8076b707d8a12d019dd349f5c1e382dd1ae1b9"}, ] -[[package]] -name = "tomlkit" -version = "0.11.6" -description = "Style preserving TOML library" -optional = false -python-versions = ">=3.6" -files = [ - {file = "tomlkit-0.11.6-py3-none-any.whl", hash = "sha256:07de26b0d8cfc18f871aec595fda24d95b08fef89d147caa861939f37230bf4b"}, - {file = "tomlkit-0.11.6.tar.gz", hash = "sha256:71b952e5721688937fb02cf9d354dbcf0785066149d2855e44531ebdd2b65d73"}, -] - [[package]] name = "troposphere" version = "4.8.0" @@ -3502,90 +3237,6 @@ files = [ [package.extras] test = ["pytest (>=6.0.0)", "setuptools (>=65)"] -[[package]] -name = "wrapt" -version = "1.15.0" -description = "Module for decorators, wrappers and monkey patching." -optional = false -python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7" -files = [ - {file = "wrapt-1.15.0-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:ca1cccf838cd28d5a0883b342474c630ac48cac5df0ee6eacc9c7290f76b11c1"}, - {file = "wrapt-1.15.0-cp27-cp27m-manylinux1_i686.whl", hash = "sha256:e826aadda3cae59295b95343db8f3d965fb31059da7de01ee8d1c40a60398b29"}, - {file = "wrapt-1.15.0-cp27-cp27m-manylinux1_x86_64.whl", hash = "sha256:5fc8e02f5984a55d2c653f5fea93531e9836abbd84342c1d1e17abc4a15084c2"}, - {file = "wrapt-1.15.0-cp27-cp27m-manylinux2010_i686.whl", hash = "sha256:96e25c8603a155559231c19c0349245eeb4ac0096fe3c1d0be5c47e075bd4f46"}, - {file = "wrapt-1.15.0-cp27-cp27m-manylinux2010_x86_64.whl", hash = "sha256:40737a081d7497efea35ab9304b829b857f21558acfc7b3272f908d33b0d9d4c"}, - {file = "wrapt-1.15.0-cp27-cp27mu-manylinux1_i686.whl", hash = "sha256:f87ec75864c37c4c6cb908d282e1969e79763e0d9becdfe9fe5473b7bb1e5f09"}, - {file = "wrapt-1.15.0-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:1286eb30261894e4c70d124d44b7fd07825340869945c79d05bda53a40caa079"}, - {file = "wrapt-1.15.0-cp27-cp27mu-manylinux2010_i686.whl", hash = "sha256:493d389a2b63c88ad56cdc35d0fa5752daac56ca755805b1b0c530f785767d5e"}, - {file = "wrapt-1.15.0-cp27-cp27mu-manylinux2010_x86_64.whl", hash = "sha256:58d7a75d731e8c63614222bcb21dd992b4ab01a399f1f09dd82af17bbfc2368a"}, - {file = "wrapt-1.15.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:21f6d9a0d5b3a207cdf7acf8e58d7d13d463e639f0c7e01d82cdb671e6cb7923"}, - {file = "wrapt-1.15.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ce42618f67741d4697684e501ef02f29e758a123aa2d669e2d964ff734ee00ee"}, - {file = "wrapt-1.15.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:41d07d029dd4157ae27beab04d22b8e261eddfc6ecd64ff7000b10dc8b3a5727"}, - {file = "wrapt-1.15.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:54accd4b8bc202966bafafd16e69da9d5640ff92389d33d28555c5fd4f25ccb7"}, - {file = "wrapt-1.15.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2fbfbca668dd15b744418265a9607baa970c347eefd0db6a518aaf0cfbd153c0"}, - {file = "wrapt-1.15.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:76e9c727a874b4856d11a32fb0b389afc61ce8aaf281ada613713ddeadd1cfec"}, - {file = "wrapt-1.15.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e20076a211cd6f9b44a6be58f7eeafa7ab5720eb796975d0c03f05b47d89eb90"}, - {file = "wrapt-1.15.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:a74d56552ddbde46c246b5b89199cb3fd182f9c346c784e1a93e4dc3f5ec9975"}, - {file = "wrapt-1.15.0-cp310-cp310-win32.whl", hash = "sha256:26458da5653aa5b3d8dc8b24192f574a58984c749401f98fff994d41d3f08da1"}, - {file = "wrapt-1.15.0-cp310-cp310-win_amd64.whl", hash = "sha256:75760a47c06b5974aa5e01949bf7e66d2af4d08cb8c1d6516af5e39595397f5e"}, - {file = "wrapt-1.15.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:ba1711cda2d30634a7e452fc79eabcadaffedf241ff206db2ee93dd2c89a60e7"}, - {file = "wrapt-1.15.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:56374914b132c702aa9aa9959c550004b8847148f95e1b824772d453ac204a72"}, - {file = "wrapt-1.15.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a89ce3fd220ff144bd9d54da333ec0de0399b52c9ac3d2ce34b569cf1a5748fb"}, - {file = "wrapt-1.15.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3bbe623731d03b186b3d6b0d6f51865bf598587c38d6f7b0be2e27414f7f214e"}, - {file = "wrapt-1.15.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3abbe948c3cbde2689370a262a8d04e32ec2dd4f27103669a45c6929bcdbfe7c"}, - {file = "wrapt-1.15.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:b67b819628e3b748fd3c2192c15fb951f549d0f47c0449af0764d7647302fda3"}, - {file = "wrapt-1.15.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:7eebcdbe3677e58dd4c0e03b4f2cfa346ed4049687d839adad68cc38bb559c92"}, - {file = "wrapt-1.15.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:74934ebd71950e3db69960a7da29204f89624dde411afbfb3b4858c1409b1e98"}, - {file = "wrapt-1.15.0-cp311-cp311-win32.whl", hash = "sha256:bd84395aab8e4d36263cd1b9308cd504f6cf713b7d6d3ce25ea55670baec5416"}, - {file = "wrapt-1.15.0-cp311-cp311-win_amd64.whl", hash = "sha256:a487f72a25904e2b4bbc0817ce7a8de94363bd7e79890510174da9d901c38705"}, - {file = "wrapt-1.15.0-cp35-cp35m-manylinux1_i686.whl", hash = "sha256:4ff0d20f2e670800d3ed2b220d40984162089a6e2c9646fdb09b85e6f9a8fc29"}, - {file = "wrapt-1.15.0-cp35-cp35m-manylinux1_x86_64.whl", hash = "sha256:9ed6aa0726b9b60911f4aed8ec5b8dd7bf3491476015819f56473ffaef8959bd"}, - {file = "wrapt-1.15.0-cp35-cp35m-manylinux2010_i686.whl", hash = "sha256:896689fddba4f23ef7c718279e42f8834041a21342d95e56922e1c10c0cc7afb"}, - {file = "wrapt-1.15.0-cp35-cp35m-manylinux2010_x86_64.whl", hash = "sha256:75669d77bb2c071333417617a235324a1618dba66f82a750362eccbe5b61d248"}, - {file = "wrapt-1.15.0-cp35-cp35m-win32.whl", hash = "sha256:fbec11614dba0424ca72f4e8ba3c420dba07b4a7c206c8c8e4e73f2e98f4c559"}, - {file = "wrapt-1.15.0-cp35-cp35m-win_amd64.whl", hash = "sha256:fd69666217b62fa5d7c6aa88e507493a34dec4fa20c5bd925e4bc12fce586639"}, - {file = "wrapt-1.15.0-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:b0724f05c396b0a4c36a3226c31648385deb6a65d8992644c12a4963c70326ba"}, - {file = "wrapt-1.15.0-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bbeccb1aa40ab88cd29e6c7d8585582c99548f55f9b2581dfc5ba68c59a85752"}, - {file = "wrapt-1.15.0-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:38adf7198f8f154502883242f9fe7333ab05a5b02de7d83aa2d88ea621f13364"}, - {file = "wrapt-1.15.0-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:578383d740457fa790fdf85e6d346fda1416a40549fe8db08e5e9bd281c6a475"}, - {file = "wrapt-1.15.0-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:a4cbb9ff5795cd66f0066bdf5947f170f5d63a9274f99bdbca02fd973adcf2a8"}, - {file = "wrapt-1.15.0-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:af5bd9ccb188f6a5fdda9f1f09d9f4c86cc8a539bd48a0bfdc97723970348418"}, - {file = "wrapt-1.15.0-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:b56d5519e470d3f2fe4aa7585f0632b060d532d0696c5bdfb5e8319e1d0f69a2"}, - {file = "wrapt-1.15.0-cp36-cp36m-win32.whl", hash = "sha256:77d4c1b881076c3ba173484dfa53d3582c1c8ff1f914c6461ab70c8428b796c1"}, - {file = "wrapt-1.15.0-cp36-cp36m-win_amd64.whl", hash = "sha256:077ff0d1f9d9e4ce6476c1a924a3332452c1406e59d90a2cf24aeb29eeac9420"}, - {file = "wrapt-1.15.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:5c5aa28df055697d7c37d2099a7bc09f559d5053c3349b1ad0c39000e611d317"}, - {file = "wrapt-1.15.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3a8564f283394634a7a7054b7983e47dbf39c07712d7b177b37e03f2467a024e"}, - {file = "wrapt-1.15.0-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:780c82a41dc493b62fc5884fb1d3a3b81106642c5c5c78d6a0d4cbe96d62ba7e"}, - {file = "wrapt-1.15.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e169e957c33576f47e21864cf3fc9ff47c223a4ebca8960079b8bd36cb014fd0"}, - {file = "wrapt-1.15.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:b02f21c1e2074943312d03d243ac4388319f2456576b2c6023041c4d57cd7019"}, - {file = "wrapt-1.15.0-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:f2e69b3ed24544b0d3dbe2c5c0ba5153ce50dcebb576fdc4696d52aa22db6034"}, - {file = "wrapt-1.15.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:d787272ed958a05b2c86311d3a4135d3c2aeea4fc655705f074130aa57d71653"}, - {file = "wrapt-1.15.0-cp37-cp37m-win32.whl", hash = "sha256:02fce1852f755f44f95af51f69d22e45080102e9d00258053b79367d07af39c0"}, - {file = "wrapt-1.15.0-cp37-cp37m-win_amd64.whl", hash = "sha256:abd52a09d03adf9c763d706df707c343293d5d106aea53483e0ec8d9e310ad5e"}, - {file = "wrapt-1.15.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:cdb4f085756c96a3af04e6eca7f08b1345e94b53af8921b25c72f096e704e145"}, - {file = "wrapt-1.15.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:230ae493696a371f1dbffaad3dafbb742a4d27a0afd2b1aecebe52b740167e7f"}, - {file = "wrapt-1.15.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:63424c681923b9f3bfbc5e3205aafe790904053d42ddcc08542181a30a7a51bd"}, - {file = "wrapt-1.15.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d6bcbfc99f55655c3d93feb7ef3800bd5bbe963a755687cbf1f490a71fb7794b"}, - {file = "wrapt-1.15.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c99f4309f5145b93eca6e35ac1a988f0dc0a7ccf9ccdcd78d3c0adf57224e62f"}, - {file = "wrapt-1.15.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:b130fe77361d6771ecf5a219d8e0817d61b236b7d8b37cc045172e574ed219e6"}, - {file = "wrapt-1.15.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:96177eb5645b1c6985f5c11d03fc2dbda9ad24ec0f3a46dcce91445747e15094"}, - {file = "wrapt-1.15.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:d5fe3e099cf07d0fb5a1e23d399e5d4d1ca3e6dfcbe5c8570ccff3e9208274f7"}, - {file = "wrapt-1.15.0-cp38-cp38-win32.whl", hash = "sha256:abd8f36c99512755b8456047b7be10372fca271bf1467a1caa88db991e7c421b"}, - {file = "wrapt-1.15.0-cp38-cp38-win_amd64.whl", hash = "sha256:b06fa97478a5f478fb05e1980980a7cdf2712015493b44d0c87606c1513ed5b1"}, - {file = "wrapt-1.15.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:2e51de54d4fb8fb50d6ee8327f9828306a959ae394d3e01a1ba8b2f937747d86"}, - {file = "wrapt-1.15.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:0970ddb69bba00670e58955f8019bec4a42d1785db3faa043c33d81de2bf843c"}, - {file = "wrapt-1.15.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:76407ab327158c510f44ded207e2f76b657303e17cb7a572ffe2f5a8a48aa04d"}, - {file = "wrapt-1.15.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cd525e0e52a5ff16653a3fc9e3dd827981917d34996600bbc34c05d048ca35cc"}, - {file = "wrapt-1.15.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9d37ac69edc5614b90516807de32d08cb8e7b12260a285ee330955604ed9dd29"}, - {file = "wrapt-1.15.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:078e2a1a86544e644a68422f881c48b84fef6d18f8c7a957ffd3f2e0a74a0d4a"}, - {file = "wrapt-1.15.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:2cf56d0e237280baed46f0b5316661da892565ff58309d4d2ed7dba763d984b8"}, - {file = "wrapt-1.15.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:7dc0713bf81287a00516ef43137273b23ee414fe41a3c14be10dd95ed98a2df9"}, - {file = "wrapt-1.15.0-cp39-cp39-win32.whl", hash = "sha256:46ed616d5fb42f98630ed70c3529541408166c22cdfd4540b88d5f21006b0eff"}, - {file = "wrapt-1.15.0-cp39-cp39-win_amd64.whl", hash = "sha256:eef4d64c650f33347c1f9266fa5ae001440b232ad9b98f1f43dfe7a79435c0a6"}, - {file = "wrapt-1.15.0-py3-none-any.whl", hash = "sha256:64b1df0f83706b4ef4cfb4fb0e4c2669100fd7ecacfb59e091fad300d4e04640"}, - {file = "wrapt-1.15.0.tar.gz", hash = "sha256:d06730c6aed78cee4126234cf2d071e01b44b915e725a6cb439a879ec9754a3a"}, -] - [[package]] name = "xmltodict" version = "0.13.0" @@ -3633,4 +3284,4 @@ test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools", [metadata] lock-version = "2.0" python-versions = ">=3.9, <3.13" -content-hash = "0c57981b4583118568443d4438c10a1bac20399d10faac78989c209b16fc904f" +content-hash = "c2bf0dfcf1f2093cf1c4ecad97d68c84738bf2c447fb7b94f67bdea7726c4a47" diff --git a/pyproject.toml b/pyproject.toml index a241026b0..bcc0541af 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,38 +1,37 @@ [tool.poetry] name = "runway" version = "2.0.0-dev" # do not change -description = "Simplify infrastructure/app testing/deployment" -license = "Apache-2.0" authors = [ "Onica Group LLC ", ] -maintainers = [ - "Kyle Finley ", "Sam Fakhreddine " -] -readme = "README.md" -homepage = "https://github.com/onicagroup/runway" -repository = "https://github.com/onicagroup/runway" -documentation = "https://docs.onica.com/projects/runway" -keywords = ["cli"] classifiers = [ "Intended Audience :: Developers", - "Topic :: Utilities", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", - "Programming Language :: Python :: 3.12" + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.9", + "Topic :: Utilities", +] +description = "Simplify infrastructure/app testing/deployment" +documentation = "https://docs.onica.com/projects/runway" +homepage = "https://github.com/onicagroup/runway" +keywords = ["cli"] +license = "Apache-2.0" +maintainers = [ + "Kyle Finley ", + "Sam Fakhreddine ", ] packages = [ - { include = "runway" }, + {include = "runway"}, ] +readme = "README.md" +repository = "https://github.com/onicagroup/runway" [tool.poetry.dependencies] python = ">=3.9, <3.13" - -"backports.cached_property" = { version = "*", python = "<3.8" } awacs = "*" boto3 = "^1.16" cfn-lint = "*" @@ -43,46 +42,34 @@ docker = ">=3.0.0" # used in runway.cfngin.hooks formic2 = "*" # only used in runway.cfngin.hooks.aws_lambda gitpython = "*" igittigitt = ">=2.0.5" -importlib-metadata = { version = "*", python = "<3.8" } jinja2 = ">=2.7" # used in runway.cfngin.blueprints.raw +moto = "3.0.5" packaging = "*" # component of setuptools needed for version compare +pipenv = "2022.1.8" pyOpenSSL = "*" # For embedded hook & associated script usage pydantic = "^1.4" pyhcl = "^0.4" # does not support HCL2, possibly move to extras_require in the future +pyinstaller = "^6.2.0" python-hcl2 = ">=3.0.0" pyyaml = ">5.4" requests = "*" send2trash = "*" +testfixtures = "^7.0.3" tomli = ">=1.2.2" troposphere = ">=2.4, <5" typing_extensions = "*" # only really needed for < 3.8 but can still be used in >= 3.8 urllib3 = "*" # allow us to follow botocore's hard pinning without needing to update our own -yamllint = "*" -pipenv = "2022.1.8" -moto = "3.0.5" -testfixtures = "^7.0.3" wheel = "^0.42.0" -pyinstaller = "^6.2.0" +yamllint = "*" [tool.poetry.group.dev.dependencies] -black = ">=22.1" -coverage = { version = ">=6.3", extras = ["toml"] } +coverage = {extras = ["toml"], version = ">=6.3"} doc8 = ">=0.10" # for linting with vscode rst extension dunamai = "^1.5" -flake8 = ">=4.0.1" -flake8-bugbear = ">=21.9.2" # flake8 plugin -flake8-comprehensions = ">=3.7.0" # flake8 plugin -flake8-docstrings = ">=1.6" # flake8 plugin -flake8-print = ">=4.0.0" # flake8 plugin -flake8-use-fstring = ">=1.3" # flake8 plugin -isort = ">=5.12" mock = ">=4.0" -moto = { version = ">=3.0", extras = ["ec2", "ecs", "iam", "s3", "ssm"] } -pep8-naming = ">=0.12.1" # flake8 plugin +moto = {extras = ["ec2", "ecs", "iam", "s3", "ssm"], version = ">=3.0"} pipenv = "^2022.1.8" # only used in tests -pre-commit = ">=2.14" -pydocstyle = ">=6.1.1" # flake8 plugin -pylint = ">=2.12" +pre-commit = "^3.7.1" pytest = ">=7.0" pytest-cov = ">=3.0" # pytest plugin pytest-mock = ">=3.7" # pytest plugin @@ -104,6 +91,10 @@ sphinx-tabs = "^3.2" sphinxcontrib-apidoc = "^0.3" sphinxcontrib-programoutput = "^0.17" +[tool.poetry.group.lint.dependencies] +black = "^24.4.2" +ruff = "^0.5.4" + [tool.poetry.group.types.dependencies] mypy-boto3 = "^1.16" # importable boto3 type annotations @@ -134,11 +125,6 @@ runway = "runway._cli.main:cli" [tool.poetry.urls] "Bug Tracker" = "https://github.com/onicagroup/runway/issues" -[build-system] -requires = ["poetry_core>=1.0.7"] -build-backend = "poetry.core.masonry.api" - - [tool.black] force-exclude = ''' /( @@ -158,187 +144,52 @@ force-exclude = ''' )/ ''' include = '\.pyi?$' -line-length = 88 -target-version = ["py38", "py39"] - +line-length = 100 +target-version = ["py310", "py311", "py312", "py39"] [tool.coverage.report] exclude_lines = [ + "@overload", "cov: ignore", # standard exclude comment + "from pathlib import Path", "if TYPE_CHECKING:", # excluded blocks "if __name__ == .__main__.:", "raise AssertionError", # defensive exceptions "raise NotImplementedError", - "from pathlib import Path", - "@overload", ] fail_under = 85 precision = 2 show_missing = true - [tool.coverage.run] concurrency = [ "multiprocessing", "thread", ] omit = [ + "*/compat.py", "*/runway/aws_sso_botocore/*", # TODO remove native support is added to botocore "*/runway/cfngin/hooks/staticsite/auth_at_edge/templates/*", - "*/compat.py", "*/type_defs.py", ] -[tool.isort] -profile = "black" -known_local_folder = [ - "jwks_rsa", - "shared", - "update_urls", -] -skip = [ - ".demo", - ".eggs", - ".git", - ".mypy_cache", - ".runway", - ".runway_cache", - ".venv", - "_build", - "build", - "dist", - "integration_tests", - "node_modules", - "venv", -] - - -[tool.pylint.basic] -# http://pylint.pycqa.org/en/latest/technical_reference/features.html#basic-checker -attr-rgx = "([a-z_][a-z0-9_]{2,50}|VARIABLES)$" -# attr-name-hint = "([a-z_][a-z0-9_]{2,50}|VARIABLES)$" -good-names = [ - "_", - "a", - "b", - "ci", - "db", - "f", - "fn", - "fp", - "gb", - "i", - "id", - "j", - "k", - "kb", - "mb", - "ok", - "os", - "ui", - "v", -] - -[tool.pylint.classes] -# http://pylint.pycqa.org/en/latest/technical_reference/features.html#classes-checker -defining-attr-methods = [ - "__init__", - "__new__", - "setUp", -] -exclude-protected=[ - "_asdict", - "_fields", - "_replace", - "_source", - "_make", - "_session", # for boto3.session.Session - "_prompter", - "_client_config", # boto3.client.Client._client_config contains info like region - "_endpoint", # boto3.client.Client._endpoint contains s3 endpoint info - "_validate_props" # called on troposphere resources -] - -[tool.pylint.design] -# http://pylint.pycqa.org/en/latest/technical_reference/features.html#design-checker-options -max-args = 10 -max-attributes = 20 -max-bool-expr = 5 -max-branches = 20 -max-locals = 25 -max-parents = 10 -max-public-methods = 30 -max-returns = 10 -max-statements = 50 -min-public-methods = 0 - -[tool.pylint.format] -# http://pylint.pycqa.org/en/latest/technical_reference/features.html#format-checker -max-line-length = 120 -max-module-lines = 1000 - -[tool.pylint.imports] -# http://pylint.pycqa.org/en/latest/technical_reference/features.html#imports-checker -allow-wildcard-with-all = "no" - -[tool.pylint.logging] -# http://pylint.pycqa.org/en/latest/technical_reference/features.html#logging-checker -logging-format-style = "old" # TODO update to new - -[tool.pylint.master] -# http://pylint.pycqa.org/en/latest/technical_reference/features.html#general-options -extension-pkg-whitelist = [ - "pydantic", # https://github.com/samuelcolvin/pydantic/issues/992#issuecomment-553545180 -] -ignore-patterns = [ - ".+py[ci]$", -] -jobs = 0 - -[tool.pylint.miscellaneous] -# http://pylint.pycqa.org/en/latest/technical_reference/features.html#miscellaneous-checker -notes = ["FIXME"] - -[tool.pylint.message_control] -# http://pylint.pycqa.org/en/latest/technical_reference/features.html#messages-control-options -disable = [ - "line-too-long", # flake8 overlap - "missing-class-docstring", # flake8 (pydocstyle) overlap - "missing-function-docstring", # flake8 (pydocstyle) overlap - "missing-module-docstring", # flake8 (pydocstyle) overlap - "similarities", # black overcomplicated this - "ungrouped-imports", # false positive when using TYPE_CHECKING; isort should cover this - "unused-import", # flake8 overlap (F401) - "broad-exception-raised", - "missing-timeout" -] - -[tool.pylint.typecheck] -# http://pylint.pycqa.org/en/latest/technical_reference/features.html#typecheck-checker -ignored-classes = [ - "runway.config.ConfigComponent", - "runway.utils.MutableMap", -] -ignored-modules = ["_typeshed", "distutils"] - - [tool.pyright] exclude = [ - "**/__pycache__", "**/.demo", "**/.eggs", "**/.git", "**/.runway", "**/.venv", + "**/__pycache__", "**/docs", "**/node_modules", "**/quickstarts", - "**/typings", "**/runway/aws_sso_botocore", "**/runway/cfngin/hooks/staticsite/auth_at_edge/templates", "**/runway/templates/cdk-py", "**/tests/functional/cfngin/test_aws_lambda_hook/lambda_src", - "**/tests/unit" + "**/tests/unit", + "**/typings", ] extraPaths = [ "./.github/scripts/urlshortener", @@ -360,7 +211,6 @@ typeCheckingMode = "strict" useLibraryCodeForTypes = true venv = ".venv" - [tool.pytest.ini_options] addopts = [ "--cov-config=pyproject.toml", @@ -378,3 +228,131 @@ python_classes = ["Test*"] python_files = ["test_*.py"] python_functions = ["test_*"] testpaths = ["tests"] + +[tool.ruff] # https://docs.astral.sh/ruff/settings/#top-level +extend-exclude = [ + "runway/aws_sso_botocore", # NOTE (kyle): ignoring vendored code + "runway/cfngin/hooks/staticsite/auth_at_edge/templates", # TODO (kyle): resolve lint error + "typings", +] +force-exclude = true +line-length = 120 +show-fixes = true +target-version = "py39" # important to set before applying fixes + +[tool.ruff.lint] # https://docs.astral.sh/ruff/settings/#lint +extend-safe-fixes = [ + "UP007", + "UP038", + "UP040", +] +ignore = [ + "ANN101", # Missing type annotation for `self` in method + "ANN102", # Missing type annotation for `cls` in classmethod + "ANN401", # Dynamically typed expressions (typing.Any) are disallowed # TODO (kyle): improve type annotations + "COM812", # Trailing comma missing + "D203", # 1 blank line required before class docstring + "D213", # Multi-line docstring summary should start at the second line + "D215", # Section underline is over-indented + "D403", # First word of the first line should be capitalized + "D406", # Section name should end with a newline + "D407", # Missing dashed underline after section + "D408", # Section underline should be in the line following the section's name + "D409", # Section underline should match the length of its name + "DTZ", # flake8-datetimez # NOTE (kyle): this is fine here + "EM", # flake8-errmsg + "ERA001", # Found commented-out code # NOTE (kyle): incorrectly detects cspell + "FA100", # Missing `from __future__ import annotations`, but uses `typing.Optional` + "FBT001", # Boolean positional arg in function definition + "FBT002", # Boolean default value in function definition + "FBT003", # Boolean positional value in function call + "FIX002", # Line contains TODO + "N818", # Exception name should be named with an Error suffix # TODO (kyle): resolve in next major release + "PERF203", # `try`-`except` within a loop incurs performance overhead + "PGH003", # Use specific rule codes when ignoring type issues # TODO (kyle): resolve this eventually + "RUF012", # TODO (kyle): remove when resolved - https://github.com/astral-sh/ruff/issues/5243 + "S105", # (hardcoded-password-string) Possible hardcoded password + "S106", # (hardcoded-password-func-arg) Possible hardcoded password + "S107", # (hardcoded-password-default) Possible hardcoded password + "S108", # Probable insecure usage of temporary file or directory + "S301", # `pickle` and modules that wrap it can be unsafe when used to deserialize untrusted data + "S60", # flake8-bandit # NOTE (kyle): most of these are for subprocess which we don't care about right now + "S604", # Function call with `shell=True` parameter identified # NOTE (kyle): required for runway + "TD003", # Missing issue link on the line following this TODO + "TID252", # Relative imports from parent modules are banned + "TRY", # tryceratops +] +select = ["ALL"] + +[tool.ruff.lint.extend-per-file-ignores] # https://docs.astral.sh/ruff/settings/#lintextend-per-file-ignores +"*.py" = [ + "PYI024", # Use `typing.NamedTuple` instead of `collections.namedtuple` # NOTE (kyle): should only apply to pyi +] +".github/scripts/*" = [ + "EXE002", # The file is executable but no shebang is present # NOTE (kyle): fails linting on windows +] +"runway/templates/*" = [ + "N999", # Invalid module name # NOTE (kyle): these are fine here +] +"tests/*" = [ + "PT004", # Fixture does not return anything, add leading underscore + "S101", # Use of `assert` detected # NOTE (kyle): this is fine here + "SLF001", # Private member accessed # NOTE (kyle): fine in tests +] + +[tool.ruff.lint.flake8-annotations] # https://docs.astral.sh/ruff/settings/#lintflake8-annotations +allow-star-arg-any = true + +[tool.ruff.lint.flake8-pytest-style] # https://docs.astral.sh/ruff/settings/#lintflake8-pytest-style +parametrize-names-type = "csv" # TODO (kyle): update tests to remove the need for this + +[tool.ruff.lint.flake8-self] +ignore-names = [ + "_Environ", + "_Hash", + "_session", +] + +[tool.ruff.lint.flake8-type-checking] # https://docs.astral.sh/ruff/settings/#lint_flake8-type-checking_runtime-evaluated-base-classes +runtime-evaluated-base-classes = [ + "pydantic.BaseModel", + "pydantic.BeforeValidator", + "runway.cfngin.hooks.base.HookArgsBaseModel", + "runway.config.models.base.ConfigProperty", + "runway.utils.BaseModel", +] + +[tool.ruff.lint.isort] # https://docs.astral.sh/ruff/settings/#lintisort +known-local-folder = [ + "jwks_rsa", + "shared", + "update_urls", +] +known-third-party = [ + "docker", # NOTE (kyle): the `docker/` directory confuses isort +] + +[tool.ruff.lint.pydocstyle] # https://docs.astral.sh/ruff/settings/#lintpydocstyle +convention = "google" + +[tool.ruff.lint.pylint] # https://docs.astral.sh/ruff/settings/#lintpylint +allow-magic-value-types = ["bytes", "int", "str"] +max-args = 15 +max-returns = 10 +max-statements = 50 + +[tool.ruff.lint.pyupgrade] # https://docs.astral.sh/ruff/settings/#pyupgrade-keep-runtime-typing +keep-runtime-typing = true # TODO (kyle): remove when dropping support for python 3.9 + +[tool.tomlsort] +all = true +in_place = true +sort_first = ["tool", "tool.poetry"] +spaces_before_inline_comment = 2 +trailing_comma_inline_array = true +overrides."tool.poetry".first = ["name", "version"] +overrides."tool.poetry.dependencies".first = ["python"] + +[build-system] +build-backend = "poetry.core.masonry.api" +requires = ["poetry_core>=1.0.7"] diff --git a/quickstarts/conduit/pyproject.toml b/quickstarts/conduit/pyproject.toml index 8062507ee..3c647bd2e 100644 --- a/quickstarts/conduit/pyproject.toml +++ b/quickstarts/conduit/pyproject.toml @@ -1,10 +1,10 @@ [tool.poetry] name = "runway-quickstart-conduit" version = "0.0.0" -description = "Runway Quickstart" authors = [ "Onica Group LLC ", ] +description = "Runway Quickstart" license = "Apache-2.0" [tool.poetry.dependencies] @@ -14,5 +14,5 @@ python = "^3.9" runway = "^2.0" [build-system] -requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" +requires = ["poetry-core>=1.0.0"] diff --git a/quickstarts/conduit/update_env_endpoint.py b/quickstarts/conduit/update_env_endpoint.py index d4e527d30..43fba72fe 100755 --- a/quickstarts/conduit/update_env_endpoint.py +++ b/quickstarts/conduit/update_env_endpoint.py @@ -9,31 +9,23 @@ STACK_PREFIX = "realworld-" -def update_api_endpoint(): +def update_api_endpoint() -> None: """Update app environment file with backend endpoint.""" - environment = ( - subprocess.check_output(["poetry", "run", "runway", "whichenv"]) - .decode() - .strip() - ) - environment_file = os.path.join( - os.path.dirname(os.path.realpath(__file__)), + environment = subprocess.check_output(["poetry", "run", "runway", "whichenv"]).decode().strip() + environment_file = os.path.join( # noqa: PTH118 + os.path.dirname(os.path.realpath(__file__)), # noqa: PTH120 "src", "environments", "environment.prod.ts" if environment == "prod" else "environment.ts", ) cloudformation = boto3.resource("cloudformation") stack = cloudformation.Stack(STACK_PREFIX + environment) - endpoint = [ - i["OutputValue"] for i in stack.outputs if i["OutputKey"] == "ServiceEndpoint" - ][0] + endpoint = next(i["OutputValue"] for i in stack.outputs if i["OutputKey"] == "ServiceEndpoint") - with open(environment_file, "r") as stream: + with open(environment_file) as stream: # noqa: PTH123 content = stream.read() - content = re.sub( - r"api_url: \'.*\'$", f"api_url: '{endpoint}/api'", content, flags=re.M - ) - with open(environment_file, "w") as stream: + content = re.sub(r"api_url: \'.*\'$", f"api_url: '{endpoint}/api'", content, flags=re.MULTILINE) + with open(environment_file, "w") as stream: # noqa: PTH123 stream.write(content) diff --git a/quickstarts/runway/runway-quickstart.yml b/quickstarts/runway/runway-quickstart.yml index 2fff4f7ac..1276ba9fb 100644 --- a/quickstarts/runway/runway-quickstart.yml +++ b/quickstarts/runway/runway-quickstart.yml @@ -10,31 +10,22 @@ Parameters: - Linux KeyPair: - Description: "The existing EC2 KeyPair to be used to access the Runway \ - instance" + Description: "The existing EC2 KeyPair to be used to access the Runway instance" Type: AWS::EC2::KeyPair::KeyName SourceIP: - Description: "The egress (public) IPv4 address from which you plan to \ - access your Runway instance. Hint- https://whatismyip.com . \ - Specify address only, do not include /CIDR designator, \ - example 157.123.231.123" + Description: "The egress (public) IPv4 address from which you plan to access your Runway instance. Hint- https://whatismyip.com . Specify address only, do not include /CIDR designator, example 157.123.231.123" Type: String IamRole: Type: String - Description: "Choose 'auto/admin' to have this CloudFormation template \ - deploy an ADMIN IAM Role for Runway to use to call AWS \ - services. Choose 'manual' to specify an existing IAM Role \ - with more restrictive permissions." + Description: "Choose 'auto/admin' to have this CloudFormation template deploy an ADMIN IAM Role for Runway to use to call AWS services. Choose 'manual' to specify an existing IAM Role with more restrictive permissions." AllowedValues: - auto/admin - manual IamRoleName: - Description: "If you chose 'manual' for IamRole, specify the name of an \ - existing IAM Role here, otherwise leave as the default value \ - of 'none'" + Description: "If you chose 'manual' for IamRole, specify the name of an existing IAM Role here, otherwise leave as the default value of 'none'" Type: String Default: none @@ -209,7 +200,7 @@ Resources: Properties: VpcId: !Ref VPC CidrBlock: 10.0.0.0/24 - AvailabilityZone: !Select ['0', !GetAZs {Ref: 'AWS::Region'}] + AvailabilityZone: !Select ['0', !GetAZs Ref: 'AWS::Region'] PublicRouteTable: Type: AWS::EC2::RouteTable @@ -266,20 +257,17 @@ Resources: AssumeRolePolicyDocument: Version: 2012-10-17 Statement: - - - Effect: Allow + - Effect: Allow Principal: Service: - ec2.amazonaws.com Action: - sts:AssumeRole Policies: - - - PolicyName: RunwayIamRolePolicy + - PolicyName: RunwayIamRolePolicy PolicyDocument: Version: 2012-10-17 Statement: - - - Effect: Allow + - Effect: Allow Action: '*' Resource: '*' diff --git a/runway.file.spec b/runway.file.spec index 3b8b79db0..a02017b88 100644 --- a/runway.file.spec +++ b/runway.file.spec @@ -3,8 +3,6 @@ This file should be considered a python file and linted as such. """ -# pylint: disable=undefined-variable,wrong-import-order,invalid-name -# pylint: disable=wrong-import-position,import-self import os import pkgutil from pkg_resources import get_distribution, get_entry_info @@ -18,7 +16,7 @@ import distutils if getattr(distutils, "distutils_path", "").endswith("__init__.py"): distutils.distutils_path = os.path.dirname(distutils.distutils_path) -CLI_PATH = os.path.join(os.path.dirname(os.path.dirname(workpath)), "runway") # noqa +CLI_PATH = os.path.join(os.path.dirname(os.path.dirname(workpath)), "runway") def get_submodules(package): @@ -45,17 +43,17 @@ def get_submodules(package): ] -def Entrypoint(dist, group, name, **kwargs): # noqa +def Entrypoint(dist, group, name, **kwargs): """Get entrypoint info for packages using setuptools.""" ep = get_entry_info(dist, group, name) # script name must not be a valid module name to avoid name clashes on import - script_path = os.path.join(workpath, name + "-script.py") # noqa: F821 + script_path = os.path.join(workpath, name + "-script.py") print("creating script for entry point", dist, group, name) with open(script_path, "w") as fh: print("import", ep.module_name, file=fh) print("%s.%s()" % (ep.module_name, ".".join(ep.attrs)), file=fh) - return Analysis([script_path] + kwargs.get("scripts", []), **kwargs) # noqa: F821 + return Analysis([script_path] + kwargs.get("scripts", []), **kwargs) # files that are not explicitly imported but consumed at runtime @@ -87,14 +85,14 @@ data_files.append(copy_metadata("runway")[0]) # support scm version hiddenimports = [] # these packages do not have pyinstaller hooks so we need to import # them to collect a list of submodules to include as hidden imports. -import runway # noqa -import troposphere # noqa -import awacs # noqa -import botocore # noqa -import pip # noqa -import wheel # noqa -import yamllint # noqa -import cfnlint # noqa +import runway +import troposphere +import awacs +import botocore +import pip +import wheel +import yamllint +import cfnlint hiddenimports.extend(get_submodules(runway)) hiddenimports.extend(get_submodules(troposphere)) @@ -123,9 +121,9 @@ a = Entrypoint( noarchive=False, binaries=[], ) -pyz = PYZ(a.pure, a.zipped_data, cipher=None) # noqa: F821 +pyz = PYZ(a.pure, a.zipped_data, cipher=None) exe = EXE( - pyz, # noqa: F821 + pyz, a.scripts, a.binaries, a.zipfiles, diff --git a/runway.folder.spec b/runway.folder.spec index 16de8ac5c..1b8ee4c52 100644 --- a/runway.folder.spec +++ b/runway.folder.spec @@ -3,8 +3,6 @@ This file should be considered a python file and linted as such. """ -# pylint: disable=undefined-variable,wrong-import-order,invalid-name -# pylint: disable=wrong-import-position,import-self import os import pkgutil from pkg_resources import get_distribution, get_entry_info @@ -18,7 +16,7 @@ import distutils if getattr(distutils, "distutils_path", "").endswith("__init__.py"): distutils.distutils_path = os.path.dirname(distutils.distutils_path) -CLI_PATH = os.path.join(os.path.dirname(os.path.dirname(workpath)), "runway") # noqa +CLI_PATH = os.path.join(os.path.dirname(os.path.dirname(workpath)), "runway") def get_submodules(package): @@ -45,17 +43,17 @@ def get_submodules(package): ] -def Entrypoint(dist, group, name, **kwargs): # noqa +def Entrypoint(dist, group, name, **kwargs): """Get entrypoint info for packages using setuptools.""" ep = get_entry_info(dist, group, name) # script name must not be a valid module name to avoid name clashes on import - script_path = os.path.join(workpath, name + "-script.py") # noqa: F821 + script_path = os.path.join(workpath, name + "-script.py") print("creating script for entry point", dist, group, name) with open(script_path, "w") as fh: print("import", ep.module_name, file=fh) print("%s.%s()" % (ep.module_name, ".".join(ep.attrs)), file=fh) - return Analysis([script_path] + kwargs.get("scripts", []), **kwargs) # noqa: F821 + return Analysis([script_path] + kwargs.get("scripts", []), **kwargs) # files that are not explicitly imported but consumed at runtime @@ -87,14 +85,14 @@ data_files.append(copy_metadata("runway")[0]) # support scm version hiddenimports = [] # these packages do not have pyinstaller hooks so we need to import # them to collect a list of submodules to include as hidden imports. -import runway # noqa -import troposphere # noqa -import awacs # noqa -import botocore # noqa -import pip # noqa -import wheel # noqa -import yamllint # noqa -import cfnlint # noqa +import runway +import troposphere +import awacs +import botocore +import pip +import wheel +import yamllint +import cfnlint hiddenimports.extend(get_submodules(runway)) hiddenimports.extend(get_submodules(troposphere)) @@ -123,9 +121,9 @@ a = Entrypoint( noarchive=False, binaries=[], ) -pyz = PYZ(a.pure, a.zipped_data, cipher=None) # noqa: F821 +pyz = PYZ(a.pure, a.zipped_data, cipher=None) exe = EXE( - pyz, # noqa: F821 + pyz, a.scripts, [], exclude_binaries=True, @@ -137,7 +135,7 @@ exe = EXE( console=True, ) coll = COLLECT( - exe, # noqa: F821 + exe, a.binaries, a.zipfiles, a.datas, diff --git a/runway/__init__.py b/runway/__init__.py index aeda2c1bb..1a381e765 100644 --- a/runway/__init__.py +++ b/runway/__init__.py @@ -1,18 +1,12 @@ """Set package version.""" import logging -import sys +from importlib.metadata import PackageNotFoundError, version # type: ignore from ._logging import LogLevels, RunwayLogger # noqa: F401 logging.setLoggerClass(RunwayLogger) -if sys.version_info < (3, 8): - # importlib.metadata is standard lib for python>=3.8, use backport - from importlib_metadata import PackageNotFoundError, version # type: ignore -else: - from importlib.metadata import PackageNotFoundError, version # type: ignore - try: __version__ = version(__name__) except PackageNotFoundError: diff --git a/runway/_cli/commands/_deploy.py b/runway/_cli/commands/_deploy.py index 7c20ecde7..3498ab03b 100644 --- a/runway/_cli/commands/_deploy.py +++ b/runway/_cli/commands/_deploy.py @@ -2,7 +2,7 @@ # docs: file://./../../../docs/source/commands.rst import logging -from typing import Any, Tuple +from typing import Any import click from pydantic import ValidationError @@ -23,7 +23,7 @@ @options.tags @options.verbose @click.pass_context -def deploy(ctx: click.Context, debug: bool, tags: Tuple[str, ...], **_: Any) -> None: +def deploy(ctx: click.Context, debug: bool, tags: tuple[str, ...], **_: Any) -> None: """Deploy infrastructure as code. \b diff --git a/runway/_cli/commands/_destroy.py b/runway/_cli/commands/_destroy.py index 8a2a14a8c..ddc8802e1 100644 --- a/runway/_cli/commands/_destroy.py +++ b/runway/_cli/commands/_destroy.py @@ -2,7 +2,7 @@ # docs: file://./../../../docs/source/commands.rst import logging -from typing import Any, Tuple +from typing import Any import click from pydantic import ValidationError @@ -23,7 +23,7 @@ @options.tags @options.verbose @click.pass_context -def destroy(ctx: click.Context, debug: bool, tags: Tuple[str, ...], **_: Any) -> None: +def destroy(ctx: click.Context, debug: bool, tags: tuple[str, ...], **_: Any) -> None: """Destroy infrastructure as code. \b diff --git a/runway/_cli/commands/_envvars.py b/runway/_cli/commands/_envvars.py index ebf939d2f..1b5cda697 100644 --- a/runway/_cli/commands/_envvars.py +++ b/runway/_cli/commands/_envvars.py @@ -4,7 +4,7 @@ import logging import os import platform -from typing import TYPE_CHECKING, Any, Dict, cast +from typing import TYPE_CHECKING, Any, cast import click from pydantic import ValidationError @@ -41,9 +41,7 @@ def envvars(ctx: click.Context, debug: bool, **_: Any) -> None: ctx.obj.env.ci = True LOGGER.verbose("forced Runway to non-interactive mode to suppress prompts") try: - env_vars = Runway( - ctx.obj.runway_config, ctx.obj.get_runway_context() - ).get_env_vars() + env_vars = Runway(ctx.obj.runway_config, ctx.obj.get_runway_context()).get_env_vars() except ValidationError as err: LOGGER.error(err, exc_info=debug) ctx.exit(1) @@ -58,7 +56,7 @@ def envvars(ctx: click.Context, debug: bool, **_: Any) -> None: print_env_vars(env_vars) -def print_env_vars(env_vars: Dict[str, Any]) -> None: +def print_env_vars(env_vars: dict[str, Any]) -> None: """Print environment variables.""" if platform.system() == "Windows": if os.getenv("MSYSTEM", "").startswith("MINGW"): @@ -67,14 +65,14 @@ def print_env_vars(env_vars: Dict[str, Any]) -> None: return __print_env_vars_posix(env_vars) -def __print_env_vars_posix(env_vars: Dict[str, Any]) -> None: +def __print_env_vars_posix(env_vars: dict[str, Any]) -> None: """Print environment variables for bash.""" LOGGER.debug("using posix formatting for environment variable export") for key, val in env_vars.items(): click.echo(f'export {key}="{val}"') -def __print_env_vars_psh(env_vars: Dict[str, Any]) -> None: +def __print_env_vars_psh(env_vars: dict[str, Any]) -> None: """Print environment variables for Powershell.""" LOGGER.debug("using powershell formatting for environment variable export") for key, val in env_vars.items(): diff --git a/runway/_cli/commands/_gen_sample/_k8s_flux_repo.py b/runway/_cli/commands/_gen_sample/_k8s_flux_repo.py index 75d6959fd..3c7f15981 100644 --- a/runway/_cli/commands/_gen_sample/_k8s_flux_repo.py +++ b/runway/_cli/commands/_gen_sample/_k8s_flux_repo.py @@ -42,9 +42,7 @@ def k8s_flux_repo(ctx: click.Context, **_: Any) -> None: copy_sample(ctx, tfstate_src_dir, dest / tfstate_src_dir.parts[-1]) tfstate_templates_dir = dest / "tfstate.cfn/templates" tfstate_templates_dir.mkdir() - write_tfstate_template( - tfstate_templates_dir / "tf_state.yml", bucket_deletion_policy="Delete" - ) + write_tfstate_template(tfstate_templates_dir / "tf_state.yml", bucket_deletion_policy="Delete") LOGGER.success("Sample k8s infrastructure repo created at %s", dest) LOGGER.notice("See the README for setup and deployment instructions.") diff --git a/runway/_cli/commands/_gen_sample/_k8s_tf_repo.py b/runway/_cli/commands/_gen_sample/_k8s_tf_repo.py index 3e9907ee9..c406ed618 100644 --- a/runway/_cli/commands/_gen_sample/_k8s_tf_repo.py +++ b/runway/_cli/commands/_gen_sample/_k8s_tf_repo.py @@ -35,9 +35,7 @@ def k8s_tf_repo(ctx: click.Context, **_: Any) -> None: tfstate_dir = dest / "tfstate.cfn/templates" tfstate_dir.mkdir() - write_tfstate_template( - tfstate_dir / "tf_state.yml", bucket_deletion_policy="Delete" - ) + write_tfstate_template(tfstate_dir / "tf_state.yml", bucket_deletion_policy="Delete") LOGGER.success("Sample k8s infrastructure repo created at %s", dest) LOGGER.notice("See the README for setup and deployment instructions.") diff --git a/runway/_cli/commands/_gen_sample/_tf.py b/runway/_cli/commands/_gen_sample/_tf.py index a6577edac..35129e483 100644 --- a/runway/_cli/commands/_gen_sample/_tf.py +++ b/runway/_cli/commands/_gen_sample/_tf.py @@ -22,7 +22,7 @@ @options.no_color @options.verbose @click.pass_context -def tf(ctx: click.Context, **_: Any) -> None: # pylint: disable=invalid-name +def tf(ctx: click.Context, **_: Any) -> None: """Generate a sample Terraform project.""" src = TEMPLATES / "terraform" dest = Path.cwd() / "sampleapp.tf" diff --git a/runway/_cli/commands/_gen_sample/utils.py b/runway/_cli/commands/_gen_sample/utils.py index fd80fc191..4d5ff87cf 100644 --- a/runway/_cli/commands/_gen_sample/utils.py +++ b/runway/_cli/commands/_gen_sample/utils.py @@ -20,7 +20,7 @@ def convert_gitignore(src: Path) -> Path: """Rename a gitignore template. Keyword Args: - Path object for source file. + src: Path object for source file. Returns: The renamed file if it was created. diff --git a/runway/_cli/commands/_init.py b/runway/_cli/commands/_init.py index a4e08af90..a983cd122 100644 --- a/runway/_cli/commands/_init.py +++ b/runway/_cli/commands/_init.py @@ -2,7 +2,7 @@ # docs: file://./../../../docs/source/commands.rst import logging -from typing import Any, Tuple +from typing import Any import click from pydantic import ValidationError @@ -23,7 +23,7 @@ @options.tags @options.verbose @click.pass_context -def init(ctx: click.Context, debug: bool, tags: Tuple[str, ...], **_: Any) -> None: +def init(ctx: click.Context, debug: bool, tags: tuple[str, ...], **_: Any) -> None: """Run initialization/bootstrap steps. \b diff --git a/runway/_cli/commands/_kbenv/__init__.py b/runway/_cli/commands/_kbenv/__init__.py index 656d10b1f..db30f094f 100644 --- a/runway/_cli/commands/_kbenv/__init__.py +++ b/runway/_cli/commands/_kbenv/__init__.py @@ -1,7 +1,7 @@ """``runway kbenv`` command group.""" # docs: file://./../../../../docs/source/commands.rst -from typing import Any, List +from typing import Any import click @@ -13,7 +13,7 @@ __all__ = ["install", "list_installed", "run", "uninstall"] -COMMANDS: List[click.Command] = [install, list_installed, run, uninstall] +COMMANDS: list[click.Command] = [install, list_installed, run, uninstall] @click.group("kbenv", short_help="kubectl (install|run)") diff --git a/runway/_cli/commands/_kbenv/_list.py b/runway/_cli/commands/_kbenv/_list.py index 78abc9d8e..0d2478e0b 100644 --- a/runway/_cli/commands/_kbenv/_list.py +++ b/runway/_cli/commands/_kbenv/_list.py @@ -26,6 +26,4 @@ def list_installed(**_: Any) -> None: LOGGER.info("kubectl versions installed:") click.echo("\n".join(v.name for v in versions)) else: - LOGGER.warning( - "no versions of kubectl installed at path %s", kbenv.versions_dir - ) + LOGGER.warning("no versions of kubectl installed at path %s", kbenv.versions_dir) diff --git a/runway/_cli/commands/_kbenv/_run.py b/runway/_cli/commands/_kbenv/_run.py index c5ea3e4dc..8b01fc9fa 100644 --- a/runway/_cli/commands/_kbenv/_run.py +++ b/runway/_cli/commands/_kbenv/_run.py @@ -3,7 +3,7 @@ # docs: file://./../../../../docs/source/commands.rst import logging import subprocess -from typing import Any, Tuple +from typing import Any import click @@ -13,15 +13,13 @@ LOGGER = logging.getLogger(__name__.replace("._", ".")) -@click.command( - "run", short_help="run kubectl", context_settings={"ignore_unknown_options": True} -) +@click.command("run", short_help="run kubectl", context_settings={"ignore_unknown_options": True}) @click.argument("args", metavar="", nargs=-1, required=True) @options.debug @options.no_color @options.verbose @click.pass_context -def run(ctx: click.Context, args: Tuple[str, ...], **_: Any) -> None: +def run(ctx: click.Context, args: tuple[str, ...], **_: Any) -> None: """Run a kubectl command. Uses the version of kubectl specified in the ".kubectl-version" file @@ -31,4 +29,4 @@ def run(ctx: click.Context, args: Tuple[str, ...], **_: Any) -> None: before the kubectl command. """ - ctx.exit(subprocess.call([KBEnvManager().install()] + list(args))) + ctx.exit(subprocess.call([KBEnvManager().install(), *list(args)])) diff --git a/runway/_cli/commands/_kbenv/_uninstall.py b/runway/_cli/commands/_kbenv/_uninstall.py index 5e76b1c0a..08a05c7b7 100644 --- a/runway/_cli/commands/_kbenv/_uninstall.py +++ b/runway/_cli/commands/_kbenv/_uninstall.py @@ -1,8 +1,10 @@ """Uninstall kubectl version(s) that were installed by Runway and/or kbenv.""" # docs: file://./../../../../docs/source/commands.rst +from __future__ import annotations + import logging -from typing import TYPE_CHECKING, Any, Optional, cast +from typing import TYPE_CHECKING, Any, cast import click @@ -33,7 +35,7 @@ def uninstall( ctx: click.Context, *, - version: Optional[str] = None, + version: str | None = None, all_versions: bool = False, **_: Any, ) -> None: @@ -45,10 +47,7 @@ def uninstall( """ kbenv = KBEnvManager() version = version or (str(kbenv.version) if kbenv.version else None) - if version: - version_tuple = KBEnvManager.parse_version_string(version) - else: - version_tuple = kbenv.version + version_tuple = KBEnvManager.parse_version_string(version) if version else kbenv.version if version_tuple and not all_versions: if not kbenv.uninstall(version_tuple): ctx.exit(1) diff --git a/runway/_cli/commands/_new.py b/runway/_cli/commands/_new.py index 180d183a5..e09aa4c1c 100644 --- a/runway/_cli/commands/_new.py +++ b/runway/_cli/commands/_new.py @@ -37,14 +37,10 @@ def new(ctx: click.Context, **_: Any) -> None: LOGGER.verbose("checking for preexisting runway.yml file...") if runway_yml.is_file(): - LOGGER.error( - "There is already a %s file in the current directory", runway_yml.name - ) + LOGGER.error("There is already a %s file in the current directory", runway_yml.name) ctx.exit(1) - runway_yml.write_text( - RUNWAY_YML, encoding=locale.getpreferredencoding(do_setlocale=False) - ) + runway_yml.write_text(RUNWAY_YML, encoding=locale.getpreferredencoding(do_setlocale=False)) LOGGER.success("runway.yml generated") LOGGER.notice( "See addition getting started information at " diff --git a/runway/_cli/commands/_plan.py b/runway/_cli/commands/_plan.py index ff9c10f2a..b78fd50c0 100644 --- a/runway/_cli/commands/_plan.py +++ b/runway/_cli/commands/_plan.py @@ -2,7 +2,7 @@ # docs: file://./../../../docs/source/commands.rst import logging -from typing import Any, Tuple +from typing import Any import click from pydantic import ValidationError @@ -23,7 +23,7 @@ @options.tags @options.verbose @click.pass_context -def plan(ctx: click.Context, debug: bool, tags: Tuple[str, ...], **_: Any) -> None: +def plan(ctx: click.Context, debug: bool, tags: tuple[str, ...], **_: Any) -> None: """Determine what infrastructure changes will occur during the next deploy. \b diff --git a/runway/_cli/commands/_run_python.py b/runway/_cli/commands/_run_python.py index 336a1b2e0..ff3c91abb 100644 --- a/runway/_cli/commands/_run_python.py +++ b/runway/_cli/commands/_run_python.py @@ -33,10 +33,8 @@ def run_python(filename: str, **_: Any) -> None: execglobals = globals().copy() # override name & file so script operates as if it were invoked directly execglobals.update({"__name__": "__main__", "__file__": filename}) - exec( # pylint: disable=exec-used - Path(filename).read_text( - encoding=locale.getpreferredencoding(do_setlocale=False) - ), + exec( # noqa: S102 + Path(filename).read_text(encoding=locale.getpreferredencoding(do_setlocale=False)), execglobals, execglobals, ) diff --git a/runway/_cli/commands/_tfenv/_install.py b/runway/_cli/commands/_tfenv/_install.py index 4bfa49064..ffc38c774 100644 --- a/runway/_cli/commands/_tfenv/_install.py +++ b/runway/_cli/commands/_tfenv/_install.py @@ -1,8 +1,10 @@ """Install a version of Terraform.""" # docs: file://./../../../../docs/source/commands.rst +from __future__ import annotations + import logging -from typing import Any, Optional +from typing import Any import click @@ -19,7 +21,7 @@ @options.no_color @options.verbose @click.pass_context -def install(ctx: click.Context, version: Optional[str] = None, **_: Any) -> None: +def install(ctx: click.Context, version: str | None = None, **_: Any) -> None: """Install the specified of Terraform (e.g. 0.12.0). If no version is specified, Runway will attempt to find and read a @@ -28,13 +30,11 @@ def install(ctx: click.Context, version: Optional[str] = None, **_: Any) -> None """ try: - LOGGER.debug( - "terraform path: %s", TFEnvManager().install(version_requested=version) - ) + LOGGER.debug("terraform path: %s", TFEnvManager().install(version_requested=version)) except ValueError as err: LOGGER.debug("terraform install failed", exc_info=True) if "unable to find" not in str(err): - LOGGER.error( + LOGGER.error( # noqa: G201 "unexpected error encountered when trying to install Terraform", exc_info=True, ) diff --git a/runway/_cli/commands/_tfenv/_list.py b/runway/_cli/commands/_tfenv/_list.py index a9a46685c..e54a41b5d 100644 --- a/runway/_cli/commands/_tfenv/_list.py +++ b/runway/_cli/commands/_tfenv/_list.py @@ -26,6 +26,4 @@ def list_installed(**_: Any) -> None: LOGGER.info("Terraform versions installed:") click.echo("\n".join(v.name for v in versions)) else: - LOGGER.warning( - "no versions of Terraform installed at path %s", tfenv.versions_dir - ) + LOGGER.warning("no versions of Terraform installed at path %s", tfenv.versions_dir) diff --git a/runway/_cli/commands/_tfenv/_run.py b/runway/_cli/commands/_tfenv/_run.py index 31465c776..031f15602 100644 --- a/runway/_cli/commands/_tfenv/_run.py +++ b/runway/_cli/commands/_tfenv/_run.py @@ -3,7 +3,7 @@ # docs: file://./../../../../docs/source/commands.rst import logging import subprocess -from typing import Any, Tuple +from typing import Any import click @@ -14,15 +14,13 @@ LOGGER = logging.getLogger(__name__.replace("._", ".")) -@click.command( - "run", short_help="run terraform", context_settings={"ignore_unknown_options": True} -) +@click.command("run", short_help="run terraform", context_settings={"ignore_unknown_options": True}) @click.argument("args", metavar="", nargs=-1, required=True) @options.debug @options.no_color @options.verbose @click.pass_context -def run(ctx: click.Context, args: Tuple[str, ...], **_: Any) -> None: +def run(ctx: click.Context, args: tuple[str, ...], **_: Any) -> None: """Run a Terraform command. Uses the version of Terraform specified in the ".terraform-version" file @@ -33,11 +31,11 @@ def run(ctx: click.Context, args: Tuple[str, ...], **_: Any) -> None: """ try: - ctx.exit(subprocess.call([TFEnvManager().install()] + list(args))) + ctx.exit(subprocess.call([TFEnvManager().install(), *list(args)])) except ValueError as err: LOGGER.debug("terraform install failed", exc_info=True) if "unable to find" not in str(err): - LOGGER.error( + LOGGER.error( # noqa: G201 "unexpected error encountered when trying to install Terraform", exc_info=True, ) diff --git a/runway/_cli/logs.py b/runway/_cli/logs.py index 9abf1b8f1..93b49474c 100644 --- a/runway/_cli/logs.py +++ b/runway/_cli/logs.py @@ -2,7 +2,7 @@ import logging import os -from typing import Any, Dict +from typing import Any import coloredlogs @@ -15,7 +15,7 @@ LOG_FORMAT = "[runway] %(message)s" LOG_FORMAT_VERBOSE = logging.BASIC_FORMAT -LOG_FIELD_STYLES: Dict[str, Dict[str, Any]] = { +LOG_FIELD_STYLES: dict[str, dict[str, Any]] = { "asctime": {}, "hostname": {}, "levelname": {}, @@ -24,7 +24,7 @@ "prefix": {}, "programname": {}, } -LOG_LEVEL_STYLES: Dict[str, Dict[str, Any]] = { +LOG_LEVEL_STYLES: dict[str, dict[str, Any]] = { "critical": {"color": "red", "bold": True}, "debug": {"color": "green"}, "error": {"color": "red"}, @@ -46,9 +46,7 @@ class LogSettings: "level_styles": os.getenv("RUNWAY_LOG_LEVEL_STYLES"), } - def __init__( - self, *, debug: int = 0, no_color: bool = False, verbose: bool = False - ): + def __init__(self, *, debug: int = 0, no_color: bool = False, verbose: bool = False) -> None: """Instantiate class. Args: @@ -62,7 +60,7 @@ def __init__( self.verbose = verbose @property - def coloredlogs(self) -> Dict[str, Any]: + def coloredlogs(self) -> dict[str, Any]: """Return settings for coloredlogs.""" return { "fmt": self.fmt, @@ -85,7 +83,7 @@ def fmt(self) -> str: return LOG_FORMAT @cached_property - def field_styles(self) -> Dict[str, Any]: + def field_styles(self) -> dict[str, Any]: """Return log field styles. If "RUNWAY_LOG_FIELD_STYLES" exists in the environment, it will be @@ -98,14 +96,12 @@ def field_styles(self) -> Dict[str, Any]: result = LOG_FIELD_STYLES.copy() if self.ENV["field_styles"]: result.update( - coloredlogs.parse_encoded_styles( # type: ignore - self.ENV["field_styles"] - ) + coloredlogs.parse_encoded_styles(self.ENV["field_styles"]) # type: ignore ) return result @cached_property - def level_styles(self) -> Dict[str, Any]: + def level_styles(self) -> dict[str, Any]: """Return log level styles. If "RUNWAY_LOG_LEVEL_STYLES" exists in the environment, it will be @@ -118,9 +114,7 @@ def level_styles(self) -> Dict[str, Any]: result = LOG_LEVEL_STYLES.copy() if self.ENV["level_styles"]: result.update( - coloredlogs.parse_encoded_styles( # type: ignore - self.ENV["level_styles"] - ) + coloredlogs.parse_encoded_styles(self.ENV["level_styles"]) # type: ignore ) return result @@ -134,9 +128,7 @@ def log_level(self) -> LogLevels: return LogLevels.INFO -def setup_logging( - *, debug: int = 0, no_color: bool = False, verbose: bool = False -) -> None: +def setup_logging(*, debug: int = 0, no_color: bool = False, verbose: bool = False) -> None: """Configure log settings for Runway CLI. Keyword Args: diff --git a/runway/_cli/main.py b/runway/_cli/main.py index c6ef0dec1..0250008b3 100644 --- a/runway/_cli/main.py +++ b/runway/_cli/main.py @@ -3,7 +3,7 @@ import argparse import logging import os -from typing import Any, Dict +from typing import Any import click @@ -15,7 +15,7 @@ LOGGER = logging.getLogger("runway.cli") -CLICK_CONTEXT_SETTINGS: Dict[str, Any] = { +CLICK_CONTEXT_SETTINGS: dict[str, Any] = { "help_option_names": ["-h", "--help"], "max_content_width": 999, } @@ -34,7 +34,7 @@ def invoke(self, ctx: click.Context) -> Any: return super().invoke(ctx) @staticmethod - def __parse_global_options(ctx: click.Context) -> Dict[str, Any]: + def __parse_global_options(ctx: click.Context) -> dict[str, Any]: """Parse global options. These options are passed to subcommands but, should be parsed by the @@ -44,20 +44,14 @@ def __parse_global_options(ctx: click.Context) -> Dict[str, Any]: """ parser = argparse.ArgumentParser(add_help=False) parser.add_argument("--ci", action="store_true", default=bool(os.getenv("CI"))) - parser.add_argument( - "--debug", default=int(os.getenv("DEBUG", "0")), action="count" - ) - parser.add_argument( - "-e", "--deploy-environment", default=os.getenv("DEPLOY_ENVIRONMENT") - ) + parser.add_argument("--debug", default=int(os.getenv("DEBUG", "0")), action="count") + parser.add_argument("-e", "--deploy-environment", default=os.getenv("DEPLOY_ENVIRONMENT")) parser.add_argument( "--no-color", action="store_true", default=bool(os.getenv("RUNWAY_NO_COLOR")), ) - parser.add_argument( - "--verbose", action="store_true", default=bool(os.getenv("VERBOSE")) - ) + parser.add_argument("--verbose", action="store_true", default=bool(os.getenv("VERBOSE"))) args, _ = parser.parse_known_args(list(ctx.args)) return vars(args) @@ -75,9 +69,7 @@ def cli(ctx: click.Context, **_: Any) -> None: """ opts = ctx.meta["global.options"] - setup_logging( - debug=opts["debug"], no_color=opts["no_color"], verbose=opts["verbose"] - ) + setup_logging(debug=opts["debug"], no_color=opts["no_color"], verbose=opts["verbose"]) ctx.obj = CliContext(**opts) diff --git a/runway/_cli/options.py b/runway/_cli/options.py index 463ca6630..2844fa4f6 100644 --- a/runway/_cli/options.py +++ b/runway/_cli/options.py @@ -14,8 +14,7 @@ "--debug", count=True, envvar="DEBUG", - help="Supply once to display Runway debug logs. " - "Supply twice to display all debug logs.", + help="Supply once to display Runway debug logs. Supply twice to display all debug logs.", ) deploy_environment = click.option( diff --git a/runway/_cli/utils.py b/runway/_cli/utils.py index be895ed40..ca6f4ccce 100644 --- a/runway/_cli/utils.py +++ b/runway/_cli/utils.py @@ -6,21 +6,25 @@ import os import sys from pathlib import Path -from typing import Any, Iterator, List, Optional, Tuple +from typing import TYPE_CHECKING, Any import click import yaml from ..compat import cached_property from ..config import RunwayConfig -from ..config.components.runway import ( - RunwayDeploymentDefinition, - RunwayModuleDefinition, -) from ..context import RunwayContext from ..core.components import DeployEnvironment from ..exceptions import ConfigNotFound +if TYPE_CHECKING: + from collections.abc import Iterator + + from ..config.components.runway import ( + RunwayDeploymentDefinition, + RunwayModuleDefinition, + ) + LOGGER = logging.getLogger(__name__) @@ -32,7 +36,7 @@ def __init__( *, ci: bool = False, debug: int = 0, - deploy_environment: Optional[str] = None, + deploy_environment: str | None = None, verbose: bool = False, **_: Any, ) -> None: @@ -95,7 +99,7 @@ def runway_config_path(self) -> Path: sys.exit(1) def get_runway_context( - self, deploy_environment: Optional[DeployEnvironment] = None + self, deploy_environment: DeployEnvironment | None = None ) -> RunwayContext: """Get a Runway context object. @@ -104,7 +108,7 @@ def get_runway_context( Args: deploy_environment: Object representing the current deploy environment. - Returns + Returns: RunwayContext """ @@ -168,9 +172,9 @@ def __str__(self) -> str: def select_deployments( ctx: click.Context, - deployments: List[RunwayDeploymentDefinition], - tags: Optional[Tuple[str, ...]] = None, -) -> List[RunwayDeploymentDefinition]: + deployments: list[RunwayDeploymentDefinition], + tags: tuple[str, ...] | None = None, +) -> list[RunwayDeploymentDefinition]: """Select which deployments to run. Uses tags, interactive prompts, or selects all. @@ -178,6 +182,7 @@ def select_deployments( Args: ctx: Current click context. deployments: List of deployment(s) to choose from. + tags: Deployment tags to filter. Returns: Selected deployment(s). @@ -192,9 +197,7 @@ def select_deployments( LOGGER.debug("only one deployment detected; no selection necessary") else: # build the menu before displaying it so debug logs don't break up what is printed - deployment_menu = yaml.safe_dump( - {i + 1: d.menu_entry for i, d in enumerate(deployments)} - ) + deployment_menu = yaml.safe_dump({i + 1: d.menu_entry for i, d in enumerate(deployments)}) click.secho("\nConfigured deployments\n", bold=True, underline=True) click.echo(deployment_menu) if ctx.command.name == "destroy": @@ -206,9 +209,7 @@ def select_deployments( 'Enter number of deployment to run (or "all")', default="all", show_choices=False, - type=click.Choice( - [str(n) for n in range(1, len(deployments) + 1)] + ["all"] - ), + type=click.Choice([str(n) for n in range(1, len(deployments) + 1)] + ["all"]), ) if choice != "all": deployments = [deployments[int(choice) - 1]] @@ -217,8 +218,8 @@ def select_deployments( def select_modules( - ctx: click.Context, modules: List[RunwayModuleDefinition] -) -> List[RunwayModuleDefinition]: + ctx: click.Context, modules: list[RunwayModuleDefinition] +) -> list[RunwayModuleDefinition]: """Interactively select which modules to run. Args: @@ -233,8 +234,7 @@ def select_modules( LOGGER.debug("only one module detected; no selection necessary") if ctx.command.name == "destroy": LOGGER.info( - "Only one module detected; all modules " - "automatically selected for deletion." + "Only one module detected; all modules automatically selected for deletion." ) if not click.confirm("Proceed?"): ctx.exit(0) @@ -243,8 +243,7 @@ def select_modules( click.echo(yaml.safe_dump({i + 1: m.menu_entry for i, m in enumerate(modules)})) if ctx.command.name == "destroy": click.echo( - '(operating in destroy mode -- "all" will destroy all ' - "modules in reverse order)\n" + '(operating in destroy mode -- "all" will destroy all modules in reverse order)\n' ) choice = click.prompt( 'Enter number of module to run (or "all")', @@ -263,9 +262,9 @@ def select_modules( def select_modules_using_tags( ctx: click.Context, - deployments: List[RunwayDeploymentDefinition], - tags: Tuple[str, ...], -) -> List[RunwayDeploymentDefinition]: + deployments: list[RunwayDeploymentDefinition], + tags: tuple[str, ...], +) -> list[RunwayDeploymentDefinition]: """Select modules to run using tags. Args: @@ -277,9 +276,9 @@ def select_modules_using_tags( List of selected deployments with selected modules. """ - deployments_to_run: List[RunwayDeploymentDefinition] = [] + deployments_to_run: list[RunwayDeploymentDefinition] = [] for deployment in deployments: - modules_to_run: List[RunwayModuleDefinition] = [] + modules_to_run: list[RunwayModuleDefinition] = [] for module in deployment.modules: if module.child_modules: module.child_modules = [ diff --git a/runway/_logging.py b/runway/_logging.py index b80df2b67..15ea7592f 100644 --- a/runway/_logging.py +++ b/runway/_logging.py @@ -1,8 +1,13 @@ """Runway logging.""" +from __future__ import annotations + import logging from enum import IntEnum -from typing import Any, MutableMapping, Tuple, Union +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from collections.abc import MutableMapping class LogLevels(IntEnum): @@ -21,7 +26,7 @@ class LogLevels(IntEnum): @classmethod def has_value(cls, value: int) -> bool: """Check if IntEnum has a value.""" - return value in cls._value2member_map_ # pylint: disable=no-member + return value in cls._value2member_map_ # Issue with this version of LoggerAdapter https://github.com/python/typeshed/issues/7855 @@ -54,18 +59,20 @@ def __init__( self.prefix = prefix self.prefix_template = prefix_template - def notice(self, msg: Union[Exception, str], *args: Any, **kwargs: Any) -> None: + def notice(self, msg: Exception | str, *args: Any, **kwargs: Any) -> None: """Delegate a notice call to the underlying logger. Args: msg: String template or exception to use for the log record. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.log(LogLevels.NOTICE, msg, *args, **kwargs) def process( - self, msg: Union[Exception, str], kwargs: MutableMapping[str, Any] - ) -> Tuple[str, MutableMapping[str, Any]]: + self, msg: Exception | str, kwargs: MutableMapping[str, Any] + ) -> tuple[str, MutableMapping[str, Any]]: """Process the message to append the prefix. Args: @@ -75,7 +82,7 @@ def process( """ return self.prefix_template.format(prefix=self.prefix, msg=msg), kwargs - def setLevel(self, level: Union[int, str]) -> None: # noqa + def setLevel(self, level: int | str) -> None: # noqa: N802 """Set the specified level on the underlying logger. Python 2 backport. @@ -83,20 +90,24 @@ def setLevel(self, level: Union[int, str]) -> None: # noqa """ self.logger.setLevel(level) - def success(self, msg: Union[Exception, str], *args: Any, **kwargs: Any) -> None: + def success(self, msg: Exception | str, *args: Any, **kwargs: Any) -> None: """Delegate a success call to the underlying logger. Args: msg: String template or exception to use for the log record. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.log(LogLevels.SUCCESS, msg, *args, **kwargs) - def verbose(self, msg: Union[Exception, str], *args: Any, **kwargs: Any) -> None: + def verbose(self, msg: Exception | str, *args: Any, **kwargs: Any) -> None: """Delegate a verbose call to the underlying logger. Args: msg: String template or exception to use for the log record. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.log(LogLevels.VERBOSE, msg, *args, **kwargs) @@ -105,7 +116,7 @@ def verbose(self, msg: Union[Exception, str], *args: Any, **kwargs: Any) -> None class RunwayLogger(logging.Logger): """Extend built-in logger with additional levels.""" - def __init__(self, name: str, level: Union[int, str] = logging.NOTSET) -> None: + def __init__(self, name: str, level: int | str = logging.NOTSET) -> None: """Instantiate the class. Args: @@ -118,31 +129,37 @@ def __init__(self, name: str, level: Union[int, str] = logging.NOTSET) -> None: logging.addLevelName(LogLevels.NOTICE, LogLevels.NOTICE.name) logging.addLevelName(LogLevels.SUCCESS, LogLevels.SUCCESS.name) - def notice(self, msg: Union[Exception, str], *args: Any, **kwargs: Any) -> None: + def notice(self, msg: Exception | str, *args: Any, **kwargs: Any) -> None: """Log 'msg % args' with severity `NOTICE`. Args: msg: String template or exception to use for the log record. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ if self.isEnabledFor(LogLevels.NOTICE): self._log(LogLevels.NOTICE, msg, args, **kwargs) - def success(self, msg: Union[Exception, str], *args: Any, **kwargs: Any) -> None: + def success(self, msg: Exception | str, *args: Any, **kwargs: Any) -> None: """Log 'msg % args' with severity `SUCCESS`. Args: msg: String template or exception to use for the log record. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ if self.isEnabledFor(LogLevels.SUCCESS): self._log(LogLevels.SUCCESS, msg, args, **kwargs) - def verbose(self, msg: Union[Exception, str], *args: Any, **kwargs: Any) -> None: + def verbose(self, msg: Exception | str, *args: Any, **kwargs: Any) -> None: """Log 'msg % args' with severity `VERBOSE`. Args: msg: String template or exception to use for the log record. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ if self.isEnabledFor(LogLevels.VERBOSE): diff --git a/runway/aws_sso_botocore/credentials.py b/runway/aws_sso_botocore/credentials.py index e842a9767..ee532ed4d 100644 --- a/runway/aws_sso_botocore/credentials.py +++ b/runway/aws_sso_botocore/credentials.py @@ -248,7 +248,6 @@ class SSOProvider(CredentialProvider): "sso_account_id", ] - # pylint: disable=super-init-not-called def __init__( self, load_config, client_creator, profile_name, cache=None, token_cache=None ): diff --git a/runway/blueprints/k8s/k8s_iam.py b/runway/blueprints/k8s/k8s_iam.py index 75c33443d..57397dd71 100755 --- a/runway/blueprints/k8s/k8s_iam.py +++ b/runway/blueprints/k8s/k8s_iam.py @@ -52,9 +52,7 @@ def create_template(self) -> None: ) nodeinstanceprofile = template.add_resource( - iam.InstanceProfile( - "NodeInstanceProfile", Path="/", Roles=[nodeinstancerole.ref()] - ) + iam.InstanceProfile("NodeInstanceProfile", Path="/", Roles=[nodeinstancerole.ref()]) ) template.add_output( Output( @@ -105,6 +103,4 @@ def create_template(self) -> None: if __name__ == "__main__": from runway.context import CfnginContext - print( # noqa: T201 - Iam("test", CfnginContext(parameters={"namespace": "test"})).to_json() - ) + print(Iam("test", CfnginContext(parameters={"namespace": "test"})).to_json()) # noqa: T201 diff --git a/runway/blueprints/k8s/k8s_master.py b/runway/blueprints/k8s/k8s_master.py index d253f2457..7fc8c7318 100755 --- a/runway/blueprints/k8s/k8s_master.py +++ b/runway/blueprints/k8s/k8s_master.py @@ -159,6 +159,4 @@ def create_template(self) -> None: if __name__ == "__main__": from runway.context import CfnginContext - print( # noqa: T201 - Cluster("test", CfnginContext(parameters={"namespace": "test"})).to_json() - ) + print(Cluster("test", CfnginContext(parameters={"namespace": "test"})).to_json()) # noqa: T201 diff --git a/runway/blueprints/k8s/k8s_workers.py b/runway/blueprints/k8s/k8s_workers.py index 8181b5749..18caa7c55 100755 --- a/runway/blueprints/k8s/k8s_workers.py +++ b/runway/blueprints/k8s/k8s_workers.py @@ -22,18 +22,18 @@ def get_valid_instance_types() -> Any: """Return list of instance types from either a JSON or gzipped JSON file.""" - base_path = os.path.join( - os.path.dirname(botocore.__file__), "data", "ec2", "2016-11-15" + base_path = os.path.join( # noqa: PTH118 + os.path.dirname(botocore.__file__), "data", "ec2", "2016-11-15" # noqa: PTH120 ) - json_path = os.path.join(base_path, "service-2.json") - gzip_path = os.path.join(base_path, "service-2.json.gz") + json_path = os.path.join(base_path, "service-2.json") # noqa: PTH118 + gzip_path = os.path.join(base_path, "service-2.json.gz") # noqa: PTH118 - if os.path.exists(gzip_path): + if os.path.exists(gzip_path): # noqa: PTH110 with gzip.open(gzip_path, "rt", encoding="utf-8") as stream: data = json.load(stream) - elif os.path.exists(json_path): - with open(json_path, "r", encoding="utf-8") as stream: + elif os.path.exists(json_path): # noqa: PTH110 + with open(json_path, encoding="utf-8") as stream: # noqa: PTH123 data = json.load(stream) else: raise FileNotFoundError("Neither JSON nor gzipped JSON file found.") @@ -47,8 +47,7 @@ class NodeGroup(Blueprint): VARIABLES = { "KeyName": { "type": CFNString, # string to allow it to be unset - "description": "(Optional) EC2 Key Pair to allow SSH " - "access to the instances", + "description": "(Optional) EC2 Key Pair to allow SSH access to the instances", "default": "", }, "NodeImageId": { @@ -57,10 +56,10 @@ class NodeGroup(Blueprint): }, "NodeInstanceType": { "type": CFNString, - "description": "EC2 instance type for the node " "instances", + "description": "EC2 instance type for the node instances", "default": "t2.medium", "allowed_values": get_valid_instance_types(), - "constraint_description": "Must be a valid EC2 " "instance type", + "constraint_description": "Must be a valid EC2 instance type", }, "NodeInstanceProfile": { "type": CFNString, @@ -68,12 +67,12 @@ class NodeGroup(Blueprint): }, "NodeAutoScalingGroupMinSize": { "type": CFNNumber, - "description": "Minimum size of Node " "Group ASG.", + "description": "Minimum size of Node Group ASG.", "default": 1, }, "NodeAutoScalingGroupMaxSize": { "type": CFNNumber, - "description": "Maximum size of Node " "Group ASG.", + "description": "Maximum size of Node Group ASG.", "default": 3, }, "NodeVolumeSize": { @@ -98,16 +97,16 @@ class NodeGroup(Blueprint): }, "NodeGroupName": { "type": CFNString, - "description": "Unique identifier for the Node " "Group.", + "description": "Unique identifier for the Node Group.", }, "ClusterControlPlaneSecurityGroup": { "type": EC2SecurityGroupId, - "description": "The security " "group of the " "cluster control " "plane.", + "description": "The security group of the cluster control plane.", }, "VpcId": {"type": EC2VPCId, "description": "The VPC of the worker instances"}, "Subnets": { "type": EC2SubnetIdList, - "description": "The subnets where workers can be " "created.", + "description": "The subnets where workers can be created.", }, "UseDesiredInstanceCount": { "type": CFNString, @@ -120,8 +119,7 @@ def create_template(self) -> None: template = self.template template.set_version("2010-09-09") template.set_description( - "Kubernetes workers via EKS - V1.0.0 " - "- compatible with amazon-eks-node-v23+" + "Kubernetes workers via EKS - V1.0.0 - compatible with amazon-eks-node-v23+" ) # Metadata @@ -159,9 +157,7 @@ def create_template(self) -> None: }, { "Label": {"default": "Worker Network Configuration"}, - "Parameters": [ - self.variables[i].name for i in ["VpcId", "Subnets"] - ], + "Parameters": [self.variables[i].name for i in ["VpcId", "Subnets"]], }, ] } @@ -173,9 +169,7 @@ def create_template(self) -> None: "DesiredInstanceCountSpecified", Equals(self.variables["UseDesiredInstanceCount"].ref, "true"), ) - template.add_condition( - "KeyNameSpecified", Not(Equals(self.variables["KeyName"].ref, "")) - ) + template.add_condition("KeyNameSpecified", Not(Equals(self.variables["KeyName"].ref, ""))) # Resources nodesecuritygroup = template.add_resource( @@ -215,9 +209,7 @@ def create_template(self) -> None: Description="Allow worker Kubelets and pods to receive " "communication from the cluster control plane", GroupId=nodesecuritygroup.ref(), - SourceSecurityGroupId=self.variables[ - "ClusterControlPlaneSecurityGroup" - ].ref, + SourceSecurityGroupId=self.variables["ClusterControlPlaneSecurityGroup"].ref, IpProtocol="tcp", FromPort=1025, ToPort=65535, @@ -242,9 +234,7 @@ def create_template(self) -> None: "443 to receive communication from cluster " "control plane", GroupId=nodesecuritygroup.ref(), - SourceSecurityGroupId=self.variables[ - "ClusterControlPlaneSecurityGroup" - ].ref, # noqa + SourceSecurityGroupId=self.variables["ClusterControlPlaneSecurityGroup"].ref, IpProtocol="tcp", FromPort=443, ToPort=443, @@ -266,7 +256,7 @@ def create_template(self) -> None: template.add_resource( ec2.SecurityGroupIngress( "ClusterControlPlaneSecurityGroupIngress", - Description="Allow pods to communicate with the cluster API " "Server", + Description="Allow pods to communicate with the cluster API Server", GroupId=self.variables["ClusterControlPlaneSecurityGroup"].ref, SourceSecurityGroupId=nodesecuritygroup.ref(), IpProtocol="tcp", @@ -294,9 +284,7 @@ def create_template(self) -> None: ), ImageId=self.variables["NodeImageId"].ref, InstanceType=self.variables["NodeInstanceType"].ref, - KeyName=If( - "KeyNameSpecified", self.variables["KeyName"].ref, NoValue - ), + KeyName=If("KeyNameSpecified", self.variables["KeyName"].ref, NoValue), MetadataOptions=ec2.MetadataOptions( HttpPutResponseHopLimit=2, HttpEndpoint="enabled", @@ -305,7 +293,7 @@ def create_template(self) -> None: SecurityGroupIds=[nodesecuritygroup.ref()], UserData=Base64( Sub( - "\n".join( + "\n".join( # noqa: FLY002 [ "#!/bin/bash", "set -o xtrace", @@ -342,12 +330,8 @@ def create_template(self) -> None: MinSize=self.variables["NodeAutoScalingGroupMinSize"].ref, MaxSize=self.variables["NodeAutoScalingGroupMaxSize"].ref, Tags=[ - autoscaling.Tag( - "Name", Sub("${ClusterName}-${NodeGroupName}-Node"), True - ), - autoscaling.Tag( - Sub("kubernetes.io/cluster/${ClusterName}"), "owned", True - ), + autoscaling.Tag("Name", Sub("${ClusterName}-${NodeGroupName}-Node"), True), + autoscaling.Tag(Sub("kubernetes.io/cluster/${ClusterName}"), "owned", True), ], VPCZoneIdentifier=self.variables["Subnets"].ref, UpdatePolicy=UpdatePolicy( diff --git a/runway/blueprints/staticsite/auth_at_edge.py b/runway/blueprints/staticsite/auth_at_edge.py index 04ed244b6..1e7bbeb36 100644 --- a/runway/blueprints/staticsite/auth_at_edge.py +++ b/runway/blueprints/staticsite/auth_at_edge.py @@ -8,7 +8,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, ClassVar, Dict, List, Optional +from typing import TYPE_CHECKING, Any, ClassVar, Optional import awacs.logs import awacs.s3 @@ -27,7 +27,7 @@ class AuthAtEdge(StaticSite): """Auth@Edge Blueprint.""" - AUTH_VARIABLES: Dict[str, BlueprintVariableTypeDef] = { + AUTH_VARIABLES: dict[str, BlueprintVariableTypeDef] = { "OAuthScopes": {"type": list, "default": [], "description": "OAuth2 Scopes"}, "PriceClass": { "type": str, @@ -44,8 +44,7 @@ class AuthAtEdge(StaticSite): "RedirectPathAuthRefresh": { "type": str, "default": "/refreshauth", - "description": "The URL path that should " - "handle the JWT refresh request.", + "description": "The URL path that should handle the JWT refresh request.", }, "NonSPAMode": { "type": bool, @@ -59,13 +58,13 @@ class AuthAtEdge(StaticSite): }, } IAM_ARN_PREFIX = "arn:aws:iam::aws:policy/service-role/" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = {} + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = {} def __init__( self, name: str, context: CfnginContext, - mappings: Optional[Dict[str, Dict[str, Any]]] = None, + mappings: Optional[dict[str, dict[str, Any]]] = None, description: Optional[str] = None, ) -> None: """Initialize the Blueprint. @@ -77,9 +76,7 @@ def __init__( description: Used to describe the resulting CloudFormation template. """ - super().__init__( - name=name, context=context, description=description, mappings=mappings - ) + super().__init__(name=name, context=context, description=description, mappings=mappings) self.VARIABLES.update(StaticSite.VARIABLES) self.VARIABLES.update(self.AUTH_VARIABLES) @@ -94,8 +91,8 @@ def create_template(self) -> None: bucket = self.add_bucket() oai = self.add_origin_access_identity() bucket_policy = self.add_cloudfront_bucket_policy(bucket, oai) - # TODO Make this available in Auth@Edge - lambda_function_associations: List[cloudfront.LambdaFunctionAssociation] = [] + # TODO (kyle): make this available in Auth@Edge + lambda_function_associations: list[cloudfront.LambdaFunctionAssociation] = [] if self.directory_index_specified: index_rewrite = self._get_index_rewrite_role_function_and_version() @@ -109,36 +106,28 @@ def create_template(self) -> None: check_auth_name, "Check Authorization information for request", "check_auth", - self.add_lambda_execution_role( - "CheckAuthLambdaExecutionRole", check_auth_name - ), + self.add_lambda_execution_role("CheckAuthLambdaExecutionRole", check_auth_name), ) http_headers_name = "HttpHeaders" http_headers_lambda = self.get_auth_at_edge_lambda_and_ver( http_headers_name, "Additional Headers added to every response", "http_headers", - self.add_lambda_execution_role( - "HttpHeadersLambdaExecutionRole", http_headers_name - ), + self.add_lambda_execution_role("HttpHeadersLambdaExecutionRole", http_headers_name), ) parse_auth_name = "ParseAuth" parse_auth_lambda = self.get_auth_at_edge_lambda_and_ver( parse_auth_name, "Parse the Authorization Headers/Cookies for the request", "parse_auth", - self.add_lambda_execution_role( - "ParseAuthLambdaExecutionRole", parse_auth_name - ), + self.add_lambda_execution_role("ParseAuthLambdaExecutionRole", parse_auth_name), ) refresh_auth_name = "RefreshAuth" refresh_auth_lambda = self.get_auth_at_edge_lambda_and_ver( refresh_auth_name, "Refresh the Authorization information when expired", "refresh_auth", - self.add_lambda_execution_role( - "RefreshAuthLambdaExecutionRole", refresh_auth_name - ), + self.add_lambda_execution_role("RefreshAuthLambdaExecutionRole", refresh_auth_name), ) sign_out_name = "SignOut" sign_out_lambda = self.get_auth_at_edge_lambda_and_ver( @@ -163,7 +152,7 @@ def create_template(self) -> None: def get_auth_at_edge_lambda_and_ver( self, title: str, description: str, handle: str, role: iam.Role - ) -> Dict[str, Any]: + ) -> dict[str, Any]: """Create a lambda function and its version. Args: @@ -217,9 +206,7 @@ def get_auth_at_edge_lambda( return lamb - def add_version( - self, title: str, lambda_function: awslambda.Function - ) -> awslambda.Version: + def add_version(self, title: str, lambda_function: awslambda.Function) -> awslambda.Version: """Create a version association with a Lambda@Edge function. In order to ensure different versions of the function @@ -235,22 +222,20 @@ def add_version( s3_key = lambda_function.properties["Code"].to_dict()["S3Key"] code_hash = s3_key.split(".")[0].split("-")[-1] return self.template.add_resource( - awslambda.Version( - title + "Ver" + code_hash, FunctionName=lambda_function.ref() - ) + awslambda.Version(title + "Ver" + code_hash, FunctionName=lambda_function.ref()) ) def get_distribution_options( self, bucket: s3.Bucket, oai: cloudfront.CloudFrontOriginAccessIdentity, - lambda_funcs: List[cloudfront.LambdaFunctionAssociation], + lambda_funcs: list[cloudfront.LambdaFunctionAssociation], check_auth_lambda_version: awslambda.Version, http_headers_lambda_version: awslambda.Version, parse_auth_lambda_version: awslambda.Version, refresh_auth_lambda_version: awslambda.Version, sign_out_lambda_version: awslambda.Version, - ) -> Dict[str, Any]: + ) -> dict[str, Any]: """Retrieve the options for our CloudFront distribution. Keyword Args: @@ -353,7 +338,7 @@ def get_distribution_options( "ViewerCertificate": self.add_acm_cert(), } - def _get_error_responses(self) -> List[cloudfront.CustomErrorResponse]: + def _get_error_responses(self) -> list[cloudfront.CustomErrorResponse]: """Return error response based on site stack variables. When custom_error_responses are defined return those, if running @@ -379,9 +364,9 @@ def _get_error_responses(self) -> List[cloudfront.CustomErrorResponse]: ] # pyright: reportIncompatibleMethodOverride=none - def _get_cloudfront_bucket_policy_statements( # pylint: disable=arguments-differ + def _get_cloudfront_bucket_policy_statements( self, bucket: s3.Bucket, oai: cloudfront.CloudFrontOriginAccessIdentity - ) -> List[Statement]: + ) -> list[Statement]: return [ Statement( Action=[awacs.s3.GetObject], diff --git a/runway/blueprints/staticsite/dependencies.py b/runway/blueprints/staticsite/dependencies.py index 595de7622..f055462b2 100755 --- a/runway/blueprints/staticsite/dependencies.py +++ b/runway/blueprints/staticsite/dependencies.py @@ -98,12 +98,8 @@ def create_template(self) -> None: Statement( Action=[awacs.s3.PutObject], Effect=Allow, - Principal=AWSPrincipal( - Join(":", ["arn:aws:iam:", AccountId, "root"]) - ), - Resource=[ - Join("", ["arn:aws:s3:::", awslogbucket.ref(), "/*"]) - ], + Principal=AWSPrincipal(Join(":", ["arn:aws:iam:", AccountId, "root"])), + Resource=[Join("", ["arn:aws:s3:::", awslogbucket.ref(), "/*"])], ) ], ), @@ -114,11 +110,7 @@ def create_template(self) -> None: "Artifacts", AccessControl=s3.Private, LifecycleConfiguration=s3.LifecycleConfiguration( - Rules=[ - s3.LifecycleRule( - NoncurrentVersionExpirationInDays=90, Status="Enabled" - ) - ] + Rules=[s3.LifecycleRule(NoncurrentVersionExpirationInDays=90, Status="Enabled")] ), VersioningConfiguration=s3.VersioningConfiguration(Status="Enabled"), ) @@ -142,11 +134,8 @@ def create_template(self) -> None: "SupportedIdentityProviders" ] - redirect_domains = [ - add_url_scheme(x) for x in self.variables["Aliases"] - ] + [ - add_url_scheme(x) - for x in self.variables["AdditionalRedirectDomains"] + redirect_domains = [add_url_scheme(x) for x in self.variables["Aliases"]] + [ + add_url_scheme(x) for x in self.variables["AdditionalRedirectDomains"] ] redirect_uris = get_redirect_uris( redirect_domains, @@ -161,9 +150,7 @@ def create_template(self) -> None: ]["callback_urls"] if self.variables["CreateUserPool"]: - user_pool = template.add_resource( - cognito.UserPool("AuthAtEdgeUserPool") - ) + user_pool = template.add_resource(cognito.UserPool("AuthAtEdgeUserPool")) user_pool_id = user_pool.ref() @@ -175,9 +162,7 @@ def create_template(self) -> None: ) ) else: - user_pool_id = self.context.hook_data["aae_user_pool_id_retriever"][ - "id" - ] + user_pool_id = self.context.hook_data["aae_user_pool_id_retriever"]["id"] userpool_client_params["UserPoolId"] = user_pool_id client = template.add_resource( diff --git a/runway/blueprints/staticsite/staticsite.py b/runway/blueprints/staticsite/staticsite.py index 1cd91c701..9722a7383 100755 --- a/runway/blueprints/staticsite/staticsite.py +++ b/runway/blueprints/staticsite/staticsite.py @@ -5,7 +5,7 @@ import hashlib import logging import os -from typing import TYPE_CHECKING, Any, ClassVar, Dict, List, Union +from typing import TYPE_CHECKING, Any, ClassVar, Union import awacs.awslambda import awacs.iam @@ -52,7 +52,7 @@ class _IndexRewriteFunctionInfoTypeDef(TypedDict): class StaticSite(Blueprint): """CFNgin blueprint for creating S3 bucket and CloudFront distribution.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "AcmCertificateArn": { "type": str, "default": "", @@ -61,7 +61,7 @@ class StaticSite(Blueprint): "Aliases": { "type": list, "default": [], - "description": "(Optional) Domain aliases the " "distribution", + "description": "(Optional) Domain aliases the distribution", }, "Compress": { "type": bool, @@ -87,9 +87,7 @@ class StaticSite(Blueprint): "RewriteDirectoryIndex": { "type": str, "default": "", - "description": "(Optional) File name to " - "append to directory " - "requests.", + "description": "(Optional) File name to append to directory requests.", }, "RoleBoundaryArn": { "type": str, @@ -101,17 +99,17 @@ class StaticSite(Blueprint): "WAFWebACL": { "type": str, "default": "", - "description": "(Optional) WAF id to associate with the " "distribution.", + "description": "(Optional) WAF id to associate with the distribution.", }, "custom_error_responses": { "type": list, "default": [], - "description": "(Optional) Custom error " "responses.", + "description": "(Optional) Custom error responses.", }, "lambda_function_associations": { "type": list, "default": [], - "description": "(Optional) Lambda " "function " "associations.", + "description": "(Optional) Lambda function associations.", }, } @@ -165,10 +163,8 @@ def create_template(self) -> None: if self.directory_index_specified: index_rewrite = self._get_index_rewrite_role_function_and_version() - lambda_function_associations = ( - self.get_directory_index_lambda_association( - lambda_function_associations, index_rewrite["version"] - ) + lambda_function_associations = self.get_directory_index_lambda_association( + lambda_function_associations, index_rewrite["version"] ) distribution_options = self.get_cloudfront_distribution_options( @@ -178,7 +174,7 @@ def create_template(self) -> None: else: self.add_bucket_policy(bucket) - def get_lambda_associations(self) -> List[cloudfront.LambdaFunctionAssociation]: + def get_lambda_associations(self) -> list[cloudfront.LambdaFunctionAssociation]: """Retrieve any lambda associations from the instance variables.""" # If custom associations defined, use them if self.variables["lambda_function_associations"]: @@ -192,9 +188,9 @@ def get_lambda_associations(self) -> List[cloudfront.LambdaFunctionAssociation]: @staticmethod def get_directory_index_lambda_association( - lambda_associations: List[cloudfront.LambdaFunctionAssociation], + lambda_associations: list[cloudfront.LambdaFunctionAssociation], directory_index_rewrite_version: awslambda.Version, - ) -> List[cloudfront.LambdaFunctionAssociation]: + ) -> list[cloudfront.LambdaFunctionAssociation]: """Retrieve the directory index lambda associations with the added rewriter. Args: @@ -214,8 +210,8 @@ def get_cloudfront_distribution_options( self, bucket: s3.Bucket, oai: cloudfront.CloudFrontOriginAccessIdentity, - lambda_function_associations: List[cloudfront.LambdaFunctionAssociation], - ) -> Dict[str, Any]: + lambda_function_associations: list[cloudfront.LambdaFunctionAssociation], + ) -> dict[str, Any]: """Retrieve the options for our CloudFront distribution. Args: @@ -275,7 +271,7 @@ def get_cloudfront_distribution_options( "ViewerCertificate": self.add_acm_cert(), } - def add_aliases(self) -> Union[List[str], Ref]: + def add_aliases(self) -> Union[list[str], Ref]: """Add aliases.""" if self.aliases_specified: return self.variables["Aliases"] @@ -309,7 +305,7 @@ def add_origin_access_identity(self) -> cloudfront.CloudFrontOriginAccessIdentit return self.template.add_resource( cloudfront.CloudFrontOriginAccessIdentity( "OAI", - CloudFrontOriginAccessIdentityConfig=cloudfront.CloudFrontOriginAccessIdentityConfig( # noqa + CloudFrontOriginAccessIdentityConfig=cloudfront.CloudFrontOriginAccessIdentityConfig( Comment="CF access to website" ), ) @@ -364,19 +360,13 @@ def add_bucket(self) -> s3.Bucket: Rules=[s3.OwnershipControlsRule(ObjectOwnership="ObjectWriter")] ), LifecycleConfiguration=s3.LifecycleConfiguration( - Rules=[ - s3.LifecycleRule( - NoncurrentVersionExpirationInDays=90, Status="Enabled" - ) - ] + Rules=[s3.LifecycleRule(NoncurrentVersionExpirationInDays=90, Status="Enabled")] ), VersioningConfiguration=s3.VersioningConfiguration(Status="Enabled"), ) ) self.template.add_output( - Output( - "BucketName", Description="Name of website bucket", Value=bucket.ref() - ) + Output("BucketName", Description="Name of website bucket", Value=bucket.ref()) ) if not self.cf_enabled: @@ -413,9 +403,7 @@ def add_cloudfront_bucket_policy( Bucket=bucket.ref(), PolicyDocument=PolicyDocument( Version="2012-10-17", - Statement=self._get_cloudfront_bucket_policy_statements( - bucket, oai - ), + Statement=self._get_cloudfront_bucket_policy_statements(bucket, oai), ), ) ) @@ -464,9 +452,7 @@ def add_lambda_execution_role( "lambda.amazonaws.com", "edgelambda.amazonaws.com" ), PermissionsBoundary=( - self.variables["RoleBoundaryArn"] - if self.role_boundary_specified - else NoValue + self.variables["RoleBoundaryArn"] if self.role_boundary_specified else NoValue ), Policies=[ iam.Policy( @@ -490,9 +476,7 @@ def add_lambda_execution_role( ) ) - def add_cloudfront_directory_index_rewrite( - self, role: iam.Role - ) -> awslambda.Function: + def add_cloudfront_directory_index_rewrite(self, role: iam.Role) -> awslambda.Function: """Add an index CloudFront directory index rewrite lambda function to the template. Keyword Args: @@ -503,11 +487,11 @@ def add_cloudfront_directory_index_rewrite( """ code_str = "" - path = os.path.join( - os.path.dirname(__file__), + path = os.path.join( # noqa: PTH118 + os.path.dirname(__file__), # noqa: PTH120 "templates/cf_directory_index_rewrite.template.js", ) - with open(path, encoding="utf-8") as file_: + with open(path, encoding="utf-8") as file_: # noqa: PTH123 code_str = file_.read().replace( "{{RewriteDirectoryIndex}}", self.variables["RewriteDirectoryIndex"] ) @@ -546,10 +530,8 @@ def add_cloudfront_directory_index_rewrite_version( The CloudFront directory index rewrite version. """ - code_hash = hashlib.md5( - str( - directory_index_rewrite.properties["Code"].properties["ZipFile"] - ).encode() + code_hash = hashlib.md5( # noqa: S324 + str(directory_index_rewrite.properties["Code"].properties["ZipFile"]).encode() ).hexdigest() return self.template.add_resource( @@ -562,7 +544,7 @@ def add_cloudfront_directory_index_rewrite_version( def add_cloudfront_distribution( self, bucket_policy: s3.BucketPolicy, - cloudfront_distribution_options: Dict[str, Any], + cloudfront_distribution_options: dict[str, Any], ) -> cloudfront.Distribution: """Add the CloudFront distribution to the template / output the id and domain name. @@ -578,9 +560,7 @@ def add_cloudfront_distribution( cloudfront.Distribution( "CFDistribution", DependsOn=bucket_policy.title, - DistributionConfig=cloudfront.DistributionConfig( - **cloudfront_distribution_options - ), + DistributionConfig=cloudfront.DistributionConfig(**cloudfront_distribution_options), ) ) self.template.add_output( @@ -602,7 +582,7 @@ def add_cloudfront_distribution( @staticmethod def _get_cloudfront_bucket_policy_statements( bucket: s3.Bucket, oai: cloudfront.CloudFrontOriginAccessIdentity - ) -> List[Statement]: + ) -> list[Statement]: return [ Statement( Action=[awacs.s3.GetObject], @@ -621,9 +601,7 @@ def _get_index_rewrite_role_function_and_version( ) function = self.add_cloudfront_directory_index_rewrite(role) version = self.add_cloudfront_directory_index_rewrite_version(function) - return _IndexRewriteFunctionInfoTypeDef( - function=function, role=role, version=version - ) + return _IndexRewriteFunctionInfoTypeDef(function=function, role=role, version=version) # Helper section to enable easy blueprint -> template generation diff --git a/runway/blueprints/tf_state.py b/runway/blueprints/tf_state.py index d6417aaba..7adc14424 100755 --- a/runway/blueprints/tf_state.py +++ b/runway/blueprints/tf_state.py @@ -2,7 +2,7 @@ """Module with Terraform state resources.""" from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict +from typing import TYPE_CHECKING, ClassVar import awacs.dynamodb import awacs.s3 @@ -19,7 +19,7 @@ class TfState(Blueprint): """CFNgin blueprint for creating Terraform state resources.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "BucketDeletionPolicy": { "type": str, "allowed_values": ["Delete", "Retain"], @@ -58,17 +58,13 @@ def create_template(self) -> None: dynamodb.Table( "TerraformStateTable", AttributeDefinitions=[ - dynamodb.AttributeDefinition( - AttributeName="LockID", AttributeType="S" - ) + dynamodb.AttributeDefinition(AttributeName="LockID", AttributeType="S") ], KeySchema=[dynamodb.KeySchema(AttributeName="LockID", KeyType="HASH")], ProvisionedThroughput=dynamodb.ProvisionedThroughput( ReadCapacityUnits=2, WriteCapacityUnits=2 ), - TableName=If( - "TableNameOmitted", NoValue, self.variables["TableName"].ref - ), + TableName=If("TableNameOmitted", NoValue, self.variables["TableName"].ref), ) ) self.template.add_output( @@ -84,15 +80,9 @@ def create_template(self) -> None: "TerraformStateBucket", DeletionPolicy=self.variables["BucketDeletionPolicy"], AccessControl=s3.Private, - BucketName=If( - "BucketNameOmitted", NoValue, self.variables["BucketName"].ref - ), + BucketName=If("BucketNameOmitted", NoValue, self.variables["BucketName"].ref), LifecycleConfiguration=s3.LifecycleConfiguration( - Rules=[ - s3.LifecycleRule( - NoncurrentVersionExpirationInDays=90, Status="Enabled" - ) - ] + Rules=[s3.LifecycleRule(NoncurrentVersionExpirationInDays=90, Status="Enabled")] ), VersioningConfiguration=s3.VersioningConfiguration(Status="Enabled"), ) @@ -129,9 +119,7 @@ def create_template(self) -> None: Statement( Action=[awacs.s3.GetObject, awacs.s3.PutObject], Effect=Allow, - Resource=[ - Join("", [terraformstatebucket.get_att("Arn"), "/*"]) - ], + Resource=[Join("", [terraformstatebucket.get_att("Arn"), "/*"])], ), Statement( Action=[ @@ -160,6 +148,4 @@ def create_template(self) -> None: if __name__ == "__main__": from runway.context import CfnginContext - print( # noqa: T201 - TfState("test", CfnginContext(parameters={"namespace": "test"})).to_json() - ) + print(TfState("test", CfnginContext(parameters={"namespace": "test"})).to_json()) # noqa: T201 diff --git a/runway/cfngin/actions/base.py b/runway/cfngin/actions/base.py index 5e98739af..522a9c330 100644 --- a/runway/cfngin/actions/base.py +++ b/runway/cfngin/actions/base.py @@ -6,7 +6,7 @@ import os import sys import threading -from typing import TYPE_CHECKING, Any, Callable, ClassVar, Optional, Union +from typing import TYPE_CHECKING, Any, Callable, ClassVar, Union import botocore.exceptions @@ -66,7 +66,7 @@ def build_walker(concurrency: int) -> Callable[..., Any]: return ThreadedWalker(semaphore).walk -def stack_template_url(bucket_name: str, blueprint: Blueprint, endpoint: str): +def stack_template_url(bucket_name: str, blueprint: Blueprint, endpoint: str) -> str: """Produce an s3 url for a given blueprint. Args: @@ -99,21 +99,21 @@ class BaseAction: """ DESCRIPTION: ClassVar[str] = "Base action" - NAME: ClassVar[Optional[str]] = None + NAME: ClassVar[str | None] = None - bucket_name: Optional[str] - bucket_region: Optional[str] + bucket_name: str | None + bucket_region: str | None cancel: threading.Event context: CfnginContext - provider_builder: Optional[ProviderBuilder] + provider_builder: ProviderBuilder | None s3_conn: S3Client def __init__( self, context: CfnginContext, - provider_builder: Optional[ProviderBuilder] = None, - cancel: Optional[threading.Event] = None, - ): + provider_builder: ProviderBuilder | None = None, + cancel: threading.Event | None = None, + ) -> None: """Instantiate class. Args: @@ -158,9 +158,7 @@ def ensure_cfn_bucket(self) -> None: """CloudFormation bucket where templates will be stored.""" if self.bucket_name: try: - ensure_s3_bucket( - self.s3_conn, self.bucket_name, self.bucket_region, create=False - ) + ensure_s3_bucket(self.s3_conn, self.bucket_name, self.bucket_region, create=False) except botocore.exceptions.ClientError: raise CfnginBucketNotFound(bucket_name=self.bucket_name) from None @@ -214,8 +212,7 @@ def s3_stack_push(self, blueprint: Blueprint, force: bool = False) -> str: template_url = self.stack_template_url(blueprint) try: template_exists = ( - self.s3_conn.head_object(Bucket=self.bucket_name, Key=key_name) - is not None + self.s3_conn.head_object(Bucket=self.bucket_name, Key=key_name) is not None ) except botocore.exceptions.ClientError as err: if err.response["Error"]["Code"] == "404": @@ -240,9 +237,7 @@ def stack_template_url(self, blueprint: Blueprint) -> str: """S3 URL for CloudFormation template object.""" if not self.bucket_name: raise ValueError("bucket_name required") - return stack_template_url( - self.bucket_name, blueprint, get_s3_endpoint(self.s3_conn) - ) + return stack_template_url(self.bucket_name, blueprint, get_s3_endpoint(self.s3_conn)) def _generate_plan( self, @@ -266,8 +261,7 @@ def _generate_plan( tail_fn = self._tail_stack if tail else None steps = [ - Step(stack, fn=self._stack_action, watch_func=tail_fn) - for stack in self.context.stacks + Step(stack, fn=self._stack_action, watch_func=tail_fn) for stack in self.context.stacks ] graph = Graph.from_steps(steps) @@ -295,6 +289,4 @@ def _tail_stack( ) -> None: """Tail a stack's event stream.""" provider = self.build_provider() - return provider.tail_stack( - stack, cancel, action=self.NAME, retries=retries, **kwargs - ) + return provider.tail_stack(stack, cancel, action=self.NAME, retries=retries, **kwargs) diff --git a/runway/cfngin/actions/deploy.py b/runway/cfngin/actions/deploy.py index 8b4081315..cdb031669 100644 --- a/runway/cfngin/actions/deploy.py +++ b/runway/cfngin/actions/deploy.py @@ -3,9 +3,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Tuple, Union - -from typing_extensions import Literal +from typing import TYPE_CHECKING, Any, Callable, Union from ..exceptions import ( CancelExecution, @@ -35,6 +33,7 @@ if TYPE_CHECKING: from mypy_boto3_cloudformation.type_defs import ParameterTypeDef, StackTypeDef + from typing_extensions import Literal from ...config.models.cfngin import CfnginHookDefinitionModel from ...context import CfnginContext @@ -50,7 +49,7 @@ DESTROYING_STATUS = SubmittedStatus("submitted for destruction") -def build_stack_tags(stack: Stack) -> List[TagTypeDef]: +def build_stack_tags(stack: Stack) -> list[TagTypeDef]: """Build a common set of tags to attach to a stack.""" return [{"Key": t[0], "Value": t[1]} for t in stack.tags.items()] @@ -64,9 +63,7 @@ def should_update(stack: Stack) -> bool: """ if stack.locked: if not stack.force: - LOGGER.debug( - "%s:locked and not in --force list; refusing to update", stack.name - ) + LOGGER.debug("%s:locked and not in --force list; refusing to update", stack.name) return False LOGGER.debug("%s:locked but is in --force list", stack.name) return True @@ -100,9 +97,7 @@ def should_ensure_cfn_bucket(outline: bool, dump: bool) -> bool: return not outline and not dump -def _resolve_parameters( - parameters: Dict[str, Any], blueprint: Blueprint -) -> Dict[str, Any]: +def _resolve_parameters(parameters: dict[str, Any], blueprint: Blueprint) -> dict[str, Any]: """Resolve CloudFormation Parameters for a given blueprint. Given a list of parameters, handles: @@ -118,7 +113,7 @@ def _resolve_parameters( The resolved parameters. """ - params: Dict[str, Any] = {} + params: dict[str, Any] = {} for key, value in parameters.items(): if key not in blueprint.parameter_definitions: LOGGER.debug("blueprint %s does not use parameter %s", blueprint.name, key) @@ -132,7 +127,7 @@ def _resolve_parameters( continue if isinstance(value, bool): LOGGER.debug('converting parameter %s boolean "%s" to string', key, value) - value = str(value).lower() + value = str(value).lower() # noqa: PLW2901 params[key] = value return params @@ -142,11 +137,11 @@ class UsePreviousParameterValue: def _handle_missing_parameters( - parameter_values: Dict[str, Any], - all_params: List[str], - required_params: List[str], - existing_stack: Optional[StackTypeDef] = None, -) -> List[Tuple[str, Any]]: + parameter_values: dict[str, Any], + all_params: list[str], + required_params: list[str], + existing_stack: StackTypeDef | None = None, +) -> list[tuple[str, Any]]: """Handle any missing parameters. If an existing_stack is provided, look up missing parameters there. @@ -175,9 +170,7 @@ def _handle_missing_parameters( ] for param in missing_params: if param in stack_parameters: - LOGGER.debug( - "using previous value for parameter %s from existing stack", param - ) + LOGGER.debug("using previous value for parameter %s from existing stack", param) parameter_values[param] = UsePreviousParameterValue final_missing = list(set(required_params) - set(parameter_values.keys())) if final_missing: @@ -188,7 +181,7 @@ def _handle_missing_parameters( def handle_hooks( stage: Literal["post_deploy", "pre_deploy"], - hooks: List[CfnginHookDefinitionModel], + hooks: list[CfnginHookDefinitionModel], provider: Provider, context: CfnginContext, *, @@ -239,9 +232,7 @@ def upload_disabled(self) -> bool: """Whether the CloudFormation template should be uploaded to S3.""" if self.upload_explicitly_disabled: return True - if not self.bucket_name: - return True - return False + return bool(not self.bucket_name) @upload_disabled.setter def upload_disabled(self, value: bool) -> None: @@ -261,8 +252,8 @@ def upload_disabled(self, value: bool) -> None: @staticmethod def build_parameters( - stack: Stack, provider_stack: Optional[StackTypeDef] = None - ) -> List[ParameterTypeDef]: + stack: Stack, provider_stack: StackTypeDef | None = None + ) -> list[ParameterTypeDef]: """Build the CloudFormation Parameters for our stack. Args: @@ -280,7 +271,7 @@ def build_parameters( resolved, all_parameters, required_parameters, provider_stack ) - param_list: List[ParameterTypeDef] = [] + param_list: list[ParameterTypeDef] = [] for key, value in parameters: param_dict: ParameterTypeDef = {"ParameterKey": key} @@ -293,9 +284,7 @@ def build_parameters( return param_list - def _destroy_stack( - self, stack: Stack, *, status: Optional[Status] = None, **_: Any - ) -> Status: + def _destroy_stack(self, stack: Stack, *, status: Status | None = None, **_: Any) -> Status: """Delete a CloudFormation stack. Used to remove stacks that exist in the persistent graph but not @@ -344,9 +333,10 @@ def _destroy_stack( except CancelExecution: return SkippedStatus(reason="canceled execution") - # TODO refactor long if, elif, else block - # pylint: disable=too-many-return-statements,too-many-branches,too-many-statements - def _launch_stack(self, stack: Stack, *, status: Status, **_: Any) -> Status: + # TODO (kyle): refactor long if, elif, else block + def _launch_stack( # noqa: C901, PLR0911, PLR0915, PLR0912 + self, stack: Stack, *, status: Status, **_: Any + ) -> Status: """Handle the creating or updating of a stack in CloudFormation. Also makes sure that we don't try to create or update a stack while @@ -383,9 +373,7 @@ def _launch_stack(self, stack: Stack, *, status: Status, **_: Any) -> Status: provider.get_stack_status(provider_stack), ) - if provider.is_stack_rolling_back( # pylint: disable=no-else-return - provider_stack - ): + if provider.is_stack_rolling_back(provider_stack): if status.reason and "rolling back" in status.reason: return status @@ -396,10 +384,10 @@ def _launch_stack(self, stack: Stack, *, status: Status, **_: Any) -> Status: reason = "rolling back new stack" return SubmittedStatus(reason) - elif provider.is_stack_in_progress(provider_stack): + if provider.is_stack_in_progress(provider_stack): LOGGER.debug("%s:in progress", stack.fqn) return status - elif provider.is_stack_destroyed(provider_stack): + if provider.is_stack_destroyed(provider_stack): LOGGER.debug("%s:finished deleting", stack.fqn) recreate = True # Continue with creation afterwards @@ -502,7 +490,7 @@ def _template(self, blueprint: Blueprint) -> Template: return Template(url=self.s3_stack_push(blueprint)) @staticmethod - def _stack_policy(stack: Stack) -> Optional[Template]: + def _stack_policy(stack: Stack) -> Template | None: """Return a Template object for the stacks stack policy.""" return Template(body=stack.stack_policy) if stack.stack_policy else None @@ -523,7 +511,7 @@ def __generate_plan(self, tail: bool = False) -> Plan: graph = Graph() config_stack_names = [stack.name for stack in self.context.stacks] - inverse_steps: List[Step] = [] + inverse_steps: list[Step] = [] persist_graph = self.context.persistent_graph.transposed() for ind_node, dep_nodes in persist_graph.dag.graph.items(): @@ -556,9 +544,7 @@ def __generate_plan(self, tail: bool = False) -> Plan: return Plan(context=self.context, description=self.DESCRIPTION, graph=graph) - def pre_run( - self, *, dump: Union[bool, str] = False, outline: bool = False, **_: Any - ) -> None: + def pre_run(self, *, dump: bool | str = False, outline: bool = False, **_: Any) -> None: """Any steps that need to be taken prior to running the action.""" if should_ensure_cfn_bucket(outline, bool(dump)): self.ensure_cfn_bucket() @@ -575,8 +561,8 @@ def run( self, *, concurrency: int = 0, - dump: Union[bool, str] = False, - force: bool = False, # pylint: disable=unused-argument + dump: bool | str = False, + force: bool = False, # noqa: ARG002 outline: bool = False, tail: bool = False, upload_disabled: bool = False, @@ -616,9 +602,7 @@ def run( if isinstance(dump, str): plan.dump(directory=dump, context=self.context, provider=self.provider) - def post_run( - self, *, dump: Union[bool, str] = False, outline: bool = False, **_: Any - ) -> None: + def post_run(self, *, dump: Union[bool, str] = False, outline: bool = False, **_: Any) -> None: """Any steps that need to be taken after running the action.""" handle_hooks( "post_deploy", diff --git a/runway/cfngin/actions/destroy.py b/runway/cfngin/actions/destroy.py index e83dae0c5..7396327dc 100644 --- a/runway/cfngin/actions/destroy.py +++ b/runway/cfngin/actions/destroy.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Callable, Optional, Union +from typing import TYPE_CHECKING, Any, Callable from ..exceptions import StackDoesNotExist from ..hooks.utils import handle_hooks @@ -49,9 +49,7 @@ def _stack_action(self) -> Callable[..., Status]: """Run against a step.""" return self._destroy_stack - def _destroy_stack( - self, stack: Stack, *, status: Optional[Status], **_: Any - ) -> Status: + def _destroy_stack(self, stack: Stack, *, status: Status | None, **_: Any) -> Status: wait_time = 0 if status is PENDING else STACK_POLL_TIME if self.cancel.wait(wait_time): return INTERRUPTED @@ -82,17 +80,15 @@ def _destroy_stack( LOGGER.debug("%s:destroying stack", stack.fqn) provider.destroy_stack(stack_data) return DESTROYING_STATUS - LOGGER.critical( - "%s: %s", stack.fqn, provider.get_delete_failed_status_reason(stack.fqn) - ) + LOGGER.critical("%s: %s", stack.fqn, provider.get_delete_failed_status_reason(stack.fqn)) return FailedStatus(provider.get_stack_status_reason(stack_data)) def pre_run( self, *, - dump: Union[bool, str] = False, # pylint: disable=unused-argument + dump: bool | str = False, # noqa: ARG002 outline: bool = False, - **__kwargs: Any, + **_kwargs: Any, ) -> None: """Any steps that need to be taken prior to running the action.""" pre_destroy = self.context.config.pre_destroy @@ -108,17 +104,15 @@ def run( self, *, concurrency: int = 0, - dump: Union[bool, str] = False, # pylint: disable=unused-argument + dump: bool | str = False, # noqa: ARG002 force: bool = False, - outline: bool = False, # pylint: disable=unused-argument + outline: bool = False, # noqa: ARG002 tail: bool = False, - upload_disabled: bool = False, # pylint: disable=unused-argument + upload_disabled: bool = False, # noqa: ARG002 **_kwargs: Any, ) -> None: """Kicks off the destruction of the stacks in the stack_definitions.""" - plan = self._generate_plan( - tail=tail, reverse=True, include_persistent_graph=True - ) + plan = self._generate_plan(tail=tail, reverse=True, include_persistent_graph=True) if not plan.keys(): LOGGER.warning("no stacks detected (error in config?)") if force: @@ -137,9 +131,9 @@ def run( def post_run( self, *, - dump: Union[bool, str] = False, # pylint: disable=unused-argument + dump: bool | str = False, # noqa: ARG002 outline: bool = False, - **__kwargs: Any, + **_kwargs: Any, ) -> None: """Any steps that need to be taken after running the action.""" if not outline and self.context.config.post_destroy: diff --git a/runway/cfngin/actions/diff.py b/runway/cfngin/actions/diff.py index 620027742..e63ec16d5 100644 --- a/runway/cfngin/actions/diff.py +++ b/runway/cfngin/actions/diff.py @@ -9,10 +9,7 @@ TYPE_CHECKING, Any, Callable, - Dict, Generic, - List, - Tuple, TypeVar, Union, cast, @@ -64,14 +61,14 @@ def __eq__(self, other: object) -> bool: """Compare if self is equal to another object.""" return self.__dict__ == other.__dict__ - def changes(self) -> List[str]: + def changes(self) -> list[str]: """Return changes to represent the diff between old and new value. Returns: Representation of the change (if any) between old and new value. """ - output: List[str] = [] + output: list[str] = [] if self.status() is self.UNMODIFIED: output = [self.formatter % (" ", self.key, self.old_value)] elif self.status() is self.ADDED: @@ -95,8 +92,8 @@ def status(self) -> str: def diff_dictionaries( - old_dict: Dict[str, _OV], new_dict: Dict[str, _NV] -) -> Tuple[int, List[DictValue[_OV, _NV]]]: + old_dict: dict[str, _OV], new_dict: dict[str, _NV] +) -> tuple[int, list[DictValue[_OV, _NV]]]: """Calculate the diff two single dimension dictionaries. Args: @@ -116,7 +113,7 @@ def diff_dictionaries( common_set = old_set & new_set changes = 0 - output: List[DictValue[Any, Any]] = [] + output: list[DictValue[Any, Any]] = [] for key in added_set: changes += 1 output.append(DictValue(key, None, new_dict[key])) @@ -134,7 +131,7 @@ def diff_dictionaries( return changes, output -def format_params_diff(parameter_diff: List[DictValue[Any, Any]]) -> str: +def format_params_diff(parameter_diff: list[DictValue[Any, Any]]) -> str: """Handle the formatting of differences in parameters. Args: @@ -155,8 +152,8 @@ def format_params_diff(parameter_diff: List[DictValue[Any, Any]]) -> str: def diff_parameters( - old_params: Dict[str, _OV], new_params: Dict[str, _NV] -) -> List[DictValue[_OV, _NV]]: + old_params: dict[str, _OV], new_params: dict[str, _NV] +) -> list[DictValue[_OV, _NV]]: """Compare the old vs. new parameters and returns a "diff". If there are no changes, we return an empty list. @@ -195,7 +192,7 @@ def _stack_action(self) -> Callable[..., Status]: """Run against a step.""" return self._diff_stack - def _diff_stack(self, stack: Stack, **_: Any) -> Status: + def _diff_stack(self, stack: Stack, **_: Any) -> Status: # noqa: C901 """Handle diffing a stack in CloudFormation vs our config.""" if self.cancel.wait(0): return INTERRUPTED @@ -228,15 +225,10 @@ def _diff_stack(self, stack: Stack, **_: Any) -> Status: stack.set_outputs(provider.get_outputs(stack.fqn)) except exceptions.StackDoesNotExist: if self.context.persistent_graph: - return SkippedStatus( - "persistent graph: stack does not exist, will be removed" - ) + return SkippedStatus("persistent graph: stack does not exist, will be removed") return DoesNotExistInCloudFormation() except AttributeError as err: - if ( - self.context.persistent_graph - and "defined class or template path" in str(err) - ): + if self.context.persistent_graph and "defined class or template path" in str(err): return SkippedStatus("persistent graph: will be destroyed") raise except ClientError as err: @@ -245,8 +237,7 @@ def _diff_stack(self, stack: Stack, **_: Any) -> Status: and "length less than or equal to" in err.response["Error"]["Message"] ): LOGGER.error( - "%s:template is too large to provide directly to the API; " - "S3 must be used", + "%s:template is too large to provide directly to the API; S3 must be used", stack.name, ) return SkippedStatus("cfngin_bucket: existing bucket required") @@ -257,17 +248,15 @@ def run( self, *, concurrency: int = 0, - dump: Union[bool, str] = False, # pylint: disable=unused-argument - force: bool = False, # pylint: disable=unused-argument - outline: bool = False, # pylint: disable=unused-argument - tail: bool = False, # pylint: disable=unused-argument - upload_disabled: bool = False, # pylint: disable=unused-argument + dump: bool | str = False, # noqa: ARG002 + force: bool = False, # noqa: ARG002 + outline: bool = False, # noqa: ARG002 + tail: bool = False, # noqa: ARG002 + upload_disabled: bool = False, # noqa: ARG002 **_kwargs: Any, ) -> None: """Kicks off the diffing of the stacks in the stack_definitions.""" - plan = self._generate_plan( - require_unlocked=False, include_persistent_graph=True - ) + plan = self._generate_plan(require_unlocked=False, include_persistent_graph=True) plan.outline(logging.DEBUG) if plan.keys(): LOGGER.info("diffing stacks: %s", ", ".join(plan.keys())) @@ -279,9 +268,9 @@ def run( def pre_run( self, *, - dump: Union[bool, str] = False, # pylint: disable=unused-argument - outline: bool = False, # pylint: disable=unused-argument - **__kwargs: Any, + dump: bool | str = False, # noqa: ARG002 + outline: bool = False, # noqa: ARG002 + **_kwargs: Any, ) -> None: """Any steps that need to be taken prior to running the action. @@ -296,8 +285,7 @@ def pre_run( sys.exit(1) if bucket.not_found: LOGGER.warning( - 'cfngin_bucket "%s" does not exist and will be creating ' - "during the next deploy", + 'cfngin_bucket "%s" does not exist and will be creating during the next deploy', bucket.name, ) LOGGER.verbose("proceeding without a cfngin_bucket...") diff --git a/runway/cfngin/actions/graph.py b/runway/cfngin/actions/graph.py index aa44e5acc..2f74c020d 100644 --- a/runway/cfngin/actions/graph.py +++ b/runway/cfngin/actions/graph.py @@ -5,18 +5,20 @@ import json import logging import sys -from typing import TYPE_CHECKING, Any, Iterable, List, TextIO, Tuple, Union +from typing import TYPE_CHECKING, Any, TextIO from ..plan import merge_graphs from .base import BaseAction if TYPE_CHECKING: + from collections.abc import Iterable + from ..plan import Graph, Step LOGGER = logging.getLogger(__name__) -def each_step(graph: Graph) -> Iterable[Tuple[Step, List[Step]]]: +def each_step(graph: Graph) -> Iterable[tuple[Step, list[Step]]]: """Yield each step and it's direct dependencies. Args: @@ -56,10 +58,7 @@ def json_format(out: TextIO, graph: Graph) -> None: graph: Graph to be output. """ - steps = { - step.name: {"deps": [dep.name for dep in deps]} - for step, deps in each_step(graph) - } + steps = {step.name: {"deps": [dep.name for dep in deps]} for step, deps in each_step(graph)} json.dump({"steps": steps}, out, indent=4) out.write("\n") @@ -85,18 +84,16 @@ def _stack_action(self) -> Any: def run( self, *, - concurrency: int = 0, # pylint: disable=unused-argument - dump: Union[bool, str] = False, # pylint: disable=unused-argument - force: bool = False, # pylint: disable=unused-argument - outline: bool = False, # pylint: disable=unused-argument - tail: bool = False, # pylint: disable=unused-argument - upload_disabled: bool = False, # pylint: disable=unused-argument + concurrency: int = 0, # noqa: ARG002 + dump: bool | str = False, # noqa: ARG002 + force: bool = False, # noqa: ARG002 + outline: bool = False, # noqa: ARG002 + tail: bool = False, # noqa: ARG002 + upload_disabled: bool = False, # noqa: ARG002 **kwargs: Any, ) -> None: """Generate the underlying graph and prints it.""" - graph = self._generate_plan( - require_unlocked=False, include_persistent_graph=True - ).graph + graph = self._generate_plan(require_unlocked=False, include_persistent_graph=True).graph if self.context.persistent_graph: graph = merge_graphs(self.context.persistent_graph, graph) if kwargs.get("reduce"): diff --git a/runway/cfngin/actions/info.py b/runway/cfngin/actions/info.py index 2d0770911..81ca4eb93 100644 --- a/runway/cfngin/actions/info.py +++ b/runway/cfngin/actions/info.py @@ -40,6 +40,4 @@ def run(self, *_args: Any, **_kwargs: Any) -> None: LOGGER.info("%s:", stack.fqn) if "Outputs" in provider_stack: for output in provider_stack["Outputs"]: - LOGGER.info( - "\t%s: %s", output.get("OutputKey"), output.get("OutputValue") - ) + LOGGER.info("\t%s: %s", output.get("OutputKey"), output.get("OutputValue")) diff --git a/runway/cfngin/actions/init.py b/runway/cfngin/actions/init.py index 9fec7f05d..9d59de217 100644 --- a/runway/cfngin/actions/init.py +++ b/runway/cfngin/actions/init.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Optional, Union, cast +from typing import TYPE_CHECKING, Any, cast from ...compat import cached_property from ...config.models.cfngin import CfnginStackDefinitionModel @@ -31,9 +31,9 @@ class Action(BaseAction): def __init__( self, context: CfnginContext, - provider_builder: Optional[ProviderBuilder] = None, - cancel: Optional[threading.Event] = None, - ): + provider_builder: ProviderBuilder | None = None, + cancel: threading.Event | None = None, + ) -> None: """Instantiate class. This class creates a copy of the context object prior to initialization @@ -46,9 +46,7 @@ def __init__( cancel: Cancel handler. """ - super().__init__( - context=context.copy(), provider_builder=provider_builder, cancel=cancel - ) + super().__init__(context=context.copy(), provider_builder=provider_builder, cancel=cancel) @property def _stack_action(self) -> Any: @@ -56,7 +54,7 @@ def _stack_action(self) -> Any: return None @cached_property - def cfngin_bucket(self) -> Optional[Bucket]: + def cfngin_bucket(self) -> Bucket | None: """CFNgin bucket. Raises: @@ -86,11 +84,11 @@ def run( self, *, concurrency: int = 0, - dump: Union[bool, str] = False, # pylint: disable=unused-argument - force: bool = False, # pylint: disable=unused-argument - outline: bool = False, # pylint: disable=unused-argument + dump: bool | str = False, # noqa: ARG002 + force: bool = False, # noqa: ARG002 + outline: bool = False, # noqa: ARG002 tail: bool = False, - upload_disabled: bool = True, # pylint: disable=unused-argument + upload_disabled: bool = True, # noqa: ARG002 **_kwargs: Any, ) -> None: """Run the action. @@ -125,9 +123,7 @@ def run( LOGGER.notice("using default blueprint to create cfngin_bucket...") self.context.config.stacks = [self.default_cfngin_bucket_stack] # clear cached values that were populated by checking the previous condition - self.context._del_cached_property( # pylint: disable=protected-access - "stacks", "stacks_dict" - ) + self.context._del_cached_property("stacks", "stacks_dict") # noqa: SLF001 if self.provider_builder: self.provider_builder.region = self.context.bucket_region deploy.Action( @@ -144,7 +140,7 @@ def run( def pre_run( self, *, - dump: Union[bool, str] = False, + dump: bool | str = False, outline: bool = False, **__kwargs: Any, ) -> None: @@ -153,7 +149,7 @@ def pre_run( def post_run( self, *, - dump: Union[bool, str] = False, + dump: bool | str = False, outline: bool = False, **__kwargs: Any, ) -> None: diff --git a/runway/cfngin/awscli_yamlhelper.py b/runway/cfngin/awscli_yamlhelper.py index 723cb7b79..cfe1b5db0 100644 --- a/runway/cfngin/awscli_yamlhelper.py +++ b/runway/cfngin/awscli_yamlhelper.py @@ -15,14 +15,15 @@ from __future__ import annotations import json -from typing import Any, Dict, MutableMapping, MutableSequence, cast +from collections.abc import MutableMapping, MutableSequence +from typing import Any, cast import yaml -def intrinsics_multi_constructor( # pylint: disable=unused-argument - loader: yaml.Loader, tag_prefix: str, node: yaml.Node -) -> Dict[str, Any]: +def intrinsics_multi_constructor( + loader: yaml.Loader, tag_prefix: str, node: yaml.Node # noqa: ARG001 +) -> dict[str, Any]: """YAML constructor to parse CloudFormation intrinsics. This will return a dictionary with key being the intrinsic name @@ -59,12 +60,12 @@ def intrinsics_multi_constructor( # pylint: disable=unused-argument return {cfntag: value} -def yaml_dump(dict_to_dump: Dict[str, Any]) -> str: +def yaml_dump(dict_to_dump: dict[str, Any]) -> str: """Dump the dictionary as a YAML document.""" return yaml.safe_dump(dict_to_dump, default_flow_style=False) -def yaml_parse(yamlstr: str) -> Dict[str, Any]: +def yaml_parse(yamlstr: str) -> dict[str, Any]: """Parse a yaml string.""" try: # PyYAML doesn't support json as well as it should, so if the input diff --git a/runway/cfngin/blueprints/base.py b/runway/cfngin/blueprints/base.py index f404a987c..5f90d9063 100644 --- a/runway/cfngin/blueprints/base.py +++ b/runway/cfngin/blueprints/base.py @@ -6,18 +6,7 @@ import hashlib import logging import string -from typing import ( - TYPE_CHECKING, - Any, - ClassVar, - Dict, - List, - Optional, - Tuple, - Type, - TypeVar, - Union, -) +from typing import TYPE_CHECKING, Any, ClassVar from troposphere import Output, Parameter, Ref, Template @@ -54,15 +43,11 @@ "constraint_description": "ConstraintDescription", } -_T = TypeVar("_T") - class CFNParameter: """Wrapper around a value to indicate a CloudFormation Parameter.""" - def __init__( - self, name: str, value: Union[bool, float, int, List[Any], str, Any] - ) -> None: + def __init__(self, name: str, value: bool | float | list[Any] | str | Any) -> None: """Instantiate class. Args: @@ -82,7 +67,7 @@ def __init__( else: raise TypeError( f"CFNParameter ({name}) value must be one of bool, float, int, str, " - f"List[str] but got: {type(value)}" + f"list[str] but got: {type(value)}" ) def __repr__(self) -> str: @@ -94,7 +79,7 @@ def ref(self) -> Ref: """Ref the value of a parameter.""" return Ref(self.name) - def to_parameter_value(self) -> Union[List[Any], str]: + def to_parameter_value(self) -> list[Any] | str: """Return the value to be submitted to CloudFormation.""" return self.value @@ -110,7 +95,7 @@ def build_parameter(name: str, properties: BlueprintVariableTypeDef) -> Paramete Returns: The created parameter object. - """ # noqa: E501 + """ param = Parameter(name, Type=properties.get("type")) for name_, attr in PARAMETER_PROPERTIES.items(): if name_ in properties: @@ -120,7 +105,7 @@ def build_parameter(name: str, properties: BlueprintVariableTypeDef) -> Paramete def validate_variable_type( var_name: str, - var_type: Union[Type[CFNType], TroposphereType[Any], type], + var_type: type[CFNType] | TroposphereType[Any] | type, value: Any, ) -> Any: """Ensure the value is the correct variable type. @@ -143,21 +128,18 @@ def validate_variable_type( try: value = var_type.create(value) except Exception as exc: - raise ValidatorError( - var_name, f"{var_type.resource_name}.create", value, exc - ) from exc + raise ValidatorError(var_name, f"{var_type.resource_name}.create", value, exc) from exc elif issubclass(var_type, CFNType): value = CFNParameter(name=var_name, value=value) - else: - if not isinstance(value, var_type): - raise TypeError( - f"Value for variable {var_name} must be of type {var_type}. Actual " - f"type: {type(value)}" - ) + elif not isinstance(value, var_type): + raise TypeError( + f"Value for variable {var_name} must be of type {var_type}. Actual " + f"type: {type(value)}" + ) return value -def validate_allowed_values(allowed_values: Optional[List[Any]], value: Any) -> bool: +def validate_allowed_values(allowed_values: list[Any] | None, value: Any) -> bool: """Support a variable defining which values it allows. Args: @@ -177,7 +159,7 @@ def validate_allowed_values(allowed_values: Optional[List[Any]], value: Any) -> def resolve_variable( var_name: str, var_def: BlueprintVariableTypeDef, - provided_variable: Optional[Variable], + provided_variable: Variable | None, blueprint_name: str, ) -> Any: """Resolve a provided variable value against the variable definition. @@ -241,9 +223,7 @@ def resolve_variable( return value -def parse_user_data( - variables: Dict[str, Any], raw_user_data: str, blueprint_name: str -) -> str: +def parse_user_data(variables: dict[str, Any], raw_user_data: str, blueprint_name: str) -> str: """Parse the given user data and renders it as a template. It supports referencing template variables to create userdata @@ -271,7 +251,7 @@ def parse_user_data( is not given in the blueprint """ - variable_values: Dict[str, Any] = {} + variable_values: dict[str, Any] = {} for key, value in variables.items(): if isinstance(value, CFNParameter): @@ -311,11 +291,11 @@ class Blueprint(DelCachedPropMixin): """ - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = {} + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = {} context: CfnginContext - description: Optional[str] - mappings: Optional[Dict[str, Dict[str, Any]]] + description: str | None + mappings: dict[str, dict[str, Any]] | None name: str template: Template @@ -324,11 +304,11 @@ def __init__( name: str, context: CfnginContext, *, - description: Optional[str] = None, - mappings: Optional[Dict[str, Dict[str, Any]]] = None, - template: Optional[Template] = None, + description: str | None = None, + mappings: dict[str, dict[str, Any]] | None = None, + template: Template | None = None, **_: Any, - ): + ) -> None: """Instantiate class. Args: @@ -349,7 +329,7 @@ def __init__( """ self._rendered = None - self._resolved_variables: Optional[Dict[str, Any]] = None + self._resolved_variables: dict[str, Any] | None = None self._version = None self.context = context self.description = description @@ -368,7 +348,7 @@ def __init__( ) @cached_property - def cfn_parameters(self) -> Dict[str, Union[List[Any], str]]: + def cfn_parameters(self) -> dict[str, list[Any] | str]: """Return a dict of variables with type :class:`~runway.cfngin.blueprints.variables.types.CFNType`. .. versionadded:: 2.0.0 @@ -376,8 +356,8 @@ def cfn_parameters(self) -> Dict[str, Union[List[Any], str]]: Returns: Variables that need to be submitted as CloudFormation Parameters. - """ # noqa - output: Dict[str, Union[List[Any], str]] = {} + """ + output: dict[str, list[Any] | str] = {} for key, value in self.variables.items(): if hasattr(value, "to_parameter_value"): output[key] = value.to_parameter_value() @@ -388,7 +368,7 @@ def create_template(self) -> None: raise NotImplementedError @property - def defined_variables(self) -> Dict[str, BlueprintVariableTypeDef]: + def defined_variables(self) -> dict[str, BlueprintVariableTypeDef]: """Return a copy of :attr:`VARIABLES` to avoid accidental modification of the ClassVar. .. versionchanged:: 2.0.0 @@ -398,7 +378,7 @@ def defined_variables(self) -> Dict[str, BlueprintVariableTypeDef]: return copy.deepcopy(self.VARIABLES) @property - def output_definitions(self) -> Dict[str, Dict[str, Any]]: + def output_definitions(self) -> dict[str, dict[str, Any]]: """Get the output definitions. .. versionadded:: 2.0.0 @@ -411,7 +391,7 @@ def output_definitions(self) -> Dict[str, Dict[str, Any]]: return {k: output.to_dict() for k, output in self.template.outputs.items()} @cached_property - def parameter_definitions(self) -> Dict[str, BlueprintVariableTypeDef]: + def parameter_definitions(self) -> dict[str, BlueprintVariableTypeDef]: """Get the parameter definitions to submit to CloudFormation. Any variable definition whose type is an instance of @@ -425,7 +405,7 @@ def parameter_definitions(self) -> Dict[str, BlueprintVariableTypeDef]: containing key/values for various parameter properties. """ - output: Dict[str, BlueprintVariableTypeDef] = {} + output: dict[str, BlueprintVariableTypeDef] = {} for var_name, attrs in self.defined_variables.items(): var_type = attrs.get("type") if isinstance(var_type, type) and issubclass(var_type, CFNType): @@ -435,7 +415,7 @@ def parameter_definitions(self) -> Dict[str, BlueprintVariableTypeDef]: return output @cached_property - def parameter_values(self) -> Dict[str, Union[List[Any], str]]: + def parameter_values(self) -> dict[str, list[Any] | str]: """Return a dict of variables with type :class:`~runway.cfngin.blueprints.variables.types.CFNType`. .. versionadded:: 2.0.0 @@ -444,8 +424,8 @@ def parameter_values(self) -> Dict[str, Union[List[Any], str]]: Variables that need to be submitted as CloudFormation Parameters. Will be a dictionary of : . - """ # noqa - output: Dict[str, Any] = {} + """ + output: dict[str, Any] = {} for key, value in self.variables.items(): try: output[key] = value.to_parameter_value() @@ -461,7 +441,7 @@ def rendered(self) -> str: return self._rendered @cached_property - def required_parameter_definitions(self) -> Dict[str, BlueprintVariableTypeDef]: + def required_parameter_definitions(self) -> dict[str, BlueprintVariableTypeDef]: """Return all template parameters that do not have a default value. .. versionadded:: 2.0.0 @@ -483,7 +463,7 @@ def requires_change_set(self) -> bool: return self.template.transform is not None @property - def variables(self) -> Dict[str, Any]: + def variables(self) -> dict[str, Any]: """Return a Dict of variables available to the Template. These variables will have been defined within :attr:`VARIABLES` or @@ -504,7 +484,7 @@ def variables(self) -> Dict[str, Any]: return self._resolved_variables @variables.setter - def variables(self, value: Dict[str, Any]) -> None: + def variables(self, value: dict[str, Any]) -> None: """Setter for :meth:`variables`. .. versionadded:: 2.0.0 @@ -533,7 +513,7 @@ def add_output(self, name: str, value: Any) -> None: """ self.template.add_output(Output(name, Value=value)) - def get_cfn_parameters(self) -> Dict[str, Union[List[Any], str]]: + def get_cfn_parameters(self) -> dict[str, list[Any] | str]: """Return a dictionary of variables with `type` :class:`CFNType`. .. deprecated:: 2.0.0 @@ -549,7 +529,7 @@ def get_cfn_parameters(self) -> Dict[str, Union[List[Any], str]]: ) return self.cfn_parameters - def get_output_definitions(self) -> Dict[str, Dict[str, Any]]: + def get_output_definitions(self) -> dict[str, dict[str, Any]]: """Get the output definitions. .. deprecated:: 2.0.0 @@ -566,7 +546,7 @@ def get_output_definitions(self) -> Dict[str, Dict[str, Any]]: ) return self.output_definitions - def get_parameter_definitions(self) -> Dict[str, BlueprintVariableTypeDef]: + def get_parameter_definitions(self) -> dict[str, BlueprintVariableTypeDef]: """Get the parameter definitions to submit to CloudFormation. Any variable definition whose `type` is an instance of @@ -587,7 +567,7 @@ def get_parameter_definitions(self) -> Dict[str, BlueprintVariableTypeDef]: ) return self.parameter_definitions - def get_parameter_values(self) -> Dict[str, Union[List[Any], str]]: + def get_parameter_values(self) -> dict[str, list[Any] | str]: """Return a dict of variables with type :class:`~runway.cfngin.blueprints.variables.types.CFNType`. .. deprecated:: 2.0.0 @@ -597,14 +577,14 @@ def get_parameter_values(self) -> Dict[str, Union[List[Any], str]]: Variables that need to be submitted as CloudFormation Parameters. Will be a dictionary of : . - """ # noqa + """ LOGGER.warning( "%s.get_parameter_values is deprecated and will be removed in a future release", self.__class__.__name__, ) return self.parameter_values - def get_required_parameter_definitions(self) -> Dict[str, BlueprintVariableTypeDef]: + def get_required_parameter_definitions(self) -> dict[str, BlueprintVariableTypeDef]: """Return all template parameters that do not have a default value. .. deprecated:: 2.0.0 @@ -622,7 +602,7 @@ def get_required_parameter_definitions(self) -> Dict[str, BlueprintVariableTypeD ) return self.required_parameter_definitions - def get_variables(self) -> Dict[str, Any]: + def get_variables(self) -> dict[str, Any]: """Return a dictionary of variables available to the template. These variables will have been defined within `VARIABLES` or @@ -664,7 +644,7 @@ def read_user_data(self, user_data_path: str) -> str: raw_user_data = read_value_from_path(user_data_path) return parse_user_data(self.variables, raw_user_data, self.name) - def render_template(self) -> Tuple[str, str]: + def render_template(self) -> tuple[str, str]: """Render the Blueprint to a CloudFormation template.""" self.import_mappings() self.create_template() @@ -672,7 +652,7 @@ def render_template(self) -> Tuple[str, str]: self.set_template_description(self.description) self.setup_parameters() rendered = self.template.to_json(indent=self.context.template_indent) - version = hashlib.md5(rendered.encode()).hexdigest()[:8] + version = hashlib.md5(rendered.encode()).hexdigest()[:8] # noqa: S324 return version, rendered def reset_template(self) -> None: @@ -681,7 +661,7 @@ def reset_template(self) -> None: self._rendered = None self._version = None - def resolve_variables(self, provided_variables: List[Variable]) -> None: + def resolve_variables(self, provided_variables: list[Variable]) -> None: """Resolve the values of the blueprint variables. This will resolve the values of the `VARIABLES` with values from the @@ -694,9 +674,7 @@ def resolve_variables(self, provided_variables: List[Variable]) -> None: self._resolved_variables = {} variable_dict = {var.name: var for var in provided_variables} for var_name, var_def in self.defined_variables.items(): - value = resolve_variable( - var_name, var_def, variable_dict.get(var_name), self.name - ) + value = resolve_variable(var_name, var_def, variable_dict.get(var_name), self.name) self._resolved_variables[var_name] = value def set_template_description(self, description: str) -> None: @@ -720,14 +698,14 @@ def setup_parameters(self) -> None: built_param = build_parameter(name, attrs) template.add_parameter(built_param) - def to_json(self, variables: Optional[Dict[str, Any]] = None) -> str: + def to_json(self, variables: dict[str, Any] | None = None) -> str: """Render the blueprint and return the template in json form. Args: variables: Dictionary providing/overriding variable values. """ - variables_to_resolve: List[Variable] = [] + variables_to_resolve: list[Variable] = [] if variables: for key, value in variables.items(): variables_to_resolve.append(Variable(key, value, "cfngin")) @@ -736,7 +714,7 @@ def to_json(self, variables: Optional[Dict[str, Any]] = None) -> str: # The provided value for a CFN parameter has no effect in this # context (generating the CFN template), so any string can be # provided for its value - just needs to be something - variables_to_resolve.append(Variable(k, "unused_value", "cfngin")) + variables_to_resolve.append(Variable(k, "unused_value", "cfngin")) # noqa: PERF401 self.resolve_variables(variables_to_resolve) return self.render_template()[1] diff --git a/runway/cfngin/blueprints/cfngin_bucket.py b/runway/cfngin/blueprints/cfngin_bucket.py index 2e528d302..ebd9dff8e 100644 --- a/runway/cfngin/blueprints/cfngin_bucket.py +++ b/runway/cfngin/blueprints/cfngin_bucket.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict, Union +from typing import TYPE_CHECKING, ClassVar, Union from troposphere import Equals, If, Not, NoValue, Or, Tag, Tags, s3 @@ -21,7 +21,7 @@ class CfnginBucket(Blueprint): """CFNgin Bucket Blueprint.""" DESCRIPTION: ClassVar[str] = f"{__name__}.CFNginBucket (v{__version__})" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "AccessControl": { "allowed_values": [ "AuthenticatedRead", @@ -66,9 +66,7 @@ def bucket(self) -> s3.Bucket: self.add_output("BucketArn", bucket.get_att("Arn")) self.add_output("BucketDomainName", bucket.get_att("DomainName")) self.add_output("BucketName", bucket.ref()) - self.add_output( - "BucketRegionalDomainName", bucket.get_att("RegionalDomainName") - ) + self.add_output("BucketRegionalDomainName", bucket.get_att("RegionalDomainName")) return bucket @cached_property diff --git a/runway/cfngin/blueprints/raw.py b/runway/cfngin/blueprints/raw.py index 8a5e141a2..3218eba77 100644 --- a/runway/cfngin/blueprints/raw.py +++ b/runway/cfngin/blueprints/raw.py @@ -5,10 +5,9 @@ import hashlib import json import logging -import os import sys from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union +from typing import TYPE_CHECKING, Any, Union from jinja2 import Environment, FileSystemLoader @@ -24,7 +23,7 @@ LOGGER = logging.getLogger(__name__) -def get_template_path(file_path: Path) -> Optional[Path]: +def get_template_path(file_path: Path) -> Path | None: """Find raw template in working directory or in sys.path. template_path from config may refer to templates co-located with the CFNgin @@ -32,7 +31,7 @@ def get_template_path(file_path: Path) -> Optional[Path]: loading to find the path to the template. Args: - filename: Template path. + file_path: Template path. Returns: Path to file, or None if no file found @@ -47,7 +46,7 @@ def get_template_path(file_path: Path) -> Optional[Path]: return None -def resolve_variable(provided_variable: Optional[Variable], blueprint_name: str) -> Any: +def resolve_variable(provided_variable: Variable | None, blueprint_name: str) -> Any: """Resolve a provided variable value against the variable definition. This acts as a subset of resolve_variable logic in the base module, leaving @@ -73,7 +72,7 @@ def resolve_variable(provided_variable: Optional[Variable], blueprint_name: str) return value -class RawTemplateBlueprint(Blueprint): # pylint: disable=abstract-method +class RawTemplateBlueprint(Blueprint): """Blueprint class for blueprints auto-generated from raw templates. Attributes: @@ -89,13 +88,13 @@ class RawTemplateBlueprint(Blueprint): # pylint: disable=abstract-method raw_template_path: Path - def __init__( # pylint: disable=super-init-not-called + def __init__( self, name: str, context: CfnginContext, *, - description: Optional[str] = None, - mappings: Optional[Dict[str, Any]] = None, + description: str | None = None, + mappings: dict[str, Any] | None = None, raw_template_path: Path, **_: Any, ) -> None: @@ -116,7 +115,7 @@ def __init__( # pylint: disable=super-init-not-called self.raw_template_path = raw_template_path @property - def output_definitions(self) -> Dict[str, Dict[str, Any]]: + def output_definitions(self) -> dict[str, dict[str, Any]]: """Get the output definitions. .. versionadded:: 2.0.0 @@ -129,7 +128,7 @@ def output_definitions(self) -> Dict[str, Dict[str, Any]]: return self.to_dict().get("Outputs", {}) @cached_property - def parameter_definitions(self) -> Dict[str, Any]: + def parameter_definitions(self) -> dict[str, Any]: """Get the parameter definitions to submit to CloudFormation. .. versionadded:: 2.0.0 @@ -142,7 +141,7 @@ def parameter_definitions(self) -> Dict[str, Any]: return self.to_dict().get("Parameters", {}) @cached_property - def parameter_values(self) -> Dict[str, Union[List[Any], str]]: + def parameter_values(self) -> dict[str, Union[list[Any], str]]: """Return a dict of variables with type :class:`~runway.cfngin.blueprints.variables.types.CFNType`. .. versionadded:: 2.0.0 @@ -151,25 +150,21 @@ def parameter_values(self) -> Dict[str, Union[List[Any], str]]: Variables that need to be submitted as CloudFormation Parameters. Will be a dictionary of ``: ``. - """ # noqa + """ return self._resolved_variables or {} @property def rendered(self) -> str: - """Return (generating first if needed) rendered template.""" + """Return (generating first if needed) rendered Template.""" if not self._rendered: template_path = get_template_path(self.raw_template_path) if template_path: - if len(os.path.splitext(template_path)) == 2 and ( - os.path.splitext(template_path)[1] == ".j2" - ): + if template_path.suffix == ".j2": self._rendered = ( - Environment( - loader=FileSystemLoader( - searchpath=os.path.dirname(template_path) - ) + Environment( # noqa: S701 + loader=FileSystemLoader(searchpath=template_path.parent) ) - .get_template(os.path.basename(template_path)) + .get_template(template_path.name) .render( context=self.context, mappings=self.mappings, @@ -178,10 +173,10 @@ def rendered(self) -> str: ) ) else: - with open(template_path, "r", encoding="utf-8") as template: + with template_path.open(encoding="utf-8") as template: self._rendered = template.read() else: - raise InvalidConfig(f"Could not find template {self.raw_template_path}") + raise InvalidConfig(f"Could not find Template {self.raw_template_path}") # clear cached properties that rely on this property self._del_cached_property("parameter_definitions") @@ -196,10 +191,10 @@ def requires_change_set(self) -> bool: def version(self) -> str: """Return (generating first if needed) version hash.""" if not self._version: - self._version = hashlib.md5(self.rendered.encode()).hexdigest()[:8] + self._version = hashlib.md5(self.rendered.encode()).hexdigest()[:8] # noqa: S324 return self._version - def to_dict(self) -> Dict[str, Any]: + def to_dict(self) -> dict[str, Any]: """Return the template as a python dictionary. Returns: @@ -208,7 +203,7 @@ def to_dict(self) -> Dict[str, Any]: """ return parse_cloudformation_template(self.rendered) - def to_json(self, variables: Optional[Dict[str, Any]] = None) -> str: + def to_json(self, variables: dict[str, Any] | None = None) -> str: # noqa: ARG002 """Return the template in JSON. Args: @@ -218,11 +213,11 @@ def to_json(self, variables: Optional[Dict[str, Any]] = None) -> str: # load -> dumps will produce json from json or yaml templates return json.dumps(self.to_dict(), sort_keys=True, indent=4) - def render_template(self) -> Tuple[str, str]: + def render_template(self) -> tuple[str, str]: """Load template and generate its md5 hash.""" return (self.version, self.rendered) - def resolve_variables(self, provided_variables: List[Variable]) -> None: + def resolve_variables(self, provided_variables: list[Variable]) -> None: """Resolve the values of the blueprint variables. This will resolve the values of the template parameters with values @@ -237,7 +232,7 @@ def resolve_variables(self, provided_variables: List[Variable]) -> None: # Pass 1 to set resolved_variables to provided variables self._resolved_variables = {} variable_dict = {var.name: var for var in provided_variables} - for var_name, _var_def in variable_dict.items(): + for var_name in variable_dict: value = resolve_variable(variable_dict.get(var_name), self.name) if value is not None: self._resolved_variables[var_name] = value @@ -248,7 +243,7 @@ def resolve_variables(self, provided_variables: List[Variable]) -> None: defined_variables = self.parameter_definitions.copy() self._resolved_variables = {} variable_dict = {var.name: var for var in provided_variables} - for var_name, _var_def in defined_variables.items(): + for var_name in defined_variables: value = resolve_variable(variable_dict.get(var_name), self.name) if value is not None: self._resolved_variables[var_name] = value diff --git a/runway/cfngin/blueprints/testutil.py b/runway/cfngin/blueprints/testutil.py index b2d943bbd..363b11944 100644 --- a/runway/cfngin/blueprints/testutil.py +++ b/runway/cfngin/blueprints/testutil.py @@ -8,7 +8,7 @@ import unittest from glob import glob from pathlib import Path -from typing import TYPE_CHECKING, Any, Iterator, List, Optional, Type, cast +from typing import TYPE_CHECKING, Any, cast from ...config import CfnginConfig from ...context import CfnginContext @@ -16,15 +16,15 @@ from ...variables import Variable if TYPE_CHECKING: + from collections.abc import Iterator + from ...config.models.cfngin import CfnginStackDefinitionModel from .base import Blueprint def diff(first: str, second: str) -> str: """Human readable differ.""" - return "\n".join( - list(difflib.Differ().compare(first.splitlines(), second.splitlines())) - ) + return "\n".join(list(difflib.Differ().compare(first.splitlines(), second.splitlines()))) class BlueprintTestCase(unittest.TestCase): @@ -32,9 +32,7 @@ class BlueprintTestCase(unittest.TestCase): OUTPUT_PATH: str = "tests/fixtures/blueprints" - def assertRenderedBlueprint( # noqa: N802 pylint: disable=invalid-name - self, blueprint: Blueprint - ) -> None: + def assertRenderedBlueprint(self, blueprint: Blueprint) -> None: # noqa: N802 """Test that the rendered blueprint json matches the expected result. Result files are to be stored in the repo as @@ -46,18 +44,16 @@ def assertRenderedBlueprint( # noqa: N802 pylint: disable=invalid-name rendered_dict = blueprint.template.to_dict() rendered_text = json.dumps(rendered_dict, indent=4, sort_keys=True) - with open( + with open( # noqa: PTH123 expected_output + "-result", "w", encoding="utf-8" ) as expected_output_file: expected_output_file.write(rendered_text) - with open(expected_output, encoding="utf-8") as expected_output_file: + with open(expected_output, encoding="utf-8") as expected_output_file: # noqa: PTH123 expected_dict = json.loads(expected_output_file.read()) expected_text = json.dumps(expected_dict, indent=4, sort_keys=True) - self.assertEqual( - rendered_dict, expected_dict, diff(rendered_text, expected_text) - ) + assert rendered_dict == expected_dict, diff(rendered_text, expected_text) # noqa: S101 class YamlDirTestGenerator: @@ -107,17 +103,17 @@ class YamlDirTestGenerator: def __init__(self) -> None: """Instantiate class.""" self.classdir = os.path.relpath(self.__class__.__module__.replace(".", "/")) - if not os.path.isdir(self.classdir): - self.classdir = os.path.dirname(self.classdir) + if not os.path.isdir(self.classdir): # noqa: PTH112 + self.classdir = os.path.dirname(self.classdir) # noqa: PTH120 # These properties can be overridden from the test generator subclass. @property - def base_class(self) -> Type[BlueprintTestCase]: + def base_class(self) -> type[BlueprintTestCase]: """Return the baseclass.""" return BlueprintTestCase @property - def yaml_dirs(self) -> List[str]: + def yaml_dirs(self) -> list[str]: """Yaml directories.""" return ["."] @@ -126,22 +122,23 @@ def yaml_filename(self) -> str: """Yaml filename.""" return "test_*.yaml" - # pylint incorrectly detects this def test_generator( self, ) -> Iterator[BlueprintTestCase]: """Test generator.""" # Search for tests in given paths - configs: List[str] = [] + configs: list[str] = [] for directory in self.yaml_dirs: - configs.extend(glob(f"{self.classdir}/{directory}/{self.yaml_filename}")) + configs.extend( + glob(f"{self.classdir}/{directory}/{self.yaml_filename}") # noqa: PTH207 + ) class ConfigTest(self.base_class): # type: ignore """Config test.""" context: CfnginContext - def __init__( # pylint: disable=super-init-not-called + def __init__( self, config: CfnginConfig, stack: CfnginStackDefinitionModel, @@ -152,23 +149,19 @@ def __init__( # pylint: disable=super-init-not-called self.stack = stack self.description = f"{stack.name} ({filepath})" - def __call__(self) -> None: # pylint: disable=arguments-differ + def __call__(self) -> None: """Run when the class instance is called directly.""" # Use the context property of the baseclass, if present. # If not, default to a basic context. try: ctx = self.context except AttributeError: - ctx = CfnginContext( - config=self.config, parameters={"environment": "test"} - ) + ctx = CfnginContext(config=self.config, parameters={"environment": "test"}) configvars = self.stack.variables or {} variables = [Variable(k, v, "cfngin") for k, v in configvars.items()] - blueprint_class = load_object_from_string( - cast(str, self.stack.class_path) - ) + blueprint_class = load_object_from_string(cast(str, self.stack.class_path)) blueprint = blueprint_class(self.stack.name, ctx) blueprint.resolve_variables(variables or []) blueprint.setup_parameters() @@ -176,14 +169,14 @@ def __call__(self) -> None: # pylint: disable=arguments-differ self.assertRenderedBlueprint(blueprint) def assertEqual( # noqa: N802 - self, first: Any, second: Any, msg: Optional[str] = None + self, first: Any, second: Any, msg: str | None = None ) -> None: """Test that first and second are equal. If the values do not compare equal, the test will fail. """ - assert first == second, msg + assert first == second, msg # noqa: S101 for config_file in configs: config_path = Path(config_file) diff --git a/runway/cfngin/blueprints/type_defs.py b/runway/cfngin/blueprints/type_defs.py index 9bfa9d678..30d5a1469 100644 --- a/runway/cfngin/blueprints/type_defs.py +++ b/runway/cfngin/blueprints/type_defs.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import Any, Callable, List +from typing import Any, Callable from typing_extensions import TypedDict @@ -17,7 +17,7 @@ class _OptionalBlueprintVariableTypeDef(TypedDict, total=False): """Type definition for runway.cfngin.blueprints.base.Blueprint.VARIABLES items.""" allowed_pattern: str - allowed_values: List[Any] + allowed_values: list[Any] constraint_description: str default: Any description: str @@ -74,4 +74,4 @@ class BlueprintVariableTypeDef( If there is an issue validating the value, an exception (``ValueError``, ``TypeError``, etc) should be raised by the function. - """ # noqa + """ diff --git a/runway/cfngin/blueprints/variables/types.py b/runway/cfngin/blueprints/variables/types.py index ce1ea3f11..d4b027f11 100644 --- a/runway/cfngin/blueprints/variables/types.py +++ b/runway/cfngin/blueprints/variables/types.py @@ -2,19 +2,7 @@ from __future__ import annotations -from typing import ( - TYPE_CHECKING, - Any, - ClassVar, - Dict, - Generic, - List, - Optional, - Type, - TypeVar, - Union, - overload, -) +from typing import TYPE_CHECKING, Any, ClassVar, Generic, TypeVar, overload from troposphere import BaseAWSObject @@ -22,7 +10,6 @@ from typing_extensions import Literal TroposphereT = TypeVar("TroposphereT", bound=BaseAWSObject) -# https://github.com/PyCQA/pylint/issues/6003 class TroposphereType(Generic[TroposphereT]): @@ -46,7 +33,7 @@ class TroposphereType(Generic[TroposphereT]): def __init__( self, - defined_type: Type[TroposphereT], + defined_type: type[TroposphereT], *, many: bool = False, optional: bool = False, @@ -78,7 +65,7 @@ def __init__( self._validate = validate @staticmethod - def _validate_type(defined_type: Type[TroposphereT]) -> None: + def _validate_type(defined_type: type[TroposphereT]) -> None: if not hasattr(defined_type, "from_dict"): raise ValueError("Type must have `from_dict` attribute") @@ -88,17 +75,17 @@ def resource_name(self) -> str: return str(getattr(self._type, "resource_name", None) or self._type.__name__) @overload - def create(self, value: Dict[str, Any]) -> TroposphereT: ... + def create(self, value: dict[str, Any]) -> TroposphereT: ... @overload - def create(self, value: List[Dict[str, Any]]) -> List[TroposphereT]: ... + def create(self, value: list[dict[str, Any]]) -> list[TroposphereT]: ... @overload def create(self, value: None) -> None: ... def create( - self, value: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] - ) -> Optional[Union[TroposphereT, List[TroposphereT]]]: + self, value: dict[str, Any] | list[dict[str, Any]] | None + ) -> TroposphereT | list[TroposphereT] | None: """Create the troposphere type from the value. Args: @@ -119,33 +106,27 @@ def create( # Our type is a resource, so ensure we have a dict of title to # parameters if not isinstance(value, dict): - raise ValueError( - "Resources must be specified as a dict of title to parameters" - ) + raise ValueError("Resources must be specified as a dict of title to parameters") if not self._many and len(value) > 1: raise ValueError( - "Only one resource can be provided for this " - "TroposphereType variable" + "Only one resource can be provided for this TroposphereType variable" ) result = [self._type.from_dict(title, v) for title, v in value.items()] + elif self._many and isinstance(value, list): + result = [self._type.from_dict(None, v) for v in value] + elif not isinstance(value, dict): + raise ValueError( + "TroposphereType for a single non-resource" + "type must be specified as a dict of " + "parameters" + ) else: - # Our type is for properties, not a resource, so don't use - # titles - if self._many and isinstance(value, list): - result = [self._type.from_dict(None, v) for v in value] - elif not isinstance(value, dict): - raise ValueError( - "TroposphereType for a single non-resource" - "type must be specified as a dict of " - "parameters" - ) - else: - result = [self._type.from_dict(None, value)] + result = [self._type.from_dict(None, value)] if self._validate: for v in result: - v._validate_props() + v._validate_props() # noqa: SLF001 return result[0] if not self._many else result @@ -235,17 +216,13 @@ class EC2ImageId(CFNType): class EC2InstanceId(CFNType): """An Amazon EC2 instance ID, such as i-1e731a32.""" - parameter_type: ClassVar[Literal["AWS::EC2::Instance::Id"]] = ( - "AWS::EC2::Instance::Id" - ) + parameter_type: ClassVar[Literal["AWS::EC2::Instance::Id"]] = "AWS::EC2::Instance::Id" class EC2KeyPairKeyName(CFNType): """An Amazon EC2 key pair name.""" - parameter_type: ClassVar[Literal["AWS::EC2::KeyPair::KeyName"]] = ( - "AWS::EC2::KeyPair::KeyName" - ) + parameter_type: ClassVar[Literal["AWS::EC2::KeyPair::KeyName"]] = "AWS::EC2::KeyPair::KeyName" class EC2SecurityGroupGroupName(CFNType): @@ -259,9 +236,7 @@ class EC2SecurityGroupGroupName(CFNType): class EC2SecurityGroupId(CFNType): """A security group ID, such as sg-a123fd85.""" - parameter_type: ClassVar[Literal["AWS::EC2::SecurityGroup::Id"]] = ( - "AWS::EC2::SecurityGroup::Id" - ) + parameter_type: ClassVar[Literal["AWS::EC2::SecurityGroup::Id"]] = "AWS::EC2::SecurityGroup::Id" class EC2SubnetId(CFNType): @@ -306,9 +281,7 @@ class EC2ImageIdList(CFNType): """ - parameter_type: ClassVar[Literal["List"]] = ( - "List" - ) + parameter_type: ClassVar[Literal["List"]] = "List" class EC2InstanceIdList(CFNType): @@ -338,25 +311,19 @@ class EC2SecurityGroupIdList(CFNType): class EC2SubnetIdList(CFNType): """An array of subnet IDs, such as subnet-123a351e, subnet-456b351e.""" - parameter_type: ClassVar[Literal["List"]] = ( - "List" - ) + parameter_type: ClassVar[Literal["List"]] = "List" class EC2VolumeIdList(CFNType): """An array of Amazon EBS volume IDs, such as vol-3cdd3f56, vol-4cdd3f56.""" - parameter_type: ClassVar[Literal["List"]] = ( - "List" - ) + parameter_type: ClassVar[Literal["List"]] = "List" class EC2VPCIdList(CFNType): """An array of VPC IDs, such as vpc-a123baa3, vpc-b456baa3.""" - parameter_type: ClassVar[Literal["List"]] = ( - "List" - ) + parameter_type: ClassVar[Literal["List"]] = "List" class Route53HostedZoneIdList(CFNType): @@ -377,9 +344,7 @@ class SSMParameterName(CFNType): """ - parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Name"]] = ( - "AWS::SSM::Parameter::Name" - ) + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Name"]] = "AWS::SSM::Parameter::Name" class SSMParameterValueString(CFNType): @@ -413,9 +378,9 @@ class SSMParameterValueCommaDelimitedList(CFNType): """ - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value"] - ] = "AWS::SSM::Parameter::Value" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value"]] = ( + "AWS::SSM::Parameter::Value" + ) class SSMParameterValueEC2AvailabilityZoneName(CFNType): @@ -429,25 +394,25 @@ class SSMParameterValueEC2AvailabilityZoneName(CFNType): class SSMParameterValueEC2ImageId(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value"] - ] = "AWS::SSM::Parameter::Value" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value"]] = ( + "AWS::SSM::Parameter::Value" + ) class SSMParameterValueEC2InstanceId(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value"] - ] = "AWS::SSM::Parameter::Value" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value"]] = ( + "AWS::SSM::Parameter::Value" + ) class SSMParameterValueEC2KeyPairKeyName(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value"] - ] = "AWS::SSM::Parameter::Value" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value"]] = ( + "AWS::SSM::Parameter::Value" + ) class SSMParameterValueEC2SecurityGroupGroupName(CFNType): @@ -461,33 +426,33 @@ class SSMParameterValueEC2SecurityGroupGroupName(CFNType): class SSMParameterValueEC2SecurityGroupId(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value"] - ] = "AWS::SSM::Parameter::Value" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value"]] = ( + "AWS::SSM::Parameter::Value" + ) class SSMParameterValueEC2SubnetId(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value"] - ] = "AWS::SSM::Parameter::Value" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value"]] = ( + "AWS::SSM::Parameter::Value" + ) class SSMParameterValueEC2VolumeId(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value"] - ] = "AWS::SSM::Parameter::Value" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value"]] = ( + "AWS::SSM::Parameter::Value" + ) class SSMParameterValueEC2VPCId(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value"] - ] = "AWS::SSM::Parameter::Value" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value"]] = ( + "AWS::SSM::Parameter::Value" + ) class SSMParameterValueRoute53HostedZoneId(CFNType): @@ -509,9 +474,9 @@ class SSMParameterValueEC2AvailabilityZoneNameList(CFNType): class SSMParameterValueEC2ImageIdList(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value>"] - ] = "AWS::SSM::Parameter::Value>" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value>"]] = ( + "AWS::SSM::Parameter::Value>" + ) class SSMParameterValueEC2InstanceIdList(CFNType): @@ -541,25 +506,25 @@ class SSMParameterValueEC2SecurityGroupIdList(CFNType): class SSMParameterValueEC2SubnetIdList(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value>"] - ] = "AWS::SSM::Parameter::Value>" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value>"]] = ( + "AWS::SSM::Parameter::Value>" + ) class SSMParameterValueEC2VolumeIdList(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value>"] - ] = "AWS::SSM::Parameter::Value>" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value>"]] = ( + "AWS::SSM::Parameter::Value>" + ) class SSMParameterValueEC2VPCIdList(CFNType): """A Systems Manager parameter whose value is an AWS-specific parameter type.""" - parameter_type: ClassVar[ - Literal["AWS::SSM::Parameter::Value>"] - ] = "AWS::SSM::Parameter::Value>" + parameter_type: ClassVar[Literal["AWS::SSM::Parameter::Value>"]] = ( + "AWS::SSM::Parameter::Value>" + ) class SSMParameterValueRoute53HostedZoneIdList(CFNType): diff --git a/runway/cfngin/cfngin.py b/runway/cfngin/cfngin.py index 0dd876783..fbd9e8597 100644 --- a/runway/cfngin/cfngin.py +++ b/runway/cfngin/cfngin.py @@ -3,9 +3,8 @@ from __future__ import annotations import logging -import os from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, cast +from typing import TYPE_CHECKING, Any, cast from .._logging import PrefixAdaptor from ..compat import cached_property @@ -52,8 +51,8 @@ class and any environment files that are found. def __init__( self, ctx: RunwayContext, - parameters: Optional[Dict[str, Any]] = None, - sys_path: Optional[Path] = None, + parameters: dict[str, Any] | None = None, + sys_path: Path | None = None, ) -> None: """Instantiate class. @@ -84,21 +83,21 @@ def __init__( @cached_property def env_file(self) -> MutableMap: """Contents of a CFNgin environment file.""" - result: Dict[str, Any] = {} + result: dict[str, Any] = {} supported_names = [ f"{self.__ctx.env.name}.env", f"{self.__ctx.env.name}-{self.region}.env", ] for _, file_name in enumerate(supported_names): - file_path = os.path.join(self.sys_path, file_name) - if os.path.isfile(file_path): + file_path = self.sys_path / file_name + if file_path.is_file(): LOGGER.info("found environment file: %s", file_path) self._env_file_name = file_path - with open(file_path, "r", encoding="utf-8") as file_: + with file_path.open(encoding="utf-8") as file_: result.update(parse_environment(file_.read())) return MutableMap(**result) - def deploy(self, force: bool = False, sys_path: Optional[Path] = None) -> None: + def deploy(self, force: bool = False, sys_path: Path | None = None) -> None: """Run the CFNgin deploy action. Args: @@ -113,24 +112,20 @@ def deploy(self, force: bool = False, sys_path: Optional[Path] = None) -> None: sys_path = sys_path or self.sys_path config_file_paths = self.find_config_files(sys_path=sys_path) - with SafeHaven( - environ=self.__ctx.env.vars, sys_modules_exclude=["awacs", "troposphere"] - ): + with SafeHaven(environ=self.__ctx.env.vars, sys_modules_exclude=["awacs", "troposphere"]): for config_path in config_file_paths: - logger = PrefixAdaptor(os.path.basename(config_path), LOGGER) + logger = PrefixAdaptor(config_path.name, LOGGER) logger.notice("deploy (in progress)") with SafeHaven(sys_modules_exclude=["awacs", "troposphere"]): ctx = self.load(config_path) action = deploy.Action( context=ctx, - provider_builder=self._get_provider_builder( - ctx.config.service_role - ), + provider_builder=self._get_provider_builder(ctx.config.service_role), ) action.execute(concurrency=self.concurrency, tail=self.tail) logger.success("deploy (complete)") - def destroy(self, force: bool = False, sys_path: Optional[Path] = None) -> None: + def destroy(self, force: bool = False, sys_path: Path | None = None) -> None: """Run the CFNgin destroy action. Args: @@ -155,35 +150,27 @@ def destroy(self, force: bool = False, sys_path: Optional[Path] = None) -> None: ctx = self.load(config_path) action = destroy.Action( context=ctx, - provider_builder=self._get_provider_builder( - ctx.config.service_role - ), - ) - action.execute( - concurrency=self.concurrency, force=True, tail=self.tail + provider_builder=self._get_provider_builder(ctx.config.service_role), ) + action.execute(concurrency=self.concurrency, force=True, tail=self.tail) logger.success("destroy (complete)") - def init(self, force: bool = False, sys_path: Optional[Path] = None) -> None: + def init(self, force: bool = False, sys_path: Path | None = None) -> None: """Initialize environment.""" if self.should_skip(force): return sys_path = sys_path or self.sys_path config_file_paths = self.find_config_files(sys_path=sys_path) - with SafeHaven( - environ=self.__ctx.env.vars, sys_modules_exclude=["awacs", "troposphere"] - ): + with SafeHaven(environ=self.__ctx.env.vars, sys_modules_exclude=["awacs", "troposphere"]): for config_path in config_file_paths: - logger = PrefixAdaptor(os.path.basename(config_path), LOGGER) + logger = PrefixAdaptor(config_path.name, LOGGER) logger.notice("init (in progress)") with SafeHaven(sys_modules_exclude=["awacs", "troposphere"]): ctx = self.load(config_path) action = init.Action( context=ctx, - provider_builder=self._get_provider_builder( - ctx.config.service_role - ), + provider_builder=self._get_provider_builder(ctx.config.service_role), ) action.execute(concurrency=self.concurrency, tail=self.tail) logger.success("init (complete)") @@ -210,7 +197,7 @@ def load(self, config_path: Path) -> CfnginContext: config.load() return self._get_context(config, config_path) - def plan(self, force: bool = False, sys_path: Optional[Path] = None): + def plan(self, force: bool = False, sys_path: Path | None = None) -> None: """Run the CFNgin plan action. Args: @@ -232,9 +219,7 @@ def plan(self, force: bool = False, sys_path: Optional[Path] = None): ctx = self.load(config_path) action = diff.Action( context=ctx, - provider_builder=self._get_provider_builder( - ctx.config.service_role - ), + provider_builder=self._get_provider_builder(ctx.config.service_role), ) action.execute() logger.success("plan (complete)") @@ -284,9 +269,7 @@ def _get_context(self, config: CfnginConfig, config_path: Path) -> CfnginContext work_dir=self.__ctx.work_dir, ) - def _get_provider_builder( - self, service_role: Optional[str] = None - ) -> ProviderBuilder: + def _get_provider_builder(self, service_role: str | None = None) -> ProviderBuilder: """Initialize provider builder. Args: @@ -330,8 +313,8 @@ def _inject_common_parameters(self) -> None: @classmethod def find_config_files( - cls, exclude: Optional[List[str]] = None, sys_path: Optional[Path] = None - ) -> List[Path]: + cls, exclude: list[str] | None = None, sys_path: Path | None = None + ) -> list[Path]: """Find CFNgin config files. Args: diff --git a/runway/cfngin/dag/__init__.py b/runway/cfngin/dag/__init__.py index 1966f812f..e962973ed 100644 --- a/runway/cfngin/dag/__init__.py +++ b/runway/cfngin/dag/__init__.py @@ -4,25 +4,16 @@ import collections import collections.abc +import contextlib import logging +from collections import OrderedDict from copy import copy, deepcopy from threading import Thread -from typing import ( - TYPE_CHECKING, - Any, - Callable, - Dict, - Iterable, - List, - OrderedDict, - Set, - Tuple, - Union, - cast, -) +from typing import TYPE_CHECKING, Any, Callable, Union, cast if TYPE_CHECKING: import threading + from collections.abc import Iterable LOGGER = logging.getLogger(__name__) @@ -34,7 +25,7 @@ class DAGValidationError(Exception): class DAG: """Directed acyclic graph implementation.""" - graph: OrderedDict[str, Set[str]] + graph: OrderedDict[str, set[str]] def __init__(self) -> None: """Instantiate a new DAG with no nodes or edges.""" @@ -54,7 +45,7 @@ def add_node(self, node_name: str) -> None: graph = self.graph if node_name in graph: raise KeyError(f"node {node_name} already exists") - graph[node_name] = cast(Set[str], set()) + graph[node_name] = cast(set[str], set()) def add_node_if_not_exists(self, node_name: str) -> None: """Add a node if it does not exist yet, ignoring duplicates. @@ -63,10 +54,8 @@ def add_node_if_not_exists(self, node_name: str) -> None: node_name: The name of the node to add. """ - try: + with contextlib.suppress(KeyError): self.add_node(node_name) - except KeyError: - pass def delete_node(self, node_name: str) -> None: """Delete this node and all edges referencing it. @@ -83,7 +72,7 @@ def delete_node(self, node_name: str) -> None: raise KeyError(f"node {node_name} does not exist") graph.pop(node_name) - for _node, edges in graph.items(): + for edges in graph.values(): if node_name in edges: edges.remove(node_name) @@ -97,10 +86,8 @@ def delete_node_if_exists(self, node_name: str) -> None: node_name: The name of the node to delete. """ - try: + with contextlib.suppress(KeyError): self.delete_node(node_name) - except KeyError: - pass def add_edge(self, ind_node: str, dep_node: str) -> None: """Add an edge (dependency) between the specified nodes. @@ -150,7 +137,7 @@ def transpose(self) -> DAG: """Build a new graph with the edges reversed.""" graph = self.graph transposed = DAG() - for node, _edges in graph.items(): + for node in graph: transposed.add_node(node) for node, edges in graph.items(): # for each edge A -> B, transpose it so that B -> A @@ -185,12 +172,12 @@ def transitive_reduction(self) -> None: See https://en.wikipedia.org/wiki/Transitive_reduction """ - combinations: List[List[str]] = [] + combinations: list[list[str]] = [] for node, edges in self.graph.items(): combinations += [[node, edge] for edge in edges] while True: - new_combinations: List[List[str]] = [] + new_combinations: list[list[str]] = [] for comb1 in combinations: for comb2 in combinations: if comb1[-1] != comb2[0]: @@ -221,25 +208,24 @@ def rename_edges(self, old_node_name: str, new_node_name: str) -> None: graph[new_node_name] = copy(edges) del graph[old_node_name] - else: - if old_node_name in edges: - edges.remove(old_node_name) - edges.add(new_node_name) + elif old_node_name in edges: + edges.remove(old_node_name) + edges.add(new_node_name) - def predecessors(self, node: str) -> List[str]: + def predecessors(self, node: str) -> list[str]: """Return a list of all immediate predecessors of the given node. Args: node (str): The node whose predecessors you want to find. Returns: - List[str]: A list of nodes that are immediate predecessors to node. + list[str]: A list of nodes that are immediate predecessors to node. """ graph = self.graph return [key for key in graph if node in graph[key]] - def downstream(self, node: str) -> List[str]: + def downstream(self, node: str) -> list[str]: """Return a list of all nodes this node has edges towards. Args: @@ -254,7 +240,7 @@ def downstream(self, node: str) -> List[str]: raise KeyError(f"node {node} is not in graph") return list(graph[node]) - def all_downstreams(self, node: str) -> List[str]: + def all_downstreams(self, node: str) -> list[str]: """Return a list of all nodes downstream in topological order. Args: @@ -265,7 +251,7 @@ def all_downstreams(self, node: str) -> List[str]: """ nodes = [node] - nodes_seen: Set[str] = set() + nodes_seen: set[str] = set() nodes_iter = nodes for node__ in nodes_iter: downstreams = self.downstream(node__) @@ -275,7 +261,7 @@ def all_downstreams(self, node: str) -> List[str]: nodes.append(downstream_node) return [node_ for node_ in self.topological_sort() if node_ in nodes_seen] - def filter(self, nodes: List[str]) -> DAG: + def filter(self, nodes: list[str]) -> DAG: """Return a new DAG with only the given nodes and their dependencies. Args: @@ -297,12 +283,12 @@ def filter(self, nodes: List[str]) -> DAG: return filtered_dag - def all_leaves(self) -> List[str]: + def all_leaves(self) -> list[str]: """Return a list of all leaves (nodes with no downstreams).""" graph = self.graph return [key for key in graph if not graph[key]] - def from_dict(self, graph_dict: Dict[str, Union[Iterable[str], Any]]) -> None: + def from_dict(self, graph_dict: dict[str, Union[Iterable[str], Any]]) -> None: """Reset the graph and build it from the passed dictionary. The dictionary takes the form of {node_name: [directed edges]} @@ -327,7 +313,7 @@ def reset_graph(self) -> None: """Restore the graph to an empty state.""" self.graph = collections.OrderedDict() - def ind_nodes(self) -> List[str]: + def ind_nodes(self) -> list[str]: """Return a list of all nodes in the graph with no dependencies.""" graph = self.graph @@ -335,7 +321,7 @@ def ind_nodes(self) -> List[str]: return [node_ for node_ in graph if node_ not in dependent_nodes] - def validate(self) -> Tuple[bool, str]: + def validate(self) -> tuple[bool, str]: """Return (Boolean, message) of whether DAG is valid.""" if not self.ind_nodes(): return (False, "no independent nodes detected") @@ -345,7 +331,7 @@ def validate(self) -> Tuple[bool, str]: return False, str(err) return True, "valid" - def topological_sort(self) -> List[str]: + def topological_sort(self) -> list[str]: """Return a topological ordering of the DAG. Raises: @@ -359,12 +345,12 @@ def topological_sort(self) -> List[str]: for val in graph[node]: in_degree[val] += 1 - queue: "collections.deque[str]" = collections.deque() + queue: collections.deque[str] = collections.deque() for node, value in in_degree.items(): if value == 0: queue.appendleft(node) - sorted_graph: List[str] = [] + sorted_graph: list[str] = [] while queue: node = queue.pop() sorted_graph.append(node) @@ -404,7 +390,7 @@ def release(self) -> Any: class ThreadedWalker: """Walk a DAG as quickly as the graph topology allows, using threads.""" - def __init__(self, semaphore: Union[threading.Semaphore, UnlimitedSemaphore]): + def __init__(self, semaphore: Union[threading.Semaphore, UnlimitedSemaphore]) -> None: """Instantiate class. Args: @@ -431,11 +417,11 @@ def walk(self, dag: DAG, walk_func: Callable[[str], Any]) -> None: nodes.reverse() # This maps a node name to a thread of execution. - threads: Dict[str, Any] = {} + threads: dict[str, Any] = {} # Blocks until all of the given nodes have completed execution (whether # successfully, or errored). Returns True if all nodes returned True. - def wait_for(nodes: List[str]): + def wait_for(nodes: list[str]) -> None: """Wait for nodes.""" for node in nodes: thread = threads[node] @@ -447,11 +433,9 @@ def wait_for(nodes: List[str]): # nodes dependencies have executed. for node in nodes: - def _fn(node_: str, deps: List[str]) -> Any: + def _fn(node_: str, deps: list[str]) -> Any: if deps: - LOGGER.debug( - "%s waiting for %s to complete", node_, ", ".join(deps) - ) + LOGGER.debug("%s waiting for %s to complete", node_, ", ".join(deps)) # Wait for all dependencies to complete. wait_for(deps) diff --git a/runway/cfngin/environment.py b/runway/cfngin/environment.py index c9a7c3c73..0cf405a5e 100644 --- a/runway/cfngin/environment.py +++ b/runway/cfngin/environment.py @@ -1,18 +1,18 @@ """CFNgin environment file parsing.""" -from typing import Any, Dict +from typing import Any -def parse_environment(raw_environment: str) -> Dict[str, Any]: +def parse_environment(raw_environment: str) -> dict[str, Any]: """Parse environment file contents. Args: raw_environment: Environment file read into a string. """ - environment: Dict[str, Any] = {} - for line in raw_environment.split("\n"): - line = line.strip() + environment: dict[str, Any] = {} + for raw_line in raw_environment.split("\n"): + line = raw_line.strip() if not line: continue diff --git a/runway/cfngin/exceptions.py b/runway/cfngin/exceptions.py index e1ebee2be..3edd4d06b 100644 --- a/runway/cfngin/exceptions.py +++ b/runway/cfngin/exceptions.py @@ -3,7 +3,7 @@ from __future__ import annotations from pathlib import Path -from typing import TYPE_CHECKING, Any, List, Optional, Union +from typing import TYPE_CHECKING, Any from ..exceptions import RunwayError @@ -74,12 +74,10 @@ def __init__(self, *, bucket_name: str) -> None: class CfnginBucketRequired(CfnginError): """CFNgin bucket is required to use a feature but it not provided/disabled.""" - config_path: Optional[Path] + config_path: Path | None message: str - def __init__( - self, *, config_path: Optional[AnyPath] = None, reason: Optional[str] = None - ) -> None: + def __init__(self, *, config_path: AnyPath | None = None, reason: str | None = None) -> None: """Instantiate class. Args: @@ -106,9 +104,7 @@ class CfnginOnlyLookupError(CfnginError): def __init__(self, lookup_name: str) -> None: """Instantiate class.""" self.lookup_name = lookup_name - self.message = ( - f"attempted to use CFNgin only lookup {lookup_name} outside of CFNgin" - ) + self.message = f"attempted to use CFNgin only lookup {lookup_name} outside of CFNgin" super().__init__() @@ -165,6 +161,8 @@ def __init__(self, kls: Any, error: Exception, *args: Any, **kwargs: Any) -> Non Args: kls: The class that was improperly configured. error: The exception that was raised when trying to use cls. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.message = f'Class "{kls}" is improperly configured: {error}' @@ -174,10 +172,10 @@ def __init__(self, kls: Any, error: Exception, *args: Any, **kwargs: Any) -> Non class InvalidConfig(CfnginError): """Provided config file is invalid.""" - errors: Union[str, List[Union[Exception, str]]] + errors: str | list[Exception | str] message: str - def __init__(self, errors: Union[str, List[Union[Exception, str]]]) -> None: + def __init__(self, errors: str | list[Exception | str]) -> None: """Instantiate class. Args: @@ -227,6 +225,8 @@ def __init__( blueprint_name: Name of the blueprint with invalid userdata placeholder. exception_message: Message from the exception that was raised while parsing the userdata. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.message = ( @@ -246,6 +246,8 @@ def __init__(self, key: str, *args: Any, **kwargs: Any) -> None: Args: key: The key that was used but doesn't exist in the environment. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.key = key @@ -258,17 +260,17 @@ class MissingParameterException(CfnginError): message: str - def __init__(self, parameters: List[str], *args: Any, **kwargs: Any) -> None: + def __init__(self, parameters: list[str], *args: Any, **kwargs: Any) -> None: """Instantiate class. Args: parameters: A list of the parameters that are missing. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.parameters = parameters - self.message = ( - f"Missing required cloudformation parameters: {', '.join(parameters)}" - ) + self.message = f"Missing required cloudformation parameters: {', '.join(parameters)}" super().__init__(*args, **kwargs) @@ -277,19 +279,17 @@ class MissingVariable(CfnginError): message: str - def __init__( - self, blueprint_name: str, variable_name: str, *args: Any, **kwargs: Any - ) -> None: + def __init__(self, blueprint_name: str, variable_name: str, *args: Any, **kwargs: Any) -> None: """Instantiate class. Args: blueprint_name: Name of the blueprint. variable_name: Name of the variable missing a value. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ - self.message = ( - f'Variable "{variable_name}" in blueprint "{blueprint_name}" is missing' - ) + self.message = f'Variable "{variable_name}" in blueprint "{blueprint_name}" is missing' super().__init__(*args, **kwargs) @@ -339,7 +339,7 @@ class PersistentGraphCannotUnlock(CfnginError): message: str - def __init__(self, reason: Union[Exception, str]) -> None: + def __init__(self, reason: Exception | str) -> None: """Instantiate class.""" self.message = f"Could not unlock persistent graph; {reason}" super().__init__() @@ -354,17 +354,12 @@ class PersistentGraphLocked(CfnginError): message: str - def __init__( - self, *, message: Optional[str] = None, reason: Optional[str] = None - ) -> None: + def __init__(self, *, message: str | None = None, reason: str | None = None) -> None: """Instantiate class.""" if message: self.message = message else: - reason = ( - reason - or "This action requires the graph to be unlocked to be executed." - ) + reason = reason or "This action requires the graph to be unlocked to be executed." self.message = f"Persistent graph is locked. {reason}" super().__init__() @@ -379,7 +374,7 @@ class PersistentGraphLockCodeMismatch(CfnginError): message: str - def __init__(self, provided_code: str, s3_code: Optional[str]) -> None: + def __init__(self, provided_code: str, s3_code: str | None) -> None: """Instantiate class.""" self.message = ( f"The provided lock code '{provided_code}' does not match the S3 " @@ -397,16 +392,12 @@ class PersistentGraphUnlocked(CfnginError): message: str - def __init__( - self, message: Optional[str] = None, reason: Optional[str] = None - ) -> None: + def __init__(self, message: str | None = None, reason: str | None = None) -> None: """Instantiate class.""" if message: self.message = message else: - reason = ( - reason or "This action requires the graph to be locked to be executed." - ) + reason = reason or "This action requires the graph to be locked to be executed." self.message = f"Persistent graph is unlocked. {reason}" super().__init__() @@ -416,11 +407,13 @@ class PlanFailed(CfnginError): message: str - def __init__(self, failed_steps: List[Step], *args: Any, **kwargs: Any) -> None: + def __init__(self, failed_steps: list[Step], *args: Any, **kwargs: Any) -> None: """Instantiate class. Args: failed_steps: The steps that failed. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.failed_steps = failed_steps @@ -447,6 +440,8 @@ def __init__(self, stack_name: str, *args: Any, **kwargs: Any) -> None: Args: stack_name: Name of the stack that does not exist. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.message = ( @@ -470,6 +465,8 @@ def __init__( stack_name: Name of the stack. stack_status: The stack's status. reason: The reason for the current status. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.stack_name = stack_name @@ -491,7 +488,7 @@ class StackFailed(CfnginError): message: str - def __init__(self, stack_name: str, status_reason: Optional[str] = None) -> None: + def __init__(self, stack_name: str, status_reason: str | None = None) -> None: """Instantiate class. Args: @@ -513,9 +510,7 @@ class UnableToExecuteChangeSet(CfnginError): message: str - def __init__( - self, stack_name: str, change_set_id: str, execution_status: str - ) -> None: + def __init__(self, stack_name: str, change_set_id: str, execution_status: str) -> None: """Instantiate class. Args: @@ -575,20 +570,19 @@ class UnresolvedBlueprintVariable(CfnginError): message: str - def __init__( - self, blueprint_name: str, variable: Variable, *args: Any, **kwargs: Any - ) -> None: + def __init__(self, blueprint_name: str, variable: Variable, *args: Any, **kwargs: Any) -> None: """Instantiate class. Args: blueprint_name: Name of the blueprint that tried to use the unresolved variables. variable: The unresolved variable. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.message = ( - f'Variable "{variable.name}" in blueprint "{blueprint_name}" ' - "hasn't been resolved" + f'Variable "{variable.name}" in blueprint "{blueprint_name}" hasn\'t been resolved' ) super().__init__(*args, **kwargs) @@ -604,6 +598,8 @@ def __init__(self, blueprint_name: str, *args: Any, **kwargs: Any) -> None: Args: blueprint_name: Name of the blueprint that tried to use the unresolved variables. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.message = f"Blueprint: \"{blueprint_name}\" hasn't resolved it's variables" @@ -620,7 +616,7 @@ def __init__( variable: str, validator: str, value: str, - exception: Optional[Exception] = None, + exception: Exception | None = None, ) -> None: """Instantiate class. @@ -641,12 +637,10 @@ def __init__( ) if self.exception: - self.message += ( - f": {self.exception.__class__.__name__}: {str(self.exception)}" - ) + self.message += f": {self.exception.__class__.__name__}: {self.exception!s}" super().__init__() - def __str__(self): + def __str__(self) -> str: """Return the exception's message when converting to a string.""" return self.message @@ -656,18 +650,17 @@ class VariableTypeRequired(CfnginError): message: str - def __init__( - self, blueprint_name: str, variable_name: str, *args: Any, **kwargs: Any - ) -> None: + def __init__(self, blueprint_name: str, variable_name: str, *args: Any, **kwargs: Any) -> None: """Instantiate class. Args: blueprint_name: Name of the blueprint. variable_name: Name of the variable missing a type. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.message = ( - f'Variable "{variable_name}" in blueprint "{blueprint_name}" ' - "does not have a type" + f'Variable "{variable_name}" in blueprint "{blueprint_name}" does not have a type' ) super().__init__(*args, **kwargs) diff --git a/runway/cfngin/hooks/acm.py b/runway/cfngin/hooks/acm.py index fb1cc22cc..5b34c8067 100644 --- a/runway/cfngin/hooks/acm.py +++ b/runway/cfngin/hooks/acm.py @@ -4,12 +4,11 @@ import logging import time -from typing import TYPE_CHECKING, Any, ClassVar, Dict, List, Optional, Type +from typing import TYPE_CHECKING, Any, ClassVar, List, Optional # noqa: UP035 from botocore.exceptions import ClientError from troposphere import Ref from troposphere.certificatemanager import Certificate as CertificateResource -from typing_extensions import Literal from ...utils import MutableMap from ..blueprints.variables.types import CFNString @@ -23,6 +22,7 @@ from mypy_boto3_acm.type_defs import ResourceRecordTypeDef from mypy_boto3_route53.client import Route53Client from mypy_boto3_route53.type_defs import ChangeTypeDef + from typing_extensions import Literal from ...context import CfnginContext from ..blueprints.base import Blueprint @@ -36,7 +36,7 @@ class HookArgs(HookArgsBaseModel): """Hook arguments.""" - alt_names: List[str] = [] + alt_names: List[str] = [] # noqa: UP006 domain: str hosted_zone_id: str stack_name: Optional[str] = None @@ -47,7 +47,7 @@ class Certificate(Hook): r"""Hook for managing a **AWS::CertificateManager::Certificate**. Keyword Args: - alt_names (Optional[List[str]]): Additional FQDNs to be included in the + alt_names (Optional[list[str]]): Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, you can add www.example.net to a certificate for which the domain field is www.example.com if users can reach your site by @@ -80,7 +80,7 @@ class Certificate(Hook): """ - ARGS_PARSER: ClassVar[Type[HookArgs]] = HookArgs + ARGS_PARSER: ClassVar[type[HookArgs]] = HookArgs acm_client: ACMClient args: HookArgs @@ -89,14 +89,13 @@ class Certificate(Hook): stack: Stack template_description: str - def __init__( - self, context: CfnginContext, provider: Provider, **kwargs: Any - ) -> None: + def __init__(self, context: CfnginContext, provider: Provider, **kwargs: Any) -> None: """Instantiate class. Args: context: Context instance. (passed in by CFNgin) provider: Provider instance. (passed in by CFNgin) + **kwargs: Arbitrary keyword arguments. """ super().__init__(context, provider, **kwargs) @@ -105,12 +104,10 @@ def __init__( self.stack_name = self.args.stack_name or self.args.domain.replace(".", "-") self.properties = MutableMap( - **{ - "DomainName": self.args.domain, - "SubjectAlternativeNames": self.args.alt_names, - "Tags": self.tags, - "ValidationMethod": "DNS", - } + DomainName=self.args.domain, + SubjectAlternativeNames=self.args.alt_names, + Tags=self.tags, + ValidationMethod="DNS", ) self.blueprint = self._create_blueprint() @@ -158,22 +155,16 @@ def domain_changed(self) -> bool: try: stack_info = self.provider.get_stack(self.stack.fqn) if self.provider.is_stack_recreatable(stack_info): - LOGGER.debug( - "stack is in a recreatable state; domain change does not matter" - ) + LOGGER.debug("stack is in a recreatable state; domain change does not matter") return False if self.provider.is_stack_in_progress( stack_info ) or self.provider.is_stack_rolling_back(stack_info): LOGGER.debug("stack is in progress; can't check for domain change") return False - if ( - self.args.domain - != self.provider.get_outputs(self.stack.fqn)["DomainName"] - ): + if self.args.domain != self.provider.get_outputs(self.stack.fqn)["DomainName"]: LOGGER.error( - '"domain" can\'t be changed for existing ' - 'certificate in stack "%s"', + '"domain" can\'t be changed for existing certificate in stack "%s"', self.stack.fqn, ) return True @@ -199,10 +190,9 @@ def get_certificate(self, interval: int = 5) -> str: response = self.provider.cloudformation.describe_stack_resources( StackName=self.stack.fqn, LogicalResourceId="Certificate" )["StackResources"] - if response: - # can be returned without having a PhysicalResourceId - if "PhysicalResourceId" in response[0]: - return response[0]["PhysicalResourceId"] + # can be returned without having a PhysicalResourceId + if response and "PhysicalResourceId" in response[0]: + return response[0]["PhysicalResourceId"] LOGGER.debug("waiting for certificate to be created...") time.sleep(interval) return self.get_certificate(interval=interval) @@ -228,25 +218,18 @@ def get_validation_record( """ if not cert_arn: cert_arn = self.get_certificate() - cert = self.acm_client.describe_certificate(CertificateArn=cert_arn).get( - "Certificate", {} - ) + cert = self.acm_client.describe_certificate(CertificateArn=cert_arn).get("Certificate", {}) try: domain_validation = [ - opt - for opt in cert["DomainValidationOptions"] - if opt["ValidationStatus"] == status + opt for opt in cert["DomainValidationOptions"] if opt["ValidationStatus"] == status ] except KeyError: LOGGER.debug( - "waiting for DomainValidationOptions to become " - "available for the certificate..." + "waiting for DomainValidationOptions to become available for the certificate..." ) time.sleep(interval) - return self.get_validation_record( - cert_arn=cert_arn, interval=interval, status=status - ) + return self.get_validation_record(cert_arn=cert_arn, interval=interval, status=status) if not domain_validation: raise ValueError( @@ -266,9 +249,7 @@ def get_validation_record( "to become available for the certificate..." ) time.sleep(interval) - return self.get_validation_record( - cert_arn=cert_arn, interval=interval, status=status - ) + return self.get_validation_record(cert_arn=cert_arn, interval=interval, status=status) def put_record_set(self, record_set: ResourceRecordTypeDef) -> None: """Create/update a record set on a Route 53 Hosted Zone. @@ -277,13 +258,11 @@ def put_record_set(self, record_set: ResourceRecordTypeDef) -> None: record_set: Record set to be added to Route 53. """ - LOGGER.info( - "adding validation record to hosted zone: %s", self.args.hosted_zone_id - ) + LOGGER.info("adding validation record to hosted zone: %s", self.args.hosted_zone_id) self.__change_record_set("CREATE", [record_set]) def remove_validation_records( - self, records: Optional[List[ResourceRecordTypeDef]] = None + self, records: Optional[list[ResourceRecordTypeDef]] = None ) -> None: """Remove all record set entries used to validate an ACM Certificate. @@ -324,7 +303,7 @@ def update_record_set(self, record_set: ResourceRecordTypeDef) -> None: def __change_record_set( self, action: Literal["CREATE", "DELETE", "UPSERT"], - record_sets: List[ResourceRecordTypeDef], + record_sets: list[ResourceRecordTypeDef], ) -> None: """Wrap boto3.client('acm').change_resource_record_sets. @@ -336,7 +315,7 @@ def __change_record_set( if not record_sets: raise ValueError("Must provide one of more record sets") - changes: List[ChangeTypeDef] = [ + changes: list[ChangeTypeDef] = [ { "Action": action, "ResourceRecordSet": { @@ -360,7 +339,7 @@ def __change_record_set( ChangeBatch={"Comment": self.template_description, "Changes": changes}, ) - def deploy(self, status: Optional[Status] = None) -> Dict[str, str]: + def deploy(self, status: Optional[Status] = None) -> dict[str, str]: """Deploy an ACM Certificate.""" record = None try: @@ -425,7 +404,7 @@ def deploy(self, status: Optional[Status] = None) -> Dict[str, str]: def destroy( self, - records: Optional[List[ResourceRecordTypeDef]] = None, + records: Optional[list[ResourceRecordTypeDef]] = None, skip_r53: bool = False, ) -> bool: """Destroy an ACM certificate. @@ -447,23 +426,19 @@ def destroy( ) as err: # these error are fine if they happen during destruction but # could require manual steps to finish cleanup. - LOGGER.warning( - "deletion of the validation records failed with error:\n%s", err - ) + LOGGER.warning("deletion of the validation records failed with error:\n%s", err) except ClientError as err: if err.response["Error"]["Message"] != ( f"Stack with id {self.stack.fqn} does not exist" ): raise - LOGGER.warning( - "deletion of the validation records failed with error:\n%s", err - ) + LOGGER.warning("deletion of the validation records failed with error:\n%s", err) else: LOGGER.info("deletion of validation records was skipped") self.destroy_stack(wait=True) return True - def post_deploy(self) -> Dict[str, str]: + def post_deploy(self) -> dict[str, str]: """Run during the **post_deploy** stage.""" return self.deploy() @@ -471,7 +446,7 @@ def post_destroy(self) -> bool: """Run during the **post_destroy** stage.""" return self.destroy() - def pre_deploy(self) -> Dict[str, str]: + def pre_deploy(self) -> dict[str, str]: """Run during the **pre_deploy** stage.""" return self.deploy() diff --git a/runway/cfngin/hooks/aws_lambda.py b/runway/cfngin/hooks/aws_lambda.py index f8ab897d8..48286851e 100644 --- a/runway/cfngin/hooks/aws_lambda.py +++ b/runway/cfngin/hooks/aws_lambda.py @@ -1,6 +1,5 @@ """AWS Lambda hook.""" -# pylint: disable=too-many-lines from __future__ import annotations import hashlib @@ -13,18 +12,14 @@ import subprocess import sys import tempfile +from collections.abc import Iterable, Iterator from io import BytesIO as StringIO from pathlib import Path from shutil import copyfile from typing import ( TYPE_CHECKING, Any, - Dict, - Iterable, - Iterator, - List, Optional, - Tuple, Union, cast, ) @@ -62,9 +57,7 @@ DockerizePipArgTypeDef = Optional[ Union[ bool, - Literal[ - "false", "False", "no", "No", "non-linux", "true", "True", "yes", "Yes" - ], + Literal["false", "False", "no", "No", "non-linux", "true", "True", "yes", "Yes"], ] ] @@ -72,8 +65,8 @@ def copydir( source: str, destination: str, - includes: List[str], - excludes: Optional[List[str]] = None, + includes: list[str], + excludes: Optional[list[str]] = None, follow_symlinks: bool = False, ) -> None: """Extend the functionality of shutil. @@ -93,24 +86,24 @@ def copydir( def _mkdir(dir_name: str) -> None: """Recursively create directories.""" - parent = os.path.dirname(dir_name) - if not os.path.isdir(parent): + parent = os.path.dirname(dir_name) # noqa: PTH120 + if not os.path.isdir(parent): # noqa: PTH112 _mkdir(parent) LOGGER.debug("creating directory: %s", dir_name) - os.mkdir(dir_name) + os.mkdir(dir_name) # noqa: PTH102 for file_name in files: - src = os.path.join(source, file_name) - dest = os.path.join(destination, file_name) + src = os.path.join(source, file_name) # noqa: PTH118 + dest = os.path.join(destination, file_name) # noqa: PTH118 try: LOGGER.debug('copying file "%s" to "%s"', src, dest) copyfile(src, dest) except OSError: - _mkdir(os.path.dirname(dest)) + _mkdir(os.path.dirname(dest)) # noqa: PTH120 copyfile(src, dest) -def find_requirements(root: str) -> Optional[Dict[str, bool]]: +def find_requirements(root: str) -> Optional[dict[str, bool]]: """Identify Python requirement files. Args: @@ -122,7 +115,7 @@ def find_requirements(root: str) -> Optional[Dict[str, bool]]: """ findings = { - file_name: os.path.isfile(os.path.join(root, file_name)) + file_name: os.path.isfile(os.path.join(root, file_name)) # noqa: PTH118, PTH113 for file_name in ["requirements.txt", "Pipfile", "Pipfile.lock"] } @@ -151,12 +144,12 @@ def should_use_docker(dockerize_pip: DockerizePipArgTypeDef = None) -> bool: return False -def str2bool(v: str): +def str2bool(v: str) -> bool: """Return boolean value of string.""" return v.lower() in ("yes", "true", "t", "1", "on", "y") -def _zip_files(files: Iterable[str], root: str) -> Tuple[bytes, str]: +def _zip_files(files: Iterable[str], root: str) -> tuple[bytes, str]: """Generate a ZIP file in-memory from a list of files. Files will be stored in the archive with relative names, and have their @@ -175,7 +168,7 @@ def _zip_files(files: Iterable[str], root: str) -> Tuple[bytes, str]: files = list(files) # create copy of list also converts generator to list with ZipFile(zip_data, "w", ZIP_DEFLATED) as zip_file: for file_name in files: - zip_file.write(os.path.join(root, file_name), file_name) + zip_file.write(os.path.join(root, file_name), file_name) # noqa: PTH118 # Fix file permissions to avoid any issues - only care whether a file # is executable or not, choosing between modes 755 and 644 accordingly. @@ -183,12 +176,8 @@ def _zip_files(files: Iterable[str], root: str) -> Tuple[bytes, str]: perms = (zip_entry.external_attr & ZIP_PERMS_MASK) >> 16 new_perms = 0o755 if perms & stat.S_IXUSR != 0 else 0o644 if new_perms != perms: - LOGGER.debug( - "fixing perms: %s: %o => %o", zip_entry.filename, perms, new_perms - ) - new_attr = (zip_entry.external_attr & ~ZIP_PERMS_MASK) | ( - new_perms << 16 - ) + LOGGER.debug("fixing perms: %s: %o => %o", zip_entry.filename, perms, new_perms) + new_attr = (zip_entry.external_attr & ~ZIP_PERMS_MASK) | (new_perms << 16) zip_entry.external_attr = new_attr contents = zip_data.getvalue() @@ -207,25 +196,24 @@ def _calculate_hash(files: Iterable[str], root: str) -> str: root: base directory to analyze files in. """ - file_hash = hashlib.md5() + file_hash = hashlib.md5() # noqa: S324 for file_name in sorted(files): - file_path = os.path.join(root, file_name) + file_path = os.path.join(root, file_name) # noqa: PTH118 file_hash.update((file_name + "\0").encode()) - with open(file_path, "rb") as file_: - # pylint: disable=cell-var-from-loop + with open(file_path, "rb") as file_: # noqa: PTH123 for chunk in iter(lambda: file_.read(4096), ""): if not chunk: break file_hash.update(chunk) - file_hash.update("\0".encode()) + file_hash.update(b"\0") return file_hash.hexdigest() def _find_files( root: str, - includes: Union[List[str], str], - excludes: Optional[List[str]] = None, + includes: Union[list[str], str], + excludes: Optional[list[str]] = None, follow_symlinks: bool = False, ) -> Iterator[str]: """List files inside a directory based on include and exclude rules. @@ -249,7 +237,7 @@ def _find_files( http://www.aviser.asia/formic/doc/index.html """ - root = os.path.abspath(root) + root = os.path.abspath(root) # noqa: PTH100 file_set = formic.FileSet( directory=root, include=includes, exclude=excludes, symlinks=follow_symlinks ) @@ -257,8 +245,8 @@ def _find_files( def _zip_from_file_patterns( - root: str, includes: List[str], excludes: List[str], follow_symlinks: bool -) -> Tuple[bytes, str]: + root: str, includes: list[str], excludes: list[str], follow_symlinks: bool +) -> tuple[bytes, str]: """Generate a ZIP file in-memory from file search patterns. Args: @@ -296,9 +284,9 @@ def _zip_from_file_patterns( def handle_requirements( package_root: str, dest_path: str, - requirements: Dict[str, bool], + requirements: dict[str, bool], pipenv_timeout: int = 300, - python_path: Optional[str] = None, + python_path: str | None = None, use_pipenv: bool = False, ) -> str: """Use the correct requirements file. @@ -330,7 +318,7 @@ def handle_requirements( ) if requirements["requirements.txt"]: LOGGER.info("using requirements.txt for dependencies") - return os.path.join(dest_path, "requirements.txt") + return os.path.join(dest_path, "requirements.txt") # noqa: PTH118 if requirements["Pipfile"] or requirements["Pipfile.lock"]: LOGGER.info("using pipenv for dependencies") return _handle_use_pipenv( @@ -368,30 +356,26 @@ def _handle_use_pipenv( LOGGER.error("pipenv can only be used with python installed from PyPi") sys.exit(1) LOGGER.info("creating requirements.txt from Pipfile...") - req_path = os.path.join(dest_path, "requirements.txt") + req_path = os.path.join(dest_path, "requirements.txt") # noqa: PTH118 cmd = ["pipenv", "lock", "--requirements", "--keep-outdated"] if python_path: cmd.insert(0, python_path) cmd.insert(1, "-m") - with open(req_path, "w", encoding="utf-8") as requirements: - with subprocess.Popen( + with ( + open(req_path, "w", encoding="utf-8") as requirements, # noqa: PTH123 + subprocess.Popen( cmd, cwd=package_root, stdout=requirements, stderr=subprocess.PIPE - ) as pipenv_process: - if int(sys.version[0]) > 2: - _stdout, stderr = pipenv_process.communicate(timeout=timeout) - else: - _stdout, stderr = pipenv_process.communicate() - if pipenv_process.returncode == 0: - return req_path - if int(sys.version[0]) > 2: - stderr = stderr.decode("UTF-8") - LOGGER.error( - '"%s" failed with the following output:\n%s', " ".join(cmd), stderr - ) - raise PipenvError + ) as pipenv_process, + ): + _stdout, stderr = pipenv_process.communicate(timeout=timeout) + if pipenv_process.returncode == 0: + return req_path + stderr = stderr.decode("UTF-8") + LOGGER.error('"%s" failed with the following output:\n%s', " ".join(cmd), stderr) + raise PipenvError -def dockerized_pip( +def dockerized_pip( # noqa: C901, PLR0912 work_dir: str, client: Optional[docker.DockerClient] = None, runtime: Optional[str] = None, @@ -414,31 +398,30 @@ def dockerized_pip( python_dontwritebytecode: Don't write bytecode. """ - # TODO use kwargs to pass args to docker for advanced config + # TODO (craig): use kwargs to pass args to docker for advanced config if bool(docker_file) + bool(docker_image) + bool(runtime) != 1: # exactly one of these is needed. converting to bool will give us a # 'False' (0) for 'None' and 'True' (1) for anything else. raise InvalidDockerizePipConfiguration( - "exactly only one of [docker_file, docker_file, runtime] must be " - "provided" + "exactly only one of [docker_file, docker_file, runtime] must be provided" ) if not client: client = docker.from_env() if docker_file: - if not os.path.isfile(docker_file): + if not os.path.isfile(docker_file): # noqa: PTH113 raise ValueError(f'could not find docker_file "{docker_file}"') LOGGER.info('building docker image from "%s"', docker_file) response = cast( - Union[Image, Tuple[Image, Iterator[Dict[str, str]]]], + Union[Image, tuple[Image, Iterator[dict[str, str]]]], client.images.build( - path=os.path.dirname(docker_file), - dockerfile=os.path.basename(docker_file), + path=os.path.dirname(docker_file), # noqa: PTH120 + dockerfile=os.path.basename(docker_file), # noqa: PTH119 forcerm=True, ), ) - # the response can be either a tuple of (Image, Generator[Dict[str, str]]) + # the response can be either a tuple of (Image, Generator[dict[str, str]]) # or just Image depending on API version. if isinstance(response, tuple): docker_image = response[0].id @@ -450,26 +433,20 @@ def dockerized_pip( LOGGER.info('docker image "%s" created', docker_image) if runtime: if runtime not in SUPPORTED_RUNTIMES: - raise ValueError( - f'invalid runtime "{runtime}" must be one of {SUPPORTED_RUNTIMES}' - ) + raise ValueError(f'invalid runtime "{runtime}" must be one of {SUPPORTED_RUNTIMES}') docker_image = f"lambci/lambda:build-{runtime}" - LOGGER.debug( - 'selected docker image "%s" based on provided runtime', docker_image - ) + LOGGER.debug('selected docker image "%s" based on provided runtime', docker_image) if sys.platform.lower() == "win32": LOGGER.debug("formatted docker mount path for Windows") work_dir = work_dir.replace("\\", "/") - work_dir_mount = docker.types.Mount( - target="/var/task", source=work_dir, type="bind" - ) + work_dir_mount = docker.types.Mount(target="/var/task", source=work_dir, type="bind") pip_cmd = "python -m pip install -t /var/task -r /var/task/requirements.txt" LOGGER.info('using docker image "%s" to build deployment package...', docker_image) - docker_run_args: Dict[str, Any] = {} + docker_run_args: dict[str, Any] = {} if python_dontwritebytecode: docker_run_args["environment"] = "1" @@ -512,9 +489,7 @@ def _pip_has_no_color_option(python_path: str) -> bool: [ python_path, "-c", - "from __future__ import print_function;" - "import pip;" - "print(pip.__version__)", + "from __future__ import print_function;import pip;print(pip.__version__)", ] ) if isinstance(pip_version_string, bytes): # type: ignore @@ -526,24 +501,24 @@ def _pip_has_no_color_option(python_path: str) -> bool: return False -# TODO refactor logic to breakup logic into smaller chunks -def _zip_package( # pylint: disable=too-many-locals,too-many-statements +# TODO (kyle): refactor logic to breakup logic into smaller chunks +def _zip_package( # noqa: PLR0915, PLR0912, C901, D417 package_root: str, *, dockerize_pip: DockerizePipArgTypeDef = False, - excludes: Optional[List[str]] = None, + excludes: Optional[list[str]] = None, follow_symlinks: bool = False, - includes: List[str], + includes: list[str], pipenv_timeout: int = 300, python_dontwritebytecode: bool = False, python_exclude_bin_dir: bool = False, python_exclude_setuptools_dirs: bool = False, python_path: Optional[str] = None, - requirements_files: Dict[str, bool], + requirements_files: dict[str, bool], use_pipenv: bool = False, work_dir: Path, **kwargs: Any, -) -> Tuple[bytes, str]: +) -> tuple[bytes, str]: """Create zip file in memory with package dependencies. Args: @@ -578,9 +553,8 @@ def _zip_package( # pylint: disable=too-many-locals,too-many-statements excludes = excludes or [] excludes.append(".venv/") - # pylint: disable=consider-using-with tmpdir = tempfile.TemporaryDirectory(prefix="cfngin", dir=work_dir) - tmp_req = os.path.join(tmpdir.name, "requirements.txt") + tmp_req = os.path.join(tmpdir.name, "requirements.txt") # noqa: PTH118 copydir(package_root, tmpdir.name, includes, excludes, follow_symlinks) tmp_req = handle_requirements( package_root=package_root, @@ -607,7 +581,7 @@ def _zip_package( # pylint: disable=too-many-locals,too-many-statements "--no-color", ] - subprocess_args: Dict[str, Any] = {} + subprocess_args: dict[str, Any] = {} if python_dontwritebytecode: subprocess_args["env"] = dict(os.environ, PYTHONDONTWRITEBYTECODE="1") @@ -646,14 +620,16 @@ def _zip_package( # pylint: disable=too-many-locals,too-many-statements if tmp_script.is_file(): tmp_script.unlink() - if python_exclude_bin_dir and os.path.isdir(os.path.join(tmpdir.name, "bin")): + if python_exclude_bin_dir and os.path.isdir( # noqa: PTH112 + os.path.join(tmpdir.name, "bin") # noqa: PTH118 + ): LOGGER.debug("Removing python /bin directory from Lambda files") - shutil.rmtree(os.path.join(tmpdir.name, "bin")) + shutil.rmtree(os.path.join(tmpdir.name, "bin")) # noqa: PTH118 if python_exclude_setuptools_dirs: for i in os.listdir(tmpdir.name): - if i.endswith(".egg-info") or i.endswith(".dist-info"): + if i.endswith((".egg-info", ".dist-info")): LOGGER.debug("Removing directory %s from Lambda files", i) - shutil.rmtree(os.path.join(tmpdir.name, i)) + shutil.rmtree(os.path.join(tmpdir.name, i)) # noqa: PTH118 req_files = _find_files(tmpdir.name, includes="**", follow_symlinks=False) contents, content_hash = _zip_files(req_files, tmpdir.name) @@ -673,9 +649,7 @@ def _zip_package( # pylint: disable=too-many-locals,too-many-statements return contents, content_hash -def _head_object( - s3_conn: S3Client, bucket: str, key: str -) -> Optional[HeadObjectOutputTypeDef]: +def _head_object(s3_conn: S3Client, bucket: str, key: str) -> Optional[HeadObjectOutputTypeDef]: """Retrieve information about an object in S3 if it exists. Args: @@ -753,10 +727,10 @@ def _upload_code( def _check_pattern_list( - patterns: Optional[Union[List[str], str]], + patterns: Optional[Union[list[str], str]], key: str, - default: Optional[List[str]] = None, -) -> Optional[List[str]]: + default: Optional[list[str]] = None, +) -> Optional[list[str]]: """Validate file search patterns from user configuration. Acceptable input is a string (which will be converted to a singleton list), @@ -785,9 +759,7 @@ def _check_pattern_list( if isinstance(patterns, list) and all(isinstance(p, str) for p in patterns): # type: ignore return patterns - raise ValueError( - f"Invalid file patterns in key '{key}': must be a string or " "list of strings" - ) + raise ValueError(f"Invalid file patterns in key '{key}': must be a string or list of strings") class _UploadFunctionOptionsTypeDef(TypedDict): @@ -802,8 +774,8 @@ class _UploadFunctionOptionsTypeDef(TypedDict): """ - exclude: Optional[List[str]] - include: Optional[List[str]] + exclude: Optional[list[str]] + include: Optional[list[str]] path: str @@ -845,11 +817,9 @@ def _upload_function( """ try: - root = os.path.expanduser(options["path"]) + root = os.path.expanduser(options["path"]) # noqa: PTH111 except KeyError as exc: - raise ValueError( - f"missing required property '{exc.args[0]}' in function '{name}'" - ) from exc + raise ValueError(f"missing required property '{exc.args[0]}' in function '{name}'") from exc includes = _check_pattern_list(options.get("include"), "include", default=["**"]) excludes = _check_pattern_list(options.get("exclude"), "exclude", default=[]) @@ -858,13 +828,13 @@ def _upload_function( # os.path.join will ignore other parameters if the right-most one is an # absolute path, which is exactly what we want. - if not os.path.isabs(root): - root = os.path.abspath(os.path.join(sys_path, root)) + if not os.path.isabs(root): # noqa: PTH117 + root = os.path.abspath(os.path.join(sys_path, root)) # noqa: PTH118, PTH100 requirements_files = find_requirements(root) if requirements_files: zip_contents, content_hash = _zip_package( root, - includes=cast(List[str], includes), + includes=cast("list[str]", includes), excludes=excludes, follow_symlinks=follow_symlinks, requirements_files=requirements_files, @@ -873,12 +843,10 @@ def _upload_function( ) else: zip_contents, content_hash = _zip_from_file_patterns( - root, cast(List[str], includes), cast(List[str], excludes), follow_symlinks + root, cast("list[str]", includes), cast("list[str]", excludes), follow_symlinks ) - return _upload_code( - s3_conn, bucket, prefix, name, zip_contents, content_hash, payload_acl - ) + return _upload_code(s3_conn, bucket, prefix, name, zip_contents, content_hash, payload_acl) def select_bucket_region( @@ -908,7 +876,9 @@ def select_bucket_region( return region or provider_region -def upload_lambda_functions(context: CfnginContext, provider: Provider, **kwargs: Any): +def upload_lambda_functions( # noqa: D417 + context: CfnginContext, provider: Provider, **kwargs: Any +) -> dict[str, Any]: """Build Lambda payloads from user configuration and upload them to S3. Constructs ZIP archives containing files matching specified patterns for @@ -945,7 +915,7 @@ def upload_lambda_functions(context: CfnginContext, provider: Provider, **kwargs ``False``) payload_acl (Optional[str]): The canned S3 object ACL to be applied to the uploaded payload. (*default: private*) - functions (Dict[str, Any]): Configurations of desired payloads to + functions (dict[str, Any]): Configurations of desired payloads to build. Keys correspond to function names, used to derive key names for the payload. Each value should itself be a dictionary, with the following data: @@ -966,7 +936,7 @@ def upload_lambda_functions(context: CfnginContext, provider: Provider, **kwargs which will only run on non Linux systems. To use this option Docker must be installed. - **exclude (Optional[Union[str, List[str]]])** + **exclude (Optional[Union[str, list[str]]])** Pattern or list of patterns of files to exclude from the payload. If provided, any files that match will be ignored, regardless of whether they match an inclusion pattern. @@ -975,7 +945,7 @@ def upload_lambda_functions(context: CfnginContext, provider: Provider, **kwargs such as ``.git``, ``.svn``, ``__pycache__``, ``*.pyc``, ``.gitignore``, etc. - **include (Optional[Union[str, List[str]]])** + **include (Optional[Union[str, list[str]]])** Pattern or list of patterns of files to include in the payload. If provided, only files that match these patterns will be included in the payload. @@ -1074,8 +1044,8 @@ def create_template(self): "see documentation for replacement", __name__, ) - # TODO add better handling for misconfiguration (e.g. forgetting function names) - # TODO support defining dockerize_pip options at the top level of args + # TODO (craig): add better handling for misconfiguration (e.g. forgetting function names) + # TODO (craig): support defining dockerize_pip options at the top level of args custom_bucket = cast(str, kwargs.get("bucket", "")) if not custom_bucket: if not context.bucket_name: @@ -1114,11 +1084,11 @@ def create_template(self): prefix = kwargs.get("prefix", "") - results: Dict[str, Any] = {} + results: dict[str, Any] = {} for name, options in kwargs["functions"].items(): sys_path = ( - os.path.dirname(context.config_path) - if os.path.isfile(context.config_path) + os.path.dirname(context.config_path) # noqa: PTH120 + if os.path.isfile(context.config_path) # noqa: PTH113 else context.config_path ) results[name] = _upload_function( diff --git a/runway/cfngin/hooks/awslambda/_python_hooks.py b/runway/cfngin/hooks/awslambda/_python_hooks.py index a6eb1e9ee..303d96995 100644 --- a/runway/cfngin/hooks/awslambda/_python_hooks.py +++ b/runway/cfngin/hooks/awslambda/_python_hooks.py @@ -1,7 +1,5 @@ """Hook for creating an AWS Lambda Function using Python runtime.""" -# pylint errors are python3.7 only -# pylint: disable=inherit-non-class,no-value-for-parameter from __future__ import annotations import logging diff --git a/runway/cfngin/hooks/awslambda/base_classes.py b/runway/cfngin/hooks/awslambda/base_classes.py index f4846ab6d..a15e30e4e 100644 --- a/runway/cfngin/hooks/awslambda/base_classes.py +++ b/runway/cfngin/hooks/awslambda/base_classes.py @@ -3,23 +3,16 @@ from __future__ import annotations import logging -from pathlib import Path from typing import ( TYPE_CHECKING, Any, ClassVar, Generic, - List, - Optional, - Set, - Tuple, TypeVar, cast, overload, ) -from typing_extensions import Literal - from ....compat import cached_property from ..protocols import CfnginHookProtocol from .exceptions import RuntimeMismatchError @@ -28,6 +21,10 @@ from .source_code import SourceCode if TYPE_CHECKING: + from pathlib import Path + + from typing_extensions import Literal + from ...._logging import RunwayLogger from ....context import CfnginContext from ....utils import BaseModel @@ -54,9 +51,7 @@ class Project(Generic[_AwsLambdaHookArgsTypeVar_co]): ctx: CfnginContext """CFNgin context object.""" - def __init__( - self, args: _AwsLambdaHookArgsTypeVar_co, context: CfnginContext - ) -> None: + def __init__(self, args: _AwsLambdaHookArgsTypeVar_co, context: CfnginContext) -> None: """Instantiate class. Args: @@ -78,7 +73,7 @@ def build_directory(self) -> Path: return result @cached_property - def cache_dir(self) -> Optional[Path]: + def cache_dir(self) -> Path | None: """Directory where a dependency manager's cache data will be stored. Returns: @@ -98,12 +93,12 @@ def cache_dir(self) -> Optional[Path]: return cache_dir @cached_property - def compatible_architectures(self) -> Optional[List[str]]: + def compatible_architectures(self) -> list[str] | None: """List of compatible instruction set architectures.""" return getattr(self.args, "compatible_architectures", None) @cached_property - def compatible_runtimes(self) -> Optional[List[str]]: + def compatible_runtimes(self) -> list[str] | None: """List of compatible runtimes. Value should be valid Lambda Function runtimes @@ -114,7 +109,7 @@ def compatible_runtimes(self) -> Optional[List[str]]: compatible runtimes. """ - runtimes = getattr(self.args, "compatible_runtimes", cast(List[str], [])) + runtimes = getattr(self.args, "compatible_runtimes", cast("list[str]", [])) if runtimes and self.runtime not in runtimes: raise ValueError( f"runtime ({self.runtime}) not in compatible runtimes ({', '.join(runtimes)})" @@ -129,7 +124,7 @@ def dependency_directory(self) -> Path: return result @cached_property - def license(self) -> Optional[str]: + def license(self) -> str | None: """Software license for the project. Can be any of the following: @@ -142,8 +137,8 @@ def license(self) -> Optional[str]: """ return getattr(self.args, "license", None) - @cached_property # pylint error is python3.7 only - def metadata_files(self) -> Tuple[Path, ...]: + @cached_property + def metadata_files(self) -> tuple[Path, ...]: """Project metadata files (e.g. ``project.json``, ``pyproject.toml``).""" return () @@ -163,9 +158,9 @@ def runtime(self) -> str: raise ValueError("runtime could not be determined from the build system") @cached_property - def _runtime_from_docker(self) -> Optional[str]: + def _runtime_from_docker(self) -> str | None: """runtime from Docker if class can use Docker.""" - docker: Optional[DockerDependencyInstaller] = getattr(self, "docker", None) + docker: DockerDependencyInstaller | None = getattr(self, "docker", None) if not docker: return None return docker.runtime @@ -226,11 +221,7 @@ def project_root(self) -> Path: top_lvl_dir = ( self.ctx.config_path.parent if self.ctx.config_path.is_file() - else ( - self.ctx.config_path - if self.ctx.config_path.is_dir() - else self.args.source_code - ) + else (self.ctx.config_path if self.ctx.config_path.is_dir() else self.args.source_code) ) if top_lvl_dir == self.args.source_code: return top_lvl_dir @@ -238,8 +229,7 @@ def project_root(self) -> Path: parents = list(self.args.source_code.parents) if top_lvl_dir not in parents: LOGGER.info( - "ignoring project directory; " - "source code located outside of project directory" + "ignoring project directory; source code located outside of project directory" ) return self.args.source_code @@ -269,8 +259,8 @@ def project_type(self) -> str: """ raise NotImplementedError - @cached_property # pylint error is python3.7 only - def supported_metadata_files(self) -> Set[str]: + @cached_property + def supported_metadata_files(self) -> set[str]: """Names of all supported metadata files. Returns: @@ -326,7 +316,6 @@ class AwsLambdaHook(CfnginHookProtocol, Generic[_ProjectTypeVar]): ctx: CfnginContext """CFNgin context object.""" - # pylint: disable=super-init-not-called def __init__(self, context: CfnginContext, **_kwargs: Any) -> None: """Instantiate class. @@ -350,19 +339,15 @@ def project(self) -> _ProjectTypeVar: raise NotImplementedError @overload - def build_response( - self, stage: Literal["deploy"] - ) -> AwsLambdaHookDeployResponse: ... + def build_response(self, stage: Literal["deploy"]) -> AwsLambdaHookDeployResponse: ... @overload - def build_response(self, stage: Literal["destroy"]) -> Optional[BaseModel]: ... + def build_response(self, stage: Literal["destroy"]) -> BaseModel | None: ... @overload def build_response(self, stage: Literal["plan"]) -> AwsLambdaHookDeployResponse: ... - def build_response( - self, stage: Literal["deploy", "destroy", "plan"] - ) -> Optional[BaseModel]: + def build_response(self, stage: Literal["deploy", "destroy", "plan"]) -> BaseModel | None: """Build response object that will be returned by this hook. Args: @@ -390,7 +375,7 @@ def _build_response_deploy(self) -> AwsLambdaHookDeployResponse: runtime=self.deployment_package.runtime, ) - def _build_response_destroy(self) -> Optional[BaseModel]: + def _build_response_destroy(self) -> BaseModel | None: """Build response for destroy stage.""" return None diff --git a/runway/cfngin/hooks/awslambda/deployment_package.py b/runway/cfngin/hooks/awslambda/deployment_package.py index 6724c6ea3..9c25b0842 100644 --- a/runway/cfngin/hooks/awslambda/deployment_package.py +++ b/runway/cfngin/hooks/awslambda/deployment_package.py @@ -7,26 +7,10 @@ import logging import mimetypes import stat -import sys import zipfile -from contextlib import suppress -from typing import ( - TYPE_CHECKING, - ClassVar, - Dict, - Generic, - Iterator, - List, - Optional, - TypeVar, - Union, - cast, - overload, -) +from typing import TYPE_CHECKING, ClassVar, Final, Generic, TypeVar, cast, overload from urllib.parse import urlencode -from typing_extensions import Final, Literal - from ....compat import cached_property from ....core.providers.aws.s3 import Bucket from ....core.providers.aws.s3.exceptions import ( @@ -42,10 +26,12 @@ from .models.args import AwsLambdaHookArgs if TYPE_CHECKING: + from collections.abc import Iterator from pathlib import Path import igittigitt from mypy_boto3_s3.type_defs import HeadObjectOutputTypeDef, PutObjectOutputTypeDef + from typing_extensions import Literal from ...._logging import RunwayLogger @@ -64,7 +50,7 @@ class DeploymentPackage(DelCachedPropMixin, Generic[_ProjectTypeVar]): """ - META_TAGS: ClassVar[Dict[str, str]] = { + META_TAGS: ClassVar[dict[str, str]] = { "code_sha256": "runway.cfngin:awslambda.code_sha256", "compatible_architectures": "runway.cfngin:awslambda.compatible_architectures", "compatible_runtimes": "runway.cfngin:awslambda.compatible_runtimes", @@ -78,9 +64,7 @@ class DeploymentPackage(DelCachedPropMixin, Generic[_ProjectTypeVar]): SIZE_EOCD: Final[Literal[22]] = 22 """Size of a zip file's End of Central Directory Record (empty zip).""" - ZIPFILE_PERMISSION_MASK: ClassVar[int] = ( - stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO - ) << 16 + ZIPFILE_PERMISSION_MASK: ClassVar[int] = (stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO) << 16 """Mask to retrieve unix file permissions from the external attributes property of a ``zipfile.ZipInfo``. """ @@ -91,7 +75,7 @@ class DeploymentPackage(DelCachedPropMixin, Generic[_ProjectTypeVar]): usage_type: Literal["function", "layer"] """How the deployment package can be used by AWS Lambda.""" - _put_object_response: Optional[PutObjectOutputTypeDef] = None + _put_object_response: PutObjectOutputTypeDef | None = None def __init__( self, @@ -154,26 +138,24 @@ def code_sha256(self) -> str: return base64.b64encode(file_hash.digest).decode() @cached_property - def compatible_architectures(self) -> Optional[List[str]]: + def compatible_architectures(self) -> list[str] | None: """List of compatible instruction set architectures.""" return self.project.compatible_architectures @cached_property - def compatible_runtimes(self) -> Optional[List[str]]: + def compatible_runtimes(self) -> list[str] | None: """List of compatible runtimes.""" return self.project.compatible_runtimes @cached_property def exists(self) -> bool: """Whether the deployment package exists.""" - if self.archive_file.exists(): - return True - return False + return bool(self.archive_file.exists()) @cached_property def gitignore_filter( self, - ) -> Optional[igittigitt.IgnoreParser]: + ) -> igittigitt.IgnoreParser | None: """Filter to use when zipping dependencies. This should be overridden by subclasses if a filter should be used. @@ -182,7 +164,7 @@ def gitignore_filter( return None @cached_property - def license(self) -> Optional[str]: + def license(self) -> str | None: """Software license for the project.""" return self.project.license @@ -197,7 +179,7 @@ def md5_checksum(self) -> str: FileNotFoundError: Property accessed before archive file has been built. """ - file_hash = FileHash(hashlib.md5()) + file_hash = FileHash(hashlib.md5()) # noqa: S324 file_hash.add_file(self.archive_file) return base64.b64encode(file_hash.digest).decode() @@ -206,16 +188,14 @@ def object_key(self) -> str: """Key to use when upload object to AWS S3.""" prefix = f"awslambda/{self.usage_type}s" if self.project.args.object_prefix: - prefix = ( - f"{prefix}/{self.project.args.object_prefix.lstrip('/').rstrip('/')}" - ) + prefix = f"{prefix}/{self.project.args.object_prefix.lstrip('/').rstrip('/')}" return ( # this can't contain runtime - causes a cyclic dependency f"{prefix}/{self.project.source_code.root_directory.name}." f"{self.project.source_code.md5_hash}.zip" ) @cached_property - def object_version_id(self) -> Optional[str]: + def object_version_id(self) -> str | None: """S3 object version ID. Returns: @@ -223,10 +203,7 @@ def object_version_id(self) -> Optional[str]: if versioning is enabled on the bucket. """ - if ( - not self._put_object_response - or "VersionId" not in self._put_object_response - ): + if not self._put_object_response or "VersionId" not in self._put_object_response: return None return self._put_object_response["VersionId"] @@ -244,9 +221,7 @@ def build(self) -> Path: # we need to use runtime BEFORE the build process starts to allow runtime # errors to be raised early. LOGGER.info("building %s (%s)...", self.archive_file.name, self.runtime) - with zipfile.ZipFile( - self.archive_file, "w", zipfile.ZIP_DEFLATED - ) as archive_file: + with zipfile.ZipFile(self.archive_file, "w", zipfile.ZIP_DEFLATED) as archive_file: self._build_zip_dependencies(archive_file) self._build_zip_source_code(archive_file) self._build_fix_file_permissions(archive_file) @@ -273,9 +248,7 @@ def _build_fix_file_permissions(self, archive_file: zipfile.ZipFile) -> None: """ for file_info in archive_file.filelist: - current_perms = ( - file_info.external_attr & self.ZIPFILE_PERMISSION_MASK - ) >> 16 + current_perms = (file_info.external_attr & self.ZIPFILE_PERMISSION_MASK) >> 16 required_perm = 0o755 if current_perms & stat.S_IXUSR != 0 else 0o644 if current_perms != required_perm: LOGGER.debug( @@ -304,9 +277,9 @@ def _build_zip_dependencies( archive_file.write( dep, ( - self.insert_layer_dir( - dep, self.project.dependency_directory - ).relative_to(self.project.dependency_directory) + self.insert_layer_dir(dep, self.project.dependency_directory).relative_to( + self.project.dependency_directory + ) if self.usage_type == "layer" else dep.relative_to(self.project.dependency_directory) ), @@ -336,14 +309,12 @@ def _build_zip_source_code(self, archive_file: zipfile.ZipFile) -> None: def build_tag_set(self, *, url_encoded: Literal[True] = ...) -> str: ... @overload - def build_tag_set(self, *, url_encoded: Literal[False] = ...) -> Dict[str, str]: ... + def build_tag_set(self, *, url_encoded: Literal[False] = ...) -> dict[str, str]: ... @overload - def build_tag_set( - self, *, url_encoded: bool = ... - ) -> Union[Dict[str, str], str]: ... + def build_tag_set(self, *, url_encoded: bool = ...) -> dict[str, str] | str: ... - def build_tag_set(self, *, url_encoded: bool = True) -> Union[Dict[str, str], str]: + def build_tag_set(self, *, url_encoded: bool = True) -> dict[str, str] | str: """Build tag set to be applied to the S3 object. Args: @@ -382,21 +353,13 @@ def build_tag_set(self, *, url_encoded: bool = True) -> Union[Dict[str, str], st def delete(self) -> None: """Delete deployment package.""" - if sys.version_info < (3, 8): # cov: ignore - with suppress(FileNotFoundError): # acts the same as `missing_ok=true` - self.archive_file.unlink() # python3.7 does not support `missing_ok` - else: # cov: ignore - self.archive_file.unlink(missing_ok=True) + self.archive_file.unlink(missing_ok=True) LOGGER.verbose("deleted local deployment package %s", self.archive_file) # clear cached properties so they can recalculate - self._del_cached_property( - "code_sha256", "exists", "md5_checksum", "object_version_id" - ) + self._del_cached_property("code_sha256", "exists", "md5_checksum", "object_version_id") @staticmethod - def insert_layer_dir( - file_path: Path, relative_to: Path # pylint: disable=unused-argument - ) -> Path: + def insert_layer_dir(file_path: Path, relative_to: Path) -> Path: # noqa: ARG004 """Insert directory into local file path for layer archive. If required, this should be overridden by a subclass for language @@ -518,16 +481,14 @@ def code_sha256(self) -> str: return self.object_tags[self.META_TAGS["code_sha256"]] @cached_property - def compatible_architectures(self) -> Optional[List[str]]: + def compatible_architectures(self) -> list[str] | None: """List of compatible instruction set architectures.""" if self.META_TAGS["compatible_architectures"] in self.object_tags: - return self.object_tags[self.META_TAGS["compatible_architectures"]].split( - "+" - ) + return self.object_tags[self.META_TAGS["compatible_architectures"]].split("+") return None @cached_property - def compatible_runtimes(self) -> Optional[List[str]]: + def compatible_runtimes(self) -> list[str] | None: """List of compatible runtimes.""" if self.META_TAGS["compatible_runtimes"] in self.object_tags: return self.object_tags[self.META_TAGS["compatible_runtimes"]].split("+") @@ -536,21 +497,15 @@ def compatible_runtimes(self) -> Optional[List[str]]: @cached_property def exists(self) -> bool: """Whether the S3 object exists.""" - if self.head and not self.head.get("DeleteMarker", False): - return True - return False + return bool(self.head and not self.head.get("DeleteMarker", False)) @cached_property - def head(self) -> Optional[HeadObjectOutputTypeDef]: + def head(self) -> HeadObjectOutputTypeDef | None: """Response from HeadObject API call.""" try: - return self.bucket.client.head_object( - Bucket=self.bucket.name, Key=self.object_key - ) + return self.bucket.client.head_object(Bucket=self.bucket.name, Key=self.object_key) except self.bucket.client.exceptions.ClientError as exc: - status_code = exc.response.get("ResponseMetadata", {}).get( - "HTTPStatusCode", 0 - ) + status_code = exc.response.get("ResponseMetadata", {}).get("HTTPStatusCode", 0) if status_code == 404: LOGGER.verbose( "%s not found", @@ -566,7 +521,7 @@ def head(self) -> Optional[HeadObjectOutputTypeDef]: raise @cached_property - def license(self) -> Optional[str]: + def license(self) -> str | None: """Software license for the project.""" if self.META_TAGS["license"] in self.object_tags: return self.object_tags[self.META_TAGS["license"]] @@ -591,7 +546,7 @@ def md5_checksum(self) -> str: return self.object_tags[self.META_TAGS["md5_checksum"]] @cached_property - def object_tags(self) -> Dict[str, str]: + def object_tags(self) -> dict[str, str]: """S3 object tags.""" response = self.bucket.client.get_object_tagging( Bucket=self.bucket.name, Key=self.object_key @@ -602,7 +557,7 @@ def object_tags(self) -> Dict[str, str]: return {t["Key"]: t["Value"] for t in response["TagSet"]} @cached_property - def object_version_id(self) -> Optional[str]: + def object_version_id(self) -> str | None: """S3 object version ID. Returns: @@ -649,9 +604,7 @@ def build(self) -> Path: def delete(self) -> None: """Delete deployment package.""" if self.exists: - self.bucket.client.delete_object( - Bucket=self.bucket.name, Key=self.object_key - ) + self.bucket.client.delete_object(Bucket=self.bucket.name, Key=self.object_key) LOGGER.verbose( "deleted deployment package S3 object %s", self.bucket.format_bucket_path_uri(key=self.object_key), @@ -682,8 +635,7 @@ def update_tags(self) -> None: ) LOGGER.info("updated S3 object's tags") - # pylint: disable=unused-argument - def upload(self, *, build: bool = True) -> None: + def upload(self, *, build: bool = True) -> None: # noqa: ARG002 """Upload deployment package. The object should already exist. This method only exists as a "placeholder" diff --git a/runway/cfngin/hooks/awslambda/docker.py b/runway/cfngin/hooks/awslambda/docker.py index 2612e76b7..1dc1cf6b2 100644 --- a/runway/cfngin/hooks/awslambda/docker.py +++ b/runway/cfngin/hooks/awslambda/docker.py @@ -5,23 +5,10 @@ import logging import os import platform -from typing import ( - TYPE_CHECKING, - Any, - ClassVar, - Dict, - Iterator, - List, - Optional, - Type, - TypeVar, - Union, - cast, -) +from typing import TYPE_CHECKING, Any, ClassVar, TypeVar, cast from docker import DockerClient from docker.errors import DockerException, ImageNotFound -from docker.models.images import Image from docker.types import Mount from ...._logging import PrefixAdaptor @@ -30,8 +17,11 @@ from .constants import AWS_SAM_BUILD_IMAGE_PREFIX, DEFAULT_IMAGE_NAME, DEFAULT_IMAGE_TAG if TYPE_CHECKING: + from collections.abc import Iterator from pathlib import Path + from docker.models.images import Image + from ...._logging import RunwayLogger from ....context import CfnginContext, RunwayContext from .base_classes import Project @@ -61,7 +51,7 @@ class DockerDependencyInstaller: client: DockerClient """Docker client.""" - ctx: Union[CfnginContext, RunwayContext] + ctx: CfnginContext | RunwayContext """Context object.""" options: DockerOptions @@ -71,8 +61,8 @@ def __init__( self, project: Project[AwsLambdaHookArgs], *, - client: Optional[DockerClient] = None, - context: Optional[Union[CfnginContext, RunwayContext]] = None, + client: DockerClient | None = None, + context: CfnginContext | RunwayContext | None = None, ) -> None: """Instantiate class. @@ -96,7 +86,7 @@ def __init__( self.project = project @cached_property - def bind_mounts(self) -> List[Mount]: + def bind_mounts(self) -> list[Mount]: """Bind mounts that will be used by the container.""" mounts = [ Mount( @@ -121,7 +111,7 @@ def bind_mounts(self) -> List[Mount]: return mounts @cached_property - def environment_variables(self) -> Dict[str, str]: + def environment_variables(self) -> dict[str, str]: """Environment variables to pass to the Docker container. This is a subset of the environment variables stored in the context @@ -131,7 +121,7 @@ def environment_variables(self) -> Dict[str, str]: return {k: v for k, v in self.ctx.env.vars.items() if k.startswith("DOCKER")} @cached_property - def image(self) -> Union[Image, str]: + def image(self) -> Image | str: """Docker image that will be used. Raises: @@ -149,13 +139,13 @@ def image(self) -> Union[Image, str]: ) raise ValueError("docker.file, docker.image, or runtime is required") - @cached_property # pylint error is python3.7 only - def install_commands(self) -> List[str]: + @cached_property + def install_commands(self) -> list[str]: """Commands to run to install dependencies.""" return [] @cached_property - def post_install_commands(self) -> List[str]: + def post_install_commands(self) -> list[str]: """Commands to run after dependencies have been installed.""" cmds = [ *[ @@ -171,7 +161,7 @@ def post_install_commands(self) -> List[str]: ] if platform.system() != "Windows": # methods only exist on POSIX systems - gid, uid = os.getgid(), os.getuid() # pylint: disable=no-member + gid, uid = os.getgid(), os.getuid() cmds.append( f"chown -R {uid}:{gid} {self.DEPENDENCY_DIR}", ) @@ -180,7 +170,7 @@ def post_install_commands(self) -> List[str]: return cmds @cached_property - def pre_install_commands(self) -> List[str]: + def pre_install_commands(self) -> list[str]: """Commands to run before dependencies have been installed.""" cmds = [ f"chown -R 0:0 {self.DEPENDENCY_DIR}", @@ -189,8 +179,8 @@ def pre_install_commands(self) -> List[str]: cmds.append(f"chown -R 0:0 {self.CACHE_DIR}") return cmds - @cached_property # pylint error is python3.7 only - def runtime(self) -> Optional[str]: + @cached_property + def runtime(self) -> str | None: """AWS Lambda runtime determined from the Docker container.""" return None @@ -198,8 +188,8 @@ def build_image( self, docker_file: Path, *, - name: Optional[str] = None, - tag: Optional[str] = None, + name: str | None = None, + tag: str | None = None, ) -> Image: """Build Docker image from Dockerfile. @@ -233,7 +223,7 @@ def build_image( def log_docker_msg_bytes( self, stream: Iterator[bytes], *, level: int = logging.INFO - ) -> List[str]: + ) -> list[str]: """Log Docker output message from blocking generator that return bytes. Args: @@ -244,7 +234,7 @@ def log_docker_msg_bytes( List of log messages. """ - result: List[str] = [] + result: list[str] = [] for raw_msg in stream: msg = raw_msg.decode().strip() result.append(msg) @@ -252,8 +242,8 @@ def log_docker_msg_bytes( return result def log_docker_msg_dict( - self, stream: Iterator[Dict[str, Any]], *, level: int = logging.INFO - ) -> List[str]: + self, stream: Iterator[dict[str, Any]], *, level: int = logging.INFO + ) -> list[str]: """Log Docker output message from blocking generator that return dict. Args: @@ -264,7 +254,7 @@ def log_docker_msg_dict( list of log messages. """ - result: List[str] = [] + result: list[str] = [] for raw_msg in stream: for key in ["stream", "status"]: if key in raw_msg: @@ -283,7 +273,7 @@ def install(self) -> None: - :attr:`~runway.cfngin.hooks.awslambda.docker.DockerDependencyInstaller.install_commands` - :attr:`~runway.cfngin.hooks.awslambda.docker.DockerDependencyInstaller.post_install_commands` - """ # noqa + """ for cmd in self.pre_install_commands: self.run_command(cmd) for cmd in self.install_commands: @@ -315,7 +305,7 @@ def pull_image(self, name: str, *, force: bool = True) -> Image: LOGGER.info("image not found; pulling docker image %s...", name) return self.client.images.pull(repository=name) - def run_command(self, command: str, *, level: int = logging.INFO) -> List[str]: + def run_command(self, command: str, *, level: int = logging.INFO) -> list[str]: """Execute equivalent of ``docker container run``. Args: @@ -350,9 +340,7 @@ def run_command(self, command: str, *, level: int = logging.INFO) -> List[str]: raise DockerExecFailedError(response) @classmethod - def from_project( - cls: Type[_T], project: Project[AwsLambdaHookArgs] - ) -> Optional[_T]: + def from_project(cls: type[_T], project: Project[AwsLambdaHookArgs]) -> _T | None: """Instantiate class from a project. High-level method that wraps instantiation in error handling. diff --git a/runway/cfngin/hooks/awslambda/models/args.py b/runway/cfngin/hooks/awslambda/models/args.py index 5729a711f..be586a124 100644 --- a/runway/cfngin/hooks/awslambda/models/args.py +++ b/runway/cfngin/hooks/awslambda/models/args.py @@ -1,10 +1,10 @@ """Argument data models.""" -# pylint: disable=no-self-argument +# ruff: noqa: UP006, UP035 from __future__ import annotations from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, cast +from typing import Any, List, Optional from pydantic import DirectoryPath, Extra, Field, FilePath, validator @@ -12,9 +12,6 @@ from .....utils import BaseModel from ...base import HookArgsBaseModel -if TYPE_CHECKING: - from typing import Callable - class DockerOptions(BaseModel): """Docker options.""" @@ -126,10 +123,7 @@ class Config: extra = Extra.ignore - _resolve_path_fields = cast( - "classmethod[Callable[..., Any]]", - validator("file", allow_reuse=True)(resolve_path_field), - ) + _resolve_path_fields = validator("file", allow_reuse=True)(resolve_path_field) # type: ignore class AwsLambdaHookArgs(HookArgsBaseModel): @@ -270,15 +264,12 @@ class AwsLambdaHookArgs(HookArgsBaseModel): use_cache: bool = True """Whether to use a cache directory with pip that will persist builds (default ``True``).""" - _resolve_path_fields = cast( - "classmethod[Callable[..., Any]]", - validator("cache_dir", "source_code", allow_reuse=True)(resolve_path_field), - ) + _resolve_path_fields = validator("cache_dir", "source_code", allow_reuse=True)(resolve_path_field) # type: ignore @validator("runtime", always=True, allow_reuse=True) def _validate_runtime_or_docker( - cls, v: Optional[str], values: Dict[str, Any] - ) -> Optional[str]: + cls, v: str | None, values: dict[str, Any] # noqa: N805 + ) -> str | None: """Validate that either runtime is provided or Docker image is provided.""" if v: # if runtime was provided, we don't need to check anything else return v diff --git a/runway/cfngin/hooks/awslambda/models/responses.py b/runway/cfngin/hooks/awslambda/models/responses.py index a2b6a4578..4d2003df7 100644 --- a/runway/cfngin/hooks/awslambda/models/responses.py +++ b/runway/cfngin/hooks/awslambda/models/responses.py @@ -1,5 +1,6 @@ """Response data models.""" +# ruff: noqa: UP006, UP035 from typing import List, Optional from pydantic import Extra diff --git a/runway/cfngin/hooks/awslambda/python_requirements/_deployment_package.py b/runway/cfngin/hooks/awslambda/python_requirements/_deployment_package.py index 2e625bacd..90938d87b 100644 --- a/runway/cfngin/hooks/awslambda/python_requirements/_deployment_package.py +++ b/runway/cfngin/hooks/awslambda/python_requirements/_deployment_package.py @@ -2,8 +2,7 @@ from __future__ import annotations -from pathlib import Path -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING from igittigitt import IgnoreParser @@ -11,6 +10,8 @@ from ..deployment_package import DeploymentPackage if TYPE_CHECKING: + from pathlib import Path + from . import PythonProject @@ -20,7 +21,7 @@ class PythonDeploymentPackage(DeploymentPackage["PythonProject"]): project: PythonProject @cached_property - def gitignore_filter(self) -> Optional[IgnoreParser]: + def gitignore_filter(self) -> IgnoreParser | None: """Filter to use when zipping dependencies. This should be overridden by subclasses if a filter should be used. @@ -28,15 +29,9 @@ def gitignore_filter(self) -> Optional[IgnoreParser]: """ if self.project.args.slim: gitignore_filter = IgnoreParser() - gitignore_filter.add_rule( - "**/*.dist-info*", self.project.dependency_directory - ) - gitignore_filter.add_rule( - "**/*.py[c|d|i|o]", self.project.dependency_directory - ) - gitignore_filter.add_rule( - "**/__pycache__*", self.project.dependency_directory - ) + gitignore_filter.add_rule("**/*.dist-info*", self.project.dependency_directory) + gitignore_filter.add_rule("**/*.py[c|d|i|o]", self.project.dependency_directory) + gitignore_filter.add_rule("**/__pycache__*", self.project.dependency_directory) if self.project.args.strip: gitignore_filter.add_rule("**/*.so", self.project.dependency_directory) return gitignore_filter diff --git a/runway/cfngin/hooks/awslambda/python_requirements/_docker.py b/runway/cfngin/hooks/awslambda/python_requirements/_docker.py index ed968dd0c..a883e87c5 100644 --- a/runway/cfngin/hooks/awslambda/python_requirements/_docker.py +++ b/runway/cfngin/hooks/awslambda/python_requirements/_docker.py @@ -4,7 +4,7 @@ import logging import re -from typing import TYPE_CHECKING, Dict, List, Optional, Union +from typing import TYPE_CHECKING, Optional, Union from docker.types.services import Mount @@ -42,7 +42,7 @@ def __init__( super().__init__(project, client=client, context=context) @cached_property - def bind_mounts(self) -> List[Mount]: + def bind_mounts(self) -> list[Mount]: """Bind mounts that will be used by the container.""" mounts = [*super().bind_mounts] if self.project.requirements_txt: @@ -56,7 +56,7 @@ def bind_mounts(self) -> List[Mount]: return mounts @cached_property - def environment_variables(self) -> Dict[str, str]: + def environment_variables(self) -> dict[str, str]: """Environment variables to pass to the docker container. This is a subset of the environment variables stored in the context @@ -64,13 +64,11 @@ def environment_variables(self) -> Dict[str, str]: """ docker_env_vars = super().environment_variables - pip_env_vars = { - k: v for k, v in self.ctx.env.vars.items() if k.startswith("PIP") - } + pip_env_vars = {k: v for k, v in self.ctx.env.vars.items() if k.startswith("PIP")} return {**docker_env_vars, **pip_env_vars} @cached_property - def install_commands(self) -> List[str]: + def install_commands(self) -> list[str]: """Commands to run to install dependencies.""" if self.project.requirements_txt: return [ diff --git a/runway/cfngin/hooks/awslambda/python_requirements/_project.py b/runway/cfngin/hooks/awslambda/python_requirements/_project.py index 25eaacd4d..7b66dc6cf 100644 --- a/runway/cfngin/hooks/awslambda/python_requirements/_project.py +++ b/runway/cfngin/hooks/awslambda/python_requirements/_project.py @@ -4,9 +4,7 @@ import logging import shutil -from typing import TYPE_CHECKING, ClassVar, Optional, Set, Tuple - -from typing_extensions import Literal +from typing import TYPE_CHECKING, ClassVar, Optional from .....compat import cached_property from .....dependency_managers import ( @@ -23,6 +21,8 @@ if TYPE_CHECKING: from pathlib import Path + from typing_extensions import Literal + LOGGER = logging.getLogger(__name__.replace("._", ".")) @@ -38,24 +38,18 @@ def docker(self) -> Optional[PythonDockerDependencyInstaller]: return PythonDockerDependencyInstaller.from_project(self) @cached_property - def metadata_files(self) -> Tuple[Path, ...]: + def metadata_files(self) -> tuple[Path, ...]: """Project metadata files. Files are only included in return value if they exist. """ if self.project_type == "poetry": - config_files = [ - self.project_root / config_file for config_file in Poetry.CONFIG_FILES - ] + config_files = [self.project_root / config_file for config_file in Poetry.CONFIG_FILES] elif self.project_type == "pipenv": - config_files = [ - self.project_root / config_file for config_file in Pipenv.CONFIG_FILES - ] + config_files = [self.project_root / config_file for config_file in Pipenv.CONFIG_FILES] else: - config_files = [ - self.project_root / config_file for config_file in Pip.CONFIG_FILES - ] + config_files = [self.project_root / config_file for config_file in Pip.CONFIG_FILES] return tuple(path for path in config_files if path.exists()) @cached_property @@ -119,15 +113,11 @@ def project_type(self) -> Literal["pip", "pipenv", "poetry"]: if Poetry.dir_is_project(self.project_root): if self.args.use_poetry: return "poetry" - LOGGER.warning( - "poetry project detected but use of poetry is explicitly disabled" - ) + LOGGER.warning("poetry project detected but use of poetry is explicitly disabled") if Pipenv.dir_is_project(self.project_root): if self.args.use_pipenv: return "pipenv" - LOGGER.warning( - "pipenv project detected but use of pipenv is explicitly disabled" - ) + LOGGER.warning("pipenv project detected but use of pipenv is explicitly disabled") return "pip" @cached_property @@ -143,7 +133,7 @@ def requirements_txt(self) -> Optional[Path]: return None @cached_property - def supported_metadata_files(self) -> Set[str]: + def supported_metadata_files(self) -> set[str]: """Names of all supported metadata files. Returns: @@ -190,8 +180,6 @@ def install_dependencies(self) -> None: requirements=self.requirements_txt, target=self.dependency_directory, ) - LOGGER.debug( - "dependencies successfully installed to %s", self.dependency_directory - ) + LOGGER.debug("dependencies successfully installed to %s", self.dependency_directory) else: LOGGER.info("skipped installing dependencies; none found") diff --git a/runway/cfngin/hooks/awslambda/source_code.py b/runway/cfngin/hooks/awslambda/source_code.py index e815c79ca..c351958e2 100644 --- a/runway/cfngin/hooks/awslambda/source_code.py +++ b/runway/cfngin/hooks/awslambda/source_code.py @@ -5,7 +5,7 @@ import hashlib import logging from pathlib import Path -from typing import TYPE_CHECKING, Iterator, List, Optional, Sequence, Union +from typing import TYPE_CHECKING import igittigitt @@ -13,6 +13,8 @@ from runway.utils import FileHash if TYPE_CHECKING: + from collections.abc import Iterator, Sequence + from _typeshed import StrPath LOGGER = logging.getLogger(__name__) @@ -41,9 +43,9 @@ def __init__( self, root_directory: StrPath, *, - gitignore_filter: Optional[igittigitt.IgnoreParser] = None, - include_files_in_hash: Optional[Sequence[Path]] = None, - project_root: Optional[StrPath] = None, + gitignore_filter: igittigitt.IgnoreParser | None = None, + include_files_in_hash: Sequence[Path] | None = None, + project_root: StrPath | None = None, ) -> None: """Instantiate class. @@ -88,7 +90,7 @@ def md5_hash(self) -> str: for include_file in self._include_files_in_hash: if include_file not in sorted_files: sorted_files.append(include_file) - file_hash = FileHash(hashlib.md5()) + file_hash = FileHash(hashlib.md5()) # noqa: S324 file_hash.add_files(sorted(sorted_files), relative_to=self.project_root) return file_hash.hexdigest @@ -101,7 +103,7 @@ def add_filter_rule(self, pattern: str) -> None: """ self.gitignore_filter.add_rule(pattern=pattern, base_path=self.root_directory) - def sorted(self, *, reverse: bool = False) -> List[Path]: + def sorted(self, *, reverse: bool = False) -> list[Path]: """Sorted list of source code files. Args: @@ -120,7 +122,7 @@ def __eq__(self, other: object) -> bool: return self.root_directory == other.root_directory return False - def __fspath__(self) -> Union[str, bytes]: + def __fspath__(self) -> str | bytes: """Return the file system path representation of the object.""" return str(self.root_directory) diff --git a/runway/cfngin/hooks/awslambda/type_defs.py b/runway/cfngin/hooks/awslambda/type_defs.py index d3aacb37b..168a86396 100644 --- a/runway/cfngin/hooks/awslambda/type_defs.py +++ b/runway/cfngin/hooks/awslambda/type_defs.py @@ -2,16 +2,14 @@ from __future__ import annotations -from typing import Optional - from typing_extensions import TypedDict class AwsLambdaHookDeployResponseTypedDict(TypedDict): - """Dict output of :class:`runway.cfngin.hooks.awslambda.models.response.AwsLambdaHookDeployResponse` using aliases.""" # noqa + """Dict output of :class:`runway.cfngin.hooks.awslambda.models.response.AwsLambdaHookDeployResponse` using aliases.""" # noqa: E501 CodeSha256: str Runtime: str S3Bucket: str S3Key: str - S3ObjectVersion: Optional[str] + S3ObjectVersion: str | None diff --git a/runway/cfngin/hooks/base.py b/runway/cfngin/hooks/base.py index 9c48d517d..e515b16b4 100644 --- a/runway/cfngin/hooks/base.py +++ b/runway/cfngin/hooks/base.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, ClassVar, Dict, Optional, Type, Union, cast +from typing import TYPE_CHECKING, Any, ClassVar, Dict, cast # noqa: UP035 from troposphere import Tags @@ -28,7 +28,7 @@ class HookArgsBaseModel(BaseModel): """Base model for hook args.""" - tags: Dict[str, str] = {} + tags: Dict[str, str] = {} # noqa: UP006 class Hook(CfnginHookProtocol): @@ -46,24 +46,23 @@ class Hook(CfnginHookProtocol): """ - ARGS_PARSER: ClassVar[Type[HookArgsBaseModel]] = HookArgsBaseModel + ARGS_PARSER: ClassVar[type[HookArgsBaseModel]] = HookArgsBaseModel """Class used to parse arguments passed to the hook.""" args: HookArgsBaseModel - blueprint: Optional[Blueprint] = None + blueprint: Blueprint | None = None context: CfnginContext provider: Provider - stack: Optional[Stack] = None + stack: Stack | None = None stack_name: str = "stack" - def __init__( # pylint: disable=super-init-not-called - self, context: CfnginContext, provider: Provider, **kwargs: Any - ) -> None: + def __init__(self, context: CfnginContext, provider: Provider, **kwargs: Any) -> None: """Instantiate class. Args: context: Context instance. (passed in by CFNgin) provider: Provider instance. (passed in by CFNgin) + **kwargs: Arbitrary keyword arguments. """ kwargs.setdefault("tags", {}) @@ -72,7 +71,7 @@ def __init__( # pylint: disable=super-init-not-called self.args.tags.update(context.tags) self.context = context self.provider = provider - # TODO BREAKING remove these from the primary base class + # TODO (kyle): BREAKING remove these from the primary base class self._deploy_action = HookDeployAction(self.context, self.provider) self._destroy_action = HookDestroyAction(self.context, self.provider) @@ -87,10 +86,10 @@ def generate_stack(self, **kwargs: Any) -> Stack: name=self.stack_name, tags=self.args.tags, **kwargs ) stack = Stack(definition, self.context) - stack._blueprint = self.blueprint # pylint: disable=protected-access + stack._blueprint = self.blueprint # noqa: SLF001 return stack - def get_template_description(self, suffix: Optional[str] = None) -> str: + def get_template_description(self, suffix: str | None = None) -> str: """Generate a template description. Args: @@ -104,7 +103,7 @@ def get_template_description(self, suffix: Optional[str] = None) -> str: return template.format(self.__class__.__module__, suffix) return template.format(self.__class__.__module__) - def deploy_stack(self, stack: Optional[Stack] = None, wait: bool = False) -> Status: + def deploy_stack(self, stack: Stack | None = None, wait: bool = False) -> Status: """Deploy a stack. Args: @@ -115,13 +114,9 @@ def deploy_stack(self, stack: Optional[Stack] = None, wait: bool = False) -> Sta Ending status of the stack. """ - return self._run_stack_action( - action=self._deploy_action, stack=stack, wait=wait - ) + return self._run_stack_action(action=self._deploy_action, stack=stack, wait=wait) - def destroy_stack( - self, stack: Optional[Stack] = None, wait: bool = False - ) -> Status: + def destroy_stack(self, stack: Stack | None = None, wait: bool = False) -> Status: """Destroy a stack. Args: @@ -132,9 +127,7 @@ def destroy_stack( Ending status of the stack. """ - return self._run_stack_action( - action=self._destroy_action, stack=stack, wait=wait - ) + return self._run_stack_action(action=self._destroy_action, stack=stack, wait=wait) def post_deploy(self) -> Any: """Run during the **post_deploy** stage.""" @@ -175,8 +168,8 @@ def _log_stack(stack: Stack, status: Status) -> None: def _run_stack_action( self, - action: Union[HookDeployAction, HookDestroyAction], - stack: Optional[Stack] = None, + action: HookDeployAction | HookDestroyAction, + stack: Stack | None = None, wait: bool = False, ) -> Status: """Run a CFNgin hook modified for use in hooks. @@ -197,18 +190,16 @@ def _run_stack_action( self._log_stack(stack, status) if wait and status != SKIPPED: - status = self._wait_for_stack( - action=action, stack=stack, last_status=status - ) + status = self._wait_for_stack(action=action, stack=stack, last_status=status) return status def _wait_for_stack( self, - action: Union[HookDeployAction, HookDestroyAction], - last_status: Optional[Status] = None, - stack: Optional[Stack] = None, - till_reason: Optional[str] = None, - ): + action: HookDeployAction | HookDestroyAction, + last_status: Status | None = None, + stack: Stack | None = None, + till_reason: str | None = None, + ) -> Status: """Wait for a CloudFormation stack to complete. Args: @@ -249,11 +240,11 @@ def _wait_for_stack( return status -# TODO BREAKING find a better place for this - can cause cyclic imports +# TODO (kyle): BREAKING find a better place for this - can cause cyclic imports class HookDeployAction(deploy.Action): """Deploy action that can be used from hooks.""" - def __init__(self, context: CfnginContext, provider: Provider): + def __init__(self, context: CfnginContext, provider: Provider) -> None: """Instantiate class. Args: diff --git a/runway/cfngin/hooks/cleanup_s3.py b/runway/cfngin/hooks/cleanup_s3.py index f6fcfad66..860f58e1b 100644 --- a/runway/cfngin/hooks/cleanup_s3.py +++ b/runway/cfngin/hooks/cleanup_s3.py @@ -31,9 +31,7 @@ def purge_bucket(context: CfnginContext, *__args: Any, **kwargs: Any) -> bool: s3_resource.meta.client.head_bucket(Bucket=args.bucket_name) except ClientError as exc: if exc.response["Error"]["Code"] == "404": - LOGGER.info( - 'bucket "%s" does not exist; unable to complete purge', args.bucket_name - ) + LOGGER.info('bucket "%s" does not exist; unable to complete purge', args.bucket_name) return True raise diff --git a/runway/cfngin/hooks/command.py b/runway/cfngin/hooks/command.py index 110bf5b32..1cf202281 100644 --- a/runway/cfngin/hooks/command.py +++ b/runway/cfngin/hooks/command.py @@ -3,7 +3,7 @@ import logging import os import subprocess -from typing import Any, Dict, List, Optional, Union +from typing import Any, Dict, List, Optional, Union # noqa: UP035 from typing_extensions import TypedDict @@ -19,10 +19,10 @@ class RunCommandHookArgs(BaseModel): capture: bool = False """If enabled, capture the command's stdout and stderr, and return them in the hook result.""" - command: Union[str, List[str]] + command: Union[str, List[str]] # noqa: UP006 """Command(s) to run.""" - env: Optional[Dict[str, str]] = None + env: Optional[Dict[str, str]] = None # noqa: UP006 """Dictionary of environment variable overrides for the command context. Will be merged with the current environment. @@ -55,7 +55,7 @@ class RunCommandResponseTypeDef(TypedDict, total=False): stdout: str -def run_command(*__args: Any, **kwargs: Any) -> RunCommandResponseTypeDef: +def run_command(*_args: Any, **kwargs: Any) -> RunCommandResponseTypeDef: # noqa: C901, PLR0912 """Run a custom command as a hook. Arguments not parsed by the data model will be forwarded to the @@ -106,7 +106,7 @@ def run_command(*__args: Any, **kwargs: Any) -> RunCommandResponseTypeDef: ValueError("Cannot enable `quiet` and `capture` options simultaneously"), ) - with open(os.devnull, "wb") as devnull: + with open(os.devnull, "wb") as devnull: # noqa: PTH123 if args.quiet: out_err_type = devnull elif args.capture: @@ -147,10 +147,8 @@ def run_command(*__args: Any, **kwargs: Any) -> RunCommandResponseTypeDef: if LOGGER.isEnabledFor(logging.INFO): # cov: ignore LOGGER.warning("command failed with returncode %d", status) else: - LOGGER.warning( - "command failed with returncode %d: %s", status, args.command - ) + LOGGER.warning("command failed with returncode %d: %s", status, args.command) return {} - except Exception: # pylint: disable=broad-except # cov: ignore + except Exception: # cov: ignore # noqa: BLE001 return {} diff --git a/runway/cfngin/hooks/docker/_login.py b/runway/cfngin/hooks/docker/_login.py index 9eebfbc8f..52d54a8e2 100644 --- a/runway/cfngin/hooks/docker/_login.py +++ b/runway/cfngin/hooks/docker/_login.py @@ -1,20 +1,17 @@ """Docker login hook.""" -# pylint: disable=no-self-argument from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, Optional +from typing import Any, Optional from pydantic import Field, validator +from ....context import CfnginContext from ....utils import BaseModel from .data_models import ElasticContainerRegistry from .hook_data import DockerHookData -if TYPE_CHECKING: - from ....context import CfnginContext - LOGGER = logging.getLogger(__name__.replace("._", ".")) @@ -42,21 +39,19 @@ class LoginArgs(BaseModel): """The registry username.""" @validator("ecr", pre=True, allow_reuse=True) - def _set_ecr(cls, v: Any, values: Dict[str, Any]) -> Any: + def _set_ecr(cls, v: Any, values: dict[str, Any]) -> Any: # noqa: N805 """Set the value of ``ecr``.""" if v and isinstance(v, dict): - return ElasticContainerRegistry.parse_obj( - {"context": values.get("context"), **v} - ) + return ElasticContainerRegistry.parse_obj({"context": values.get("context"), **v}) return v @validator("registry", pre=True, always=True, allow_reuse=True) - def _set_registry(cls, v: Any, values: Dict[str, Any]) -> Any: + def _set_registry(cls, v: Any, values: dict[str, Any]) -> Any: # noqa: N805 """Set the value of ``registry``.""" if v: return v - ecr: Optional[ElasticContainerRegistry] = values.get("ecr") + ecr: ElasticContainerRegistry | None = values.get("ecr") if ecr: return ecr.fqn diff --git a/runway/cfngin/hooks/docker/data_models.py b/runway/cfngin/hooks/docker/data_models.py index d8b97f5fc..c8ffc10f8 100644 --- a/runway/cfngin/hooks/docker/data_models.py +++ b/runway/cfngin/hooks/docker/data_models.py @@ -5,24 +5,18 @@ """ -# pylint: disable=no-self-argument from __future__ import annotations -from typing import TYPE_CHECKING, Any, ClassVar, Dict, List, Optional, cast +from typing import Any, ClassVar, Optional, cast from docker.models.images import Image from pydantic import Field, root_validator +from ....context import CfnginContext from ....core.providers.aws import AccountDetails from ....utils import BaseModel, MutableMap -if TYPE_CHECKING: - from ....context import CfnginContext - - -ECR_REPO_FQN_TEMPLATE = ( - "{aws_account_id}.dkr.ecr.{aws_region}.amazonaws.com/{repo_name}" -) +ECR_REPO_FQN_TEMPLATE = "{aws_account_id}.dkr.ecr.{aws_region}.amazonaws.com/{repo_name}" class ElasticContainerRegistry(BaseModel): @@ -51,18 +45,16 @@ def fqn(self) -> str: """Fully qualified ECR name.""" if self.public: return self.PUBLIC_URI_TEMPLATE.format(registry_alias=self.alias) - return self.URI_TEMPLATE.format( - aws_account_id=self.account_id, aws_region=self.region - ) + return self.URI_TEMPLATE.format(aws_account_id=self.account_id, aws_region=self.region) @root_validator(allow_reuse=True, pre=True) - def _set_defaults(cls, values: Dict[str, Any]) -> Dict[str, Any]: + def _set_defaults(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Set default values based on other values.""" values.setdefault("public", bool(values.get("alias"))) if not values["public"]: account_id = values.get("account_id") - ctx: Optional[CfnginContext] = values.get("context") + ctx: CfnginContext | None = values.get("context") region = values.get("aws_region") if not ctx and not (account_id or region): raise ValueError("context is required to resolve values") @@ -106,7 +98,7 @@ def short_id(self) -> str: return self.image.short_id @property - def tags(self) -> List[str]: + def tags(self) -> list[str]: """List of image tags.""" self.image.reload() return [uri.split(":")[-1] for uri in self.image.tags] diff --git a/runway/cfngin/hooks/docker/hook_data.py b/runway/cfngin/hooks/docker/hook_data.py index ad58cce04..7c8e45908 100644 --- a/runway/cfngin/hooks/docker/hook_data.py +++ b/runway/cfngin/hooks/docker/hook_data.py @@ -17,7 +17,7 @@ class DockerHookData(MutableMap): """Docker hook_data object.""" - image: Optional["DockerImage"] = None + image: Optional[DockerImage] = None @cached_property def client(self) -> DockerClient: @@ -25,16 +25,12 @@ def client(self) -> DockerClient: return DockerClient.from_env() @overload - def update_context(self, context: CfnginContext = ...) -> DockerHookData: # noqa - ... + def update_context(self, context: CfnginContext = ...) -> DockerHookData: ... @overload - def update_context(self, context: None = ...) -> None: # noqa - ... + def update_context(self, context: None = ...) -> None: ... - def update_context( - self, context: Optional[CfnginContext] = None - ) -> Optional[DockerHookData]: + def update_context(self, context: Optional[CfnginContext] = None) -> Optional[DockerHookData]: """Update context object with new the current DockerHookData.""" if not context: return None diff --git a/runway/cfngin/hooks/docker/image/_build.py b/runway/cfngin/hooks/docker/image/_build.py index 7cc31eeb1..af1fa2aec 100644 --- a/runway/cfngin/hooks/docker/image/_build.py +++ b/runway/cfngin/hooks/docker/image/_build.py @@ -4,26 +4,20 @@ """ -# pylint: disable=no-self-argument from __future__ import annotations import logging from pathlib import Path -from typing import ( - TYPE_CHECKING, +from typing import ( # noqa: UP035 Any, Dict, - Iterator, List, Optional, - Tuple, - Union, - cast, ) -from docker.models.images import Image from pydantic import DirectoryPath, Field, validator +from .....context import CfnginContext from .....utils import BaseModel from ..data_models import ( DockerImage, @@ -32,22 +26,19 @@ ) from ..hook_data import DockerHookData -if TYPE_CHECKING: - from .....context import CfnginContext - LOGGER = logging.getLogger(__name__.replace("._", ".")) class DockerImageBuildApiOptions(BaseModel): """Options for controlling Docker.""" - buildargs: Dict[str, Any] = {} + buildargs: Dict[str, Any] = {} # noqa: UP006 """Dict of build-time variables that will be passed to Docker.""" custom_context: bool = False """Whether to use custom context when providing a file object.""" - extra_hosts: Dict[str, str] = {} + extra_hosts: Dict[str, str] = {} # noqa: UP006 """Extra hosts to add to `/etc/hosts` in the build containers. Defined as a mapping of hostname to IP address. @@ -125,14 +116,14 @@ class ImageBuildArgs(BaseModel): docker: DockerImageBuildApiOptions = DockerImageBuildApiOptions() # depends on repo """Options for ``docker image build``.""" - tags: List[str] = ["latest"] + tags: List[str] = ["latest"] # noqa: UP006 """List of tags to apply to the image.""" @validator("docker", pre=True, always=True, allow_reuse=True) def _set_docker( - cls, - v: Union[Dict[str, Any], DockerImageBuildApiOptions, Any], - values: Dict[str, Any], + cls, # noqa: N805 + v: dict[str, Any] | DockerImageBuildApiOptions | Any, + values: dict[str, Any], ) -> Any: """Set the value of ``docker``.""" repo = values["repo"] @@ -144,7 +135,7 @@ def _set_docker( return v @validator("ecr_repo", pre=True, allow_reuse=True) - def _set_ecr_repo(cls, v: Any, values: Dict[str, Any]) -> Any: + def _set_ecr_repo(cls, v: Any, values: dict[str, Any]) -> Any: # noqa: N805 """Set the value of ``ecr_repo``.""" if v and isinstance(v, dict): return ElasticContainerRegistryRepository.parse_obj( @@ -163,26 +154,24 @@ def _set_ecr_repo(cls, v: Any, values: Dict[str, Any]) -> Any: return v @validator("repo", pre=True, always=True, allow_reuse=True) - def _set_repo(cls, v: Optional[str], values: Dict[str, Any]) -> Optional[str]: + def _set_repo(cls, v: str | None, values: dict[str, Any]) -> str | None: # noqa: N805 """Set the value of ``repo``.""" if v: return v - ecr_repo: Optional[ElasticContainerRegistryRepository] = values.get("ecr_repo") + ecr_repo: ElasticContainerRegistryRepository | None = values.get("ecr_repo") if ecr_repo: return ecr_repo.fqn return None @validator("dockerfile", pre=True, always=True, allow_reuse=True) - def _validate_dockerfile(cls, v: Any, values: Dict[str, Any]) -> Any: + def _validate_dockerfile(cls, v: Any, values: dict[str, Any]) -> Any: # noqa: N805 """Validate ``dockerfile``.""" path: Path = values["path"] dockerfile = path / v if not dockerfile.is_file(): - raise ValueError( - f"Dockerfile does not exist at path provided: {dockerfile}" - ) + raise ValueError(f"Dockerfile does not exist at path provided: {dockerfile}") return v @@ -196,10 +185,7 @@ def build(*, context: CfnginContext, **kwargs: Any) -> DockerHookData: """ args = ImageBuildArgs.parse_obj({"context": context, **kwargs}) docker_hook_data = DockerHookData.from_cfngin_context(context) - image, logs = cast( - Tuple[Image, Iterator[Dict[str, str]]], - docker_hook_data.client.images.build(path=str(args.path), **args.docker.dict()), - ) + image, logs = docker_hook_data.client.images.build(path=str(args.path), **args.docker.dict()) for msg in logs: # iterate through JSON log messages if "stream" in msg: # log if they contain a message LOGGER.info(msg["stream"].strip()) # remove any new line characters diff --git a/runway/cfngin/hooks/docker/image/_push.py b/runway/cfngin/hooks/docker/image/_push.py index 4f4921afb..cec7fdd01 100644 --- a/runway/cfngin/hooks/docker/image/_push.py +++ b/runway/cfngin/hooks/docker/image/_push.py @@ -4,14 +4,14 @@ """ -# pylint: disable=no-self-argument from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, List, Optional +from typing import Any, List, Optional # noqa: UP035 from pydantic import Field, validator +from .....context import CfnginContext from .....utils import BaseModel from ..data_models import ( DockerImage, @@ -20,9 +20,6 @@ ) from ..hook_data import DockerHookData -if TYPE_CHECKING: - from .....context import CfnginContext - LOGGER = logging.getLogger(__name__.replace("._", ".")) @@ -47,11 +44,11 @@ class ImagePushArgs(BaseModel): repo: Optional[str] = None # depends on ecr_repo & image """URI of a non Docker Hub repository where the image will be stored.""" - tags: List[str] = [] # depends on image + tags: List[str] = [] # depends on image # noqa: UP006 """List of tags to push.""" @validator("ecr_repo", pre=True, allow_reuse=True) - def _set_ecr_repo(cls, v: Any, values: Dict[str, Any]) -> Any: + def _set_ecr_repo(cls, v: Any, values: dict[str, Any]) -> Any: # noqa: N805 """Set the value of ``ecr_repo``.""" if v and isinstance(v, dict): return ElasticContainerRegistryRepository.parse_obj( @@ -70,28 +67,28 @@ def _set_ecr_repo(cls, v: Any, values: Dict[str, Any]) -> Any: return v @validator("repo", pre=True, always=True, allow_reuse=True) - def _set_repo(cls, v: Optional[str], values: Dict[str, Any]) -> Optional[str]: + def _set_repo(cls, v: str | None, values: dict[str, Any]) -> str | None: # noqa: N805 """Set the value of ``repo``.""" if v: return v - image: Optional[DockerImage] = values.get("image") + image: DockerImage | None = values.get("image") if image: return image.repo - ecr_repo: Optional[ElasticContainerRegistryRepository] = values.get("ecr_repo") + ecr_repo: ElasticContainerRegistryRepository | None = values.get("ecr_repo") if ecr_repo: return ecr_repo.fqn return None @validator("tags", pre=True, always=True, allow_reuse=True) - def _set_tags(cls, v: List[str], values: Dict[str, Any]) -> List[str]: + def _set_tags(cls, v: list[str], values: dict[str, Any]) -> list[str]: # noqa: N805 """Set the value of ``tags``.""" if v: return v - image: Optional[DockerImage] = values.get("image") + image: DockerImage | None = values.get("image") if image: return image.tags diff --git a/runway/cfngin/hooks/docker/image/_remove.py b/runway/cfngin/hooks/docker/image/_remove.py index d2476c388..5f7a7f289 100644 --- a/runway/cfngin/hooks/docker/image/_remove.py +++ b/runway/cfngin/hooks/docker/image/_remove.py @@ -4,15 +4,15 @@ """ -# pylint: disable=no-self-argument from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, List, Optional +from typing import Any, List, Optional # noqa: UP035 from docker.errors import ImageNotFound from pydantic import Field, validator +from .....context import CfnginContext from .....utils import BaseModel from ..data_models import ( DockerImage, @@ -21,9 +21,6 @@ ) from ..hook_data import DockerHookData -if TYPE_CHECKING: - from .....context import CfnginContext - LOGGER = logging.getLogger(__name__.replace("._", ".")) @@ -54,11 +51,11 @@ class ImageRemoveArgs(BaseModel): repo: Optional[str] = None # depends on ecr_repo & image """URI of a non Docker Hub repository where the image will be stored.""" - tags: List[str] = [] # depends on image + tags: List[str] = [] # depends on image # noqa: UP006 """List of tags to remove.""" @validator("ecr_repo", pre=True, allow_reuse=True) - def _set_ecr_repo(cls, v: Any, values: Dict[str, Any]) -> Any: + def _set_ecr_repo(cls, v: Any, values: dict[str, Any]) -> Any: # noqa: N805 """Set the value of ``ecr_repo``.""" if v and isinstance(v, dict): return ElasticContainerRegistryRepository.parse_obj( @@ -77,28 +74,28 @@ def _set_ecr_repo(cls, v: Any, values: Dict[str, Any]) -> Any: return v @validator("repo", pre=True, always=True, allow_reuse=True) - def _set_repo(cls, v: Optional[str], values: Dict[str, Any]) -> Optional[str]: + def _set_repo(cls, v: str | None, values: dict[str, Any]) -> str | None: # noqa: N805 """Set the value of ``repo``.""" if v: return v - image: Optional[DockerImage] = values.get("image") + image: DockerImage | None = values.get("image") if image: return image.repo - ecr_repo: Optional[ElasticContainerRegistryRepository] = values.get("ecr_repo") + ecr_repo: ElasticContainerRegistryRepository | None = values.get("ecr_repo") if ecr_repo: return ecr_repo.fqn return None @validator("tags", pre=True, always=True, allow_reuse=True) - def _set_tags(cls, v: List[str], values: Dict[str, Any]) -> List[str]: + def _set_tags(cls, v: list[str], values: dict[str, Any]) -> list[str]: # noqa: N805 """Set the value of ``tags``.""" if v: return v - image: Optional[DockerImage] = values.get("image") + image: DockerImage | None = values.get("image") if image: return image.tags @@ -125,7 +122,10 @@ def remove(*, context: CfnginContext, **kwargs: Any) -> DockerHookData: LOGGER.info("successfully removed local image %s", image) except ImageNotFound: LOGGER.warning("local image %s does not exist", image) - if docker_hook_data.image and kwargs.get("image"): - if kwargs["image"].id == docker_hook_data.image.id: - docker_hook_data.image = None # clear out the image that was set + if ( + docker_hook_data.image + and kwargs.get("image") + and kwargs["image"].id == docker_hook_data.image.id + ): + docker_hook_data.image = None # clear out the image that was set return docker_hook_data.update_context(context) diff --git a/runway/cfngin/hooks/ecr/_purge_repository.py b/runway/cfngin/hooks/ecr/_purge_repository.py index 34ef64a23..013eb543c 100644 --- a/runway/cfngin/hooks/ecr/_purge_repository.py +++ b/runway/cfngin/hooks/ecr/_purge_repository.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, List +from typing import TYPE_CHECKING, Any from ....utils import BaseModel @@ -25,34 +25,27 @@ class HookArgs(BaseModel): def delete_ecr_images( client: ECRClient, - image_ids: List[ImageIdentifierTypeDef], + image_ids: list[ImageIdentifierTypeDef], repository_name: str, ) -> None: """Delete images from an ECR repository.""" - response = client.batch_delete_image( - repositoryName=repository_name, imageIds=image_ids - ) - if "failures" in response and response["failures"]: + response = client.batch_delete_image(repositoryName=repository_name, imageIds=image_ids) + if response.get("failures"): for msg in response["failures"]: LOGGER.info( "failed to delete image %s: (%s) %s", - msg.get("imageId", {}).get("imageDigest") - or msg.get("imageId", {}).get("imageTag"), + msg.get("imageId", {}).get("imageDigest") or msg.get("imageId", {}).get("imageTag"), msg.get("failureCode"), msg.get("failureReason"), ) raise ValueError("failures present in response") -def list_ecr_images( - client: ECRClient, repository_name: str -) -> List[ImageIdentifierTypeDef]: +def list_ecr_images(client: ECRClient, repository_name: str) -> list[ImageIdentifierTypeDef]: """List all images in an ECR repository.""" - image_ids: List[ImageIdentifierTypeDef] = [] + image_ids: list[ImageIdentifierTypeDef] = [] try: - response = client.list_images( - repositoryName=repository_name, filter={"tagStatus": "ANY"} - ) + response = client.list_images(repositoryName=repository_name, filter={"tagStatus": "ANY"}) image_ids.extend(response["imageIds"]) while response.get("nextToken"): response = client.list_images( @@ -63,22 +56,19 @@ def list_ecr_images( image_ids.extend(response["imageIds"]) return [ {"imageDigest": digest} - for digest in { - image["imageDigest"] for image in image_ids if image.get("imageDigest") - } + for digest in {image["imageDigest"] for image in image_ids if image.get("imageDigest")} ] except client.exceptions.RepositoryNotFoundException: LOGGER.info("repository %s does not exist", repository_name) return [] -def purge_repository( - context: CfnginContext, *__args: Any, **kwargs: Any -) -> Dict[str, str]: +def purge_repository(context: CfnginContext, *_args: Any, **kwargs: Any) -> dict[str, str]: """Purge all images from an ECR repository. Args: context: CFNgin context object. + **kwargs: Arbitrary keyword arguments. """ args = HookArgs.parse_obj(kwargs) diff --git a/runway/cfngin/hooks/ecs.py b/runway/cfngin/hooks/ecs.py index c5950b29a..5a44f8786 100644 --- a/runway/cfngin/hooks/ecs.py +++ b/runway/cfngin/hooks/ecs.py @@ -1,10 +1,9 @@ """AWS ECS hook.""" -# pylint: disable=no-self-argument from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, List, Union +from typing import TYPE_CHECKING, Any, List # noqa: UP035 from pydantic import validator from typing_extensions import TypedDict @@ -22,11 +21,11 @@ class CreateClustersHookArgs(BaseModel): """Hook arguments for ``create_clusters``.""" - clusters: List[str] + clusters: List[str] # noqa: UP006 """List of cluster names to create.""" @validator("clusters", allow_reuse=True, pre=True) - def _convert_clusters(cls, v: Union[List[str], str]) -> List[str]: + def _convert_clusters(cls, v: list[str] | str) -> list[str]: # noqa: N805 """Convert value of ``clusters`` from str to list.""" if isinstance(v, str): return [v] @@ -36,22 +35,23 @@ def _convert_clusters(cls, v: Union[List[str], str]) -> List[str]: class CreateClustersResponseTypeDef(TypedDict): """Response from create_clusters.""" - clusters: Dict[str, CreateClusterResponseTypeDef] + clusters: dict[str, CreateClusterResponseTypeDef] def create_clusters( - context: CfnginContext, *__args: Any, **kwargs: Any + context: CfnginContext, *_args: Any, **kwargs: Any ) -> CreateClustersResponseTypeDef: """Create ECS clusters. Args: context: CFNgin context object. + **kwargs: Arbitrary keyword arguments. """ args = CreateClustersHookArgs.parse_obj(kwargs) ecs_client = context.get_session().client("ecs") - cluster_info: Dict[str, Any] = {} + cluster_info: dict[str, Any] = {} for cluster in args.clusters: LOGGER.debug("creating ECS cluster: %s", cluster) response = ecs_client.create_cluster(clusterName=cluster) diff --git a/runway/cfngin/hooks/iam.py b/runway/cfngin/hooks/iam.py index b23998ba9..edf9a6ab4 100644 --- a/runway/cfngin/hooks/iam.py +++ b/runway/cfngin/hooks/iam.py @@ -4,7 +4,7 @@ import copy import logging -from typing import TYPE_CHECKING, Any, Dict, Optional, Union, cast +from typing import TYPE_CHECKING, Any, Optional, cast from awacs import ecs from awacs.aws import Allow, Policy, Statement @@ -69,15 +69,14 @@ class EnsureServerCertExistsHookArgs(BaseModel): """Whether to prompt to upload a certificate if one does not exist.""" -def create_ecs_service_role( - context: CfnginContext, *__args: Any, **kwargs: Any -) -> bool: +def create_ecs_service_role(context: CfnginContext, *_args: Any, **kwargs: Any) -> bool: """Create ecsServiceRole IAM role. https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html Args: context: Context instance. (passed in by CFNgin) + **kwargs: Arbitrary keyword arguments. """ args = CreateEcsServiceRoleHookArgs.parse_obj(kwargs) @@ -100,9 +99,7 @@ def create_ecs_service_role( def _get_cert_arn_from_response( - response: Union[ - GetServerCertificateResponseTypeDef, UploadServerCertificateResponseTypeDef - ] + response: GetServerCertificateResponseTypeDef | UploadServerCertificateResponseTypeDef, ) -> str: result = copy.deepcopy(response) # GET response returns this extra key @@ -117,7 +114,7 @@ def _get_cert_arn_from_response( ) -def _get_cert_contents(kwargs: Dict[str, Any]) -> Dict[str, Any]: +def _get_cert_contents(kwargs: dict[str, Any]) -> dict[str, Any]: # noqa: C901 """Build parameters with server cert file contents. Args: @@ -145,7 +142,7 @@ def _get_cert_contents(kwargs: Dict[str, Any]) -> Dict[str, Any]: paths[key] = path - parameters: Dict[str, str] = {} + parameters: dict[str, str] = {} for key, path in paths.items(): if not path: @@ -155,7 +152,7 @@ def _get_cert_contents(kwargs: Dict[str, Any]) -> Dict[str, Any]: try: contents = path.read() except AttributeError: - with open(utils.full_path(path), encoding="utf-8") as read_file: + with open(utils.full_path(path), encoding="utf-8") as read_file: # noqa: PTH123 contents = read_file.read() if key == "certificate": @@ -171,13 +168,12 @@ def _get_cert_contents(kwargs: Dict[str, Any]) -> Dict[str, Any]: return parameters -def ensure_server_cert_exists( - context: CfnginContext, *__args: Any, **kwargs: Any -) -> Dict[str, str]: +def ensure_server_cert_exists(context: CfnginContext, *_args: Any, **kwargs: Any) -> dict[str, str]: """Ensure server cert exists. Args: context: CFNgin context object. + **kwargs: Arbitrary keyword arguments. Returns: Dict containing ``status``, ``cert_name``, and ``cert_arn``. @@ -193,9 +189,7 @@ def ensure_server_cert_exists( LOGGER.info("certificate exists: %s (%s)", args.cert_name, cert_arn) except ClientError: if args.prompt: - upload = input( - f"Certificate '{args.cert_name}' wasn't found. Upload it now? (yes/no) " - ) + upload = input(f"Certificate '{args.cert_name}' wasn't found. Upload it now? (yes/no) ") if upload != "yes": return {} diff --git a/runway/cfngin/hooks/keypair.py b/runway/cfngin/hooks/keypair.py index d9c799384..88bd1f176 100644 --- a/runway/cfngin/hooks/keypair.py +++ b/runway/cfngin/hooks/keypair.py @@ -5,7 +5,7 @@ import logging import sys from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, Optional, Tuple +from typing import TYPE_CHECKING, Any, Optional from botocore.exceptions import ClientError from typing_extensions import Literal, TypedDict @@ -142,7 +142,7 @@ def create_key_pair_in_ssm( keypair = create_key_pair(ec2, keypair_name) try: kms_key_label = "default" - kms_args: Dict[str, Any] = {} + kms_args: dict[str, Any] = {} if kms_key_id: kms_key_label = kms_key_id kms_args = {"KeyId": kms_key_id} @@ -219,7 +219,7 @@ def create_key_pair_local( def interactive_prompt( keypair_name: str, -) -> Tuple[Optional[Literal["create", "import"]], Optional[str]]: +) -> tuple[Optional[Literal["create", "import"]], Optional[str]]: """Interactive prompt.""" if not sys.stdin.isatty(): return None, None @@ -246,9 +246,7 @@ def interactive_prompt( return None, None -def ensure_keypair_exists( - context: CfnginContext, *__args: Any, **kwargs: Any -) -> KeyPairInfo: +def ensure_keypair_exists(context: CfnginContext, *__args: Any, **kwargs: Any) -> KeyPairInfo: """Ensure a specific keypair exists within AWS. If the key doesn't exist, upload it. @@ -257,10 +255,7 @@ def ensure_keypair_exists( args = EnsureKeypairExistsHookArgs.parse_obj(kwargs) if args.public_key_path and args.ssm_parameter_name: - LOGGER.error( - "public_key_path and ssm_parameter_name cannot be " - "specified at the same time" - ) + LOGGER.error("public_key_path and ssm_parameter_name cannot be specified at the same time") return {} session = context.get_session() @@ -282,9 +277,7 @@ def ensure_keypair_exists( else: action, path = interactive_prompt(args.keypair) if action == "import" and path: - keypair_info = create_key_pair_from_public_key_file( - ec2, args.keypair, Path(path) - ) + keypair_info = create_key_pair_from_public_key_file(ec2, args.keypair, Path(path)) elif action == "create" and path: keypair_info = create_key_pair_local(ec2, args.keypair, Path(path)) else: diff --git a/runway/cfngin/hooks/protocols.py b/runway/cfngin/hooks/protocols.py index 68368cc21..9eb3bc43c 100644 --- a/runway/cfngin/hooks/protocols.py +++ b/runway/cfngin/hooks/protocols.py @@ -8,7 +8,7 @@ from __future__ import annotations from abc import abstractmethod -from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, overload +from typing import TYPE_CHECKING, Any, TypeVar, overload from typing_extensions import Protocol, runtime_checkable @@ -30,14 +30,14 @@ class CfnginHookArgsProtocol(Protocol): @overload @abstractmethod - def get(self, __name: str) -> Optional[Any]: ... + def get(self, __name: str) -> Any | None: ... @overload @abstractmethod - def get(self, __name: str, __default: Union[Any, _T]) -> Union[Any, _T]: ... + def get(self, __name: str, __default: Any | _T) -> Any | _T: ... @abstractmethod - def get(self, __name: str, __default: Union[Any, _T] = None) -> Union[Any, _T]: + def get(self, __name: str, __default: Any | _T = None) -> Any | _T: """Safely get the value of an attribute. Args: @@ -48,19 +48,19 @@ def get(self, __name: str, __default: Union[Any, _T] = None) -> Union[Any, _T]: raise NotImplementedError @abstractmethod - def __contains__(self, __name: str) -> bool: + def __contains__(self, __name: str) -> bool: # noqa: D105 raise NotImplementedError @abstractmethod - def __getattribute__(self, __name: str) -> Any: + def __getattribute__(self, __name: str) -> Any: # noqa: D105 raise NotImplementedError @abstractmethod - def __getitem__(self, __name: str) -> Any: + def __getitem__(self, __name: str) -> Any: # noqa: D105 raise NotImplementedError @abstractmethod - def __setitem__(self, __name: str, _value: Any) -> None: + def __setitem__(self, __name: str, _value: Any) -> None: # noqa: D105 raise NotImplementedError @@ -79,16 +79,8 @@ class CfnginHookProtocol(Protocol): """Arguments passed to the hook and parsed into an object.""" @abstractmethod - def __init__( # pylint: disable=super-init-not-called - self, context: CfnginContext, **_kwargs: Any - ) -> None: - """Structural __init__ method. - - This should not be called. Pylint will erroneously warn about - "super-init-not-called" if using this class as a subclass. This should - be disabled in-line until the bug reports for this issue is resolved. - - """ + def __init__(self, context: CfnginContext, **_kwargs: Any) -> None: + """Structural __init__ method.""" raise NotImplementedError @abstractmethod diff --git a/runway/cfngin/hooks/route53.py b/runway/cfngin/hooks/route53.py index f5885bfb2..6cffb4a36 100644 --- a/runway/cfngin/hooks/route53.py +++ b/runway/cfngin/hooks/route53.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any from ...utils import BaseModel from ..utils import create_route53_zone @@ -21,13 +21,12 @@ class CreateDomainHookArgs(BaseModel): """Domain name for the Route 53 hosted zone to be created.""" -def create_domain( - context: CfnginContext, *__args: Any, **kwargs: Any -) -> Dict[str, str]: +def create_domain(context: CfnginContext, *_args: Any, **kwargs: Any) -> dict[str, str]: """Create a domain within route53. Args: context: CFNgin context object. + **kwargs: Arbitrary keyword arguments. Returns: Dict containing ``domain`` and ``zone_id``. diff --git a/runway/cfngin/hooks/ssm/parameter.py b/runway/cfngin/hooks/ssm/parameter.py index e03589b00..4ace0e92c 100644 --- a/runway/cfngin/hooks/ssm/parameter.py +++ b/runway/cfngin/hooks/ssm/parameter.py @@ -1,11 +1,10 @@ """AWS SSM Parameter Store hooks.""" -# pylint: disable=no-self-argument from __future__ import annotations import json import logging -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast +from typing import TYPE_CHECKING, Any, List, Optional, cast # noqa: UP035 from pydantic import Extra, validator from typing_extensions import Literal, TypedDict @@ -27,10 +26,11 @@ LOGGER = cast("RunwayLogger", logging.getLogger(__name__)) + # PutParameterResultTypeDef but without metadata -_PutParameterResultTypeDef = TypedDict( - "_PutParameterResultTypeDef", {"Tier": ParameterTierType, "Version": int} -) +class _PutParameterResultTypeDef(TypedDict): + Tier: ParameterTierType + Version: int class ArgsDataModel(BaseModel): @@ -69,7 +69,7 @@ class ArgsDataModel(BaseModel): name: str overwrite: bool = True policies: Optional[str] = None - tags: Optional[List[TagDataModel]] = None + tags: Optional[List[TagDataModel]] = None # noqa: UP006 tier: ParameterTierType = "Standard" type: Literal["String", "StringList", "SecureString"] value: Optional[str] = None @@ -94,28 +94,25 @@ class Config: } @validator("policies", allow_reuse=True, pre=True) - def _convert_policies(cls, v: Union[List[Dict[str, Any]], str, Any]) -> str: + def _convert_policies(cls, v: list[dict[str, Any]] | str | Any) -> str: # noqa: N805 """Convert policies to acceptable value.""" if isinstance(v, str): return v if isinstance(v, list): return json.dumps(v, cls=JsonEncoder) - raise TypeError( - f"unexpected type {type(v)}; permitted: Optional[Union[List[Dict[str, Any]], str]]" - ) + raise TypeError(f"unexpected type {type(v)}; permitted: list[dict[str, Any]] | str | None") @validator("tags", allow_reuse=True, pre=True) def _convert_tags( - cls, v: Union[Dict[str, str], List[Dict[str, str]], Any] - ) -> List[Dict[str, str]]: + cls, v: dict[str, str] | list[dict[str, str]] | Any # noqa: N805 + ) -> list[dict[str, str]]: """Convert tags to acceptable value.""" if isinstance(v, list): return v if isinstance(v, dict): return [{"Key": k, "Value": v} for k, v in v.items()] raise TypeError( - f"unexpected type {type(v)}; permitted: " - "Optional[Union[Dict[str, str], List[Dict[str, str]]]" + f"unexpected type {type(v)}; permitted: dict[str, str] | list[dict[str, str] | None" ) @@ -124,14 +121,12 @@ class _Parameter(CfnginHookProtocol): args: ArgsDataModel - def __init__( # pylint: disable=super-init-not-called + def __init__( self, context: CfnginContext, *, name: str, - type: Literal[ # pylint: disable=redefined-builtin - "String", "StringList", "SecureString" - ], + type: Literal["String", "StringList", "SecureString"], # noqa: A002 **kwargs: Any, ) -> None: """Instantiate class. @@ -141,6 +136,7 @@ def __init__( # pylint: disable=super-init-not-called name: The fully qualified name of the parameter that you want to add to the system. type: The type of parameter. + **kwargs: Arbitrary keyword arguments. """ self.args = ArgsDataModel.parse_obj({"name": name, "type": type, **kwargs}) @@ -165,14 +161,14 @@ def get(self) -> ParameterTypeDef: if self.args.force: # bypass getting current value return {} try: - return self.client.get_parameter( - Name=self.args.name, WithDecryption=True - ).get("Parameter", {}) + return self.client.get_parameter(Name=self.args.name, WithDecryption=True).get( + "Parameter", {} + ) except self.client.exceptions.ParameterNotFound: LOGGER.verbose("parameter %s does not exist", self.args.name) return {} - def get_current_tags(self) -> List[TagTypeDef]: + def get_current_tags(self) -> list[TagTypeDef]: """Get Tags currently applied to Parameter.""" try: return self.client.list_tags_for_resource( @@ -216,9 +212,7 @@ def put(self) -> _PutParameterResultTypeDef: if current_param.get("Value") != self.args.value: try: result = self.client.put_parameter( - **self.args.dict( - by_alias=True, exclude_none=True, exclude={"force", "tags"} - ) + **self.args.dict(by_alias=True, exclude_none=True, exclude={"force", "tags"}) ) except self.client.exceptions.ParameterAlreadyExists: LOGGER.warning( @@ -242,9 +236,7 @@ def update_tags(self) -> None: """Update tags.""" current_tags = self.get_current_tags() if self.args.tags and current_tags: - diff_tag_keys = list( - {i["Key"] for i in current_tags} ^ {i.key for i in self.args.tags} - ) + diff_tag_keys = list({i["Key"] for i in current_tags} ^ {i.key for i in self.args.tags}) elif self.args.tags: diff_tag_keys = [] else: @@ -258,14 +250,11 @@ def update_tags(self) -> None: ResourceType="Parameter", TagKeys=diff_tag_keys, ) - LOGGER.debug( - "removed tags for parameter %s: %s", self.args.name, diff_tag_keys - ) + LOGGER.debug("removed tags for parameter %s: %s", self.args.name, diff_tag_keys) if self.args.tags: tags_to_add = [ - cast("TagTypeDef", tag.dict(by_alias=True)) - for tag in self.args.tags + cast("TagTypeDef", tag.dict(by_alias=True)) for tag in self.args.tags ] self.client.add_tags_to_resource( ResourceId=self.args.name, @@ -278,9 +267,7 @@ def update_tags(self) -> None: [tag["Key"] for tag in tags_to_add], ) except self.client.exceptions.InvalidResourceId: - LOGGER.info( - "skipped updating tags; parameter %s does not exist", self.args.name - ) + LOGGER.info("skipped updating tags; parameter %s does not exist", self.args.name) else: LOGGER.info("updated tags for parameter %s", self.args.name) @@ -301,6 +288,7 @@ def __init__( context: CFNgin context object. name: The fully qualified name of the parameter that you want to add to the system. + **kwargs: Arbitrary keyword arguments. """ for k in ["Type", "type"]: # ensure neither of these are set diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/callback_url_retriever.py b/runway/cfngin/hooks/staticsite/auth_at_edge/callback_url_retriever.py index 9c944e49d..8ecdd37e5 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/callback_url_retriever.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/callback_url_retriever.py @@ -8,7 +8,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, Optional +from typing import TYPE_CHECKING, Any, Optional from ...base import HookArgsBaseModel @@ -28,7 +28,7 @@ class HookArgs(HookArgsBaseModel): """The ARN of the User Pool to check for a client.""" -def get(context: CfnginContext, *__args: Any, **kwargs: Any) -> Dict[str, Any]: +def get(context: CfnginContext, *_args: Any, **kwargs: Any) -> dict[str, Any]: """Retrieve the callback URLs for User Pool Client Creation. When the User Pool is created a Callback URL is required. During a post @@ -42,6 +42,7 @@ def get(context: CfnginContext, *__args: Any, **kwargs: Any) -> Dict[str, Any]: Args: context: The context instance. + **kwargs: Arbitrary keyword arguments. """ args = HookArgs.parse_obj(kwargs) @@ -59,20 +60,14 @@ def get(context: CfnginContext, *__args: Any, **kwargs: Any) -> Dict[str, Any]: if args.user_pool_arn: user_pool_id = args.user_pool_arn.split("/")[-1:][0] else: - user_pool_id = [ - o["OutputValue"] - for o in outputs - if o["OutputKey"] == "AuthAtEdgeUserPoolId" - ][0] + user_pool_id = next( + o["OutputValue"] for o in outputs if o["OutputKey"] == "AuthAtEdgeUserPoolId" + ) - client_id = [ - o["OutputValue"] for o in outputs if o["OutputKey"] == "AuthAtEdgeClient" - ][0] + client_id = next(o["OutputValue"] for o in outputs if o["OutputKey"] == "AuthAtEdgeClient") # Poll the user pool client information - resp = cognito_client.describe_user_pool_client( - UserPoolId=user_pool_id, ClientId=client_id - ) + resp = cognito_client.describe_user_pool_client(UserPoolId=user_pool_id, ClientId=client_id) # Retrieve the callbacks callbacks = resp["UserPoolClient"]["CallbackURLs"] @@ -80,5 +75,5 @@ def get(context: CfnginContext, *__args: Any, **kwargs: Any) -> Dict[str, Any]: if callbacks: context_dict["callback_urls"] = callbacks return context_dict - except Exception: # pylint: disable=broad-except + except Exception: # noqa: BLE001 return context_dict diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/client_updater.py b/runway/cfngin/hooks/staticsite/auth_at_edge/client_updater.py index d62c6082d..e4be5b8ad 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/client_updater.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/client_updater.py @@ -8,7 +8,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, List +from typing import TYPE_CHECKING, Any, List # noqa: UP035 from ...base import HookArgsBaseModel @@ -21,7 +21,7 @@ class HookArgs(HookArgsBaseModel): """Hook arguments.""" - alternate_domains: List[str] + alternate_domains: List[str] # noqa: UP006 """A list of any alternate domains that need to be listed with the primary distribution domain. @@ -33,7 +33,7 @@ class HookArgs(HookArgsBaseModel): distribution_domain: str """Distribution domain.""" - oauth_scopes: List[str] + oauth_scopes: List[str] # noqa: UP006 """A list of all available validation scopes for oauth.""" redirect_path_sign_in: str @@ -42,13 +42,13 @@ class HookArgs(HookArgsBaseModel): redirect_path_sign_out: str """The redirect path after sign out.""" - supported_identity_providers: List[str] = [] + supported_identity_providers: List[str] = [] # noqa: UP006 """Supported identity providers.""" def get_redirect_uris( - domains: List[str], redirect_path_sign_in: str, redirect_path_sign_out: str -) -> Dict[str, List[str]]: + domains: list[str], redirect_path_sign_in: str, redirect_path_sign_out: str +) -> dict[str, list[str]]: """Create dict of redirect URIs for AppClient.""" return { "sign_in": [f"{domain}{redirect_path_sign_in}" for domain in domains], @@ -56,7 +56,7 @@ def get_redirect_uris( } -def update(context: CfnginContext, *__args: Any, **kwargs: Any) -> bool: +def update(context: CfnginContext, *_args: Any, **kwargs: Any) -> bool: """Update the callback urls for the User Pool Client. Required to match the redirect_uri being sent which contains @@ -67,6 +67,7 @@ def update(context: CfnginContext, *__args: Any, **kwargs: Any) -> bool: Args: context: The context instance. + **kwargs: Arbitrary keyword arguments. """ args = HookArgs.parse_obj(kwargs) @@ -74,7 +75,7 @@ def update(context: CfnginContext, *__args: Any, **kwargs: Any) -> bool: cognito_client = session.client("cognito-idp") # Combine alternate domains with main distribution - redirect_domains = args.alternate_domains + ["https://" + args.distribution_domain] + redirect_domains = [*args.alternate_domains, "https://" + args.distribution_domain] # Create a list of all domains with their redirect paths redirect_uris = get_redirect_uris( @@ -93,6 +94,6 @@ def update(context: CfnginContext, *__args: Any, **kwargs: Any) -> bool: UserPoolId=context.hook_data["aae_user_pool_id_retriever"]["id"], ) return True - except Exception: # pylint: disable=broad-except + except Exception: LOGGER.exception("unable to update user pool client callback urls") return False diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/domain_updater.py b/runway/cfngin/hooks/staticsite/auth_at_edge/domain_updater.py index 8a2e8d10a..eb9754989 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/domain_updater.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/domain_updater.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, Union +from typing import TYPE_CHECKING, Any from ...base import HookArgsBaseModel @@ -20,9 +20,7 @@ class HookArgs(HookArgsBaseModel): """The ID of the Cognito User Pool Client.""" -def update( - context: CfnginContext, *__args: Any, **kwargs: Any -) -> Union[Dict[str, Any], bool]: +def update(context: CfnginContext, *_args: Any, **kwargs: Any) -> dict[str, Any] | bool: """Retrieve/Update the domain name of the specified client. A domain name is required in order to make authorization and token @@ -34,18 +32,17 @@ def update( Args: context: The context instance. + **kwargs: Arbitrary keyword arguments. """ args = HookArgs.parse_obj(kwargs) session = context.get_session() cognito_client = session.client("cognito-idp") - context_dict: Dict[str, Any] = {} + context_dict: dict[str, Any] = {} user_pool_id = context.hook_data["aae_user_pool_id_retriever"]["id"] - user_pool = cognito_client.describe_user_pool(UserPoolId=user_pool_id).get( - "UserPool", {} - ) + user_pool = cognito_client.describe_user_pool(UserPoolId=user_pool_id).get("UserPool", {}) (user_pool_region, user_pool_hash) = user_pool_id.split("_") domain_prefix = user_pool.get("CustomDomain", user_pool.get("Domain")) @@ -58,19 +55,15 @@ def update( try: domain_prefix = (f"{user_pool_hash}-{args.client_id}").lower() - cognito_client.create_user_pool_domain( - Domain=domain_prefix, UserPoolId=user_pool_id - ) + cognito_client.create_user_pool_domain(Domain=domain_prefix, UserPoolId=user_pool_id) context_dict["domain"] = get_user_pool_domain(domain_prefix, user_pool_region) return context_dict - except Exception: # pylint: disable=broad-except + except Exception: LOGGER.exception("could not update user pool domain: %s", user_pool_id) return False -def delete( - context: CfnginContext, *__args: Any, **kwargs: Any -) -> Union[Dict[str, Any], bool]: +def delete(context: CfnginContext, *_args: Any, **kwargs: Any) -> dict[str, Any] | bool: """Delete the domain if the user pool was created by Runway. If a User Pool was created by Runway, and populated with a domain, that @@ -83,6 +76,7 @@ def delete( Args: context: The context instance. + **kwargs: Arbitrary keyword arguments. """ args = HookArgs.parse_obj(kwargs) @@ -94,14 +88,12 @@ def delete( domain_prefix = (f"{user_pool_hash}-{args.client_id}").lower() try: - cognito_client.delete_user_pool_domain( - UserPoolId=user_pool_id, Domain=domain_prefix - ) + cognito_client.delete_user_pool_domain(UserPoolId=user_pool_id, Domain=domain_prefix) return True except cognito_client.exceptions.InvalidParameterException: LOGGER.info('skipped deletion; no domain with prefix "%s"', domain_prefix) return True - except Exception: # pylint: disable=broad-except + except Exception: LOGGER.exception("could not delete user pool domain") return False diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/lambda_config.py b/runway/cfngin/hooks/staticsite/auth_at_edge/lambda_config.py index 5e403172a..97e67494a 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/lambda_config.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/lambda_config.py @@ -9,7 +9,7 @@ import shutil import tempfile from tempfile import mkstemp -from typing import TYPE_CHECKING, Any, Dict, List, Optional +from typing import TYPE_CHECKING, Any, Dict, List, Optional # noqa: UP035 from ... import aws_lambda from ...base import HookArgsBaseModel @@ -34,16 +34,16 @@ class HookArgs(HookArgsBaseModel): client_id: str """The ID of the Cognito User Pool Client.""" - cookie_settings: Dict[str, Any] + cookie_settings: Dict[str, Any] # noqa: UP006 """The settings for our customized cookies.""" - http_headers: Dict[str, Any] + http_headers: Dict[str, Any] # noqa: UP006 """The additional headers added to our requests.""" nonce_signing_secret_param_name: str """SSM param name to store nonce signing secret.""" - oauth_scopes: List[str] + oauth_scopes: List[str] # noqa: UP006 """The validation scopes for our OAuth requests.""" redirect_path_refresh: str @@ -62,10 +62,9 @@ class HookArgs(HookArgsBaseModel): """Optional User Pool group to which access should be restricted.""" -# pylint: disable=too-many-locals def write( context: CfnginContext, provider: Provider, *__args: Any, **kwargs: Any -) -> Dict[str, Any]: +) -> dict[str, Any]: """Writes/Uploads the configured lambdas for Auth@Edge. Lambda@Edge does not have the ability to allow Environment variables @@ -96,10 +95,10 @@ def write( } # Shared file that contains the method called for configuration data - path = os.path.join(os.path.dirname(__file__), "templates", "shared.py") - context_dict: Dict[str, Any] = {} + path = os.path.join(os.path.dirname(__file__), "templates", "shared.py") # noqa: PTH120, PTH118 + context_dict: dict[str, Any] = {} - with open(path, encoding="utf-8") as file_: + with open(path, encoding="utf-8") as file_: # noqa: PTH123 # Dynamically replace our configuration values # in the shared.py template file with actual # calculated values @@ -114,7 +113,7 @@ def write( filedir, temppath = mkstemp() # Save the file to a temp path - with open(temppath, "w", encoding="utf-8") as tmp: + with open(temppath, "w", encoding="utf-8") as tmp: # noqa: PTH123 tmp.write(shared) config = temppath os.close(filedir) @@ -127,23 +126,27 @@ def write( # Copy the template code for the specific Lambda function # to the temporary folder shutil.copytree( - os.path.join(os.path.dirname(__file__), "templates", handler), + os.path.join( # noqa: PTH118 + os.path.dirname(__file__), "templates", handler # noqa: PTH120 + ), dirpath, dirs_exist_ok=True, ) # Save our dynamic configuration shared file to the # temporary folder - with open(config, encoding="utf-8") as shared: + with open(config, encoding="utf-8") as shared: # noqa: PTH123 raw = shared.read() filename = "shared.py" - with open(os.path.join(dirpath, filename), "wb") as newfile: + with open(os.path.join(dirpath, filename), "wb") as newfile: # noqa: PTH118, PTH123 newfile.write(raw.encode()) # Copy the shared jose-dependent util module to the temporary folder shutil.copyfile( - os.path.join(os.path.dirname(__file__), "templates", "shared_jose.py"), - os.path.join(dirpath, "shared_jose.py"), + os.path.join( # noqa: PTH118 + os.path.dirname(__file__), "templates", "shared_jose.py" # noqa: PTH120 + ), + os.path.join(dirpath, "shared_jose.py"), # noqa: PTH118 ) # Upload our temporary folder to our S3 bucket for @@ -193,7 +196,5 @@ def random_key(length: int = 16) -> str: length: The length of the random key. """ - secret_allowed_chars = ( - "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~" - ) + secret_allowed_chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~" return "".join(secrets.choice(secret_allowed_chars) for _ in range(length)) diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/check_auth/__init__.py b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/check_auth/__init__.py index a2929b225..c96288459 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/check_auth/__init__.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/check_auth/__init__.py @@ -10,7 +10,6 @@ """ -# pylint: disable=consider-using-f-string import base64 import datetime import hashlib @@ -20,9 +19,9 @@ import secrets from urllib.parse import quote_plus, urlencode -from shared_jose import validate_jwt # noqa pylint: disable=import-error +from shared_jose import validate_jwt -from shared import ( # noqa pylint: disable=import-error +from shared import ( decode_token, extract_and_parse_cookies, get_config, @@ -32,9 +31,7 @@ LOGGER = logging.getLogger(__file__) -SECRET_ALLOWED_CHARS = ( - "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~" -) +SECRET_ALLOWED_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~" NONCE_LENGTH = 16 PKCE_LENGTH = 43 CONFIG = get_config() @@ -44,7 +41,7 @@ def handler(event, _context): """Handle the request passed in. Args: - event (Dict[str, Any]): The Lambda Event. + event (dict[str, Any]): The Lambda Event. _context (Any): Lambda context object. """ @@ -90,9 +87,7 @@ def handler(event, _context): % ( domain_name, CONFIG.get("redirect_path_auth_refresh"), - urlencode( - {"requestedUri": requested_uri, "nonce": nonce} - ), + urlencode({"requestedUri": requested_uri, "nonce": nonce}), ), } ], @@ -129,7 +124,7 @@ def handler(event, _context): ) return request - except Exception: # noqa pylint: disable=broad-except + except Exception: # We need new authorization. Get the user over to Cognito nonce = generate_nonce() state = { @@ -139,8 +134,7 @@ def handler(event, _context): } login_query_string = urlencode( { - "redirect_uri": "https://%s%s" - % (domain_name, CONFIG["redirect_path_sign_in"]), + "redirect_uri": "https://%s%s" % (domain_name, CONFIG["redirect_path_sign_in"]), "response_type": "code", "client_id": CONFIG["client_id"], "state": base64.urlsafe_b64encode( diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/http_headers/__init__.py b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/http_headers/__init__.py index 9e60c44e9..c2b93a849 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/http_headers/__init__.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/http_headers/__init__.py @@ -1,6 +1,6 @@ """Add all configured (CloudFront compatible) headers to origin response.""" -from shared import as_cloud_front_headers, get_config # pylint: disable=import-error +from shared import as_cloud_front_headers, get_config CONFIG = get_config() diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/parse_auth/__init__.py b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/parse_auth/__init__.py index 6d27b1683..7e8cef76d 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/parse_auth/__init__.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/parse_auth/__init__.py @@ -6,7 +6,6 @@ add to the cookie headers. """ -# pylint: disable=consider-using-f-string import base64 import hmac import json @@ -14,12 +13,12 @@ from datetime import datetime from urllib.parse import parse_qs -from shared_jose import ( # noqa pylint: disable=import-error +from shared_jose import ( MissingRequiredGroupError, validate_and_check_id_token, ) -from shared import ( # noqa pylint: disable=import-error +from shared import ( create_error_html, extract_and_parse_cookies, generate_cookie_headers, @@ -44,7 +43,7 @@ def validate_querystring_and_cookies(request, cookies): Args: request (Any): Cloudfront request. - cookies (Dict[str, Any]): Cookies. + cookies (dict[str, Any]): Cookies. """ qsp = parse_qs(request.get("querystring")) @@ -107,8 +106,7 @@ def validate_querystring_and_cookies(request, cookies): calculated_hmac = sign(current_nonce, CONFIG["nonce_signing_secret"]) if not hmac.compare_digest(calculated_hmac, nonce_hmac): raise RequiresConfirmationError( - "Nonce signature mismatch; expected %s but got %s" - % (calculated_hmac, nonce_hmac) + "Nonce signature mismatch; expected %s but got %s" % (calculated_hmac, nonce_hmac) ) return [code, pkce, requested_uri] @@ -140,8 +138,7 @@ def handler(event, _context): body = { "grant_type": "authorization_code", "client_id": CONFIG["client_id"], - "redirect_uri": "https://%s%s" - % (domain_name, CONFIG.get("redirect_path_sign_in")), + "redirect_uri": "https://%s%s" % (domain_name, CONFIG.get("redirect_path_sign_in")), "code": code[0], "code_verifier": pkce, } @@ -183,7 +180,7 @@ def handler(event, _context): }, } return response - except Exception as err: # pylint: disable=broad-except + except Exception as err: if id_token: # ID token found; checking if it is valid try: @@ -203,7 +200,7 @@ def handler(event, _context): **CONFIG.get("cloud_front_headers", {}), }, } - except Exception as err2: # pylint: disable=broad-except + except Exception as err2: LOGGER.debug("Id token not valid") LOGGER.debug(err2) @@ -235,8 +232,6 @@ def handler(event, _context): "status": "200", "headers": { **CONFIG.get("cloud_front_headers", {}), - "content-type": [ - {"key": "Content-Type", "value": "text/html; charset=UTF-8"} - ], + "content-type": [{"key": "Content-Type", "value": "text/html; charset=UTF-8"}], }, } diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/refresh_auth/__init__.py b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/refresh_auth/__init__.py index 41c9efd88..79ddf7631 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/refresh_auth/__init__.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/refresh_auth/__init__.py @@ -4,7 +4,7 @@ import traceback from urllib.parse import parse_qs -from shared import ( # noqa pylint: disable=import-error +from shared import ( create_error_html, extract_and_parse_cookies, generate_cookie_headers, @@ -62,7 +62,7 @@ def handler(event, _context): tokens["id_token"] = res.get("id_token") tokens["access_token"] = res.get("access_token") cookie_headers_event_type = "new_tokens" - except Exception as err: # pylint: disable=broad-except + except Exception as err: LOGGER.debug(err) cookie_headers_event_type = "refresh_failed" @@ -88,7 +88,7 @@ def handler(event, _context): # Send a basic html error response and inform the user # why refresh was unsuccessful - except Exception as err: # pylint: disable=broad-except + except Exception as err: LOGGER.info(err) LOGGER.info(traceback.print_exc()) @@ -101,9 +101,7 @@ def handler(event, _context): ), "status": "400", "headers": { - "content-type": [ - {"key": "Content-Type", "value": "text/html; charset=UTF-8"} - ], + "content-type": [{"key": "Content-Type", "value": "text/html; charset=UTF-8"}], **CONFIG.get("cloud_front_headers", {}), }, } @@ -117,7 +115,7 @@ def validate_refresh_request(current_nonce, original_nonce, tokens): Args: current_nonce (str): The current nonce code. original_nonce (str): The original nonce code. - tokens (Dict[str, str]): A dictionary of all the token_types + tokens (dict[str, str]): A dictionary of all the token_types and their corresponding token values (id, auth, refresh). """ diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/shared.py b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/shared.py index 69cb6c86a..c0284273e 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/shared.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/shared.py @@ -1,6 +1,5 @@ """Shared functionality for the Auth@Edge Lambda suite.""" -# pylint: disable=consider-using-f-string, inconsistent-return-statements import base64 import hmac import json @@ -57,7 +56,7 @@ def as_cloud_front_headers(headers): """Convert a series of headers to CloudFront compliant ones. Args: - headers (Dict[str, str]): The request/response headers in + headers (dict[str, str]): The request/response headers in dictionary format. """ @@ -71,7 +70,7 @@ def extract_and_parse_cookies(headers, client_id, cookie_compatibility="amplify" """Extract and parse the Cognito cookies from the headers. Args: - headers (Dict[str, str]): The request/response headers in + headers (dict[str, str]): The request/response headers in dictionary format. client_id (str): The Cognito UserPool Client ID. cookie_compatibility (str): "amplify" or "elasticsearch". @@ -88,18 +87,12 @@ def extract_and_parse_cookies(headers, client_id, cookie_compatibility="amplify" return { "token_user_name": ( - cookies.get(cookie_names["last_user_key"]) - if "last_user_key" in cookie_names - else None + cookies.get(cookie_names["last_user_key"]) if "last_user_key" in cookie_names else None ), "id_token": cookies.get(cookie_names["id_token_key"]), "access_token": cookies.get(cookie_names["access_token_key"]), "refresh_token": cookies.get(cookie_names["refresh_token_key"]), - "scopes": ( - cookies.get(cookie_names["scope_key"]) - if "scope_key" in cookie_names - else None - ), + "scopes": (cookies.get(cookie_names["scope_key"]) if "scope_key" in cookie_names else None), "nonce": cookies.get("spa-auth-edge-nonce"), "nonce_hmac": cookies.get("spa-auth-edge-nonce-hmac"), "pkce": cookies.get("spa-auth-edge-pkce"), @@ -110,7 +103,7 @@ def extract_cookies_from_headers(headers): """Extract all cookies from the response headers. Args: - headers (Dict[str, Dict[str, str]]): The request/response headers in + headers (dict[str, dict[str, str]]): The request/response headers in dictionary format. """ @@ -204,11 +197,11 @@ def generate_cookie_headers( event (str): "new_tokens" | "sign_out" | "refresh_failed". client_id (str): The Cognito UserPool Client ID. oauth_scopes (List): The scopes for oauth validation. - tokens (Dict[str, str]): The tokens received from + tokens (dict[str, str]): The tokens received from the Cognito Request (id, access, refresh). domain_name (str): The Domain name the cookies are to be associated with. - cookie_settings (Dict[str, str]): The various settings + cookie_settings (dict[str, str]): The various settings that we would like for the various tokens. cookie_compatibility (str): "amplify" | "elasticsearch". @@ -249,9 +242,7 @@ def generate_cookie_headers( cookie_names = get_elasticsearch_cookie_names() cookies = { cookie_names["cognito_enabled_key"]: "True; " - + str( - with_cookie_domain(domain_name, cookie_settings.get("cognitoEnabled")) - ), + + str(with_cookie_domain(domain_name, cookie_settings.get("cognitoEnabled"))), } cookies[cookie_names["id_token_key"]] = f"{tokens.get('id_token')}; " + str( with_cookie_domain(domain_name, cookie_settings.get("idToken")), @@ -259,9 +250,8 @@ def generate_cookie_headers( cookies[cookie_names["access_token_key"]] = f"{tokens.get('access_token')}; " + str( with_cookie_domain(domain_name, cookie_settings.get("accessToken")), ) - cookies[cookie_names["refresh_token_key"]] = ( - f"{tokens.get('refresh_token')}; " - + str(with_cookie_domain(domain_name, cookie_settings.get("refreshToken"))) + cookies[cookie_names["refresh_token_key"]] = f"{tokens.get('refresh_token')}; " + str( + with_cookie_domain(domain_name, cookie_settings.get("refreshToken")) ) cookies_iter = cookies # type: ignore if event == "sign_out": @@ -278,9 +268,7 @@ def generate_cookie_headers( cookies[i] = expire_cookie(cookies[i]) # Return cookies in the form of CF headers - return [ - {"key": "set-cookie", "value": f"{key}={val}"} for key, val in cookies.items() - ] + return [{"key": "set-cookie", "value": f"{key}={val}"} for key, val in cookies.items()] def expire_cookie_filter(cookie): @@ -319,9 +307,9 @@ def http_post_with_retry(url, data, headers): Args: url (str): The URL to make the POST request to. - data (Dict[str, str]): The dictionary of data elements to + data (dict[str, str]): The dictionary of data elements to send with the request (urlencoded internally). - headers (Dict[str, str]): Any headers to send with + headers (dict[str, str]): Any headers to send with the POST request. """ @@ -335,7 +323,6 @@ def http_post_with_retry(url, data, headers): read = res.decode("utf-8") json_data = json.loads(read) return json_data - # pylint: disable=broad-except except Exception as err: LOGGER.error("HTTP POST to %s failed (attempt %s)", url, attempts) LOGGER.error(err) diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/shared_jose.py b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/shared_jose.py index 78cb9ae1d..b6b1c2567 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/shared_jose.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/shared_jose.py @@ -7,7 +7,7 @@ import re from urllib import request -from jose import jwt # noqa pylint: disable=import-error +from jose import jwt LOGGER = logging.getLogger(__name__) @@ -92,7 +92,7 @@ def __init__(self, options=None): """Initialize. Args: - options (Optional[Dict[str, str]]): Options for the client. + options (Optional[dict[str, str]]): Options for the client. """ self.options = options @@ -102,17 +102,14 @@ def get_keys(self): LOGGER.info("Fetching keys from %s", self.options.get("jwks_uri")) try: - # pylint: disable=consider-using-with request_res = request.urlopen(self.options.get("jwks_uri")) data = json.loads( - request_res.read().decode( - request_res.info().get_param("charset") or "utf-8" - ) + request_res.read().decode(request_res.info().get_param("charset") or "utf-8") ) keys = data["keys"] LOGGER.info("Keys: %s", keys) return keys - except Exception as err: # pylint: disable=broad-except + except Exception as err: LOGGER.info("Failure: ConnectionError") LOGGER.info(err) return {} @@ -167,7 +164,6 @@ def create_jwk(key): else: try: jwk["rsaPublicKey"] = rsa_public_key_to_pem(key.get("n"), key.get("e")) - # pylint: disable=broad-except except Exception as err: LOGGER.error(err) jwk["rsaPublicKey"] = None @@ -178,7 +174,7 @@ def is_signing_key(key): """Filter to determine if this is a signing key. Args: - key (Dict[str, str]): The key. + key (dict[str, str]): The key. """ if key.get("kty", "") != "RSA": @@ -240,9 +236,7 @@ def validate_jwt(jwt_token, jwks_uri, issuer, audience): ) -def validate_and_check_id_token( - id_token, jwks_uri, issuer, audience, required_group=None -): +def validate_and_check_id_token(id_token, jwks_uri, issuer, audience, required_group=None): """Validate JWT and (optionally) check group membership.""" id_token_payload = validate_jwt(id_token, jwks_uri, issuer, audience) if required_group: diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/sign_out/__init__.py b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/sign_out/__init__.py index ddb22583b..02e45c4b9 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/templates/sign_out/__init__.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/templates/sign_out/__init__.py @@ -1,10 +1,9 @@ """Sign user out of Cognito and remove all Cookie Headers.""" -# pylint: disable=consider-using-f-string import logging from urllib.parse import urlencode -from shared import ( # noqa pylint: disable=import-error +from shared import ( create_error_html, extract_and_parse_cookies, generate_cookie_headers, @@ -31,9 +30,7 @@ def handler(event, _context): ), "status": "200", "headers": { - "content-type": [ - {"key": "Content-Type", "value": "text/html; charset=UTF-8"} - ], + "content-type": [{"key": "Content-Type", "value": "text/html; charset=UTF-8"}], **CONFIG.get("cloud_front_headers", {}), }, } diff --git a/runway/cfngin/hooks/staticsite/auth_at_edge/user_pool_id_retriever.py b/runway/cfngin/hooks/staticsite/auth_at_edge/user_pool_id_retriever.py index f44a4489c..5594861fa 100644 --- a/runway/cfngin/hooks/staticsite/auth_at_edge/user_pool_id_retriever.py +++ b/runway/cfngin/hooks/staticsite/auth_at_edge/user_pool_id_retriever.py @@ -1,7 +1,7 @@ """Retrieve the ID of the Cognito User Pool.""" import logging -from typing import Any, Dict, Optional +from typing import Any, Optional from ...base import HookArgsBaseModel @@ -18,7 +18,7 @@ class HookArgs(HookArgsBaseModel): """The ARN of the supplied User pool.""" -def get(*__args: Any, **kwargs: Any) -> Dict[str, Any]: +def get(*__args: Any, **kwargs: Any) -> dict[str, Any]: """Retrieve the ID of the Cognito User Pool. The User Pool can either be supplied via an ARN or by being generated. diff --git a/runway/cfngin/hooks/staticsite/build_staticsite.py b/runway/cfngin/hooks/staticsite/build_staticsite.py index 22311bf30..597995266 100644 --- a/runway/cfngin/hooks/staticsite/build_staticsite.py +++ b/runway/cfngin/hooks/staticsite/build_staticsite.py @@ -7,7 +7,7 @@ import tempfile import zipfile from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union +from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union # noqa: UP035 import boto3 from boto3.s3.transfer import S3Transfer # type: ignore @@ -33,7 +33,7 @@ class HookArgsOptions(HookArgsBaseModel): build_output: Optional[str] = None """Path were the build static site will be stored locally before upload.""" - build_steps: List[Union[str, List[str], Dict[str, Union[str, List[str]]]]] = [] + build_steps: List[Union[str, List[str], Dict[str, Union[str, List[str]]]]] = [] # noqa: UP006 """Steps to execute to build the static site.""" name: str = "undefined" @@ -45,7 +45,9 @@ class HookArgsOptions(HookArgsBaseModel): path: str """Working directory/path to the static site's source code.""" - pre_build_steps: List[Union[str, List[str], Dict[str, Union[str, List[str]]]]] = [] + pre_build_steps: List[ # noqa: UP006 + Union[str, List[str], Dict[str, Union[str, List[str]]]] # noqa: UP006 + ] = [] """Steps to run before building the static site.""" source_hashing: RunwayStaticSiteSourceHashingDataModel = ( @@ -74,26 +76,25 @@ def zip_and_upload( filedes, temp_file = tempfile.mkstemp() os.close(filedes) LOGGER.info("archiving %s to s3://%s/%s", app_dir, bucket, key) - with zipfile.ZipFile(temp_file, "w", zipfile.ZIP_DEFLATED) as filehandle: - with change_dir(app_dir): - for dirname, _subdirs, files in os.walk("./"): - if dirname != "./": - filehandle.write(dirname) - for filename in files: - filehandle.write(os.path.join(dirname, filename)) + with zipfile.ZipFile(temp_file, "w", zipfile.ZIP_DEFLATED) as filehandle, change_dir(app_dir): + for dirname, _subdirs, files in os.walk("./"): + if dirname != "./": + filehandle.write(dirname) + for filename in files: + filehandle.write(os.path.join(dirname, filename)) # noqa: PTH118 transfer.upload_file(temp_file, bucket, key) - os.remove(temp_file) + os.remove(temp_file) # noqa: PTH107 class OptionsArgTypeDef(TypedDict, total=False): """Options argument type definition.""" build_output: str - build_steps: List[Union[str, List[str], Dict[str, Union[str, List[str]]]]] + build_steps: list[Union[str, list[str], dict[str, Union[str, list[str]]]]] name: str namespace: str path: str - pre_build_steps: List[Union[str, List[str], Dict[str, Union[str, List[str]]]]] + pre_build_steps: list[Union[str, list[str], dict[str, Union[str, list[str]]]]] def build( @@ -102,7 +103,7 @@ def build( *, options: Optional[OptionsArgTypeDef] = None, **kwargs: Any, -) -> Dict[str, Any]: +) -> dict[str, Any]: """Build static site. Arguments parsed by :class:`~runway.cfngin.hooks.staticsite.build_staticsite.HookArgs`. @@ -114,12 +115,12 @@ def build( args = HookArgs.parse_obj({"options": options, **kwargs}) session = context.get_session() - context_dict: Dict[str, Any] = { + context_dict: dict[str, Any] = { "artifact_key_prefix": f"{args.options.namespace}-{args.options.name}-" } if args.options.build_output: - build_output = os.path.join(args.options.path, args.options.build_output) + build_output = os.path.join(args.options.path, args.options.build_output) # noqa: PTH118 else: build_output = args.options.path @@ -132,17 +133,14 @@ def build( context_dict["hash"] = get_hash_of_files( root_path=Path(args.options.path), - directories=options.get("source_hashing", {"directories": None}).get( - "directories" - ), + directories=options.get("source_hashing", {"directories": None}).get("directories"), ) LOGGER.debug("application hash: %s", context_dict["hash"]) # Now determine if the current staticsite has already been deployed if args.options.source_hashing.enabled: context_dict["hash_tracking_parameter"] = ( - args.options.source_hashing.parameter - or f"{context_dict['artifact_key_prefix']}hash" + args.options.source_hashing.parameter or f"{context_dict['artifact_key_prefix']}hash" ) ssm_client = session.client("ssm") diff --git a/runway/cfngin/hooks/staticsite/cleanup.py b/runway/cfngin/hooks/staticsite/cleanup.py index 75380947b..4692e2513 100644 --- a/runway/cfngin/hooks/staticsite/cleanup.py +++ b/runway/cfngin/hooks/staticsite/cleanup.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, List +from typing import TYPE_CHECKING, Any from ..base import HookArgsBaseModel @@ -41,16 +41,12 @@ class HookArgs(HookArgsBaseModel): """Name of the CloudFormation Stack as defined in the config file (no namespace).""" -def get_replicated_function_names(outputs: List[OutputTypeDef]) -> List[str]: +def get_replicated_function_names(outputs: list[OutputTypeDef]) -> list[str]: """Extract replicated function names from CFN outputs.""" - function_names: List[str] = [] + function_names: list[str] = [] for i in REPLICATED_FUNCTION_OUTPUTS: function_arn = next( - ( - output.get("OutputValue") - for output in outputs - if output.get("OutputKey") == i - ), + (output.get("OutputValue") for output in outputs if output.get("OutputKey") == i), None, ) if function_arn: @@ -58,30 +54,26 @@ def get_replicated_function_names(outputs: List[OutputTypeDef]) -> List[str]: return function_names -def warn(context: CfnginContext, *__args: Any, **kwargs: Any) -> bool: +def warn(context: CfnginContext, *_args: Any, **kwargs: Any) -> bool: """Notify the user of Lambda functions to delete. Arguments parsed by :class:`~runway.cfngin.hooks.staticsite.cleanup.HookArgs`. Args: context: The context instance. + **kwargs: Arbitrary keyword arguments. """ args = HookArgs.parse_obj(kwargs) cfn_client = context.get_session().client("cloudformation") try: describe_response = cfn_client.describe_stacks( - StackName=context.namespace - + context.namespace_delimiter - + args.stack_relative_name + StackName=context.namespace + context.namespace_delimiter + args.stack_relative_name ) stack = next( x for x in describe_response.get("Stacks", []) - if ( - x.get("StackStatus") - and x.get("StackStatus") not in STACK_STATUSES_TO_IGNORE - ) + if (x.get("StackStatus") and x.get("StackStatus") not in STACK_STATUSES_TO_IGNORE) ) functions = get_replicated_function_names(stack["Outputs"]) if functions: @@ -101,7 +93,7 @@ def warn(context: CfnginContext, *__args: Any, **kwargs: Any) -> bool: LOGGER.warning("for x in %s; do %s; done", (" ").join(functions), cmd) LOGGER.warning("On Windows:") LOGGER.warning('Foreach ($x in "%s") { %s }', ('","').join(functions), cmd) - except Exception: # pylint: disable=broad-except + except Exception: # noqa: S110, BLE001 # There's no harm in continuing on in the event of an error # Orphaned functions have no cost pass diff --git a/runway/cfngin/hooks/staticsite/upload_staticsite.py b/runway/cfngin/hooks/staticsite/upload_staticsite.py index 5e9d173dd..b5183dc53 100644 --- a/runway/cfngin/hooks/staticsite/upload_staticsite.py +++ b/runway/cfngin/hooks/staticsite/upload_staticsite.py @@ -8,7 +8,7 @@ import os import time from operator import itemgetter -from typing import TYPE_CHECKING, Any, Dict, List, Optional, cast +from typing import TYPE_CHECKING, Any, List, Optional, cast # noqa: UP035 import yaml @@ -43,16 +43,14 @@ class HookArgs(HookArgsBaseModel): distribution_path: str = "/*" """Path in the CloudFront distribution to invalidate.""" - extra_files: List[RunwayStaticSiteExtraFileDataModel] = [] + extra_files: List[RunwayStaticSiteExtraFileDataModel] = [] # noqa: UP006 """Extra files to sync to the S3 bucket.""" website_url: Optional[str] = None """S3 bucket website URL.""" -def get_archives_to_prune( - archives: List[Dict[str, Any]], hook_data: Dict[str, Any] -) -> List[str]: +def get_archives_to_prune(archives: list[dict[str, Any]], hook_data: dict[str, Any]) -> list[str]: """Return list of keys to delete. Args: @@ -66,9 +64,7 @@ def get_archives_to_prune( if hook_data.get(i) ] - archives.sort( # sort from oldest to newest - key=itemgetter("LastModified"), reverse=False - ) + archives.sort(key=itemgetter("LastModified"), reverse=False) # sort from oldest to newest # Drop all but last 15 files return [i["Key"] for i in archives[:-15] if i["Key"] not in files_to_skip] @@ -81,6 +77,7 @@ def sync(context: CfnginContext, *__args: Any, **kwargs: Any) -> bool: Args: context: The context instance. + **kwargs: Arbitrary keyword arguments. """ args = HookArgs.parse_obj(kwargs) @@ -195,7 +192,7 @@ def prune_archives(context: CfnginContext, session: Session) -> bool: """ LOGGER.info("cleaning up old site archives...") - archives: List[Dict[str, Any]] = [] + archives: list[dict[str, Any]] = [] s3_client = session.client("s3") list_objects_v2_paginator = s3_client.get_paginator("list_objects_v2") response_iterator = list_objects_v2_paginator.paginate( @@ -231,7 +228,7 @@ def auto_detect_content_type(filename: Optional[str]) -> Optional[str]: if not filename: return None - _, ext = os.path.splitext(filename) + _, ext = os.path.splitext(filename) # noqa: PTH122 if ext == ".json": return "application/json" @@ -274,9 +271,7 @@ def get_content(extra_file: RunwayStaticSiteExtraFileDataModel) -> Optional[str] if extra_file.content_type == "text/yaml": return yaml.safe_dump(extra_file.content) - raise ValueError( - '"content_type" must be json or yaml if "content" is not a string' - ) + raise ValueError('"content_type" must be json or yaml if "content" is not a string') if not isinstance(extra_file.content, str): raise TypeError(f"unsupported content: {type(extra_file.content)}") @@ -285,7 +280,7 @@ def get_content(extra_file: RunwayStaticSiteExtraFileDataModel) -> Optional[str] def calculate_hash_of_extra_files( - extra_files: List[RunwayStaticSiteExtraFileDataModel], + extra_files: list[RunwayStaticSiteExtraFileDataModel], ) -> str: """Return a hash of all of the given extra files. @@ -299,7 +294,7 @@ def calculate_hash_of_extra_files( The hash of all the files. """ - file_hash = hashlib.md5() + file_hash = hashlib.md5() # noqa: S324 for extra_file in sorted(extra_files, key=lambda x: x.name): file_hash.update((extra_file.name + "\0").encode()) @@ -312,15 +307,13 @@ def calculate_hash_of_extra_files( file_hash.update((cast(str, extra_file.content) + "\0").encode()) if extra_file.file: - with open(extra_file.file, "rb") as f: + with open(extra_file.file, "rb") as f: # noqa: PTH123 LOGGER.debug("hashing file: %s", extra_file.file) - for chunk in iter( - lambda: f.read(4096), "" # pylint: disable=cell-var-from-loop - ): + for chunk in iter(lambda: f.read(4096), ""): if not chunk: break file_hash.update(chunk) - file_hash.update("\0".encode()) + file_hash.update(b"\0") return file_hash.hexdigest() @@ -344,9 +337,7 @@ def get_ssm_value(session: Session, name: str) -> Optional[str]: return None -def set_ssm_value( - session: Session, name: str, value: Any, description: str = "" -) -> None: +def set_ssm_value(session: Session, name: str, value: Any, description: str = "") -> None: """Set the ssm parameter. Args: @@ -363,18 +354,19 @@ def set_ssm_value( ) -def sync_extra_files( +def sync_extra_files( # noqa: C901 context: CfnginContext, bucket: str, - extra_files: List[RunwayStaticSiteExtraFileDataModel], + extra_files: list[RunwayStaticSiteExtraFileDataModel], **kwargs: Any, -) -> List[str]: +) -> list[str]: """Sync static website extra files to S3 bucket. Args: context: The context instance. bucket: The static site bucket name. extra_files: List of files and file content that should be uploaded. + **kwargs: Arbitrary keyword arguments. """ LOGGER.debug("extra_files to sync: %s", json.dumps(extra_files, cls=JsonEncoder)) @@ -384,7 +376,7 @@ def sync_extra_files( session = context.get_session() s3_client = session.client("s3") - uploaded: List[str] = [] + uploaded: list[str] = [] hash_param = cast(str, kwargs.get("hash_tracking_parameter", "")) hash_new = None @@ -404,9 +396,7 @@ def sync_extra_files( hash_new = calculate_hash_of_extra_files(extra_files) if hash_new == hash_old: - LOGGER.info( - "skipped upload of extra files; latest version already deployed" - ) + LOGGER.info("skipped upload of extra files; latest version already deployed") return [] for extra_file in extra_files: @@ -423,9 +413,7 @@ def sync_extra_files( uploaded.append(extra_file.name) if extra_file.file: - LOGGER.info( - "uploading extra file: %s as %s ", extra_file.file, extra_file.name - ) + LOGGER.info("uploading extra file: %s as %s ", extra_file.file, extra_file.name) extra_args = "" @@ -449,9 +437,7 @@ def sync_extra_files( uploaded.append(extra_file.name) if hash_new: - LOGGER.info( - "updating extra files SSM parameter %s with hash %s", hash_param, hash_new - ) + LOGGER.info("updating extra files SSM parameter %s with hash %s", hash_param, hash_new) set_ssm_value(session, hash_param, hash_new) return uploaded diff --git a/runway/cfngin/hooks/staticsite/utils.py b/runway/cfngin/hooks/staticsite/utils.py index 1f8ea2e22..6450fa193 100644 --- a/runway/cfngin/hooks/staticsite/utils.py +++ b/runway/cfngin/hooks/staticsite/utils.py @@ -6,13 +6,15 @@ import logging import os from pathlib import Path -from typing import TYPE_CHECKING, Dict, Iterable, List, Optional, Union, cast +from typing import TYPE_CHECKING, Optional, Union, cast import igittigitt from ....utils import FileHash, change_dir if TYPE_CHECKING: + from collections.abc import Iterable + from _typeshed import StrPath LOGGER = logging.getLogger(__name__) @@ -29,14 +31,14 @@ def calculate_hash_of_files(files: Iterable[StrPath], root: Path) -> str: A hash of the hashes of the given files. """ - file_hash = FileHash(hashlib.md5()) + file_hash = FileHash(hashlib.md5()) # noqa: S324 file_hash.add_files(sorted(str(f) for f in files), relative_to=root) return file_hash.hexdigest def get_hash_of_files( root_path: Path, - directories: Optional[List[Dict[str, Union[List[str], str]]]] = None, + directories: Optional[list[dict[str, Union[list[str], str]]]] = None, ) -> str: """Generate md5 hash of files. @@ -49,11 +51,11 @@ def get_hash_of_files( """ directories = directories or [{"path": "./"}] - files_to_hash: List[StrPath] = [] + files_to_hash: list[StrPath] = [] for i in directories: gitignore = get_ignorer( root_path / cast(str, i["path"]), - cast(Optional[List[str]], i.get("exclusions")), + cast("list[str] | None", i.get("exclusions")), ) with change_dir(root_path): @@ -72,7 +74,7 @@ def get_hash_of_files( def get_ignorer( - path: Path, additional_exclusions: Optional[List[str]] = None + path: Path, additional_exclusions: list[str] | None = None ) -> igittigitt.IgnoreParser: """Create gitignore filter from directory ``.gitignore`` file. diff --git a/runway/cfngin/hooks/utils.py b/runway/cfngin/hooks/utils.py index 565c99fc5..87f653ab7 100644 --- a/runway/cfngin/hooks/utils.py +++ b/runway/cfngin/hooks/utils.py @@ -4,9 +4,9 @@ import collections.abc import logging -import os import sys -from typing import TYPE_CHECKING, Any, Dict, List, cast +from pathlib import Path +from typing import TYPE_CHECKING, Any, cast import pydantic @@ -30,7 +30,7 @@ def create_template(self) -> None: """Create template without raising NotImplementedError.""" -# TODO BREAKING find a better place for this +# TODO (kyle): BREAKING move to runway.providers.aws.models.TagModel class TagDataModel(BaseModel): """AWS Resource Tag data model.""" @@ -50,16 +50,16 @@ class Config: def full_path(path: str) -> str: """Return full path.""" - return os.path.abspath(os.path.expanduser(path)) + return str(Path(path).absolute()) -# TODO split up to reduce number of statements -def handle_hooks( # pylint: disable=too-many-statements +# TODO (kyle): split up to reduce number of statements +def handle_hooks( # noqa: C901, PLR0912, PLR0915 stage: str, - hooks: List[CfnginHookDefinitionModel], + hooks: list[CfnginHookDefinitionModel], provider: Provider, context: CfnginContext, -): +) -> None: """Handle pre/post_deploy hooks. These are pieces of code that we want to run before/after deploying @@ -76,7 +76,7 @@ def handle_hooks( # pylint: disable=too-many-statements LOGGER.debug("no %s hooks defined", stage) return - hook_paths: List[str] = [] + hook_paths: list[str] = [] for i, hook in enumerate(hooks): try: hook_paths.append(hook.path) @@ -111,18 +111,16 @@ def handle_hooks( # pylint: disable=too-many-statements "does not exist yet" ) raise - kwargs: Dict[str, Any] = {v.name: v.value for v in args} + kwargs: dict[str, Any] = {v.name: v.value for v in args} else: kwargs = {} try: if isinstance(method, type): - result: Any = getattr( - method(context=context, provider=provider, **kwargs), stage - )() + result: Any = getattr(method(context=context, provider=provider, **kwargs), stage)() else: result = cast(Any, method(context=context, provider=provider, **kwargs)) - except Exception: # pylint: disable=broad-except + except Exception: LOGGER.exception("hook %s threw an exception", hook.path) if hook.required: raise @@ -130,24 +128,19 @@ def handle_hooks( # pylint: disable=too-many-statements if not result: if hook.required: - LOGGER.error( - "required hook %s failed; return value: %s", hook.path, result - ) + LOGGER.error("required hook %s failed; return value: %s", hook.path, result) sys.exit(1) - LOGGER.warning( - "non-required hook %s failed; return value: %s", hook.path, result - ) - else: - if isinstance(result, (collections.abc.Mapping, pydantic.BaseModel)): - if hook.data_key: - LOGGER.debug( - "adding result for hook %s to context in data_key %s", - hook.path, - hook.data_key, - ) - context.set_hook_data(hook.data_key, result) - else: - LOGGER.debug( - "hook %s returned result data but no data key set; ignoring", - hook.path, - ) + LOGGER.warning("non-required hook %s failed; return value: %s", hook.path, result) + elif isinstance(result, (collections.abc.Mapping, pydantic.BaseModel)): + if hook.data_key: + LOGGER.debug( + "adding result for hook %s to context in data_key %s", + hook.path, + hook.data_key, + ) + context.set_hook_data(hook.data_key, result) + else: + LOGGER.debug( + "hook %s returned result data but no data key set; ignoring", + hook.path, + ) diff --git a/runway/cfngin/logger/__init__.py b/runway/cfngin/logger/__init__.py index da3e36b3f..ebe0e5447 100644 --- a/runway/cfngin/logger/__init__.py +++ b/runway/cfngin/logger/__init__.py @@ -1,12 +1,13 @@ """CFNgin logger.""" +from __future__ import annotations + import logging import sys -from typing import Any, Dict, Optional +from typing import Any DEBUG_FORMAT = ( - "[%(asctime)s] %(levelname)s %(threadName)s " - "%(name)s:%(lineno)d(%(funcName)s): %(message)s" + "[%(asctime)s] %(levelname)s %(threadName)s %(name)s:%(lineno)d(%(funcName)s): %(message)s" ) INFO_FORMAT = "[%(asctime)s] %(message)s" COLOR_FORMAT = "[%(asctime)s] \033[%(color)sm%(message)s\033[39m" @@ -24,7 +25,7 @@ def format(self, record: logging.LogRecord) -> str: return super().format(record) -def setup_logging(verbosity: int, formats: Optional[Dict[str, Any]] = None): +def setup_logging(verbosity: int, formats: dict[str, Any] | None = None) -> None: """Configure a proper logger based on verbosity and optional log formats. Args: diff --git a/runway/cfngin/lookups/handlers/ami.py b/runway/cfngin/lookups/handlers/ami.py index 6ecde4dd8..01b498b3d 100644 --- a/runway/cfngin/lookups/handlers/ami.py +++ b/runway/cfngin/lookups/handlers/ami.py @@ -1,21 +1,21 @@ """AMI lookup.""" -# pylint: disable=no-self-argument # pyright: reportIncompatibleMethodOverride=none from __future__ import annotations import operator import re -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union +from typing import TYPE_CHECKING, Any, Final, List, Optional, Union # noqa: UP035 from pydantic import validator -from typing_extensions import Final, Literal from ....lookups.handlers.base import LookupHandler from ....utils import BaseModel from ...utils import read_value_from_path if TYPE_CHECKING: + from typing_extensions import Literal + from ....context import CfnginContext @@ -27,10 +27,10 @@ class ArgsDataModel(BaseModel): """ - executable_users: Optional[List[str]] = None + executable_users: Optional[List[str]] = None # noqa: UP006 """List of executable users.""" - owners: List[str] + owners: List[str] # noqa: UP006 """At least one owner is required. Should be ``amazon``, ``self``, or an AWS account ID. @@ -41,7 +41,7 @@ class ArgsDataModel(BaseModel): """AWS region.""" @validator("executable_users", "owners", allow_reuse=True, pre=True) - def _convert_str_to_list(cls, v: Union[List[str], str]) -> List[str]: + def _convert_str_to_list(cls, v: Union[list[str], str]) -> list[str]: # noqa: N805 """Convert str to list.""" if isinstance(v, str): return v.split(",") @@ -56,9 +56,7 @@ class ImageNotFound(Exception): def __init__(self, search_string: str) -> None: """Instantiate class.""" self.search_string = search_string - super().__init__( - f"Unable to find ec2 image with search string: {search_string}" - ) + super().__init__(f"Unable to find ec2 image with search string: {search_string}") class AmiLookup(LookupHandler): @@ -68,7 +66,7 @@ class AmiLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def parse(cls, value: str) -> Tuple[str, Dict[str, str]]: + def parse(cls, value: str) -> tuple[str, dict[str, str]]: """Parse the value passed to the lookup. This overrides the default parsing to account for special requirements. @@ -81,7 +79,7 @@ def parse(cls, value: str) -> Tuple[str, Dict[str, str]]: """ raw_value = read_value_from_path(value) - args: Dict[str, str] = {} + args: dict[str, str] = {} if "@" in raw_value: args["region"], raw_value = raw_value.split("@", 1) @@ -95,9 +93,7 @@ def parse(cls, value: str) -> Tuple[str, Dict[str, str]]: return args.pop("name_regex"), args @classmethod - def handle( # pylint: disable=arguments-differ - cls, value: str, context: CfnginContext, *__args: Any, **__kwargs: Any - ) -> str: + def handle(cls, value: str, context: CfnginContext, *__args: Any, **__kwargs: Any) -> str: """Fetch the most recent AMI Id using a filter. Args: @@ -116,18 +112,16 @@ def handle( # pylint: disable=arguments-differ You can also optionally specify the region in which to perform the AMI lookup. - """ # noqa + """ query, raw_args = cls.parse(value) args = ArgsDataModel.parse_obj(raw_args) ec2 = context.get_session(region=args.region).client("ec2") - describe_args: Dict[str, Any] = { + describe_args: dict[str, Any] = { "Filters": [ {"Name": key, "Values": val.split(",") if val else val} for key, val in { - k: v - for k, v in raw_args.items() - if k not in ArgsDataModel.__fields__ + k: v for k, v in raw_args.items() if k not in ArgsDataModel.__fields__ }.items() ], "Owners": args.owners, diff --git a/runway/cfngin/lookups/handlers/awslambda.py b/runway/cfngin/lookups/handlers/awslambda.py index 99cf925f1..682783422 100644 --- a/runway/cfngin/lookups/handlers/awslambda.py +++ b/runway/cfngin/lookups/handlers/awslambda.py @@ -8,22 +8,23 @@ The :attr:`~cfngin.hook.data_key` is then passed to the lookup as it's input/query. This allows the lookup to function during a ``runway plan``. -""" # noqa +""" from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, List, Optional, Union, cast +from typing import TYPE_CHECKING, Any, Final, Optional, Union, cast from pydantic import ValidationError from troposphere.awslambda import Code, Content -from typing_extensions import Final, Literal from ....lookups.handlers.base import LookupHandler from ....utils import load_object_from_string from ...exceptions import CfnginOnlyLookupError if TYPE_CHECKING: + from typing_extensions import Literal + from ....config import CfnginConfig from ....config.models.cfngin import CfnginHookDefinitionModel from ....context import CfnginContext, RunwayContext @@ -62,7 +63,6 @@ def get_deployment_package_data( """ # needs to be imported here to avoid cyclic imports for conditional code # caused by import of runway.cfngin.actions.deploy in runway.cfngin.hooks.base - # pylint: disable=import-outside-toplevel from ...hooks.awslambda.models.responses import ( AwsLambdaHookDeployResponse as _AwsLambdaHookDeployResponse, ) @@ -108,13 +108,11 @@ def get_required_hook_definition( if not hooks_with_data_key: raise ValueError(f"no hook definition found with data_key {data_key}") if len(hooks_with_data_key) > 1: - raise ValueError( - f"more than one hook definition found with data_key {data_key}" - ) + raise ValueError(f"more than one hook definition found with data_key {data_key}") return hooks_with_data_key.pop() @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -156,7 +154,6 @@ def init_hook_class( """ # needs to be imported here to avoid cyclic imports for conditional code # caused by import of runway.cfngin.actions.deploy in runway.cfngin.hooks.base - # pylint: disable=import-outside-toplevel from ...hooks.awslambda.base_classes import AwsLambdaHook as _AwsLambdaHook kls = load_object_from_string(hook_def.path) @@ -177,7 +174,7 @@ class Code(LookupHandler): TYPE_NAME: Final[Literal["awslambda.Code"]] = "awslambda.Code" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -189,6 +186,8 @@ def handle( # pylint: disable=arguments-differ Args: value: Value to resolve. context: The current context object. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. Returns: Value that can be passed into CloudFormation property @@ -209,7 +208,7 @@ class CodeSha256(LookupHandler): TYPE_NAME: Final[Literal["awslambda.CodeSha256"]] = "awslambda.CodeSha256" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -221,6 +220,8 @@ def handle( # pylint: disable=arguments-differ Args: value: Value to resolve. context: The current context object. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. Returns: Value that can be passed into CloudFormation property @@ -237,18 +238,20 @@ class CompatibleArchitectures(LookupHandler): ) @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], *args: Any, **kwargs: Any, - ) -> Optional[List[str]]: + ) -> Optional[list[str]]: """Retrieve metadata for an AWS Lambda deployment package. Args: value: Value to resolve. context: The current context object. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. Returns: Value that can be passed into CloudFormation property @@ -257,21 +260,17 @@ def handle( # pylint: disable=arguments-differ """ _query, lookup_args = cls.parse(value) return cls.format_results( - AwsLambdaLookup.handle( - value, context, *args, **kwargs - ).compatible_architectures, + AwsLambdaLookup.handle(value, context, *args, **kwargs).compatible_architectures, **lookup_args, ) class CompatibleRuntimes(LookupHandler): """Lookup for AwsLambdaHook responses.""" - TYPE_NAME: Final[Literal["awslambda.CompatibleRuntimes"]] = ( - "awslambda.CompatibleRuntimes" - ) + TYPE_NAME: Final[Literal["awslambda.CompatibleRuntimes"]] = "awslambda.CompatibleRuntimes" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -283,6 +282,8 @@ def handle( # pylint: disable=arguments-differ Args: value: Value to resolve. context: The current context object. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. Returns: Value that can be passed into CloudFormation property @@ -291,9 +292,7 @@ def handle( # pylint: disable=arguments-differ """ _query, lookup_args = cls.parse(value) return cls.format_results( - AwsLambdaLookup.handle( - value, context, *args, **kwargs - ).compatible_runtimes, + AwsLambdaLookup.handle(value, context, *args, **kwargs).compatible_runtimes, **lookup_args, ) @@ -303,7 +302,7 @@ class Content(LookupHandler): TYPE_NAME: Final[Literal["awslambda.Content"]] = "awslambda.Content" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -315,6 +314,8 @@ def handle( # pylint: disable=arguments-differ Args: value: Value to resolve. context: The current context object. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. Returns: Value that can be passed into CloudFormation property @@ -335,7 +336,7 @@ class LicenseInfo(LookupHandler): TYPE_NAME: Final[Literal["awslambda.LicenseInfo"]] = "awslambda.LicenseInfo" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -347,6 +348,8 @@ def handle( # pylint: disable=arguments-differ Args: value: Value to resolve. context: The current context object. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. Returns: Value that can be passed into CloudFormation property @@ -365,7 +368,7 @@ class Runtime(LookupHandler): TYPE_NAME: Final[Literal["awslambda.Runtime"]] = "awslambda.Runtime" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -377,6 +380,8 @@ def handle( # pylint: disable=arguments-differ Args: value: Value to resolve. context: The current context object. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. Returns: Value that can be passed into CloudFormation property @@ -391,7 +396,7 @@ class S3Bucket(LookupHandler): TYPE_NAME: Final[Literal["awslambda.S3Bucket"]] = "awslambda.S3Bucket" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -403,6 +408,8 @@ def handle( # pylint: disable=arguments-differ Args: value: Value to resolve. context: The current context object. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. Returns: Value that can be passed into CloudFormation property @@ -418,7 +425,7 @@ class S3Key(LookupHandler): TYPE_NAME: Final[Literal["awslambda.S3Key"]] = "awslambda.S3Key" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -430,6 +437,8 @@ def handle( # pylint: disable=arguments-differ Args: value: Value to resolve. context: The current context object. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. Returns: Value that can be passed into CloudFormation property @@ -442,12 +451,10 @@ def handle( # pylint: disable=arguments-differ class S3ObjectVersion(LookupHandler): """Lookup for AwsLambdaHook responses.""" - TYPE_NAME: Final[Literal["awslambda.S3ObjectVersion"]] = ( - "awslambda.S3ObjectVersion" - ) + TYPE_NAME: Final[Literal["awslambda.S3ObjectVersion"]] = "awslambda.S3ObjectVersion" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -459,6 +466,8 @@ def handle( # pylint: disable=arguments-differ Args: value: Value to resolve. context: The current context object. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. Returns: Value that can be passed into CloudFormation property @@ -466,6 +475,4 @@ def handle( # pylint: disable=arguments-differ ``AWS::Lambda::LayerVersion.Content.S3ObjectVersion``. """ - return AwsLambdaLookup.handle( - value, context, *args, **kwargs - ).object_version_id + return AwsLambdaLookup.handle(value, context, *args, **kwargs).object_version_id diff --git a/runway/cfngin/lookups/handlers/default.py b/runway/cfngin/lookups/handlers/default.py index 5fed55eb1..0d55df1d5 100644 --- a/runway/cfngin/lookups/handlers/default.py +++ b/runway/cfngin/lookups/handlers/default.py @@ -3,13 +3,13 @@ # pyright: reportIncompatibleMethodOverride=none from __future__ import annotations -from typing import TYPE_CHECKING, Any, Optional - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Final, Optional from ....lookups.handlers.base import LookupHandler if TYPE_CHECKING: + from typing_extensions import Literal + from ....context import CfnginContext @@ -20,9 +20,7 @@ class DefaultLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def handle( # pylint: disable=arguments-differ - cls, value: str, context: Optional[CfnginContext] = None, **_: Any - ) -> Any: + def handle(cls, value: str, context: Optional[CfnginContext] = None, **_: Any) -> Any: """Use a value from the environment or fall back to a default value. Allows defaults to be set at the config file level. diff --git a/runway/cfngin/lookups/handlers/dynamodb.py b/runway/cfngin/lookups/handlers/dynamodb.py index 61b6d4d57..3701b822b 100644 --- a/runway/cfngin/lookups/handlers/dynamodb.py +++ b/runway/cfngin/lookups/handlers/dynamodb.py @@ -4,10 +4,10 @@ from __future__ import annotations import re -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, cast +from typing import TYPE_CHECKING, Any, Final, Optional, cast from botocore.exceptions import ClientError -from typing_extensions import Final, Literal, TypedDict +from typing_extensions import Literal, TypedDict from ....lookups.handlers.base import LookupHandler from ....utils import BaseModel @@ -61,7 +61,7 @@ class QueryDataModel(BaseModel): """Name of the DynamoDB Table to query.""" @property - def item_key(self) -> Dict[str, Dict[Literal["B", "N", "S"], Any]]: + def item_key(self) -> dict[str, dict[Literal["B", "N", "S"], Any]]: """Value to pass to boto3 ``.get_item()`` call as the ``Key`` argument. Raises: @@ -78,9 +78,9 @@ def item_key(self) -> Dict[str, Dict[Literal["B", "N", "S"], Any]]: ) return { self.partition_key: { - cast( - Literal["B", "N", "S"], match.groupdict("S")["data_type"] - ): match.group("value") + cast(Literal["B", "N", "S"], match.groupdict("S")["data_type"]): match.group( + "value" + ) } } @@ -92,7 +92,7 @@ class DynamodbLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def parse(cls, value: str) -> Tuple[str, Dict[str, str]]: + def parse(cls, value: str) -> tuple[str, dict[str, str]]: """Parse the value passed to the lookup. This overrides the default parsing to account for special requirements. @@ -109,7 +109,7 @@ def parse(cls, value: str) -> Tuple[str, Dict[str, str]]: """ raw_value = read_value_from_path(value) - args: Dict[str, str] = {} + args: dict[str, str] = {} if "@" not in raw_value: raise ValueError( @@ -120,7 +120,7 @@ def parse(cls, value: str) -> Tuple[str, Dict[str, str]]: if ":" in table_info: args["region"], table_info = table_info.split(":", 1) - return "@".join([table_info, table_keys]), args + return f"{table_info}@{table_keys}", args @classmethod def parse_query(cls, value: str) -> QueryDataModel: @@ -139,9 +139,7 @@ def parse_query(cls, value: str) -> QueryDataModel: return QueryDataModel.parse_obj(match.groupdict()) @classmethod - def handle( # pylint: disable=arguments-differ - cls, value: str, context: CfnginContext, *__args: Any, **__kwargs: Any - ) -> Any: + def handle(cls, value: str, context: CfnginContext, *__args: Any, **__kwargs: Any) -> Any: """Get a value from a DynamoDB table. Args: @@ -169,22 +167,16 @@ def handle( # pylint: disable=arguments-differ response = dynamodb.get_item( TableName=query.table_name, Key=query.item_key, - ProjectionExpression=",".join( - [query.partition_key, *key_dict["clean_table_keys"]] - ), + ProjectionExpression=",".join([query.partition_key, *key_dict["clean_table_keys"]]), ) except dynamodb.exceptions.ResourceNotFoundException as exc: - raise ValueError( - f"Can't find the DynamoDB table: {query.table_name}" - ) from exc + raise ValueError(f"Can't find the DynamoDB table: {query.table_name}") from exc except ClientError as exc: if exc.response["Error"]["Code"] == "ValidationException": raise ValueError( f"No DynamoDB record matched the partition key: {query.partition_key}" ) from exc - raise ValueError( - f"The DynamoDB lookup '{value}' encountered an error: {exc}" - ) from exc + raise ValueError(f"The DynamoDB lookup '{value}' encountered an error: {exc}") from exc # find and return the key from the dynamo data returned if "Item" in response: return _get_val_from_ddb_data(response["Item"], key_dict["new_keys"]) @@ -196,11 +188,11 @@ def handle( # pylint: disable=arguments-differ class ParsedLookupKey(TypedDict): """Return value of _lookup_key_parse.""" - clean_table_keys: List[str] - new_keys: List[Dict[Literal["L", "M", "N", "S"], str]] + clean_table_keys: list[str] + new_keys: list[dict[Literal["L", "M", "N", "S"], str]] -def _lookup_key_parse(table_keys: List[str]) -> ParsedLookupKey: +def _lookup_key_parse(table_keys: list[str]) -> ParsedLookupKey: """Return the order in which the stacks should be executed. Args: @@ -217,8 +209,8 @@ def _lookup_key_parse(table_keys: List[str]) -> ParsedLookupKey: # we need to parse the key lookup passed in regex_matcher = r"\[([^\]]+)]" valid_dynamodb_datatypes = ["L", "M", "N", "S"] - clean_table_keys: List[str] = [] - new_keys: List[Dict[Literal["L", "M", "N", "S"], str]] = [] + clean_table_keys: list[str] = [] + new_keys: list[dict[Literal["L", "M", "N", "S"], str]] = [] for key in table_keys: match = re.search(regex_matcher, key) @@ -229,7 +221,7 @@ def _lookup_key_parse(table_keys: List[str]) -> ParsedLookupKey: f"CFNgin does not support looking up the data type: {match.group(1)}" ) match_val = cast(Literal["L", "M", "N", "S"], match.group(1)) - key = key.replace(match.group(0), "") + key = key.replace(match.group(0), "") # noqa: PLW2901 new_keys.append({match_val: key}) else: new_keys.append({"S": key}) @@ -237,7 +229,7 @@ def _lookup_key_parse(table_keys: List[str]) -> ParsedLookupKey: return {"new_keys": new_keys, "clean_table_keys": clean_table_keys} -def _get_val_from_ddb_data(data: Dict[str, Any], keylist: List[Dict[str, str]]) -> Any: +def _get_val_from_ddb_data(data: dict[str, Any], keylist: list[dict[str, str]]) -> Any: """Return the value of the lookup. Args: @@ -263,14 +255,14 @@ def _get_val_from_ddb_data(data: Dict[str, Any], keylist: List[Dict[str, str]]) # if type is list, convert it to a list and return return _convert_ddb_list_to_list(data[cast(str, next_type)]) if next_type == "N": - # TODO: handle various types of 'number' datatypes, (e.g. int, double) + # TODO (troyready): handle various types of 'number' datatypes, (e.g. int, double) # if a number, convert to an int and return return int(data[cast(str, next_type)]) # else, just assume its a string and return return str(data[cast(str, next_type)]) -def _convert_ddb_list_to_list(conversion_list: List[Dict[str, Any]]) -> List[Any]: +def _convert_ddb_list_to_list(conversion_list: list[dict[str, Any]]) -> list[Any]: """Return a python list without the DynamoDB datatypes. Args: @@ -280,8 +272,4 @@ def _convert_ddb_list_to_list(conversion_list: List[Dict[str, Any]]) -> List[Any Returns A sanitized list without the datatypes. """ - ret_list: List[Any] = [] - for val in conversion_list: - for v in val: - ret_list.append(val[v]) - return ret_list + return [val[v] for val in conversion_list for v in val] diff --git a/runway/cfngin/lookups/handlers/envvar.py b/runway/cfngin/lookups/handlers/envvar.py index a38d3251a..3c93ef447 100644 --- a/runway/cfngin/lookups/handlers/envvar.py +++ b/runway/cfngin/lookups/handlers/envvar.py @@ -3,9 +3,9 @@ # pyright: reportIncompatibleMethodOverride=none import logging import os -from typing import Any +from typing import Any, Final -from typing_extensions import Final, Literal +from typing_extensions import Literal from ....lookups.handlers.base import LookupHandler from ...utils import read_value_from_path @@ -21,7 +21,7 @@ class EnvvarLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def handle(cls, value: str, **_: Any) -> str: # pylint: disable=arguments-differ + def handle(cls, value: str, **_: Any) -> str: """Retrieve an environment variable. Args: diff --git a/runway/cfngin/lookups/handlers/file.py b/runway/cfngin/lookups/handlers/file.py index dcd73dfe0..b81b9b487 100644 --- a/runway/cfngin/lookups/handlers/file.py +++ b/runway/cfngin/lookups/handlers/file.py @@ -1,6 +1,5 @@ """File lookup.""" -# pylint: disable=arguments-differ,no-self-argument # pyright: reportIncompatibleMethodOverride=none from __future__ import annotations @@ -8,24 +7,27 @@ import collections.abc import json import re -from typing import Any, Callable, Dict, List, Mapping, Sequence, Tuple, Union, overload +from collections.abc import Mapping, Sequence +from typing import TYPE_CHECKING, Any, Callable, Final, Union, overload import yaml from pydantic import validator from troposphere import Base64, GenericHelperFn -from typing_extensions import Final, Literal from ....lookups.handlers.base import LookupHandler from ....utils import BaseModel from ...utils import read_value_from_path +if TYPE_CHECKING: + from typing_extensions import Literal + _PARAMETER_PATTERN = re.compile(r"{{([::|\w]+)}}") ParameterizedObjectTypeDef = Union[str, Mapping[str, Any], Sequence[Any], Any] ParameterizedObjectReturnTypeDef = Union[ - Dict[str, "ParameterizedObjectReturnTypeDef"], + dict[str, "ParameterizedObjectReturnTypeDef"], GenericHelperFn, - List["ParameterizedObjectReturnTypeDef"], + list["ParameterizedObjectReturnTypeDef"], ] @@ -36,7 +38,7 @@ class ArgsDataModel(BaseModel): """Codec that will be used to parse and/or manipulate the data.""" @validator("codec", allow_reuse=True) - def _validate_supported_codec(cls, v: str) -> str: + def _validate_supported_codec(cls, v: str) -> str: # noqa: N805 """Validate that the selected codec is supported.""" if v in CODECS: return v @@ -50,7 +52,7 @@ class FileLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def parse(cls, value: str) -> Tuple[str, Dict[str, str]]: + def parse(cls, value: str) -> tuple[str, dict[str, str]]: """Parse the value passed to the lookup. This overrides the default parsing to account for special requirements. @@ -65,13 +67,12 @@ def parse(cls, value: str) -> Tuple[str, Dict[str, str]]: ValueError: The value provided does not match the expected regex. """ - args: Dict[str, str] = {} + args: dict[str, str] = {} try: args["codec"], data_or_path = value.split(":", 1) except ValueError: raise ValueError( - f"Query '{value}' doesn't match regex: " - rf"^(?P[{'|'.join(CODECS)}]:.+$)" + rf"Query '{value}' doesn't match regex: ^(?P[{'|'.join(CODECS)}]:.+$)" ) from None return read_value_from_path(data_or_path), args @@ -97,7 +98,7 @@ def _parameterize_string(raw: str) -> GenericHelperFn: are found, and a composition of CloudFormation calls otherwise. """ - parts: List[Any] = [] + parts: list[Any] = [] s_index = 0 for match in _PARAMETER_PATTERN.finditer(raw): @@ -148,7 +149,7 @@ def _parameterize_obj(obj: Mapping[str, Any]) -> ParameterizedObjectReturnTypeDe @overload -def _parameterize_obj(obj: List[Any]) -> ParameterizedObjectReturnTypeDef: ... +def _parameterize_obj(obj: list[Any]) -> ParameterizedObjectReturnTypeDef: ... def _parameterize_obj( @@ -189,7 +190,7 @@ def json_codec(raw: str, parameterized: bool = False) -> Any: return _parameterize_obj(data) if parameterized else data -CODECS: Dict[str, Callable[[str], Any]] = { +CODECS: dict[str, Callable[[str], Any]] = { "base64": lambda x: base64.b64encode(x.encode("utf8")).decode("utf-8"), "json": lambda x: json_codec(x, parameterized=False), "json-parameterized": lambda x: json_codec(x, parameterized=True), diff --git a/runway/cfngin/lookups/handlers/hook_data.py b/runway/cfngin/lookups/handlers/hook_data.py index 433573c5d..1736cc677 100644 --- a/runway/cfngin/lookups/handlers/hook_data.py +++ b/runway/cfngin/lookups/handlers/hook_data.py @@ -4,15 +4,16 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, Final from troposphere import BaseAWSObject -from typing_extensions import Final, Literal from ....lookups.handlers.base import LookupHandler from ....utils import MutableMap if TYPE_CHECKING: + from typing_extensions import Literal + from ....context import CfnginContext LOGGER = logging.getLogger(__name__) @@ -25,9 +26,7 @@ class HookDataLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def handle( # pylint: disable=arguments-differ - cls, value: str, context: CfnginContext, **_: Any - ) -> Any: + def handle(cls, value: str, context: CfnginContext, **_: Any) -> Any: """Return the data from ``hook_data``. Args: @@ -41,11 +40,7 @@ def handle( # pylint: disable=arguments-differ result = hook_data.find(query, args.get("default")) - if ( - isinstance(result, BaseAWSObject) - and args.get("get") - and not args.get("load") - ): + if isinstance(result, BaseAWSObject) and args.get("get") and not args.get("load"): args["load"] = "troposphere" if not result: diff --git a/runway/cfngin/lookups/handlers/kms.py b/runway/cfngin/lookups/handlers/kms.py index e31699ffe..c9aef5e1c 100644 --- a/runway/cfngin/lookups/handlers/kms.py +++ b/runway/cfngin/lookups/handlers/kms.py @@ -5,15 +5,15 @@ import codecs import logging -from typing import TYPE_CHECKING, Any, BinaryIO, Dict, Tuple, Union, cast - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, BinaryIO, Final, Union, cast from ....lookups.handlers.base import LookupHandler from ....utils import DOC_SITE from ...utils import read_value_from_path if TYPE_CHECKING: + from typing_extensions import Literal + from ....context import CfnginContext LOGGER = logging.getLogger(__name__) @@ -31,7 +31,7 @@ class KmsLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def legacy_parse(cls, value: str) -> Tuple[str, Dict[str, str]]: + def legacy_parse(cls, value: str) -> tuple[str, dict[str, str]]: """Retain support for legacy lookup syntax. Format of value:: @@ -44,9 +44,7 @@ def legacy_parse(cls, value: str) -> Tuple[str, Dict[str, str]]: return value, {"region": region} @classmethod - def handle( # pylint: disable=arguments-differ - cls, value: str, context: CfnginContext, **_: Any - ) -> str: + def handle(cls, value: str, context: CfnginContext, **_: Any) -> str: r"""Decrypt the specified value with a master key in KMS. Args: diff --git a/runway/cfngin/lookups/handlers/output.py b/runway/cfngin/lookups/handlers/output.py index 32d2ebf8b..655b054bd 100644 --- a/runway/cfngin/lookups/handlers/output.py +++ b/runway/cfngin/lookups/handlers/output.py @@ -5,9 +5,7 @@ import logging import re -from typing import TYPE_CHECKING, Any, Dict, NamedTuple, Set, Tuple - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Final, NamedTuple from ....exceptions import OutputDoesNotExist from ....lookups.handlers.base import LookupHandler @@ -15,6 +13,8 @@ from ...exceptions import StackDoesNotExist if TYPE_CHECKING: + from typing_extensions import Literal + from ....context import CfnginContext from ....variables import VariableValue @@ -40,7 +40,7 @@ class OutputLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def legacy_parse(cls, value: str) -> Tuple[OutputQuery, Dict[str, str]]: + def legacy_parse(cls, value: str) -> tuple[OutputQuery, dict[str, str]]: """Retain support for legacy lookup syntax. Format of value: @@ -51,9 +51,7 @@ def legacy_parse(cls, value: str) -> Tuple[OutputQuery, Dict[str, str]]: return deconstruct(value), {} @classmethod - def handle( # pylint: disable=arguments-differ - cls, value: str, context: CfnginContext, **_: Any - ) -> str: + def handle(cls, value: str, context: CfnginContext, **_: Any) -> str: """Fetch an output from the designated stack. Args: @@ -82,9 +80,7 @@ def handle( # pylint: disable=arguments-differ raise StackDoesNotExist(context.get_fqn(query.stack_name)) if "default" in args: # handle falsy default - return cls.format_results( - stack.outputs.get(query.output_name, args["default"]), **args - ) + return cls.format_results(stack.outputs.get(query.output_name, args["default"]), **args) try: return cls.format_results(stack.outputs[query.output_name], **args) @@ -94,7 +90,7 @@ def handle( # pylint: disable=arguments-differ ) from None @classmethod - def dependencies(cls, lookup_query: VariableValue) -> Set[str]: + def dependencies(cls, lookup_query: VariableValue) -> set[str]: """Calculate any dependencies required to perform this lookup. Note that lookup_query may not be (completely) resolved at this time. @@ -127,7 +123,7 @@ def dependencies(cls, lookup_query: VariableValue) -> Set[str]: return set() -def deconstruct(value: str) -> OutputQuery: # TODO remove in next major release +def deconstruct(value: str) -> OutputQuery: # TODO (kyle): remove in next major release """Deconstruct the value.""" try: stack_name, output_name = value.split("::") diff --git a/runway/cfngin/lookups/handlers/rxref.py b/runway/cfngin/lookups/handlers/rxref.py index ab8285586..4eab30edd 100644 --- a/runway/cfngin/lookups/handlers/rxref.py +++ b/runway/cfngin/lookups/handlers/rxref.py @@ -4,9 +4,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, Tuple - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Final from ....lookups.handlers.base import LookupHandler from ....lookups.handlers.cfn import CfnLookup @@ -14,6 +12,8 @@ from .output import OutputQuery, deconstruct if TYPE_CHECKING: + from typing_extensions import Literal + from ....context import CfnginContext from ...providers.aws.default import Provider @@ -32,7 +32,7 @@ class RxrefLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def legacy_parse(cls, value: str) -> Tuple[OutputQuery, Dict[str, str]]: + def legacy_parse(cls, value: str) -> tuple[OutputQuery, dict[str, str]]: """Retain support for legacy lookup syntax. Format of value: @@ -43,9 +43,7 @@ def legacy_parse(cls, value: str) -> Tuple[OutputQuery, Dict[str, str]]: return deconstruct(value), {} @classmethod - def handle( # pylint: disable=arguments-differ - cls, value: str, context: CfnginContext, provider: Provider, **_: Any - ) -> Any: + def handle(cls, value: str, context: CfnginContext, provider: Provider, **_: Any) -> Any: """Fetch an output from the designated stack in the current namespace. The ``output`` lookup supports fetching outputs from stacks created diff --git a/runway/cfngin/lookups/handlers/split.py b/runway/cfngin/lookups/handlers/split.py index 0b4b0e5c8..0fd0b9d1a 100644 --- a/runway/cfngin/lookups/handlers/split.py +++ b/runway/cfngin/lookups/handlers/split.py @@ -1,9 +1,9 @@ """Split lookup.""" # pyright: reportIncompatibleMethodOverride=none -from typing import Any, List +from typing import Any, Final -from typing_extensions import Final, Literal +from typing_extensions import Literal from ....lookups.handlers.base import LookupHandler @@ -15,9 +15,7 @@ class SplitLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def handle( # pylint: disable=arguments-differ - cls, value: str, **_: Any - ) -> List[str]: + def handle(cls, value: str, **_: Any) -> list[str]: """Split the supplied string on the given delimiter, providing a list. Args: diff --git a/runway/cfngin/lookups/handlers/xref.py b/runway/cfngin/lookups/handlers/xref.py index a5a7a1747..a057e68de 100644 --- a/runway/cfngin/lookups/handlers/xref.py +++ b/runway/cfngin/lookups/handlers/xref.py @@ -4,14 +4,14 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Final from ....lookups.handlers.base import LookupHandler from .output import deconstruct if TYPE_CHECKING: + from typing_extensions import Literal + from ...providers.aws.default import Provider LOGGER = logging.getLogger(__name__) @@ -27,9 +27,7 @@ class XrefLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def handle( # pylint: disable=arguments-differ,arguments-renamed - cls, value: str, provider: Provider, **_: Any - ) -> str: + def handle(cls, value: str, provider: Provider, **_: Any) -> str: """Fetch an output from the designated, fully qualified stack. The `output` handler supports fetching outputs from stacks created diff --git a/runway/cfngin/lookups/registry.py b/runway/cfngin/lookups/registry.py index eac3e2e34..bf72124a0 100644 --- a/runway/cfngin/lookups/registry.py +++ b/runway/cfngin/lookups/registry.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import Dict, Type, Union, cast +from typing import cast from ...lookups.handlers.base import LookupHandler from ...lookups.handlers.cfn import CfnLookup @@ -25,13 +25,11 @@ from .handlers.split import SplitLookup from .handlers.xref import XrefLookup -CFNGIN_LOOKUP_HANDLERS: Dict[str, Type[LookupHandler]] = {} +CFNGIN_LOOKUP_HANDLERS: dict[str, type[LookupHandler]] = {} LOGGER = logging.getLogger(__name__) -def register_lookup_handler( - lookup_type: str, handler_or_path: Union[str, Type[LookupHandler]] -) -> None: +def register_lookup_handler(lookup_type: str, handler_or_path: str | type[LookupHandler]) -> None: """Register a lookup handler. Args: @@ -52,7 +50,7 @@ def register_lookup_handler( CFNGIN_LOOKUP_HANDLERS[lookup_type] = handler return # Handler is a not a new-style handler - except Exception: # pylint: disable=broad-except + except Exception: # noqa: BLE001 LOGGER.debug("failed to validate lookup handler", exc_info=True) LOGGER.error( 'lookup "%s" uses an unsupported format; to learn how to write ' @@ -82,9 +80,7 @@ def unregister_lookup_handler(lookup_type: str) -> None: register_lookup_handler(AmiLookup.TYPE_NAME, AmiLookup) register_lookup_handler(AwsLambdaLookup.TYPE_NAME, AwsLambdaLookup) register_lookup_handler(AwsLambdaLookup.Code.TYPE_NAME, AwsLambdaLookup.Code) -register_lookup_handler( - AwsLambdaLookup.CodeSha256.TYPE_NAME, AwsLambdaLookup.CodeSha256 -) +register_lookup_handler(AwsLambdaLookup.CodeSha256.TYPE_NAME, AwsLambdaLookup.CodeSha256) register_lookup_handler( AwsLambdaLookup.CompatibleArchitectures.TYPE_NAME, AwsLambdaLookup.CompatibleArchitectures, @@ -93,15 +89,11 @@ def unregister_lookup_handler(lookup_type: str) -> None: AwsLambdaLookup.CompatibleRuntimes.TYPE_NAME, AwsLambdaLookup.CompatibleRuntimes ) register_lookup_handler(AwsLambdaLookup.Content.TYPE_NAME, AwsLambdaLookup.Content) -register_lookup_handler( - AwsLambdaLookup.LicenseInfo.TYPE_NAME, AwsLambdaLookup.LicenseInfo -) +register_lookup_handler(AwsLambdaLookup.LicenseInfo.TYPE_NAME, AwsLambdaLookup.LicenseInfo) register_lookup_handler(AwsLambdaLookup.Runtime.TYPE_NAME, AwsLambdaLookup.Runtime) register_lookup_handler(AwsLambdaLookup.S3Bucket.TYPE_NAME, AwsLambdaLookup.S3Bucket) register_lookup_handler(AwsLambdaLookup.S3Key.TYPE_NAME, AwsLambdaLookup.S3Key) -register_lookup_handler( - AwsLambdaLookup.S3ObjectVersion.TYPE_NAME, AwsLambdaLookup.S3ObjectVersion -) +register_lookup_handler(AwsLambdaLookup.S3ObjectVersion.TYPE_NAME, AwsLambdaLookup.S3ObjectVersion) register_lookup_handler(CfnLookup.TYPE_NAME, CfnLookup) register_lookup_handler(DefaultLookup.TYPE_NAME, DefaultLookup) register_lookup_handler(DynamodbLookup.TYPE_NAME, DynamodbLookup) diff --git a/runway/cfngin/plan.py b/runway/cfngin/plan.py index c5f7c059e..af503563e 100644 --- a/runway/cfngin/plan.py +++ b/runway/cfngin/plan.py @@ -4,22 +4,16 @@ import json import logging -import os import threading import time import uuid +from pathlib import Path from typing import ( TYPE_CHECKING, Any, Callable, - Dict, - List, NoReturn, - Optional, - OrderedDict, - Set, TypeVar, - Union, overload, ) @@ -41,6 +35,8 @@ from .utils import stack_template_key_name if TYPE_CHECKING: + from collections import OrderedDict + from ..context import CfnginContext from .providers.aws.default import Provider from .status import Status @@ -51,14 +47,14 @@ @overload -def json_serial(obj: Set[_T]) -> List[_T]: ... +def json_serial(obj: set[_T]) -> list[_T]: ... @overload -def json_serial(obj: Union[Dict[Any, Any], int, List[Any], str]) -> NoReturn: ... +def json_serial(obj: dict[Any, Any] | int | list[Any] | str) -> NoReturn: ... -def json_serial(obj: Union[Set[Any], Any]) -> Any: +def json_serial(obj: set[Any] | Any) -> Any: """Serialize json. Args: @@ -82,10 +78,7 @@ def merge_graphs(graph1: Graph, graph2: Graph) -> Graph: """ merged_graph_dict = merge_dicts(graph1.to_dict().copy(), graph2.to_dict()) - steps = [ - graph1.steps.get(name, graph2.steps.get(name)) - for name in merged_graph_dict.keys() - ] + steps = [graph1.steps.get(name, graph2.steps.get(name)) for name in merged_graph_dict] return Graph.from_steps([step for step in steps if step]) @@ -103,19 +96,19 @@ class Step: """ - fn: Optional[Callable[..., Any]] + fn: Callable[..., Any] | None last_updated: float logger: PrefixAdaptor stack: Stack status: Status - watch_func: Optional[Callable[..., Any]] + watch_func: Callable[..., Any] | None def __init__( self, stack: Stack, *, - fn: Optional[Callable[..., Any]] = None, - watch_func: Optional[Callable[..., Any]] = None, + fn: Callable[..., Any] | None = None, + watch_func: Callable[..., Any] | None = None, ) -> None: """Instantiate class. @@ -139,9 +132,7 @@ def run(self) -> bool: stop_watcher = threading.Event() watcher = None if self.watch_func: - watcher = threading.Thread( - target=self.watch_func, args=(self.stack, stop_watcher) - ) + watcher = threading.Thread(target=self.watch_func, args=(self.stack, stop_watcher)) watcher.start() try: @@ -161,7 +152,7 @@ def _run_once(self) -> Status: status = self.fn(self.stack, status=self.status) except CancelExecution: status = SkippedStatus("canceled execution") - except Exception as err: # pylint: disable=broad-except + except Exception as err: LOGGER.exception(err) status = FailedStatus(reason=str(err)) self.set_status(status) @@ -177,12 +168,12 @@ def name(self) -> str: return self.stack.name @property - def requires(self) -> Set[str]: + def requires(self) -> set[str]: """Return a list of step names this step depends on.""" return self.stack.requires @property - def required_by(self) -> Set[str]: + def required_by(self) -> set[str]: """Return a list of step names that depend on this step.""" return self.stack.required_by @@ -265,9 +256,9 @@ def from_stack_name( cls, stack_name: str, context: CfnginContext, - requires: Optional[Union[List[str], Set[str]]] = None, - fn: Optional[Callable[..., Status]] = None, - watch_func: Optional[Callable[..., Any]] = None, + requires: list[str] | set[str] | None = None, + fn: Callable[..., Status] | None = None, + watch_func: Callable[..., Any] | None = None, ) -> Step: """Create a step using only a stack name. @@ -282,25 +273,20 @@ def from_stack_name( step action. """ - # pylint: disable=import-outside-toplevel from runway.config.models.cfngin import CfnginStackDefinitionModel - stack_def = CfnginStackDefinitionModel.construct( - name=stack_name, requires=requires or [] - ) + stack_def = CfnginStackDefinitionModel.construct(name=stack_name, requires=requires or []) stack = Stack(stack_def, context) return cls(stack, fn=fn, watch_func=watch_func) @classmethod def from_persistent_graph( cls, - graph_dict: Union[ - Dict[str, List[str]], Dict[str, Set[str]], OrderedDict[str, Set[str]] - ], + graph_dict: dict[str, list[str]] | dict[str, set[str]] | OrderedDict[str, set[str]], context: CfnginContext, - fn: Optional[Callable[..., Status]] = None, - watch_func: Optional[Callable[..., Any]] = None, - ) -> List[Step]: + fn: Callable[..., Status] | None = None, + watch_func: Callable[..., Any] | None = None, + ) -> list[Step]: """Create a steps for a persistent graph dict. Args: @@ -347,11 +333,9 @@ class Graph: """ dag: DAG - steps: Dict[str, Step] + steps: dict[str, Step] - def __init__( - self, steps: Optional[Dict[str, Step]] = None, dag: Optional[DAG] = None - ) -> None: + def __init__(self, steps: dict[str, Step] | None = None, dag: DAG | None = None) -> None: """Instantiate class. Args: @@ -423,7 +407,7 @@ def add_step_if_not_exists( except GraphError: continue - def add_steps(self, steps: List[Step]) -> None: + def add_steps(self, steps: list[Step]) -> None: """Add a list of steps. Args: @@ -501,7 +485,7 @@ def fn(step_name: str) -> Any: return walker(self.dag, fn) - def downstream(self, step_name: str) -> List[Step]: + def downstream(self, step_name: str) -> list[Step]: """Return the direct dependencies of the given step.""" return [self.steps[dep] for dep in self.dag.downstream(step_name)] @@ -513,7 +497,7 @@ def transposed(self) -> Graph: """ return Graph(steps=self.steps, dag=self.dag.transpose()) - def filtered(self, step_names: List[str]) -> Graph: + def filtered(self, step_names: list[str]) -> Graph: """Return a "filtered" version of this graph. Args: @@ -522,16 +506,16 @@ def filtered(self, step_names: List[str]) -> Graph: """ return Graph(steps=self.steps, dag=self.dag.filter(step_names)) - def topological_sort(self) -> List[Step]: + def topological_sort(self) -> list[Step]: """Perform a topological sort of the underlying DAG.""" nodes = self.dag.topological_sort() return [self.steps[step_name] for step_name in nodes] - def to_dict(self) -> OrderedDict[str, Set[str]]: + def to_dict(self) -> OrderedDict[str, set[str]]: """Return the underlying DAG as a dictionary.""" return self.dag.graph - def dumps(self, indent: Optional[int] = None) -> str: + def dumps(self, indent: int | None = None) -> str: """Output the graph as a json serialized string for storage. Args: @@ -543,9 +527,7 @@ def dumps(self, indent: Optional[int] = None) -> str: @classmethod def from_dict( cls, - graph_dict: Union[ - Dict[str, List[str]], Dict[str, Set[str]], OrderedDict[str, Set[str]] - ], + graph_dict: dict[str, list[str]] | dict[str, set[str]] | OrderedDict[str, set[str]], context: CfnginContext, ) -> Graph: """Create a Graph from a graph dict. @@ -558,7 +540,7 @@ def from_dict( return cls.from_steps(Step.from_persistent_graph(graph_dict, context)) @classmethod - def from_steps(cls, steps: List[Step]) -> Graph: + def from_steps(cls, steps: list[Step]) -> Graph: """Create a Graph from Steps. Args: @@ -588,7 +570,7 @@ class Plan: """ - context: Optional[CfnginContext] + context: CfnginContext | None description: str graph: Graph id: uuid.UUID @@ -599,7 +581,7 @@ def __init__( self, description: str, graph: Graph, - context: Optional[CfnginContext] = None, + context: CfnginContext | None = None, reverse: bool = False, require_unlocked: bool = True, ) -> None: @@ -627,11 +609,7 @@ def __init__( self.locked = self.context.persistent_graph_locked if self.context.stack_names: - nodes = [ - target - for target in self.context.stack_names - if graph.steps.get(target) - ] + nodes = [target for target in self.context.stack_names if graph.steps.get(target)] graph = graph.filtered(nodes) else: @@ -639,7 +617,7 @@ def __init__( self.graph = graph - def outline(self, level: int = logging.INFO, message: str = ""): + def outline(self, level: int = logging.INFO, message: str = "") -> None: """Print an outline of the actions the plan is going to take. The outline will represent the rough ordering of the steps that will be @@ -669,7 +647,7 @@ def dump( *, directory: str, context: CfnginContext, - provider: Optional[Provider] = None, + provider: Provider | None = None, ) -> Any: """Output the rendered blueprint for all stacks in the plan. @@ -680,30 +658,26 @@ def dump( """ LOGGER.info('dumping "%s"...', self.description) - directory = os.path.expanduser(directory) - if not os.path.exists(directory): - os.makedirs(directory) + dir_path = Path(directory).expanduser() + dir_path.mkdir(exist_ok=True, parents=True) def walk_func(step: Step) -> bool: """Walk function.""" step.stack.resolve(context=context, provider=provider) blueprint = step.stack.blueprint filename = stack_template_key_name(blueprint) - path = os.path.join(directory, filename) - - blueprint_dir = os.path.dirname(path) - if not os.path.exists(blueprint_dir): - os.makedirs(blueprint_dir) + path = dir_path / filename + path.parent.mkdir(exist_ok=True, parents=True) LOGGER.info('writing stack "%s" -> %s', step.name, path) - with open(path, "w", encoding="utf-8") as _file: + with Path(path).open("w", encoding="utf-8") as _file: _file.write(blueprint.rendered) return True return self.graph.walk(walk, walk_func) - def execute(self, *args: Any, **kwargs: Any): + def execute(self, *args: Any, **kwargs: Any) -> None: """Walk each step in the underlying graph. Raises: @@ -752,15 +726,12 @@ def walk_func(step: Step) -> bool: return result if step.completed or ( - step.skipped - and step.status.reason == ("does not exist in cloudformation") + step.skipped and step.status.reason == ("does not exist in cloudformation") ): fn_name = step.fn.__name__ if callable(step.fn) else step.fn if fn_name == "_destroy_stack": self.context.persistent_graph.pop(step) - LOGGER.debug( - "removed step '%s' from the persistent graph", step.name - ) + LOGGER.debug("removed step '%s' from the persistent graph", step.name) elif fn_name == "_launch_stack": self.context.persistent_graph.add_step_if_not_exists( step, add_dependencies=True, add_dependents=True @@ -779,17 +750,17 @@ def lock_code(self) -> str: return str(self.id) @property - def steps(self) -> List[Step]: + def steps(self) -> list[Step]: """Return a list of all steps in the plan.""" steps = self.graph.topological_sort() steps.reverse() return steps @property - def step_names(self) -> List[str]: + def step_names(self) -> list[str]: """Return a list of all step names.""" return [step.name for step in self.steps] - def keys(self) -> List[str]: + def keys(self) -> list[str]: """Return a list of all step names.""" return self.step_names diff --git a/runway/cfngin/providers/aws/default.py b/runway/cfngin/providers/aws/default.py index b91e707e5..763f71cf4 100644 --- a/runway/cfngin/providers/aws/default.py +++ b/runway/cfngin/providers/aws/default.py @@ -1,23 +1,19 @@ """Default AWS Provider.""" -# pylint: disable=too-many-lines,too-many-public-methods from __future__ import annotations +import functools import json import logging +import operator import sys import threading import time +from collections.abc import Iterable from typing import ( TYPE_CHECKING, Any, Callable, - Dict, - Iterable, - List, - Optional, - Set, - Tuple, Union, cast, ) @@ -88,7 +84,7 @@ def get_cloudformation_client(session: boto3.Session) -> CloudFormationClient: return session.client("cloudformation", config=config) -def get_output_dict(stack: StackTypeDef) -> Dict[str, str]: +def get_output_dict(stack: StackTypeDef) -> dict[str, str]: """Return a dict of key/values for the outputs for a given CF stack. Args: @@ -112,11 +108,11 @@ def get_output_dict(stack: StackTypeDef) -> Dict[str, str]: def s3_fallback( fqn: str, template: Template, - parameters: List[ParameterTypeDef], - tags: List[TagTypeDef], + parameters: list[ParameterTypeDef], + tags: list[TagTypeDef], method: Callable[..., Any], - change_set_name: Optional[str] = None, - service_role: Optional[str] = None, + change_set_name: str | None = None, + service_role: str | None = None, ) -> Any: """Falling back to legacy CFNgin S3 bucket region for templates.""" LOGGER.warning( @@ -132,7 +128,9 @@ def s3_fallback( template_url = template.url if template_url: template_url_parsed = urlparse(template_url) - template_url_parsed = template_url_parsed._replace(netloc="s3.amazonaws.com") + template_url_parsed = template_url_parsed._replace( # noqa: SLF001 + netloc="s3.amazonaws.com" + ) template_url = urlunparse(template_url_parsed) LOGGER.debug("using template_url: %s", template_url) args = generate_cloudformation_args( @@ -160,25 +158,21 @@ def get_change_set_name() -> str: return f"change-set-{int(time.time())}" -def requires_replacement(changeset: List[ChangeTypeDef]) -> List[ChangeTypeDef]: +def requires_replacement(changeset: list[ChangeTypeDef]) -> list[ChangeTypeDef]: """Return the changes within the changeset that require replacement. Args: changeset: List of changes """ - return [ - r - for r in changeset - if r.get("ResourceChange", {}).get("Replacement", False) == "True" - ] + return [r for r in changeset if r.get("ResourceChange", {}).get("Replacement", False) == "True"] def output_full_changeset( - full_changeset: Optional[List[ChangeTypeDef]] = None, - params_diff: Optional[List[DictValue[Any, Any]]] = None, - answer: Optional[str] = None, - fqn: Optional[str] = None, + full_changeset: list[ChangeTypeDef] | None = None, + params_diff: list[DictValue[Any, Any]] | None = None, + answer: str | None = None, + fqn: str | None = None, ) -> None: """Optionally output full changeset. @@ -211,10 +205,10 @@ def output_full_changeset( def ask_for_approval( - full_changeset: Optional[List[ChangeTypeDef]] = None, - params_diff: Optional[List[DictValue[Any, Any]]] = None, + full_changeset: list[ChangeTypeDef] | None = None, + params_diff: list[DictValue[Any, Any]] | None = None, include_verbose: bool = False, - fqn: Optional[str] = None, + fqn: str | None = None, ) -> None: """Prompt the user for approval to execute a change set. @@ -234,9 +228,7 @@ def ask_for_approval( if include_verbose: approval_options.append("v") - approve = ui.ask( - f"Execute the above changes? [{'/'.join(approval_options)}] " - ).lower() + approve = ui.ask(f"Execute the above changes? [{'/'.join(approval_options)}] ").lower() if include_verbose and approve == "v": output_full_changeset( @@ -254,8 +246,8 @@ def ask_for_approval( def output_summary( fqn: str, action: str, - changeset: List[ChangeTypeDef], - params_diff: List[DictValue[Any, Any]], + changeset: list[ChangeTypeDef], + params_diff: list[DictValue[Any, Any]], replacements_only: bool = False, ) -> None: """Log a summary of the changeset. @@ -271,8 +263,8 @@ def output_summary( replacements. """ - replacements: List[Any] = [] - changes: List[Any] = [] + replacements: list[Any] = [] + changes: list[Any] = [] for change in changeset: resource = change.get("ResourceChange", {}) replacement = resource.get("Replacement", "") == "True" @@ -299,12 +291,12 @@ def output_summary( LOGGER.info("%s %s:\n%s", fqn, action, summary) -def format_params_diff(params_diff: List[DictValue[Any, Any]]) -> str: +def format_params_diff(params_diff: list[DictValue[Any, Any]]) -> str: """Wrap :func:`runway.cfngin.actions.diff.format_params_diff` for testing.""" return format_diff(params_diff) -def summarize_params_diff(params_diff: List[DictValue[Any, Any]]) -> str: +def summarize_params_diff(params_diff: list[DictValue[Any, Any]]) -> str: """Summarize parameter diff.""" summary = "" @@ -366,15 +358,13 @@ def create_change_set( cfn_client: CloudFormationClient, fqn: str, template: Template, - parameters: List[ParameterTypeDef], - tags: List[TagTypeDef], + parameters: list[ParameterTypeDef], + tags: list[TagTypeDef], change_set_type: str = "UPDATE", - service_role: Optional[str] = None, -) -> Tuple[List[ChangeTypeDef], str]: + service_role: str | None = None, +) -> tuple[list[ChangeTypeDef], str]: """Create CloudFormation change set.""" - LOGGER.debug( - "attempting to create change set of type %s for stack: %s", change_set_type, fqn - ) + LOGGER.debug("attempting to create change set of type %s for stack: %s", change_set_type, fqn) args = generate_cloudformation_args( fqn, parameters, @@ -410,20 +400,16 @@ def create_change_set( "didn't contain changes" in status_reason or "No updates are to be performed" in status_reason ): - LOGGER.debug( - "%s:stack did not change; not updating and removing changeset", fqn - ) + LOGGER.debug("%s:stack did not change; not updating and removing changeset", fqn) cfn_client.delete_change_set(ChangeSetName=change_set_id) - raise exceptions.StackDidNotChange() + raise exceptions.StackDidNotChange LOGGER.warning( "got strange status, '%s' for changeset '%s'; not deleting for " "further investigation - you will need to delete the changeset manually", status, change_set_id, ) - raise exceptions.UnhandledChangeSetStatus( - fqn, change_set_id, status, status_reason - ) + raise exceptions.UnhandledChangeSetStatus(fqn, change_set_id, status, status_reason) execution_status = response["ExecutionStatus"] if execution_status != "AVAILABLE": @@ -433,7 +419,7 @@ def create_change_set( return changes, change_set_id -def check_tags_contain(actual: List[TagTypeDef], expected: List[TagTypeDef]) -> bool: +def check_tags_contain(actual: list[TagTypeDef], expected: list[TagTypeDef]) -> bool: """Check if a set of AWS resource tags is contained in another. Every tag key in ``expected`` must be present in ``actual``, and have the @@ -455,15 +441,15 @@ def check_tags_contain(actual: List[TagTypeDef], expected: List[TagTypeDef]) -> def generate_cloudformation_args( stack_name: str, - parameters: List[ParameterTypeDef], - tags: List[TagTypeDef], + parameters: list[ParameterTypeDef], + tags: list[TagTypeDef], template: Template, - capabilities: Optional[List[str]] = None, - change_set_type: Optional[str] = None, - service_role: Optional[str] = None, - stack_policy: Optional[Template] = None, - change_set_name: Optional[str] = None, -) -> Dict[str, Any]: + capabilities: list[str] | None = None, + change_set_type: str | None = None, + service_role: str | None = None, + stack_policy: Template | None = None, + change_set_name: str | None = None, +) -> dict[str, Any]: """Generate the args for common CloudFormation API interactions. This is used for ``create_stack``/``update_stack``/``create_change_set`` @@ -505,9 +491,7 @@ def generate_cloudformation_args( elif template.body: args["TemplateBody"] = template.body else: - raise ValueError( - "either template.body or template.url is required; neither were provided" - ) + raise ValueError("either template.body or template.url is required; neither were provided") # When creating args for CreateChangeSet, don't include the stack policy, # since ChangeSets don't support it. @@ -518,15 +502,15 @@ def generate_cloudformation_args( def generate_stack_policy_args( - stack_policy: Optional[Template] = None, -) -> Dict[str, str]: + stack_policy: Template | None = None, +) -> dict[str, str]: """Convert a stack policy object into keyword args. Args: stack_policy: A template object representing a stack policy. """ - args: Dict[str, str] = {} + args: dict[str, str] = {} if stack_policy: LOGGER.debug("stack has a stack policy") if stack_policy.url: @@ -544,21 +528,19 @@ def generate_stack_policy_args( class ProviderBuilder: """Implements a Memorized ProviderBuilder for the AWS provider.""" - kwargs: Dict[str, Any] + kwargs: dict[str, Any] lock: threading.Lock - providers: Dict[str, Provider] - region: Optional[str] + providers: dict[str, Provider] + region: str | None - def __init__(self, *, region: Optional[str] = None, **kwargs: Any) -> None: + def __init__(self, *, region: str | None = None, **kwargs: Any) -> None: """Instantiate class.""" self.region = region self.kwargs = kwargs self.providers = {} self.lock = threading.Lock() - def build( - self, *, profile: Optional[str] = None, region: Optional[str] = None - ) -> Provider: + def build(self, *, profile: str | None = None, region: str | None = None) -> Provider: """Get or create the provider for the given region and profile.""" with self.lock: # memorization lookup key derived from region + profile. @@ -567,9 +549,7 @@ def build( # assume provider is in provider dictionary. provider = self.providers[key] except KeyError: - LOGGER.debug( - "missed memorized lookup (%s); creating new AWS provider", key - ) + LOGGER.debug("missed memorized lookup (%s); creating new AWS provider", key) if not region: region = self.region # memoize the result for later. @@ -627,9 +607,9 @@ class Provider(BaseProvider): cloudformation: CloudFormationClient interactive: bool recreate_failed: bool - region: Optional[str] + region: str | None replacements_only: bool - service_role: Optional[str] + service_role: str | None def __init__( self, @@ -637,12 +617,12 @@ def __init__( *, interactive: bool = False, recreate_failed: bool = False, - region: Optional[str] = None, + region: str | None = None, replacements_only: bool = False, - service_role: Optional[str] = None, - ): + service_role: str | None = None, + ) -> None: """Instantiate class.""" - self._outputs: Dict[str, Dict[str, str]] = {} + self._outputs: dict[str, dict[str, str]] = {} self.cloudformation = get_cloudformation_client(session) self.interactive = interactive self.recreate_failed = interactive or recreate_failed @@ -654,13 +634,11 @@ def __init__( def get_stack(self, stack_name: str, *_args: Any, **_kwargs: Any) -> StackTypeDef: """Get stack.""" try: - return self.cloudformation.describe_stacks(StackName=stack_name)["Stacks"][ - 0 - ] + return self.cloudformation.describe_stacks(StackName=stack_name)["Stacks"][0] except botocore.exceptions.ClientError as err: if "does not exist" not in str(err): raise - raise exceptions.StackDoesNotExist(stack_name) + raise exceptions.StackDoesNotExist(stack_name) from None @staticmethod def get_stack_status(stack: StackTypeDef, *_args: Any, **_kwargs: Any) -> str: @@ -668,7 +646,7 @@ def get_stack_status(stack: StackTypeDef, *_args: Any, **_kwargs: Any) -> str: return stack["StackStatus"] @staticmethod - def get_stack_status_reason(stack: StackTypeDef) -> Optional[str]: + def get_stack_status_reason(stack: StackTypeDef) -> str | None: """Get stack status reason.""" return stack.get("StackStatusReason") @@ -712,9 +690,9 @@ def tail_stack( self, stack: Stack, cancel: threading.Event, - action: Optional[str] = None, - log_func: Optional[Callable[[StackEventTypeDef], None]] = None, - retries: Optional[int] = None, + action: str | None = None, + log_func: Callable[[StackEventTypeDef], None] | None = None, + retries: int | None = None, ) -> None: """Tail the events of a stack.""" @@ -740,19 +718,13 @@ def _log_func(event: StackEventTypeDef) -> None: while True: attempts += 1 try: - self.tail( - stack.fqn, cancel=cancel, log_func=log_func, include_initial=False - ) + self.tail(stack.fqn, cancel=cancel, log_func=log_func, include_initial=False) break except botocore.exceptions.ClientError as err: if "does not exist" in str(err): - LOGGER.debug( - "%s:unable to tail stack; it does not exist", stack.fqn - ) + LOGGER.debug("%s:unable to tail stack; it does not exist", stack.fqn) if action == "destroy": - LOGGER.debug( - "%s:stack was deleted before it could be tailed", stack.fqn - ) + LOGGER.debug("%s:stack was deleted before it could be tailed", stack.fqn) return if attempts < retries: # stack might be in the process of launching, wait for a @@ -768,7 +740,7 @@ def _tail_print(event: StackEventTypeDef) -> None: f'{event.get("ResourceStatus")} {event.get("ResourceType")} {event.get("EventId")}' ) - def get_delete_failed_status_reason(self, stack_name: str) -> Optional[str]: + def get_delete_failed_status_reason(self, stack_name: str) -> str | None: """Process events and return latest delete failed reason. Args: @@ -778,17 +750,14 @@ def get_delete_failed_status_reason(self, stack_name: str) -> Optional[str]: Reason for the Stack's DELETE_FAILED status if one can be found. """ - event: Union[Dict[str, str], StackEventTypeDef] = ( - self.get_event_by_resource_status( - stack_name, "DELETE_FAILED", chronological=True - ) - or {} + event: Union[dict[str, str], StackEventTypeDef] = ( + self.get_event_by_resource_status(stack_name, "DELETE_FAILED", chronological=True) or {} ) return event.get("ResourceStatusReason") def get_event_by_resource_status( self, stack_name: str, status: str, *, chronological: bool = True - ) -> Optional[StackEventTypeDef]: + ) -> StackEventTypeDef | None: """Get Stack Event of a given set of resource status. Args: @@ -815,7 +784,7 @@ def get_events( ) -> Iterable[StackEventTypeDef]: """Get the events in batches and return in chronological order.""" next_token = None - event_list: List[List[StackEventTypeDef]] = [] + event_list: list[list[StackEventTypeDef]] = [] while True: if next_token is not None: events = self.cloudformation.describe_stack_events( @@ -831,13 +800,11 @@ def get_events( if chronological: return cast( Iterable["StackEventTypeDef"], - reversed( - cast(List["StackEventTypeDef"], sum(event_list, [])) # type: ignore - ), + reversed(cast("list[StackEventTypeDef]", functools.reduce(operator.iadd, event_list, []))), # type: ignore ) - return cast(Iterable["StackEventTypeDef"], sum(event_list, [])) # type: ignore + return cast(Iterable["StackEventTypeDef"], functools.reduce(operator.iadd, event_list, [])) # type: ignore - def get_rollback_status_reason(self, stack_name: str) -> Optional[str]: + def get_rollback_status_reason(self, stack_name: str) -> str | None: """Process events and returns latest roll back reason. Args: @@ -847,7 +814,7 @@ def get_rollback_status_reason(self, stack_name: str) -> Optional[str]: Reason for the Stack's rollback status if one can be found. """ - event: Union[Dict[str, str], StackEventTypeDef] = ( + event: Union[dict[str, str], StackEventTypeDef] = ( self.get_event_by_resource_status( stack_name, "UPDATE_ROLLBACK_IN_PROGRESS", chronological=False ) @@ -869,7 +836,7 @@ def tail( """Show and then tail the event log.""" # First dump the full list of events in chronological order and keep # track of the events we've seen already - seen: Set[str] = set() + seen: set[str] = set() initial_events = self.get_events(stack_name) for event in initial_events: if include_initial: @@ -891,7 +858,7 @@ def destroy_stack( stack: StackTypeDef, *, action: str = "destroy", - approval: Optional[str] = None, + approval: str | None = None, force_interactive: bool = False, **kwargs: Any, ) -> None: @@ -902,15 +869,14 @@ def destroy_stack( action: Name of the action being executed. This impacts the log message used. approval: Response to approval prompt. force_interactive: Always ask for approval. + **kwargs: Arbitrary keyword arguments. """ fqn = self.get_stack_name(stack) LOGGER.debug("%s:attempting to delete stack", fqn) if action == "deploy": - LOGGER.info( - "%s:removed from the CFNgin config file; it is being destroyed", fqn - ) + LOGGER.info("%s:removed from the CFNgin config file; it is being destroyed", fqn) destroy_method = self.select_destroy_method(force_interactive) return destroy_method(fqn=fqn, action=action, approval=approval, **kwargs) @@ -919,13 +885,13 @@ def create_stack( self, fqn: str, template: Template, - parameters: List[ParameterTypeDef], - tags: List[TagTypeDef], + parameters: list[ParameterTypeDef], + tags: list[TagTypeDef], *, force_change_set: bool = False, - stack_policy: Optional[Template] = None, + stack_policy: Template | None = None, termination_protection: bool = False, - timeout: Optional[int] = None, + timeout: int | None = None, **kwargs: Any, ) -> None: """Create a new Cloudformation stack. @@ -943,14 +909,13 @@ def create_stack( protection. timeout: The amount of time that can pass before the stack status becomes ``CREATE_FAILED``. + **kwargs: Arbitrary keyword arguments. """ LOGGER.debug( "attempting to create stack %s: %s", fqn, - json.dumps( - {"parameters": parameters, "tags": tags, "template_url": template.url} - ), + json.dumps({"parameters": parameters, "tags": tags, "template_url": template.url}), ) if not template.url: LOGGER.debug("no template url; uploading template directly") @@ -988,8 +953,7 @@ def create_stack( self.cloudformation.create_stack(**args) except botocore.exceptions.ClientError as err: if err.response["Error"]["Message"] == ( - "TemplateURL must reference a valid S3 object to which you " - "have access." + "TemplateURL must reference a valid S3 object to which you have access." ): s3_fallback( fqn, @@ -1022,9 +986,7 @@ def select_update_method( return self.noninteractive_changeset_update return self.default_update_stack - def prepare_stack_for_update( - self, stack: StackTypeDef, tags: List[TagTypeDef] - ) -> bool: + def prepare_stack_for_update(self, stack: StackTypeDef, tags: list[TagTypeDef]) -> bool: """Prepare a stack for updating. It may involve deleting the stack if is has failed it's initial @@ -1076,8 +1038,7 @@ def prepare_stack_for_update( raise exceptions.StackUpdateBadStatus( stack_name, stack_status, - "Tags differ from current configuration, possibly not created " - "with CFNgin", + "Tags differ from current configuration, possibly not created with CFNgin", ) if self.interactive: @@ -1100,12 +1061,12 @@ def update_stack( self, fqn: str, template: Template, - old_parameters: List[ParameterTypeDef], - parameters: List[ParameterTypeDef], - tags: List[TagTypeDef], + old_parameters: list[ParameterTypeDef], + parameters: list[ParameterTypeDef], + tags: list[TagTypeDef], force_interactive: bool = False, force_change_set: bool = False, - stack_policy: Optional[Template] = None, + stack_policy: Template | None = None, termination_protection: bool = False, **kwargs: Any, ) -> None: @@ -1128,14 +1089,13 @@ def update_stack( executed with a change set. stack_policy: A template object representing a stack policy. termination_protection: End state of the stack's termination protection. + **kwargs: Arbitrary keyword arguments. """ LOGGER.debug( "attempting to update stack %s: %s", fqn, - json.dumps( - {"parameters": parameters, "tags": tags, "template_url": template.url} - ), + json.dumps({"parameters": parameters, "tags": tags, "template_url": template.url}), ) if not template.url: LOGGER.debug("no template url; uploading template directly") @@ -1152,9 +1112,7 @@ def update_stack( **kwargs, ) - def update_termination_protection( - self, fqn: str, termination_protection: bool - ) -> None: + def update_termination_protection(self, fqn: str, termination_protection: bool) -> None: """Update a Stack's termination protection if needed. Runs before the normal stack update process. @@ -1177,7 +1135,7 @@ def update_termination_protection( ) def deal_with_changeset_stack_policy( - self, fqn: str, stack_policy: Optional[Template] = None + self, fqn: str, stack_policy: Template | None = None ) -> None: """Set a stack policy when using changesets. @@ -1197,13 +1155,14 @@ def deal_with_changeset_stack_policy( self.cloudformation.set_stack_policy(**kwargs) def interactive_destroy_stack( - self, fqn: str, approval: Optional[str] = None, **kwargs: Any + self, fqn: str, approval: str | None = None, **kwargs: Any ) -> None: """Delete a CloudFormation stack in interactive mode. Args: fqn: A fully qualified stack name. approval: Response to approval prompt. + **kwargs: Arbitrary keyword arguments. """ LOGGER.debug("%s:using interactive provider mode", fqn) @@ -1242,10 +1201,10 @@ def interactive_update_stack( self, fqn: str, template: Template, - old_parameters: List[ParameterTypeDef], - parameters: List[ParameterTypeDef], + old_parameters: list[ParameterTypeDef], + parameters: list[ParameterTypeDef], stack_policy: Template, - tags: List[TagTypeDef], + tags: list[TagTypeDef], ) -> None: """Update a Cloudformation stack in interactive mode. @@ -1279,9 +1238,7 @@ def interactive_update_stack( if "ParameterValue" in x else { "ParameterKey": x["ParameterKey"], # type: ignore - "ParameterValue": old_parameters_as_dict[ - x["ParameterKey"] # type: ignore - ], + "ParameterValue": old_parameters_as_dict[x["ParameterKey"]], # type: ignore } ) for x in parameters @@ -1328,14 +1285,14 @@ def noninteractive_destroy_stack(self, fqn: str, **_kwargs: Any) -> None: self.cloudformation.delete_stack(**args) - def noninteractive_changeset_update( # pylint: disable=unused-argument + def noninteractive_changeset_update( self, fqn: str, template: Template, - old_parameters: List[ParameterTypeDef], - parameters: List[ParameterTypeDef], - stack_policy: Optional[Template], - tags: List[TagTypeDef], + old_parameters: list[ParameterTypeDef], # noqa: ARG002 + parameters: list[ParameterTypeDef], + stack_policy: Template | None, + tags: list[TagTypeDef], ) -> None: """Update a Cloudformation stack using a change set. @@ -1383,14 +1340,14 @@ def select_destroy_method(self, force_interactive: bool) -> Callable[..., None]: return self.interactive_destroy_stack return self.noninteractive_destroy_stack - def default_update_stack( # pylint: disable=unused-argument + def default_update_stack( self, fqn: str, template: Template, - old_parameters: List[ParameterTypeDef], - parameters: List[ParameterTypeDef], - tags: List[TagTypeDef], - stack_policy: Optional[Template] = None, + old_parameters: list[ParameterTypeDef], # noqa: ARG002 + parameters: list[ParameterTypeDef], + tags: list[TagTypeDef], + stack_policy: Template | None = None, ) -> None: """Update a Cloudformation stack in default mode. @@ -1421,7 +1378,7 @@ def default_update_stack( # pylint: disable=unused-argument except botocore.exceptions.ClientError as err: if "No updates are to be performed." in str(err): LOGGER.debug("%s:stack did not change; not updating", fqn) - raise exceptions.StackDidNotChange + raise exceptions.StackDidNotChange from None if err.response["Error"]["Message"] == ( "TemplateURL must reference a valid S3 object to which you have access." ): @@ -1441,13 +1398,11 @@ def get_stack_name(stack: StackTypeDef) -> str: return stack["StackName"] @staticmethod - def get_stack_tags(stack: StackTypeDef) -> List[TagTypeDef]: + def get_stack_tags(stack: StackTypeDef) -> list[TagTypeDef]: """Get stack tags.""" return stack.get("Tags", []) - def get_outputs( - self, stack_name: str, *_args: Any, **_kwargs: Any - ) -> Dict[str, str]: + def get_outputs(self, stack_name: str, *_args: Any, **_kwargs: Any) -> dict[str, str]: """Get stack outputs.""" if not self._outputs.get(stack_name): stack = self.get_stack(stack_name) @@ -1455,24 +1410,20 @@ def get_outputs( return self._outputs[stack_name] @staticmethod - def get_output_dict(stack: StackTypeDef) -> Dict[str, str]: + def get_output_dict(stack: StackTypeDef) -> dict[str, str]: """Get stack outputs dict.""" return get_output_dict(stack) - def get_stack_info( - self, stack: StackTypeDef - ) -> Tuple[str, Dict[str, Union[List[str], str]]]: + def get_stack_info(self, stack: StackTypeDef) -> tuple[str, dict[str, Union[list[str], str]]]: """Get the template and parameters of the stack currently in AWS.""" stack_name = stack.get("StackId", "None") try: - template = self.cloudformation.get_template(StackName=stack_name)[ - "TemplateBody" - ] + template = self.cloudformation.get_template(StackName=stack_name)["TemplateBody"] except botocore.exceptions.ClientError as err: if "does not exist" not in str(err): raise - raise exceptions.StackDoesNotExist(stack_name) + raise exceptions.StackDoesNotExist(stack_name) from None parameters = self.params_as_dict(stack.get("Parameters", [])) @@ -1482,13 +1433,13 @@ def get_stack_info( return json.dumps(template, cls=JsonEncoder), parameters - def get_stack_changes( + def get_stack_changes( # noqa: C901, PLR0912 self, stack: Stack, template: Template, - parameters: List[ParameterTypeDef], - tags: List[TagTypeDef], - ) -> Dict[str, str]: + parameters: list[ParameterTypeDef], + tags: list[TagTypeDef], + ) -> dict[str, str]: """Get the changes from a ChangeSet. Args: @@ -1509,12 +1460,10 @@ def get_stack_changes( if self.get_stack_status(stack_details) == self.REVIEW_STATUS: raise exceptions.StackDoesNotExist(stack.fqn) old_template_raw, old_params = self.get_stack_info(stack_details) - old_template: Dict[str, Any] = parse_cloudformation_template( - old_template_raw - ) + old_template: dict[str, Any] = parse_cloudformation_template(old_template_raw) change_type = "UPDATE" except exceptions.StackDoesNotExist: - old_params: Dict[str, Union[List[str], str]] = {} + old_params: dict[str, Union[list[str], str]] = {} old_template = {} change_type = "CREATE" @@ -1569,7 +1518,7 @@ def get_stack_changes( self.get_outputs(stack.fqn) # infer which outputs may have changed - refs_to_invalidate: List[str] = [] + refs_to_invalidate: list[str] = [] for change in changes: resc_change = change.get("ResourceChange", {}) if resc_change.get("Type") == "Add": @@ -1629,8 +1578,8 @@ def get_stack_changes( @staticmethod def params_as_dict( - parameters_list: List[ParameterTypeDef], - ) -> Dict[str, Union[List[str], str]]: + parameters_list: list[ParameterTypeDef], + ) -> dict[str, Union[list[str], str]]: """Parameters as dict.""" return { param["ParameterKey"]: param["ParameterValue"] # type: ignore diff --git a/runway/cfngin/providers/base.py b/runway/cfngin/providers/base.py index 24b4d07eb..7007365bc 100644 --- a/runway/cfngin/providers/base.py +++ b/runway/cfngin/providers/base.py @@ -1,7 +1,8 @@ """Provider base class.""" -# pylint: disable=unused-argument -from typing import Any, Optional +from __future__ import annotations + +from typing import Any def not_implemented(method: str) -> None: @@ -12,7 +13,7 @@ def not_implemented(method: str) -> None: class BaseProviderBuilder: """ProviderBuilder base class.""" - def build(self, region: Optional[str] = None) -> Any: + def build(self, region: str | None = None) -> Any: # noqa: ARG002 """Abstract method.""" not_implemented("build") @@ -20,11 +21,11 @@ def build(self, region: Optional[str] = None) -> Any: class BaseProvider: """Provider base class.""" - def get_stack(self, stack_name: str, *args: Any, **kwargs: Any) -> Any: + def get_stack(self, stack_name: str, *_args: Any, **_kwargs: Any) -> Any: # noqa: ARG002 """Abstract method.""" not_implemented("get_stack") - def get_outputs(self, stack_name: str, *args: Any, **kwargs: Any) -> Any: + def get_outputs(self, stack_name: str, *_args: Any, **_kwargs: Any) -> Any: # noqa: ARG002 """Abstract method.""" not_implemented("get_outputs") @@ -42,7 +43,7 @@ class Template: """ - def __init__(self, url: Optional[str] = None, body: Optional[str] = None) -> None: + def __init__(self, url: str | None = None, body: str | None = None) -> None: """Instantiate class.""" self.url = url self.body = body diff --git a/runway/cfngin/session_cache.py b/runway/cfngin/session_cache.py index 48c9ef5f1..cba1b09d2 100644 --- a/runway/cfngin/session_cache.py +++ b/runway/cfngin/session_cache.py @@ -58,5 +58,5 @@ def get_session( cred_provider = session._session.get_component("credential_provider") # type: ignore provider = cred_provider.get_provider("assume-role") # type: ignore provider.cache = BOTO3_CREDENTIAL_CACHE - provider._prompter = ui.getpass + provider._prompter = ui.getpass # noqa: SLF001 return session diff --git a/runway/cfngin/stack.py b/runway/cfngin/stack.py index a1b51381e..8e5dd6fc9 100644 --- a/runway/cfngin/stack.py +++ b/runway/cfngin/stack.py @@ -3,9 +3,7 @@ from __future__ import annotations from copy import deepcopy -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, cast - -from typing_extensions import Literal +from typing import TYPE_CHECKING, Any, cast from runway.utils import load_object_from_string from runway.variables import Variable, resolve_variables @@ -13,6 +11,8 @@ from .blueprints.raw import RawTemplateBlueprint if TYPE_CHECKING: + from typing_extensions import Literal + from ..config.models.cfngin import CfnginStackDefinitionModel from ..context import CfnginContext from .blueprints.base import Blueprint @@ -20,8 +20,8 @@ def _initialize_variables( - stack_def: CfnginStackDefinitionModel, variables: Optional[Dict[str, Any]] = None -) -> List[Variable]: + stack_def: CfnginStackDefinitionModel, variables: dict[str, Any] | None = None +) -> list[Variable]: """Convert defined variables into a list of ``Variable`` for consumption. Args: @@ -65,36 +65,36 @@ class Stack: """ - _blueprint: Optional[Blueprint] - _stack_policy: Optional[str] + _blueprint: Blueprint | None + _stack_policy: str | None context: CfnginContext definition: CfnginStackDefinitionModel enabled: bool force: bool fqn: str - in_progress_behavior: Optional[Literal["wait"]] + in_progress_behavior: Literal["wait"] | None locked: bool logging: bool - mappings: Dict[str, Dict[str, Dict[str, Any]]] + mappings: dict[str, dict[str, dict[str, Any]]] name: str - outputs: Dict[str, Any] + outputs: dict[str, Any] protected: bool termination_protection: bool - variables: List[Variable] + variables: list[Variable] def __init__( self, definition: CfnginStackDefinitionModel, context: CfnginContext, *, - variables: Optional[Dict[str, Any]] = None, - mappings: Dict[str, Dict[str, Dict[str, Any]]] = None, + variables: dict[str, Any] | None = None, + mappings: dict[str, dict[str, dict[str, Any]]] | None = None, locked: bool = False, force: bool = False, enabled: bool = True, protected: bool = False, - ): + ) -> None: """Instantiate class. Args: @@ -127,12 +127,12 @@ def __init__( self.variables = _initialize_variables(definition, variables) @property - def required_by(self) -> Set[str]: + def required_by(self) -> set[str]: """Return a list of stack names that depend on this stack.""" return set(self.definition.required_by) @property - def requires(self) -> Set[str]: + def requires(self) -> set[str]: """Return a list of stack names this stack depends on.""" requires = set(self.definition.requires or []) @@ -147,21 +147,17 @@ def requires(self) -> Set[str]: return requires @property - def stack_policy(self) -> Optional[str]: + def stack_policy(self) -> str | None: """Return the Stack Policy to use for this stack.""" - if not self._stack_policy: - self._stack_policy = None - if self.definition.stack_policy_path: - with open(self.definition.stack_policy_path, encoding="utf-8") as file_: - self._stack_policy = file_.read() - - return self._stack_policy + if self.definition.stack_policy_path: + return self.definition.stack_policy_path.read_text() or None + return None @property def blueprint(self) -> Blueprint: """Return the blueprint associated with this stack.""" if not self._blueprint: - kwargs: Dict[str, Any] = {} + kwargs: dict[str, Any] = {} if self.definition.class_path: class_path = self.definition.class_path blueprint_class = load_object_from_string(class_path) @@ -173,9 +169,7 @@ def blueprint(self) -> Blueprint: blueprint_class = RawTemplateBlueprint kwargs["raw_template_path"] = self.definition.template_path else: - raise AttributeError( - "Stack does not have a defined class or template path." - ) + raise AttributeError("Stack does not have a defined class or template path.") self._blueprint = cast( "Blueprint", @@ -190,7 +184,7 @@ def blueprint(self) -> Blueprint: return self._blueprint @property - def tags(self) -> Dict[str, Any]: + def tags(self) -> dict[str, Any]: """Return the tags that should be set on this stack. Includes both the global tags, as well as any stack specific tags @@ -201,7 +195,7 @@ def tags(self) -> Dict[str, Any]: return dict(self.context.tags, **tags) @property - def parameter_values(self) -> Dict[str, Any]: + def parameter_values(self) -> dict[str, Any]: """Return all CloudFormation Parameters for the stack. CloudFormation Parameters can be specified via Blueprint Variables @@ -215,18 +209,16 @@ def parameter_values(self) -> Dict[str, Any]: return self.blueprint.parameter_values @property - def all_parameter_definitions(self) -> Dict[str, Any]: + def all_parameter_definitions(self) -> dict[str, Any]: """Return all parameters in the blueprint/template.""" return self.blueprint.parameter_definitions @property - def required_parameter_definitions(self) -> Dict[str, Any]: + def required_parameter_definitions(self) -> dict[str, Any]: """Return all CloudFormation Parameters without a default value.""" return self.blueprint.required_parameter_definitions - def resolve( - self, context: CfnginContext, provider: Optional[Provider] = None - ) -> None: + def resolve(self, context: CfnginContext, provider: Provider | None = None) -> None: """Resolve the Stack variables. This resolves the Stack variables and then prepares the Blueprint for @@ -240,7 +232,7 @@ def resolve( resolve_variables(self.variables, context, provider) self.blueprint.resolve_variables(self.variables) - def set_outputs(self, outputs: Dict[str, Any]) -> None: + def set_outputs(self, outputs: dict[str, Any]) -> None: """Set stack outputs to the provided value. Args: diff --git a/runway/cfngin/status.py b/runway/cfngin/status.py index 456a6c153..c7f00dc9b 100644 --- a/runway/cfngin/status.py +++ b/runway/cfngin/status.py @@ -46,11 +46,11 @@ def _comparison(self, operator_: Callable[[Any, Any], bool], other: Any) -> bool return operator_(self.code, other.code) return NotImplemented - def __eq__(self, other: Any) -> bool: + def __eq__(self, other: object) -> bool: """Compare if self is equal to another object.""" return self._comparison(operator.eq, other) - def __ne__(self, other: Any) -> bool: + def __ne__(self, other: object) -> bool: """Compare if self is not equal to another object.""" return self._comparison(operator.ne, other) diff --git a/runway/cfngin/tokenize_userdata.py b/runway/cfngin/tokenize_userdata.py index cd5b48ed0..d0432f1ac 100644 --- a/runway/cfngin/tokenize_userdata.py +++ b/runway/cfngin/tokenize_userdata.py @@ -1,7 +1,6 @@ """Resources to tokenize userdata.""" import re -from typing import List from troposphere import GetAtt, Ref @@ -14,7 +13,7 @@ REPLACE_RE = re.compile(REPLACE_STRING) -def cf_tokenize(raw_userdata: str) -> List[str]: +def cf_tokenize(raw_userdata: str) -> list[str]: """Parse UserData for Cloudformation helper functions. http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html @@ -39,7 +38,7 @@ def cf_tokenize(raw_userdata: str) -> List[str]: Base64(Join('', cf_tokenize(userdata_string))) """ - result: List[str] = [] + result: list[str] = [] parts = SPLIT_RE.split(raw_userdata) for part in parts: cf_func = REPLACE_RE.search(part) diff --git a/runway/cfngin/ui.py b/runway/cfngin/ui.py index 861d0158a..dadf76869 100644 --- a/runway/cfngin/ui.py +++ b/runway/cfngin/ui.py @@ -4,12 +4,15 @@ import logging import threading +from contextlib import AbstractContextManager from getpass import getpass -from typing import TYPE_CHECKING, Any, ContextManager, Optional, TextIO, Type, Union +from typing import TYPE_CHECKING, Any, TextIO if TYPE_CHECKING: from types import TracebackType + from typing_extensions import Self + LOGGER = logging.getLogger(__name__) @@ -18,7 +21,7 @@ def get_raw_input(message: str) -> str: return input(message) -class UI(ContextManager["UI"]): +class UI(AbstractContextManager["UI"]): """Used internally from terminal output in a multithreaded environment. Ensures that two threads don't write over each other while asking a user @@ -33,9 +36,9 @@ def __init__(self) -> None: def log( self, lvl: int, - msg: Union[Exception, str], + msg: Exception | str, *args: Any, - logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = LOGGER, + logger: logging.Logger | logging.LoggerAdapter[Any] = LOGGER, **kwargs: Any, ) -> None: """Log the message if the current thread owns the underlying lock. @@ -44,8 +47,11 @@ def log( lvl: Log level. msg: String template or exception to use for the log record. logger: Specific logger to log to. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ + kwargs["stacklevel"] = kwargs.get("stacklevel", 1) + 1 with self: return logger.log(lvl, msg, *args, **kwargs) @@ -53,7 +59,7 @@ def info( self, msg: str, *args: Any, - logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = LOGGER, + logger: logging.Logger | logging.LoggerAdapter[Any] = LOGGER, **kwargs: Any, ) -> None: """Log the line if the current thread owns the underlying lock. @@ -62,6 +68,8 @@ def info( msg: String template or exception to use for the log record. logger: Specific logger to log to. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ kwargs["logger"] = logger @@ -79,21 +87,21 @@ def ask(self, message: str) -> str: with self: return get_raw_input(message) - def getpass(self, prompt: str, stream: Optional[TextIO] = None) -> str: + def getpass(self, prompt: str, stream: TextIO | None = None) -> str: """Wrap getpass to lock the UI.""" with self: return getpass(prompt, stream) - def __enter__(self) -> UI: + def __enter__(self) -> Self: """Enter the context manager.""" self._lock.__enter__() return self def __exit__( self, - exc_type: Optional[Type[BaseException]], - exc_value: Optional[BaseException], - traceback: Optional[TracebackType], + exc_type: type[BaseException] | None, + exc_value: BaseException | None, + traceback: TracebackType | None, ) -> None: """Exit the context manager.""" self._lock.__exit__(exc_type, exc_value, traceback) diff --git a/runway/cfngin/utils.py b/runway/cfngin/utils.py index 1f44abda6..4fa7fd846 100644 --- a/runway/cfngin/utils.py +++ b/runway/cfngin/utils.py @@ -14,17 +14,13 @@ import tempfile import uuid import zipfile +from collections import OrderedDict from pathlib import Path from typing import ( TYPE_CHECKING, Any, ClassVar, - Dict, - Iterator, - List, Optional, - OrderedDict, - Type, Union, cast, ) @@ -39,6 +35,8 @@ from .session_cache import get_session if TYPE_CHECKING: + from collections.abc import Iterator + from mypy_boto3_route53.client import Route53Client from mypy_boto3_route53.type_defs import ResourceRecordSetTypeDef from mypy_boto3_s3.client import S3Client @@ -147,16 +145,9 @@ def __init__(self, record_text: str) -> None: def __str__(self) -> str: """Convert an instance of this class to a string.""" - return " ".join( - [ - self.nameserver, - self.contact, - self.serial, - self.refresh, - self.retry, - self.expire, - self.min_ttl, - ] + return ( + f"{self.nameserver} {self.contact} {self.serial} {self.refresh} " + f"{self.retry} {self.expire} {self.min_ttl}" ) @@ -166,9 +157,7 @@ class SOARecord: def __init__(self, record: ResourceRecordSetTypeDef) -> None: """Instantiate class.""" self.name = record["Name"] - self.text = SOARecordText( - record.get("ResourceRecords", [{"Value": ""}])[0]["Value"] - ) + self.text = SOARecordText(record.get("ResourceRecords", [{"Value": ""}])[0]["Value"]) self.ttl = record.get("TTL", 0) @@ -238,9 +227,9 @@ def create_route53_zone(client: Route53Client, zone_name: str) -> str: return zone_id -def yaml_to_ordered_dict( +def yaml_to_ordered_dict( # noqa: C901 stream: str, - loader: Union[Type[yaml.Loader], Type[yaml.SafeLoader]] = yaml.SafeLoader, + loader: type[yaml.Loader | yaml.SafeLoader] = yaml.SafeLoader, ) -> OrderedDict[str, Any]: """yaml.load alternative with preserved dictionary order. @@ -267,12 +256,12 @@ class OrderedUniqueLoader(loader): # type: ignore @staticmethod def _error_mapping_on_dupe( - node: Union[yaml.MappingNode, yaml.ScalarNode, yaml.SequenceNode], + node: yaml.MappingNode | yaml.ScalarNode | yaml.SequenceNode, node_name: str, ) -> None: """Check mapping node for dupe children keys.""" if isinstance(node, yaml.MappingNode): - mapping: Dict[str, Any] = {} + mapping: dict[str, Any] = {} for val in node.value: a = val[0] b = mapping.get(a.value, None) @@ -285,7 +274,7 @@ def _error_mapping_on_dupe( def _validate_mapping( self, - node: Union[yaml.MappingNode, yaml.ScalarNode, yaml.SequenceNode], + node: yaml.MappingNode | yaml.ScalarNode | yaml.SequenceNode, deep: bool = False, ) -> OrderedDict[Any, Any]: if not isinstance(node, yaml.MappingNode): @@ -322,7 +311,7 @@ def _validate_mapping( def construct_mapping( self, - node: Union[yaml.MappingNode, yaml.ScalarNode, yaml.SequenceNode], + node: yaml.MappingNode | yaml.ScalarNode | yaml.SequenceNode, deep: bool = False, ) -> OrderedDict[Any, Any]: """Override parent method to use OrderedDict.""" @@ -331,7 +320,7 @@ def construct_mapping( return self._validate_mapping(node, deep=deep) def construct_yaml_map( - self, node: Union[yaml.MappingNode, yaml.ScalarNode, yaml.SequenceNode] + self, node: yaml.MappingNode | yaml.ScalarNode | yaml.SequenceNode ) -> Iterator[OrderedDict[Any, Any]]: data: OrderedDict[Any, Any] = OrderedDict() yield data @@ -341,7 +330,7 @@ def construct_yaml_map( OrderedUniqueLoader.add_constructor( "tag:yaml.org,2002:map", OrderedUniqueLoader.construct_yaml_map ) - return yaml.load(stream, OrderedUniqueLoader) + return yaml.load(stream, OrderedUniqueLoader) # noqa: S506 def uppercase_first_letter(string_: str) -> str: @@ -361,7 +350,7 @@ def cf_safe_name(name: str) -> str: return "".join(uppercase_first_letter(part) for part in parts) -def read_value_from_path(value: str, *, root_path: Optional[Path] = None) -> str: +def read_value_from_path(value: str, *, root_path: Path | None = None) -> str: """Enable translators to read values from files. The value can be referred to with the `file://` prefix. @@ -373,23 +362,16 @@ def read_value_from_path(value: str, *, root_path: Optional[Path] = None) -> str """ if value.startswith("file://"): - path = value.split("file://", 1)[1] - if os.path.isabs(path): + path = Path(value.split("file://", 1)[1]) + if path.is_absolute(): read_path = Path(path) else: root_path = root_path or Path.cwd() - if root_path.is_dir(): - read_path = root_path / path - else: - read_path = root_path.parent / path + read_path = root_path / path if root_path.is_dir() else root_path.parent / path if read_path.is_file(): - return read_path.read_text( - encoding=locale.getpreferredencoding(do_setlocale=False) - ) + return read_path.read_text(encoding=locale.getpreferredencoding(do_setlocale=False)) if read_path.is_dir(): - raise ValueError( - f"path must lead to a file not directory: {read_path.absolute()}" - ) + raise ValueError(f"path must lead to a file not directory: {read_path.absolute()}") raise ValueError(f"path does not exist: {read_path.absolute()}") return value @@ -404,7 +386,7 @@ def get_client_region(client: Any) -> str: AWS region string. """ - return client._client_config.region_name # type: ignore + return client._client_config.region_name # type: ignore # noqa: SLF001 def get_s3_endpoint(client: Any) -> str: @@ -417,7 +399,7 @@ def get_s3_endpoint(client: Any) -> str: The AWS endpoint for the client. """ - return client._endpoint.host # type: ignore + return client._endpoint.host # type: ignore # noqa: SLF001 def s3_bucket_location_constraint(region: Optional[str]) -> Optional[str]: @@ -484,7 +466,7 @@ def ensure_s3_bucket( # can't use s3_client.exceptions.NoSuchBucket here. # it does not work if the bucket was recently deleted. LOGGER.debug("creating bucket %s", bucket_name) - create_args: Dict[str, Any] = {"Bucket": bucket_name} + create_args: dict[str, Any] = {"Bucket": bucket_name} location_constraint = s3_bucket_location_constraint(bucket_region) if location_constraint: create_args["CreateBucketConfiguration"] = { @@ -498,8 +480,7 @@ def ensure_s3_bucket( return if err.response["Error"]["Message"] == "Forbidden": LOGGER.exception( - "Access denied for bucket %s. Did you remember " - "to use a globally unique name?", + "Access denied for bucket %s. Did you remember to use a globally unique name?", bucket_name, ) elif err.response["Error"]["Message"] != "Not Found": @@ -507,7 +488,7 @@ def ensure_s3_bucket( raise -def parse_cloudformation_template(template: str) -> Dict[str, Any]: +def parse_cloudformation_template(template: str) -> dict[str, Any]: """Parse CFN template string. Leverages the vendored aws-cli yamlhelper to handle JSON or YAML templates. @@ -532,8 +513,8 @@ def is_within_directory(directory: Path | str, target: str) -> bool: bool: True if the target is in the directory or subdirectories, False otherwise. """ - abs_directory = os.path.abspath(directory) - abs_target = os.path.abspath(target) + abs_directory = os.path.abspath(directory) # noqa: PTH100 + abs_target = os.path.abspath(target) # noqa: PTH100 prefix = os.path.commonprefix([abs_directory, abs_target]) return prefix == abs_directory @@ -544,27 +525,27 @@ def safe_tar_extract( members: list[tarfile.TarInfo] | None = None, *, numeric_owner: bool = False, -): +) -> None: """Safely extract the contents of a tar file to a specified directory. This code is modified from a PR provided to Runway project to address CVE-2007-4559. Args: - tar (TarFile): The tar file object that will be extracted. - path (Union[Path, str], optional): The directory to extract the tar into. - members (List[TarInfo] | None, optional): List of TarInfo objects to extract. - numeric_owner (bool, optional): Enable usage of owner and group IDs when extracting. + tar: The tar file object that will be extracted. + path: The directory to extract the tar into. + members: List of TarInfo objects to extract. + numeric_owner: Enable usage of owner and group IDs when extracting. Raises: Exception: If any tar file tries to go outside the specified area. """ for member in tar.getmembers(): - member_path = os.path.join(path, member.name) + member_path = os.path.join(path, member.name) # noqa: PTH118 if not is_within_directory(path, member_path): raise Exception("Attempted Path Traversal in Tar File") - tar.extractall(path, members, numeric_owner=numeric_owner) + tar.extractall(path, members, numeric_owner=numeric_owner) # noqa: S202 class Extractor: @@ -622,7 +603,7 @@ def extract(self, destination: Path) -> None: """Extract the archive.""" if self.archive: with zipfile.ZipFile(self.archive, "r") as zip_ref: - zip_ref.extractall(destination) + zip_ref.extractall(destination) # noqa: S202 class SourceProcessor: @@ -645,7 +626,7 @@ def __init__( self.cache_dir = cache_dir self.package_cache_dir = cache_dir / "packages" self.sources = sources - self.configs_to_merge: List[Path] = [] + self.configs_to_merge: list[Path] = [] self.create_cache_directories() def create_cache_directories(self) -> None: @@ -664,9 +645,7 @@ def get_package_sources(self) -> None: for config in self.sources.git: self.fetch_git_package(config=config) - def fetch_local_package( - self, config: LocalCfnginPackageSourceDefinitionModel - ) -> None: + def fetch_local_package(self, config: LocalCfnginPackageSourceDefinitionModel) -> None: """Make a local path available to current CFNgin config. Args: @@ -713,7 +692,7 @@ def fetch_s3_package(self, config: S3CfnginPackageSourceDefinitionModel) -> None ) session = get_session(region=None) - extra_s3_args: Dict[str, Any] = {} + extra_s3_args: dict[str, Any] = {} if config.requester_pays: extra_s3_args["RequestPayer"] = "requester" @@ -749,13 +728,12 @@ def fetch_s3_package(self, config: S3CfnginPackageSourceDefinitionModel) -> None cached_dir_path, ) tmp_dir = tempfile.mkdtemp(prefix="cfngin") - tmp_package_path = os.path.join(tmp_dir, dir_name) + tmp_package_path = os.path.join(tmp_dir, dir_name) # noqa: PTH118 with tempfile.TemporaryDirectory(prefix="runway-cfngin") as tmp_dir: tmp_package_path = Path(tmp_dir) / dir_name extractor.set_archive(tmp_package_path) LOGGER.debug( - "starting remote package download from S3 to %s " - 'with extra S3 options "%s"', + 'starting remote package download from S3 to %s with extra S3 options "%s"', extractor.archive, str(extra_s3_args), ) @@ -770,8 +748,7 @@ def fetch_s3_package(self, config: S3CfnginPackageSourceDefinitionModel) -> None ) extractor.extract(tmp_package_path) LOGGER.debug( - "moving extracted package directory %s to the " - "CFNgin cache at %s", + "moving extracted package directory %s to the CFNgin cache at %s", dir_name, self.package_cache_dir, ) @@ -797,7 +774,7 @@ def fetch_git_package(self, config: GitCfnginPackageSourceDefinitionModel) -> No """ # only loading git here when needed to avoid load errors on systems # without git installed - from git.repo import Repo # pylint: disable=import-outside-toplevel + from git.repo import Repo ref = self.determine_git_ref(config) dir_name = self.sanitize_git_path(uri=config.uri, ref=ref) @@ -813,7 +790,7 @@ def fetch_git_package(self, config: GitCfnginPackageSourceDefinitionModel) -> No ) tmp_dir = tempfile.mkdtemp(prefix="cfngin") try: - tmp_repo_path = os.path.join(tmp_dir, dir_name) + tmp_repo_path = os.path.join(tmp_dir, dir_name) # noqa: PTH118 with Repo.clone_from(config.uri, tmp_repo_path) as repo: repo.head.set_reference(ref) repo.head.reset(index=True, working_tree=True) @@ -822,8 +799,7 @@ def fetch_git_package(self, config: GitCfnginPackageSourceDefinitionModel) -> No shutil.rmtree(tmp_dir) else: LOGGER.debug( - "remote repo %s appears to have been previously " - "cloned to %s; download skipped", + "remote repo %s appears to have been previously cloned to %s; download skipped", config.uri, cached_dir_path, ) @@ -933,7 +909,7 @@ def sanitize_uri_path(uri: str) -> str: uri = uri.replace(i, "_") return uri - def sanitize_git_path(self, uri: str, ref: Optional[str] = None) -> str: + def sanitize_git_path(self, uri: str, ref: str | None = None) -> str: """Take a git URI and ref and converts it to a directory safe path. Args: @@ -944,10 +920,7 @@ def sanitize_git_path(self, uri: str, ref: Optional[str] = None) -> str: Directory name for the supplied uri """ - if uri.endswith(".git"): - dir_name = uri[:-4] # drop .git - else: - dir_name = uri + dir_name = uri[:-4] if uri.endswith(".git") else uri # drop .git dir_name = self.sanitize_uri_path(dir_name) if ref is not None: dir_name += f"-{ref}" diff --git a/runway/compat.py b/runway/compat.py index 038e76ed2..360443eff 100644 --- a/runway/compat.py +++ b/runway/compat.py @@ -1,26 +1,19 @@ """Python dependency compatibility handling.""" import sys -from typing import Iterable - -if sys.version_info < (3, 8): # 3.7 - import shlex - - from backports.cached_property import cached_property - from importlib_metadata import PackageNotFoundError, version - - def shlex_join(split_command: Iterable[str]) -> str: - """Backport of :meth:`shlex.join`.""" - return " ".join(shlex.quote(arg) for arg in split_command) +from functools import cached_property +from importlib.metadata import PackageNotFoundError, version +from shlex import join as shlex_join +if sys.version_info < (3, 11): + from typing_extensions import Self else: - from functools import cached_property - from importlib.metadata import PackageNotFoundError, version - from shlex import join as shlex_join + from typing import Self __all__ = [ - "PackageNotFoundError", - "cached_property", - "shlex_join", - "version", + "PackageNotFoundError", # TODO (kyle): remove in next major release + "Self", + "cached_property", # TODO (kyle): remove in next major release + "shlex_join", # TODO (kyle): remove in next major release + "version", # TODO (kyle): remove in next major release ] diff --git a/runway/config/__init__.py b/runway/config/__init__.py index c6a63ca8e..61e508fdb 100644 --- a/runway/config/__init__.py +++ b/runway/config/__init__.py @@ -7,18 +7,7 @@ import sys from pathlib import Path from string import Template -from typing import ( - TYPE_CHECKING, - AbstractSet, - Any, - Dict, - List, - Mapping, - MutableMapping, - Optional, - Union, - cast, -) +from typing import TYPE_CHECKING, Any, Union, cast import yaml @@ -41,6 +30,9 @@ from .models.runway import RunwayConfigDefinitionModel, RunwayFutureDefinitionModel if TYPE_CHECKING: + from collections.abc import Mapping, MutableMapping + from collections.abc import Set as AbstractSet + from packaging.specifiers import SpecifierSet from pydantic import BaseModel @@ -53,7 +45,7 @@ class BaseConfig: file_path: Path _data: BaseModel - def __init__(self, data: BaseModel, *, path: Optional[Path] = None) -> None: + def __init__(self, data: BaseModel, *, path: Path | None = None) -> None: """Instantiate class. Args: @@ -68,15 +60,11 @@ def dump( self, *, by_alias: bool = False, - exclude: Optional[ - Union[AbstractSet[Union[int, str]], Mapping[Union[int, str], Any]] - ] = None, + exclude: Union[AbstractSet[Union[int, str]], Mapping[Union[int, str], Any]] | None = None, exclude_defaults: bool = False, exclude_none: bool = False, exclude_unset: bool = True, - include: Optional[ - Union[AbstractSet[Union[int, str]], Mapping[Union[int, str], Any]] - ] = None, + include: Union[AbstractSet[Union[int, str]], Mapping[Union[int, str], Any]] | None = None, ) -> str: """Dump model to a YAML string. @@ -108,7 +96,7 @@ def dump( ) @classmethod - def find_config_file(cls, path: Path) -> Optional[Path]: + def find_config_file(cls, path: Path) -> Path | None: """Find a config file in the provided path. Args: @@ -147,24 +135,24 @@ class CfnginConfig(BaseConfig): EXCLUDE_LIST = ["bitbucket-pipelines.yml", "buildspec.yml", "docker-compose.yml"] """Explicit files names to ignore when looking for config files.""" - cfngin_bucket: Optional[str] + cfngin_bucket: str | None """Bucket to use for CFNgin resources. (e.g. CloudFormation templates). May be an empty string. """ - cfngin_bucket_region: Optional[str] + cfngin_bucket_region: str | None """Explicit region to use for :attr:`CfnginConfig.cfngin_bucket`""" cfngin_cache_dir: Path """Local directory to use for caching.""" - log_formats: Dict[str, str] + log_formats: dict[str, str] """Custom formatting for log messages.""" - lookups: Dict[str, str] + lookups: dict[str, str] """Register custom lookups.""" - mappings: Dict[str, Dict[str, Dict[str, Any]]] + mappings: dict[str, dict[str, dict[str, Any]]] """Mappings that will be added to all stacks.""" namespace: str @@ -176,31 +164,31 @@ class CfnginConfig(BaseConfig): package_sources: CfnginPackageSourcesDefinitionModel """Remote source locations.""" - persistent_graph_key: Optional[str] = None + persistent_graph_key: str | None = None """S3 object key were the persistent graph is stored.""" - post_deploy: List[CfnginHookDefinitionModel] + post_deploy: list[CfnginHookDefinitionModel] """Hooks to run after a deploy action.""" - post_destroy: List[CfnginHookDefinitionModel] + post_destroy: list[CfnginHookDefinitionModel] """Hooks to run after a destroy action.""" - pre_deploy: List[CfnginHookDefinitionModel] + pre_deploy: list[CfnginHookDefinitionModel] """Hooks to run before a deploy action.""" - pre_destroy: List[CfnginHookDefinitionModel] + pre_destroy: list[CfnginHookDefinitionModel] """Hooks to run before a destroy action.""" - service_role: Optional[str] + service_role: str | None """IAM role for CloudFormation to use.""" - stacks: List[CfnginStackDefinitionModel] + stacks: list[CfnginStackDefinitionModel] """Stacks to be processed.""" - sys_path: Optional[Path] + sys_path: Path | None """Relative or absolute path to use as the work directory.""" - tags: Optional[Dict[str, str]] + tags: dict[str, str] | None """Tags to apply to all resources.""" template_indent: int @@ -212,8 +200,8 @@ def __init__( self, data: CfnginConfigDefinitionModel, *, - path: Optional[Path] = None, - work_dir: Optional[Path] = None, + path: Path | None = None, + work_dir: Path | None = None, ) -> None: """Instantiate class. @@ -242,14 +230,12 @@ def __init__( self.namespace_delimiter = self._data.namespace_delimiter self.package_sources = self._data.package_sources self.persistent_graph_key = self._data.persistent_graph_key - self.post_deploy = cast(List[CfnginHookDefinitionModel], self._data.post_deploy) - self.post_destroy = cast( - List[CfnginHookDefinitionModel], self._data.post_destroy - ) - self.pre_deploy = cast(List[CfnginHookDefinitionModel], self._data.pre_deploy) - self.pre_destroy = cast(List[CfnginHookDefinitionModel], self._data.pre_destroy) + self.post_deploy = cast("list[CfnginHookDefinitionModel]", self._data.post_deploy) + self.post_destroy = cast("list[CfnginHookDefinitionModel]", self._data.post_destroy) + self.pre_deploy = cast("list[CfnginHookDefinitionModel]", self._data.pre_deploy) + self.pre_destroy = cast("list[CfnginHookDefinitionModel]", self._data.pre_destroy) self.service_role = self._data.service_role - self.stacks = cast(List[CfnginStackDefinitionModel], self._data.stacks) + self.stacks = cast("list[CfnginStackDefinitionModel]", self._data.stacks) self.sys_path = self._data.sys_path self.tags = self._data.tags self.template_indent = self._data.template_indent @@ -265,9 +251,9 @@ def load(self) -> None: register_lookup_handler(key, handler) @classmethod - def find_config_file( # type: ignore pylint: disable=arguments-differ - cls, path: Optional[Path] = None, *, exclude: Optional[List[str]] = None - ) -> List[Path]: + def find_config_file( # type: ignore + cls, path: Path | None = None, *, exclude: list[str] | None = None + ) -> list[Path]: """Find a config file in the provided path. Args: @@ -286,18 +272,14 @@ def find_config_file( # type: ignore pylint: disable=arguments-differ return [path] exclude = exclude or [] - result: List[Path] = [] + result: list[Path] = [] exclude.extend(cls.EXCLUDE_LIST) yml_files = list(path.glob("*.yml")) yml_files.extend(list(path.glob("*.yaml"))) for f in yml_files: - if ( - re.match(cls.EXCLUDE_REGEX, f.name) - or f.name in exclude - or f.name.startswith(".") - ): + if re.match(cls.EXCLUDE_REGEX, f.name) or f.name in exclude or f.name.startswith("."): continue # cov: ignore result.append(f) result.sort() @@ -307,10 +289,10 @@ def find_config_file( # type: ignore pylint: disable=arguments-differ def parse_file( cls, *, - path: Optional[Path] = None, - file_path: Optional[Path] = None, - parameters: Optional[MutableMapping[str, Any]] = None, - work_dir: Optional[Path] = None, + path: Path | None = None, + file_path: Path | None = None, + parameters: MutableMapping[str, Any] | None = None, + work_dir: Path | None = None, **kwargs: Any, ) -> CfnginConfig: """Parse a YAML file to create a config object. @@ -320,6 +302,7 @@ def parse_file( file_path: Exact path to a file to parse. parameters: Values to use when resolving a raw config. work_dir: Explicit working directory. + **kwargs: Arbitrary keyword arguments. Raises: ConfigNotFound: Provided config file was not found. @@ -349,7 +332,7 @@ def parse_file( @classmethod def parse_obj( - cls, obj: Any, *, path: Optional[Path] = None, work_dir: Optional[Path] = None + cls, obj: Any, *, path: Path | None = None, work_dir: Path | None = None ) -> CfnginConfig: """Parse a python object. @@ -359,19 +342,17 @@ def parse_obj( work_dir: Working directory. """ - return cls( - CfnginConfigDefinitionModel.parse_obj(obj), path=path, work_dir=work_dir - ) + return cls(CfnginConfigDefinitionModel.parse_obj(obj), path=path, work_dir=work_dir) @classmethod def parse_raw( cls, data: str, *, - parameters: Optional[MutableMapping[str, Any]] = None, - path: Optional[Path] = None, + parameters: MutableMapping[str, Any] | None = None, + path: Path | None = None, skip_package_sources: bool = False, - work_dir: Optional[Path] = None, + work_dir: Path | None = None, ) -> CfnginConfig: """Parse raw data. @@ -389,9 +370,7 @@ def parse_raw( if skip_package_sources: return cls.parse_obj(yaml.safe_load(pre_rendered)) config_dict = yaml.safe_load( - cls.process_package_sources( - pre_rendered, parameters=parameters, work_dir=work_dir - ) + cls.process_package_sources(pre_rendered, parameters=parameters, work_dir=work_dir) ) return cls.parse_obj(config_dict, path=path) @@ -400,8 +379,8 @@ def process_package_sources( cls, raw_data: str, *, - parameters: Optional[MutableMapping[str, Any]] = None, - work_dir: Optional[Path] = None, + parameters: MutableMapping[str, Any] | None = None, + work_dir: Path | None = None, ) -> str: """Process the package sources defined in a rendered config. @@ -412,29 +391,27 @@ def process_package_sources( work_dir: Explicit working directory. """ - config = yaml.safe_load(raw_data) or {} + config: dict[str, Any] = yaml.safe_load(raw_data) or {} processor = SourceProcessor( sources=CfnginPackageSourcesDefinitionModel.parse_obj( - config.get("package_sources", {}) # type: ignore + config.get("package_sources", {}) ), cache_dir=Path( - config.get( - "cfngin_cache_dir", (work_dir or Path().cwd() / ".runway") / "cache" - ) + config.get("cfngin_cache_dir", (work_dir or Path().cwd() / ".runway") / "cache") ), ) processor.get_package_sources() if processor.configs_to_merge: for i in processor.configs_to_merge: LOGGER.debug("merging in remote config: %s", i) - with open(i, "rb") as opened_file: + with i.open("rb") as opened_file: config = merge_dicts(yaml.safe_load(opened_file), config) return cls.resolve_raw_data(yaml.dump(config), parameters=parameters or {}) return raw_data @staticmethod def resolve_raw_data( - raw_data: str, *, parameters: Optional[MutableMapping[str, Any]] = None + raw_data: str, *, parameters: MutableMapping[str, Any] | None = None ) -> str: """Resolve raw data. @@ -464,19 +441,17 @@ class RunwayConfig(BaseConfig): ACCEPTED_NAMES = ["runway.yml", "runway.yaml"] - deployments: List[RunwayDeploymentDefinition] + deployments: list[RunwayDeploymentDefinition] file_path: Path future: RunwayFutureDefinitionModel ignore_git_branch: bool - runway_version: Optional[SpecifierSet] - tests: List[RunwayTestDefinition[Any]] + runway_version: SpecifierSet | None + tests: list[RunwayTestDefinition[Any]] variables: RunwayVariablesDefinition _data: RunwayConfigDefinitionModel - def __init__( - self, data: RunwayConfigDefinitionModel, *, path: Optional[Path] = None - ) -> None: + def __init__(self, data: RunwayConfigDefinitionModel, *, path: Path | None = None) -> None: """Instantiate class. Args: @@ -485,9 +460,7 @@ def __init__( """ super().__init__(data, path=path) - self.deployments = [ - RunwayDeploymentDefinition(d) for d in self._data.deployments - ] + self.deployments = [RunwayDeploymentDefinition(d) for d in self._data.deployments] self.future = self._data.future self.ignore_git_branch = self._data.ignore_git_branch self.runway_version = self._data.runway_version @@ -520,8 +493,8 @@ def find_config_file(cls, path: Path) -> Path: def parse_file( cls, *, - path: Optional[Path] = None, - file_path: Optional[Path] = None, + path: Path | None = None, + file_path: Path | None = None, **kwargs: Any, ) -> RunwayConfig: """Parse a YAML file to create a config object. @@ -529,6 +502,7 @@ def parse_file( Args: path: The path to search for a config file. file_path: Exact path to a file to parse. + **kwargs: Arbitrary keyword arguments. Raises: ConfigNotFound: Provided config file was not found. @@ -538,15 +512,13 @@ def parse_file( if file_path: if not file_path.is_file(): raise ConfigNotFound(path=file_path) - return cls.parse_obj( - yaml.safe_load(file_path.read_text()), path=file_path, **kwargs - ) + return cls.parse_obj(yaml.safe_load(file_path.read_text()), path=file_path, **kwargs) if path: return cls.parse_file(file_path=cls.find_config_file(path), **kwargs) raise ValueError("must provide path or file_path") @classmethod - def parse_obj(cls, obj: Any, *, path: Optional[Path] = None) -> RunwayConfig: + def parse_obj(cls, obj: Any, *, path: Path | None = None) -> RunwayConfig: """Parse a python object into a config object. Args: diff --git a/runway/config/components/runway/_deployment_def.py b/runway/config/components/runway/_deployment_def.py index f0ffd84e2..d2ce0bba8 100644 --- a/runway/config/components/runway/_deployment_def.py +++ b/runway/config/components/runway/_deployment_def.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Tuple, Union, overload +from typing import TYPE_CHECKING, Any, overload from ....exceptions import UnresolvedVariable from ....variables import Variable @@ -28,26 +28,26 @@ class RunwayDeploymentDefinition(ConfigComponentDefinition): """Runway deployment definition.""" - account_alias: Optional[str] - account_id: Optional[str] + account_alias: str | None + account_id: str | None assume_role: RunwayAssumeRoleDefinitionModel environments: RunwayEnvironmentsType env_vars: RunwayEnvVarsType - module_options: Dict[str, Any] + module_options: dict[str, Any] name: str - parallel_regions: List[str] - parameters: Dict[str, Any] - regions: List[str] + parallel_regions: list[str] + parameters: dict[str, Any] + regions: list[str] _data: RunwayDeploymentDefinitionModel - _pre_process_vars: Tuple[str, ...] = ( + _pre_process_vars: tuple[str, ...] = ( "account_alias", "account_id", "assume_role", "env_vars", "regions", ) - _supports_vars: Tuple[str, ...] = ( + _supports_vars: tuple[str, ...] = ( "account_alias", "account_id", "assume_role", @@ -81,12 +81,12 @@ def menu_entry(self) -> str: ) @property - def modules(self) -> List[RunwayModuleDefinition]: + def modules(self) -> list[RunwayModuleDefinition]: """List of Runway modules.""" return [RunwayModuleDefinition(module) for module in self._data.modules] @modules.setter - def modules(self, modules: List[RunwayModuleDefinition]) -> None: + def modules(self, modules: list[RunwayModuleDefinition]) -> None: """Set the value of the property. Args: @@ -97,12 +97,10 @@ def modules(self, modules: List[RunwayModuleDefinition]) -> None: """ if not all(isinstance(i, RunwayModuleDefinition) for i in modules): # type: ignore - raise TypeError("modules must be type List[RunwayModuleDefinition]") - self._data.modules = [ - RunwayModuleDefinitionModel.parse_obj(mod.data) for mod in modules - ] + raise TypeError("modules must be type list[RunwayModuleDefinition]") + self._data.modules = [RunwayModuleDefinitionModel.parse_obj(mod.data) for mod in modules] - def reverse(self): + def reverse(self) -> None: """Reverse the order of modules and regions.""" self._data.modules.reverse() for mod in self._data.modules: @@ -112,7 +110,7 @@ def reverse(self): prop.reverse() def set_modules( - self, modules: List[Union[RunwayModuleDefinition, RunwayModuleDefinitionModel]] + self, modules: list[RunwayModuleDefinition | RunwayModuleDefinitionModel] ) -> None: """Set the value of modules. @@ -124,10 +122,8 @@ def set_modules( """ if not isinstance(modules, list): # type: ignore - raise TypeError( - f"expected List[RunwayModuleDefinition]; got {type(modules)}" - ) - sanitized: List[RunwayModuleDefinitionModel] = [] + raise TypeError(f"expected list[RunwayModuleDefinition]; got {type(modules)}") + sanitized: list[RunwayModuleDefinitionModel] = [] for i, mod in enumerate(modules): if isinstance(mod, RunwayModuleDefinition): sanitized.append(RunwayModuleDefinitionModel.parse_obj(mod.data)) @@ -156,29 +152,23 @@ def _register_variable(self, var_name: str, var_value: Any) -> None: @overload @classmethod - def parse_obj( - cls, obj: List[Dict[str, Any]] - ) -> List[RunwayDeploymentDefinition]: ... + def parse_obj(cls, obj: list[dict[str, Any]]) -> list[RunwayDeploymentDefinition]: ... @overload @classmethod def parse_obj( cls, - obj: Union[ - List[ConfigProperty], Set[ConfigProperty], Tuple[ConfigProperty, ...] - ], - ) -> List[RunwayDeploymentDefinition]: ... + obj: list[ConfigProperty] | set[ConfigProperty] | tuple[ConfigProperty, ...], + ) -> list[RunwayDeploymentDefinition]: ... @overload @classmethod - def parse_obj( - cls, obj: Union[Dict[str, Any], ConfigProperty] - ) -> RunwayDeploymentDefinition: ... + def parse_obj(cls, obj: dict[str, Any] | ConfigProperty) -> RunwayDeploymentDefinition: ... @classmethod def parse_obj( # type: ignore cls, obj: Any - ) -> Union[RunwayDeploymentDefinition, List[RunwayDeploymentDefinition]]: + ) -> RunwayDeploymentDefinition | list[RunwayDeploymentDefinition]: """Parse a python object into this class. Args: @@ -186,7 +176,5 @@ def parse_obj( # type: ignore """ if isinstance(obj, (list, set, tuple)): - return [ - cls(RunwayDeploymentDefinitionModel.parse_obj(o)) for o in obj # type: ignore - ] + return [cls(RunwayDeploymentDefinitionModel.parse_obj(o)) for o in obj] # type: ignore return cls(RunwayDeploymentDefinitionModel.parse_obj(obj)) diff --git a/runway/config/components/runway/_module_def.py b/runway/config/components/runway/_module_def.py index cfb31c5ae..b604f4849 100644 --- a/runway/config/components/runway/_module_def.py +++ b/runway/config/components/runway/_module_def.py @@ -2,14 +2,15 @@ from __future__ import annotations -from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union +from typing import TYPE_CHECKING, Any from ....variables import Variable from ...models.runway import RunwayModuleDefinitionModel from .base import ConfigComponentDefinition if TYPE_CHECKING: + from pathlib import Path + from ...models.runway import ( RunwayEnvironmentsType, RunwayEnvVarsType, @@ -20,18 +21,18 @@ class RunwayModuleDefinition(ConfigComponentDefinition): """Runway module definition.""" - class_path: Optional[str] + class_path: str | None environments: RunwayEnvironmentsType env_vars: RunwayEnvVarsType name: str - options: Dict[str, Any] - parameters: Dict[str, Any] - path: Optional[Union[str, Path]] - tags: List[str] - type: Optional[RunwayModuleTypeTypeDef] + options: dict[str, Any] + parameters: dict[str, Any] + path: str | Path | None + tags: list[str] + type: RunwayModuleTypeTypeDef | None _data: RunwayModuleDefinitionModel - _supports_vars: Tuple[str, ...] = ( + _supports_vars: tuple[str, ...] = ( "class_path", "env_vars", "environments", @@ -45,14 +46,14 @@ def __init__(self, data: RunwayModuleDefinitionModel) -> None: super().__init__(data) @property - def child_modules(self) -> List[RunwayModuleDefinition]: + def child_modules(self) -> list[RunwayModuleDefinition]: """List of child modules.""" return [RunwayModuleDefinition(child) for child in self._data.parallel] @child_modules.setter def child_modules( self, - modules: List[Union[RunwayModuleDefinition, RunwayModuleDefinitionModel]], # type: ignore + modules: list[RunwayModuleDefinition | RunwayModuleDefinitionModel], # type: ignore ) -> None: """Set the value of the property. @@ -64,10 +65,8 @@ def child_modules( """ if not isinstance(modules, list): # type: ignore - raise TypeError( - f"expected List[RunwayModuleDefinition]; got {type(modules)}" - ) - sanitized: List[RunwayModuleDefinitionModel] = [] + raise TypeError(f"expected list[RunwayModuleDefinition]; got {type(modules)}") + sanitized: list[RunwayModuleDefinitionModel] = [] for i, mod in enumerate(modules): if isinstance(mod, RunwayModuleDefinition): sanitized.append(RunwayModuleDefinitionModel.parse_obj(mod.data)) @@ -89,12 +88,10 @@ def is_parent(self) -> bool: def menu_entry(self) -> str: """Return menu entry representation of this module.""" if self.is_parent: - return ( - f"{self.name} [{', '.join([c.menu_entry for c in self.child_modules])}]" - ) + return f"{self.name} [{', '.join([c.menu_entry for c in self.child_modules])}]" return self.name - def reverse(self): + def reverse(self) -> None: """Reverse the order of child/parallel modules.""" self._data.parallel.reverse() diff --git a/runway/config/components/runway/_test_def.py b/runway/config/components/runway/_test_def.py index 1b537d871..3ac48aa42 100644 --- a/runway/config/components/runway/_test_def.py +++ b/runway/config/components/runway/_test_def.py @@ -1,5 +1,6 @@ """Runway config test definition.""" +# ruff: noqa: UP006, UP035 from __future__ import annotations from typing import TYPE_CHECKING, Any, Dict, Generic, Tuple, TypeVar, Union @@ -46,8 +47,7 @@ def __init__(self, data: _DataModel) -> None: """Instantiate class.""" super().__init__(data) - # error present on python3.7 - def __new__( # pylint: disable=arguments-differ + def __new__( cls, data: _DataModel, ) -> RunwayTestDefinition[_DataModel]: @@ -60,11 +60,11 @@ def __new__( # pylint: disable=arguments-differ if cls is not RunwayTestDefinition: return super().__new__(cls) if isinstance(data, CfnLintRunwayTestDefinitionModel): - return super().__new__(CfnLintRunwayTestDefinition) + return super().__new__(CfnLintRunwayTestDefinition) # type: ignore if isinstance(data, ScriptRunwayTestDefinitionModel): - return super().__new__(ScriptRunwayTestDefinition) + return super().__new__(ScriptRunwayTestDefinition) # type: ignore if isinstance(data, YamlLintRunwayTestDefinitionModel): - return super().__new__(YamlLintRunwayTestDefinition) + return super().__new__(YamlLintRunwayTestDefinition) # type: ignore raise TypeError( "expected data of type CfnLintRunwayTestDefinitionModel, " "ScriptRunwayTestDefinitionModel, or YamlLintRunwayTestDefinitionModel; " @@ -96,9 +96,7 @@ def parse_obj(cls, obj: Any) -> RunwayTestDefinition[_DataModel]: return cls(RunwayTestDefinitionModel.parse_obj(obj)) -class CfnLintRunwayTestDefinition( - RunwayTestDefinition[CfnLintRunwayTestDefinitionModel] -): +class CfnLintRunwayTestDefinition(RunwayTestDefinition[CfnLintRunwayTestDefinitionModel]): """Runway cfn-lint test definition.""" args: CfnLintRunwayTestArgs @@ -140,9 +138,7 @@ def parse_obj(cls, obj: Any) -> ScriptRunwayTestDefinition: return cls(ScriptRunwayTestDefinitionModel.parse_obj(obj)) -class YamlLintRunwayTestDefinition( - RunwayTestDefinition[YamlLintRunwayTestDefinitionModel] -): +class YamlLintRunwayTestDefinition(RunwayTestDefinition[YamlLintRunwayTestDefinitionModel]): """Runway yamllint test definition.""" type: Literal["yamllint"] = "yamllint" diff --git a/runway/config/components/runway/_variables_def.py b/runway/config/components/runway/_variables_def.py index 8d02f2630..a8b14d218 100644 --- a/runway/config/components/runway/_variables_def.py +++ b/runway/config/components/runway/_variables_def.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, ClassVar, Dict, cast +from typing import TYPE_CHECKING, Any, ClassVar, cast import yaml @@ -32,9 +32,8 @@ def __init__(self, data: RunwayVariablesDefinitionModel) -> None: data = RunwayVariablesDefinitionModel(**{**data.dict(), **self.__load_file()}) super().__init__(**data.dict(exclude={"file_path", "sys_path"})) - def __load_file(self) -> Dict[str, Any]: + def __load_file(self) -> dict[str, Any]: """Load a variables file.""" - # pylint: disable=protected-access if self._file_path: if self._file_path.is_file(): return yaml.safe_load(self._file_path.read_text()) @@ -52,7 +51,7 @@ def __load_file(self) -> Dict[str, Any]: "could not find %s in the current directory; continuing without a variables file", " or ".join(self.default_names), ) - self.__class__._has_notified_missing_file = True + self.__class__._has_notified_missing_file = True # noqa: SLF001 return {} @classmethod diff --git a/runway/config/components/runway/base.py b/runway/config/components/runway/base.py index d0edec99a..68973c99f 100644 --- a/runway/config/components/runway/base.py +++ b/runway/config/components/runway/base.py @@ -4,7 +4,7 @@ import logging from abc import ABC, abstractmethod -from typing import TYPE_CHECKING, Any, Dict, Optional, Tuple, cast +from typing import TYPE_CHECKING, Any, Optional, cast from ...._logging import PrefixAdaptor from ....exceptions import UnresolvedVariable @@ -23,9 +23,9 @@ class ConfigComponentDefinition(ABC): """Base class for Runway config components.""" _data: ConfigProperty - _pre_process_vars: Tuple[str, ...] = () - _supports_vars: Tuple[str, ...] = () - _vars: Dict[str, Variable] = {} + _pre_process_vars: tuple[str, ...] = () + _supports_vars: tuple[str, ...] = () + _vars: dict[str, Variable] = {} def __init__(self, data: ConfigProperty) -> None: """Instantiate class.""" @@ -37,7 +37,7 @@ def __init__(self, data: ConfigProperty) -> None: self._register_variable(var, self._data[var]) @property - def data(self) -> Dict[str, Any]: + def data(self) -> dict[str, Any]: """Return the underlying data as a dict.""" return self._data.dict() @@ -96,9 +96,7 @@ def _register_variable(self, var_name: str, var_value: Any) -> None: as a variable if it contains a lookup. """ - self._vars[var_name] = Variable( - name=var_name, value=var_value, variable_type="runway" - ) + self._vars[var_name] = Variable(name=var_name, value=var_value, variable_type="runway") @classmethod @abstractmethod @@ -117,7 +115,7 @@ def __contains__(self, name: str) -> bool: return name in self.__dict__ return self._data.__contains__(name) - def __getattr__(self, name: str): + def __getattr__(self, name: str) -> Any: """Implement evaluation of self.name. Args: @@ -134,11 +132,9 @@ def __getattr__(self, name: str): raise UnresolvedVariable(self._vars[name]) if name in super().__getattribute__("_data"): return super().__getattribute__("_data").__getattribute__(name) - raise AttributeError( - f"{self.__class__.__name__} object has not attribute {name}" - ) + raise AttributeError(f"{self.__class__.__name__} object has not attribute {name}") - def __getitem__(self, name: str): + def __getitem__(self, name: str) -> Any: """Implement evaluation of self[name]. Args: diff --git a/runway/config/models/cfngin/__init__.py b/runway/config/models/cfngin/__init__.py index e227ab563..1d37c938f 100644 --- a/runway/config/models/cfngin/__init__.py +++ b/runway/config/models/cfngin/__init__.py @@ -1,6 +1,6 @@ """CFNgin config models.""" -# pylint: disable=no-self-argument +# ruff: noqa: UP006, UP035 from __future__ import annotations import copy @@ -9,11 +9,9 @@ from typing import ( TYPE_CHECKING, Any, - Callable, Dict, List, Optional, - Type, TypeVar, Union, cast, @@ -91,18 +89,14 @@ class CfnginStackDefinitionModel(ConfigProperty): title="Stack Description", description="A description that will be applied to the stack in CloudFormation.", ) - enabled: bool = Field( - default=True, description="Whether the stack will be deployed." - ) + enabled: bool = Field(default=True, description="Whether the stack will be deployed.") in_progress_behavior: Optional[Literal["wait"]] = Field( default=None, title="Stack In Progress Behavior", description="The action to take when a stack's status is " "CREATE_IN_PROGRESS or UPDATE_IN_PROGRESS when trying to update it.", ) - locked: bool = Field( - default=False, description="Whether to limit updating of the stack." - ) + locked: bool = Field(default=False, description="Whether to limit updating of the stack.") name: str = Field(..., title="Stack Name", description="Name of the stack.") protected: bool = Field( default=False, @@ -153,7 +147,7 @@ class Config(ConfigProperty.Config): title = "CFNgin Stack Definition" @staticmethod - def schema_extra(schema: Dict[str, Any]) -> None: # type: ignore + def schema_extra(schema: dict[str, Any]) -> None: # type: ignore """Process the schema after it has been generated. Schema is modified in place. Return value is ignored. @@ -161,9 +155,7 @@ def schema_extra(schema: Dict[str, Any]) -> None: # type: ignore https://pydantic-docs.helpmanual.io/usage/schema/#schema-customization """ - schema["description"] = ( - "Define CloudFormation stacks using a Blueprint or Template." - ) + schema["description"] = "Define CloudFormation stacks using a Blueprint or Template." # prevents a false error when defining stacks as a dict schema.get("required", ["name"]).remove("name") @@ -175,30 +167,23 @@ def schema_extra(schema: Dict[str, Any]) -> None: # type: ignore {"type": "string", "pattern": utils.CFNGIN_LOOKUP_STRING_REGEX}, ] - _resolve_path_fields = cast( - "classmethod[Callable[..., Any]]", - validator("stack_policy_path", "template_path", allow_reuse=True)( - utils.resolve_path_field - ), - ) + _resolve_path_fields = validator( # pyright: ignore[reportUnknownVariableType] + "stack_policy_path", "template_path", allow_reuse=True + )(utils.resolve_path_field) @root_validator(pre=True) - def _validate_class_and_template(cls, values: Dict[str, Any]) -> Dict[str, Any]: + def _validate_class_and_template(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Validate class_path and template_path are not both provided.""" if values.get("class_path") and values.get("template_path"): raise ValueError("only one of class_path or template_path can be defined") return values @root_validator(pre=True) - def _validate_class_or_template(cls, values: Dict[str, Any]) -> Dict[str, Any]: + def _validate_class_or_template(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Ensure that either class_path or template_path is defined.""" # if the stack is disabled or locked, it is ok that these are missing required = values.get("enabled", True) and not values.get("locked", False) - if ( - not values.get("class_path") - and not values.get("template_path") - and required - ): + if not values.get("class_path") and not values.get("template_path") and required: raise ValueError("either class_path or template_path must be defined") return values @@ -223,7 +208,7 @@ class CfnginConfigDefinitionModel(ConfigProperty): title="CFNgin Cache Directory", description="Path to a local directory that CFNgin will use for local caching.", ) - log_formats: Dict[str, str] = Field( # TODO create model + log_formats: Dict[str, str] = Field( # TODO (kyle): create model default={}, description="Customize log message formatting by log level." ) lookups: Dict[str, str] = Field( @@ -246,9 +231,7 @@ class CfnginConfigDefinitionModel(ConfigProperty): ) package_sources: CfnginPackageSourcesDefinitionModel = Field( default=CfnginPackageSourcesDefinitionModel(), - description=CfnginPackageSourcesDefinitionModel.Config.schema_extra[ - "description" - ], + description=CfnginPackageSourcesDefinitionModel.Config.schema_extra["description"], ) persistent_graph_key: Optional[str] = Field( default=None, @@ -304,17 +287,14 @@ class Config(ConfigProperty.Config): schema_extra = {"description": "Configuration file for Runway's CFNgin."} title = "CFNgin Config File" - _resolve_path_fields = cast( - "classmethod[Callable[..., Any]]", - validator("cfngin_cache_dir", "sys_path", allow_reuse=True)( - utils.resolve_path_field - ), - ) + _resolve_path_fields = validator( # pyright: ignore[reportUnknownVariableType] + "cfngin_cache_dir", "sys_path", allow_reuse=True + )(utils.resolve_path_field) @validator("post_deploy", "post_destroy", "pre_deploy", "pre_destroy", pre=True) def _convert_hook_definitions( - cls, v: Union[Dict[str, Any], List[Dict[str, Any]]] - ) -> List[Dict[str, Any]]: + cls, v: Union[dict[str, Any], list[dict[str, Any]]] # noqa: N805 + ) -> list[dict[str, Any]]: """Convert hooks defined as a dict to a list.""" if isinstance(v, list): return v @@ -322,12 +302,12 @@ def _convert_hook_definitions( @validator("stacks", pre=True) def _convert_stack_definitions( - cls, v: Union[Dict[str, Any], List[Dict[str, Any]]] - ) -> List[Dict[str, Any]]: + cls, v: Union[dict[str, Any], list[dict[str, Any]]] # noqa: N805 + ) -> list[dict[str, Any]]: """Convert stacks defined as a dict to a list.""" if isinstance(v, list): return v - result: List[Dict[str, Any]] = [] + result: list[dict[str, Any]] = [] for name, stack in copy.deepcopy(v).items(): stack["name"] = name result.append(stack) @@ -335,8 +315,8 @@ def _convert_stack_definitions( @validator("stacks") def _validate_unique_stack_names( - cls, stacks: List[CfnginStackDefinitionModel] - ) -> List[CfnginStackDefinitionModel]: + cls, stacks: list[CfnginStackDefinitionModel] # noqa: N805 + ) -> list[CfnginStackDefinitionModel]: """Validate that each stack has a unique name.""" stack_names = [stack.name for stack in stacks] if len(set(stack_names)) != len(stack_names): @@ -347,21 +327,19 @@ def _validate_unique_stack_names( @classmethod def parse_file( - cls: Type[Model], + cls: type[Model], path: Union[str, Path], *, - content_type: Optional[str] = None, + content_type: str | None = None, encoding: str = "utf8", - proto: Optional[Protocol] = None, + proto: Protocol | None = None, allow_pickle: bool = False, ) -> Model: """Parse a file.""" return cast( "Model", cls.parse_raw( - Path(path).read_text( - encoding=locale.getpreferredencoding(do_setlocale=False) - ), + Path(path).read_text(encoding=locale.getpreferredencoding(do_setlocale=False)), content_type=content_type, # type: ignore encoding=encoding, proto=proto, # type: ignore @@ -371,13 +349,13 @@ def parse_file( @classmethod def parse_raw( - cls: Type[Model], + cls: type[Model], b: Union[bytes, str], *, - content_type: Optional[str] = None, # pylint: disable=unused-argument - encoding: str = "utf8", # pylint: disable=unused-argument - proto: Optional[Protocol] = None, # pylint: disable=unused-argument - allow_pickle: bool = False, # pylint: disable=unused-argument + content_type: str | None = None, # noqa: ARG003 + encoding: str = "utf8", # noqa: ARG003 + proto: Protocol | None = None, # noqa: ARG003 + allow_pickle: bool = False, # noqa: ARG003 ) -> Model: """Parse raw data.""" return cast("Model", cls.parse_obj(yaml.safe_load(b))) diff --git a/runway/config/models/cfngin/_package_sources.py b/runway/config/models/cfngin/_package_sources.py index b50309c8e..4221d0bee 100644 --- a/runway/config/models/cfngin/_package_sources.py +++ b/runway/config/models/cfngin/_package_sources.py @@ -1,6 +1,6 @@ """CFNgin package source models.""" -# pylint: disable=no-self-argument +# ruff: noqa: UP006, UP035 from __future__ import annotations from typing import Any, Dict, List, Optional @@ -38,9 +38,7 @@ class GitCfnginPackageSourceDefinitionModel(ConfigProperty): default=[], description="Array of paths relative to the root of the package source to add to $PATH.", ) - tag: Optional[str] = Field( - default=None, title="Git Tag", examples=["1.0.0", "v1.0.0"] - ) + tag: Optional[str] = Field(default=None, title="Git Tag", examples=["1.0.0", "v1.0.0"]) uri: str = Field( ..., title="Git Repository URI", @@ -58,7 +56,7 @@ class Config(ConfigProperty.Config): title = "CFNgin Git Repository Package Source Definition" @root_validator - def _validate_one_ref(cls, values: Dict[str, Any]) -> Dict[str, Any]: + def _validate_one_ref(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Ensure that only one ref is defined.""" ref_keys = ["branch", "commit", "tag"] count_ref_defs = sum(bool(values.get(i)) for i in ref_keys) @@ -166,23 +164,17 @@ class CfnginPackageSourcesDefinitionModel(ConfigProperty): git: List[GitCfnginPackageSourceDefinitionModel] = Field( default=[], title="CFNgin Git Repository Package Source Definitions", - description=GitCfnginPackageSourceDefinitionModel.Config.schema_extra[ - "description" - ], + description=GitCfnginPackageSourceDefinitionModel.Config.schema_extra["description"], ) local: List[LocalCfnginPackageSourceDefinitionModel] = Field( default=[], title="CFNgin Local Package Source Definitions", - description=LocalCfnginPackageSourceDefinitionModel.Config.schema_extra[ - "description" - ], + description=LocalCfnginPackageSourceDefinitionModel.Config.schema_extra["description"], ) s3: List[S3CfnginPackageSourceDefinitionModel] = Field( default=[], title="CFNgin S3 Package Source Definitions", - description=S3CfnginPackageSourceDefinitionModel.Config.schema_extra[ - "description" - ], + description=S3CfnginPackageSourceDefinitionModel.Config.schema_extra["description"], ) class Config(ConfigProperty.Config): diff --git a/runway/config/models/runway/__init__.py b/runway/config/models/runway/__init__.py index 3d919d723..daef9a546 100644 --- a/runway/config/models/runway/__init__.py +++ b/runway/config/models/runway/__init__.py @@ -1,8 +1,8 @@ """Runway config models.""" -# pylint: disable=no-self-argument from __future__ import annotations +# ruff: noqa: UP006, UP035 import locale import logging from pathlib import Path @@ -11,10 +11,8 @@ Any, Callable, Dict, - Generator, List, Optional, - Type, TypeVar, Union, cast, @@ -39,6 +37,8 @@ ) if TYPE_CHECKING: + from collections.abc import Generator + from pydantic import BaseModel Model = TypeVar("Model", bound=BaseModel) @@ -110,7 +110,7 @@ class Config(ConfigProperty.Config): """Model configuration.""" extra = Extra.forbid - schema_extra: Dict[str, Any] = { + schema_extra: dict[str, Any] = { "description": "Used to defined a role to assume while Runway is " "processing each module.", "examples": [ @@ -126,13 +126,13 @@ class Config(ConfigProperty.Config): title = "Runway Deployment.assume_role Definition" @validator("arn") - def _convert_arn_null_value(cls, v: Optional[str]) -> Optional[str]: + def _convert_arn_null_value(cls, v: Optional[str]) -> Optional[str]: # noqa: N805 """Convert a "nul" string into type(None).""" null_strings = ["null", "none", "undefined"] return None if isinstance(v, str) and v.lower() in null_strings else v @validator("duration", pre=True) - def _validate_duration(cls, v: Union[int, str]) -> Union[int, str]: + def _validate_duration(cls, v: Union[int, str]) -> Union[int, str]: # noqa: N805 """Validate duration is within the range allowed by AWS.""" if isinstance(v, str): return v @@ -142,12 +142,9 @@ def _validate_duration(cls, v: Union[int, str]) -> Union[int, str]: raise ValueError("duration must be less than or equal to 43,200") return v - _validate_string_is_lookup = cast( - "classmethod[Callable[..., Any]]", - validator("duration", allow_reuse=True, pre=True)( - utils.validate_string_is_lookup - ), - ) + _validate_string_is_lookup = validator( # pyright: ignore[reportUnknownVariableType] + "duration", allow_reuse=True, pre=True + )(utils.validate_string_is_lookup) class RunwayDeploymentRegionDefinitionModel(ConfigProperty): @@ -172,12 +169,9 @@ class Config(ConfigProperty.Config): } title = "Runway Deployment.regions Definition" - _validate_string_is_lookup = cast( - "classmethod[Callable[..., Any]]", - validator("parallel", allow_reuse=True, pre=True)( - utils.validate_string_is_lookup - ), - ) + _validate_string_is_lookup = validator( # pyright: ignore[reportUnknownVariableType] + "parallel", allow_reuse=True, pre=True + )(utils.validate_string_is_lookup) class RunwayDeploymentDefinitionModel(ConfigProperty): @@ -198,10 +192,10 @@ class RunwayDeploymentDefinitionModel(ConfigProperty): assume_role: Union[str, RunwayAssumeRoleDefinitionModel] = Field( default={}, description="Assume a role when processing the deployment. (supports lookups)", - examples=["arn:aws:iam::123456789012:role/name"] - + cast( - List[Any], RunwayAssumeRoleDefinitionModel.Config.schema_extra["examples"] - ), + examples=[ + "arn:aws:iam::123456789012:role/name", + *cast("list[Any]", RunwayAssumeRoleDefinitionModel.Config.schema_extra["examples"]), + ], ) env_vars: RunwayEnvVarsUnresolvedType = Field( default={}, @@ -283,7 +277,7 @@ class Config(ConfigProperty.Config): title = "Runway Deployment Definition" @staticmethod - def schema_extra(schema: Dict[str, Any]) -> None: # type: ignore + def schema_extra(schema: dict[str, Any]) -> None: # type: ignore """Process the schema after it has been generated. Schema is modified in place. Return value is ignored. @@ -302,10 +296,10 @@ def schema_extra(schema: Dict[str, Any]) -> None: # type: ignore ] @root_validator(pre=True) - def _convert_simple_module(cls, values: Dict[str, Any]) -> Dict[str, Any]: + def _convert_simple_module(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Convert simple modules to dicts.""" modules = values.get("modules", []) - result: List[Dict[str, Any]] = [] + result: List[dict[str, Any]] = [] for module in modules: if isinstance(module, str): result.append({"path": module}) @@ -315,7 +309,7 @@ def _convert_simple_module(cls, values: Dict[str, Any]) -> Dict[str, Any]: return values @root_validator(pre=True) - def _validate_regions(cls, values: Dict[str, Any]) -> Dict[str, Any]: + def _validate_regions(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Validate & simplify regions.""" raw_regions = values.get("regions", []) parallel_regions = values.get("parallel_regions", []) @@ -340,19 +334,16 @@ def _validate_regions(cls, values: Dict[str, Any]) -> Dict[str, Any]: values["parallel_regions"] = regions.parallel return values - _validate_string_is_lookup = cast( - "classmethod[Callable[..., Any]]", - validator( - "env_vars", - "environments", - "module_options", - "parallel_regions", - "parameters", - "regions", - allow_reuse=True, - pre=True, - )(utils.validate_string_is_lookup), - ) + _validate_string_is_lookup = validator( # pyright: ignore[reportUnknownVariableType] + "env_vars", + "environments", + "module_options", + "parallel_regions", + "parameters", + "regions", + allow_reuse=True, + pre=True, + )(utils.validate_string_is_lookup) class RunwayFutureDefinitionModel(ConfigProperty): @@ -457,7 +448,7 @@ class Config(ConfigProperty.Config): use_enum_values = True @root_validator(pre=True) - def _validate_name(cls, values: Dict[str, Any]) -> Dict[str, Any]: + def _validate_name(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Validate module name.""" if "name" in values: return values @@ -470,7 +461,7 @@ def _validate_name(cls, values: Dict[str, Any]) -> Dict[str, Any]: return values @root_validator(pre=True) - def _validate_path(cls, values: Dict[str, Any]) -> Dict[str, Any]: + def _validate_path(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Validate path and sets a default value if needed.""" if not values.get("path") and not values.get("parallel"): values["path"] = Path.cwd() @@ -478,12 +469,12 @@ def _validate_path(cls, values: Dict[str, Any]) -> Dict[str, Any]: @validator("parallel", pre=True) def _validate_parallel( - cls, v: List[Union[Dict[str, Any], str]], values: Dict[str, Any] - ) -> List[Dict[str, Any]]: + cls, v: List[Union[dict[str, Any], str]], values: dict[str, Any] # noqa: N805 + ) -> List[dict[str, Any]]: """Validate parallel.""" if v and values.get("path"): raise ValueError("only one of parallel or path can be defined") - result: List[Dict[str, Any]] = [] + result: List[dict[str, Any]] = [] for mod in v: if isinstance(mod, str): result.append({"path": mod}) @@ -491,18 +482,15 @@ def _validate_parallel( result.append(mod) return result - # TODO add regex to schema - _validate_string_is_lookup = cast( - "classmethod[Callable[..., Any]]", - validator( - "env_vars", - "environments", - "options", - "parameters", - allow_reuse=True, - pre=True, - )(utils.validate_string_is_lookup), - ) + # TODO (kyle): add regex to schema + _validate_string_is_lookup = validator( # pyright: ignore[reportUnknownVariableType] + "env_vars", + "environments", + "options", + "parameters", + allow_reuse=True, + pre=True, + )(utils.validate_string_is_lookup) # https://pydantic-docs.helpmanual.io/usage/postponed_annotations/#self-referencing-models @@ -534,10 +522,9 @@ class Config(ConfigProperty.Config): } title = "Runway Variables Definition" - _convert_null_values = cast( - "classmethod[Callable[..., Any]]", - validator("*", allow_reuse=True)(utils.convert_null_values), - ) + _convert_null_values = validator( # pyright: ignore[reportUnknownVariableType] + "*", allow_reuse=True + )(utils.convert_null_values) class RunwayVersionField(SpecifierSet): @@ -553,7 +540,7 @@ def __get_validators__(cls) -> Generator[Callable[..., Any], None, None]: yield cls._convert_value @classmethod - def __modify_schema__(cls, field_schema: Dict[str, Any]) -> None: + def __modify_schema__(cls, field_schema: dict[str, Any]) -> None: """Mutate the field schema in place. This is only called when output JSON schema from a model. @@ -622,7 +609,7 @@ class Config(ConfigProperty.Config): validate_assignment = True @root_validator(pre=True) - def _add_deployment_names(cls, values: Dict[str, Any]) -> Dict[str, Any]: + def _add_deployment_names(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Add names to deployments that are missing them.""" deployments = values.get("deployments", []) for i, deployment in enumerate(deployments): @@ -633,21 +620,19 @@ def _add_deployment_names(cls, values: Dict[str, Any]) -> Dict[str, Any]: @classmethod def parse_file( - cls: Type[Model], + cls: type[Model], path: Union[str, Path], *, - content_type: Optional[str] = None, + content_type: str | None = None, encoding: str = "utf8", - proto: Optional[Protocol] = None, + proto: Protocol | None = None, allow_pickle: bool = False, ) -> Model: """Parse a file.""" return cast( "Model", cls.parse_raw( - Path(path).read_text( - encoding=locale.getpreferredencoding(do_setlocale=False) - ), + Path(path).read_text(encoding=locale.getpreferredencoding(do_setlocale=False)), content_type=content_type, # type: ignore encoding=encoding, proto=proto, # type: ignore @@ -657,13 +642,13 @@ def parse_file( @classmethod def parse_raw( - cls: Type[Model], + cls: type[Model], b: Union[bytes, str], *, - content_type: Optional[str] = None, # pylint: disable=unused-argument - encoding: str = "utf8", # pylint: disable=unused-argument - proto: Optional[Protocol] = None, # pylint: disable=unused-argument - allow_pickle: bool = False, # pylint: disable=unused-argument + content_type: str | None = None, # noqa: ARG003 + encoding: str = "utf8", # noqa: ARG003 + proto: Protocol | None = None, # noqa: ARG003 + allow_pickle: bool = False, # noqa: ARG003 ) -> Model: """Parse raw data.""" return cast("Model", cls.parse_obj(yaml.safe_load(b))) diff --git a/runway/config/models/runway/_builtin_tests.py b/runway/config/models/runway/_builtin_tests.py index db66e3160..7bbd9d124 100644 --- a/runway/config/models/runway/_builtin_tests.py +++ b/runway/config/models/runway/_builtin_tests.py @@ -2,6 +2,7 @@ from __future__ import annotations +# ruff: noqa: UP006, UP035 from typing import TYPE_CHECKING, Any, Dict, List, Union, cast from pydantic import Extra, Field, validator @@ -40,7 +41,7 @@ class Config(ConfigProperty.Config): title = "Runway Test Definition" use_enum_values = True - def __new__(cls, **kwargs: Any) -> RunwayTestDefinitionModel: + def __new__(cls, **kwargs: Any) -> RunwayTestDefinitionModel: # noqa: PYI034 """Create a new instance of a class. Returns: @@ -50,20 +51,17 @@ def __new__(cls, **kwargs: Any) -> RunwayTestDefinitionModel: test_type = kwargs.get("type") if cls is RunwayTestDefinitionModel: if test_type == "cfn-lint": - return super().__new__(CfnLintRunwayTestDefinitionModel) + return super().__new__(CfnLintRunwayTestDefinitionModel) # type: ignore if test_type == "script": - return super().__new__(ScriptRunwayTestDefinitionModel) + return super().__new__(ScriptRunwayTestDefinitionModel) # type: ignore if test_type == "yamllint": - return super().__new__(YamlLintRunwayTestDefinitionModel) - return super().__new__(cls) + return super().__new__(YamlLintRunwayTestDefinitionModel) # type: ignore + return super().__new__(cls) # type: ignore - # TODO add regex to schema - _validate_string_is_lookup = cast( - "classmethod[Callable[..., Any]]", - validator("args", "required", allow_reuse=True, pre=True)( - utils.validate_string_is_lookup - ), - ) + # TODO (kyle): add regex to schema + _validate_string_is_lookup = validator( # pyright: ignore[reportUnknownVariableType] + "args", "required", allow_reuse=True, pre=True + )(utils.validate_string_is_lookup) class CfnLintRunwayTestArgs(ConfigProperty): @@ -84,13 +82,10 @@ class Config(ConfigProperty.Config): } title = "cfn-lint Runway Test Arguments" - # TODO add regex to schema - _validate_string_is_lookup = cast( - "classmethod[Callable[..., Any]]", - validator("cli_args", allow_reuse=True, pre=True)( - utils.validate_string_is_lookup - ), - ) + # TODO (kyle): add regex to schema + _validate_string_is_lookup = validator( # pyright: ignore[reportUnknownVariableType] + "cli_args", allow_reuse=True, pre=True + )(utils.validate_string_is_lookup) class CfnLintRunwayTestDefinitionModel(RunwayTestDefinitionModel): @@ -106,9 +101,7 @@ class CfnLintRunwayTestDefinitionModel(RunwayTestDefinitionModel): default=False, description="Whether the test must pass for subsequent tests to be run.", ) - type: Literal["cfn-lint"] = Field( - default="cfn-lint", description="The type of test to run." - ) + type: Literal["cfn-lint"] = Field(default="cfn-lint", description="The type of test to run.") class Config(RunwayTestDefinitionModel.Config): """Model configuration.""" @@ -135,12 +128,10 @@ class Config(ConfigProperty.Config): } title = "Script Runway Test Arguments" - # TODO add regex to schema + # TODO (kyle): add regex to schema _validate_string_is_lookup = cast( "classmethod[Callable[..., Any]]", - validator("commands", allow_reuse=True, pre=True)( - utils.validate_string_is_lookup - ), + validator("commands", allow_reuse=True, pre=True)(utils.validate_string_is_lookup), ) @@ -157,9 +148,7 @@ class ScriptRunwayTestDefinitionModel(RunwayTestDefinitionModel): default=False, description="Whether the test must pass for subsequent tests to be run.", ) - type: Literal["script"] = Field( - default="script", description="The type of test to run." - ) + type: Literal["script"] = Field(default="script", description="The type of test to run.") class Config(RunwayTestDefinitionModel.Config): """Model configuration.""" @@ -178,9 +167,7 @@ class YamlLintRunwayTestDefinitionModel(RunwayTestDefinitionModel): default=False, description="Whether the test must pass for subsequent tests to be run.", ) - type: Literal["yamllint"] = Field( - default="yamllint", description="The type of test to run." - ) + type: Literal["yamllint"] = Field(default="yamllint", description="The type of test to run.") class Config(RunwayTestDefinitionModel.Config): """Model configuration.""" diff --git a/runway/config/models/runway/options/cdk.py b/runway/config/models/runway/options/cdk.py index 182310460..b27db65e6 100644 --- a/runway/config/models/runway/options/cdk.py +++ b/runway/config/models/runway/options/cdk.py @@ -1,5 +1,6 @@ """Runway AWS Cloud Development Kit Module options.""" +# ruff: noqa: UP006, UP035 from __future__ import annotations from typing import List diff --git a/runway/config/models/runway/options/serverless.py b/runway/config/models/runway/options/serverless.py index 81f051916..02567a7db 100644 --- a/runway/config/models/runway/options/serverless.py +++ b/runway/config/models/runway/options/serverless.py @@ -1,5 +1,6 @@ """Runway Serverless Framework Module options.""" +# ruff: noqa: UP006, UP035 from __future__ import annotations from typing import Any, Dict, List, Optional diff --git a/runway/config/models/runway/options/terraform.py b/runway/config/models/runway/options/terraform.py index ade284365..0f049cb5a 100644 --- a/runway/config/models/runway/options/terraform.py +++ b/runway/config/models/runway/options/terraform.py @@ -1,9 +1,9 @@ """Runway Terraform Module options.""" -# pylint: disable=no-self-argument +# ruff: noqa: UP006, UP035 from __future__ import annotations -from typing import Dict, List, Optional, Union +from typing import List, Optional, Union from pydantic import Extra, Field, validator @@ -64,8 +64,8 @@ class Config(ConfigProperty.Config): @validator("args", pre=True) def _convert_args( - cls, v: Union[List[str], Dict[str, List[str]]] - ) -> Dict[str, List[str]]: + cls, v: Union[list[str], dict[str, list[str]]] # noqa: N805 + ) -> dict[str, list[str]]: """Convert args from list to dict.""" if isinstance(v, list): return {"apply": v} diff --git a/runway/config/models/utils.py b/runway/config/models/utils.py index 0a8f7fce8..fc774a178 100644 --- a/runway/config/models/utils.py +++ b/runway/config/models/utils.py @@ -3,8 +3,10 @@ from __future__ import annotations import re -from pathlib import Path -from typing import Any, Optional +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from pathlib import Path CFNGIN_LOOKUP_STRING_REGEX = r"^\${.*}$" RUNWAY_LOOKUP_STRING_ERROR = ValueError("field can only be a string if it's a lookup") @@ -17,7 +19,7 @@ def convert_null_values(v: Any) -> Any: return None if isinstance(v, str) and v.lower() in null_strings else v -def resolve_path_field(v: Optional[Path]) -> Optional[Path]: +def resolve_path_field(v: Path | None) -> Path | None: """Resolve sys_path.""" return v.resolve() if v else v diff --git a/runway/constants.py b/runway/constants.py index 12c53db5d..a8a4c7693 100644 --- a/runway/constants.py +++ b/runway/constants.py @@ -1,8 +1,10 @@ """Runway constants.""" -from typing import Any, Dict +from __future__ import annotations -BOTO3_CREDENTIAL_CACHE: Dict[str, Any] = {} +from typing import Any + +BOTO3_CREDENTIAL_CACHE: dict[str, Any] = {} """A global credential cache that can be shared among boto3 sessions. This is inherently threadsafe thanks to the GIL. (https://docs.python.org/3/glossary.html#term-global-interpreter-lock) diff --git a/runway/context/_base.py b/runway/context/_base.py index 84d3ff2af..992706b33 100644 --- a/runway/context/_base.py +++ b/runway/context/_base.py @@ -4,7 +4,7 @@ import logging from pathlib import Path -from typing import TYPE_CHECKING, Any, Optional, Union, cast +from typing import TYPE_CHECKING, Any, cast import boto3 import botocore.exceptions @@ -30,7 +30,7 @@ class BaseContext(DelCachedPropMixin): env: DeployEnvironment """Object containing information about the environment being deployed to.""" - logger: Union[PrefixAdaptor, RunwayLogger] + logger: PrefixAdaptor | RunwayLogger """Custom logger.""" sys_info: SystemInfo @@ -43,8 +43,8 @@ def __init__( self, *, deploy_environment: DeployEnvironment, - logger: Union[PrefixAdaptor, RunwayLogger] = LOGGER, - work_dir: Optional[Path] = None, + logger: PrefixAdaptor | RunwayLogger = LOGGER, + work_dir: Path | None = None, **_: Any, ) -> None: """Instantiate class. @@ -94,11 +94,11 @@ def is_noninteractive(self) -> bool: def get_session( self, *, - aws_access_key_id: Optional[str] = None, - aws_secret_access_key: Optional[str] = None, - aws_session_token: Optional[str] = None, - profile: Optional[str] = None, - region: Optional[str] = None, + aws_access_key_id: str | None = None, + aws_secret_access_key: str | None = None, + aws_session_token: str | None = None, + profile: str | None = None, + region: str | None = None, ) -> boto3.Session: """Create a thread-safe boto3 session. @@ -125,15 +125,11 @@ def get_session( region or "default", ) else: # use explicit values or grab values from env vars - aws_access_key_id = aws_access_key_id or self.env.vars.get( - "AWS_ACCESS_KEY_ID" - ) + aws_access_key_id = aws_access_key_id or self.env.vars.get("AWS_ACCESS_KEY_ID") aws_secret_access_key = aws_secret_access_key or self.env.vars.get( "AWS_SECRET_ACCESS_KEY" ) - aws_session_token = aws_session_token or self.env.vars.get( - "AWS_SESSION_TOKEN" - ) + aws_session_token = aws_session_token or self.env.vars.get("AWS_SESSION_TOKEN") if aws_access_key_id: self.logger.debug( 'building session with Access Key "%s" in region "%s"', @@ -151,10 +147,10 @@ def get_session( cred_provider = session._session.get_component("credential_provider") # type: ignore provider = cred_provider.get_provider("assume-role") # type: ignore provider.cache = BOTO3_CREDENTIAL_CACHE - provider._prompter = ui.getpass + provider._prompter = ui.getpass # noqa: SLF001 return session - # TODO remove after IaC tools support AWS SSO + # TODO (kyle): remove after IaC tools support AWS SSO def _inject_profile_credentials(self) -> None: # cov: ignore """Inject AWS credentials into self.env_vars if using an AWS profile. diff --git a/runway/context/_cfngin.py b/runway/context/_cfngin.py index c8f386f2b..f4f60a122 100644 --- a/runway/context/_cfngin.py +++ b/runway/context/_cfngin.py @@ -3,10 +3,11 @@ from __future__ import annotations import collections.abc +import contextlib import json import logging from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, MutableMapping, Optional, Union, cast +from typing import TYPE_CHECKING, Any, cast from pydantic import BaseModel @@ -27,6 +28,8 @@ from ._base import BaseContext if TYPE_CHECKING: + from collections.abc import MutableMapping + from mypy_boto3_s3.client import S3Client from .type_defs import PersistentGraphLocation @@ -34,7 +37,7 @@ LOGGER = cast(RunwayLogger, logging.getLogger(__name__)) -def get_fqn(base_fqn: str, delimiter: str, name: Optional[str] = None) -> str: +def get_fqn(base_fqn: str, delimiter: str, name: str | None = None) -> str: """Return the fully qualified name of an object within this context. If the name passed already appears to be a fully qualified name, it @@ -70,32 +73,32 @@ class CfnginContext(BaseContext): """ - _persistent_graph_lock_code: Optional[str] + _persistent_graph_lock_code: str | None _persistent_graph_lock_tag: str = "cfngin_lock_code" - _persistent_graph: Optional[Graph] + _persistent_graph: Graph | None _s3_bucket_verified: bool bucket_region: str config: CfnginConfig config_path: Path env: DeployEnvironment - force_stacks: List[str] - hook_data: Dict[str, Any] - logger: Union[PrefixAdaptor, RunwayLogger] + force_stacks: list[str] + hook_data: dict[str, Any] + logger: PrefixAdaptor | RunwayLogger parameters: MutableMapping[str, Any] - stack_names: List[str] + stack_names: list[str] def __init__( self, *, - config: Optional[CfnginConfig] = None, - config_path: Optional[Path] = None, - deploy_environment: Optional[DeployEnvironment] = None, - force_stacks: Optional[List[str]] = None, - logger: Union[PrefixAdaptor, RunwayLogger] = LOGGER, - parameters: Optional[MutableMapping[str, Any]] = None, - stack_names: Optional[List[str]] = None, - work_dir: Optional[Path] = None, + config: CfnginConfig | None = None, + config_path: Path | None = None, + deploy_environment: DeployEnvironment | None = None, + force_stacks: list[str] | None = None, + logger: PrefixAdaptor | RunwayLogger = LOGGER, + parameters: MutableMapping[str, Any] | None = None, + stack_names: list[str] | None = None, + work_dir: Path | None = None, **_: Any, ) -> None: """Instantiate class. @@ -137,17 +140,14 @@ def base_fqn(self) -> str: return self.config.namespace.replace(".", "-").lower() @cached_property - def bucket_name(self) -> Optional[str]: + def bucket_name(self) -> str | None: """Return ``cfngin_bucket`` from config, calculated name, or None.""" if not self.upload_to_s3: return None - return ( - self.config.cfngin_bucket - or f"cfngin-{self.get_fqn()}-{self.env.aws_region}" - ) + return self.config.cfngin_bucket or f"cfngin-{self.get_fqn()}-{self.env.aws_region}" @cached_property - def mappings(self) -> Dict[str, Dict[str, Dict[str, Any]]]: + def mappings(self) -> dict[str, dict[str, dict[str, Any]]]: """Return ``mappings`` from config.""" return self.config.mappings or {} @@ -185,7 +185,7 @@ def persistent_graph_locked(self) -> bool: return bool(self.persistent_graph_lock_code) @property - def persistent_graph_lock_code(self) -> Optional[str]: + def persistent_graph_lock_code(self) -> str | None: """Code used to lock the persistent graph S3 object.""" if not self._persistent_graph_lock_code and self.persistent_graph_location: self._persistent_graph_lock_code = self.persistent_graph_tags.get( @@ -194,23 +194,21 @@ def persistent_graph_lock_code(self) -> Optional[str]: return self._persistent_graph_lock_code @property - def persistent_graph_tags(self) -> Dict[str, str]: + def persistent_graph_tags(self) -> dict[str, str]: """Cache of tags on the persistent graph object.""" try: return { t["Key"]: t["Value"] - for t in self.s3_client.get_object_tagging( - **self.persistent_graph_location - ).get("TagSet", []) + for t in self.s3_client.get_object_tagging(**self.persistent_graph_location).get( + "TagSet", [] + ) } except self.s3_client.exceptions.NoSuchKey: - self.logger.debug( - "persistent graph object does not exist in S3; could not get tags" - ) + self.logger.debug("persistent graph object does not exist in S3; could not get tags") return {} @property - def persistent_graph(self) -> Optional[Graph]: + def persistent_graph(self) -> Graph | None: """Graph if a persistent graph is being used. Will create an "empty" object in S3 if one is not found. @@ -238,8 +236,7 @@ def persistent_graph(self) -> Optional[Graph]: ) except self.s3_client.exceptions.NoSuchKey: self.logger.info( - "persistent graph object does not exist in s3; " - "creating one now..." + "persistent graph object does not exist in s3; creating one now..." ) self.s3_client.put_object( Body=content.encode(), @@ -253,7 +250,7 @@ def persistent_graph(self) -> Optional[Graph]: return self._persistent_graph @persistent_graph.setter - def persistent_graph(self, graph: Optional[Graph]) -> None: + def persistent_graph(self, graph: Graph | None) -> None: """Load a persistent graph dict as a :class:`runway.cfngin.plan.Graph`.""" self._persistent_graph = graph @@ -281,12 +278,12 @@ def s3_client(self) -> S3Client: return self.get_session(region=self.bucket_region).client("s3") @cached_property - def stacks_dict(self) -> Dict[str, Stack]: + def stacks_dict(self) -> dict[str, Stack]: """Construct a dict of ``{stack.fqn: Stack}`` for easy access to stacks.""" return {stack.fqn: stack for stack in self.stacks} @cached_property - def stacks(self) -> List[Stack]: + def stacks(self) -> list[Stack]: """Stacks for the current action.""" return [ Stack( @@ -302,16 +299,12 @@ def stacks(self) -> List[Stack]: ] @cached_property - def tags(self) -> Dict[str, str]: + def tags(self) -> dict[str, str]: """Return ``tags`` from config.""" return ( self.config.tags if self.config.tags is not None - else ( - {"cfngin_namespace": self.config.namespace} - if self.config.namespace - else {} - ) + else ({"cfngin_namespace": self.config.namespace} if self.config.namespace else {}) ) @cached_property @@ -326,8 +319,7 @@ def upload_to_s3(self) -> bool: # explicitly set to an empty string. if self.config.cfngin_bucket == "": self.logger.debug( - "not uploading to s3; cfngin_bucket " - "is explicitly set to an empty string" + "not uploading to s3; cfngin_bucket is explicitly set to an empty string" ) return False @@ -336,9 +328,7 @@ def upload_to_s3(self) -> bool: # sense because we can't realistically auto generate a cfngin # bucket name in this case. if not self.config.namespace and not self.config.cfngin_bucket: - self.logger.debug( - "not uploading to s3; namespace & cfngin_bucket not provided" - ) + self.logger.debug("not uploading to s3; namespace & cfngin_bucket not provided") return False return True @@ -356,7 +346,7 @@ def copy(self) -> CfnginContext: work_dir=self.work_dir, ) - def get_fqn(self, name: Optional[str] = None) -> str: + def get_fqn(self, name: str | None = None) -> str: """Return the fully qualified name of an object within this context. If the name passed already appears to be a fully qualified name, it @@ -365,7 +355,7 @@ def get_fqn(self, name: Optional[str] = None) -> str: """ return get_fqn(self.base_fqn, self.config.namespace_delimiter, name) - def get_stack(self, name: str) -> Optional[Stack]: + def get_stack(self, name: str) -> Stack | None: """Get a stack by name. Args: @@ -400,11 +390,7 @@ def lock_persistent_graph(self, lock_code: str) -> None: try: self.s3_client.put_object_tagging( - Tagging={ - "TagSet": [ - {"Key": self._persistent_graph_lock_tag, "Value": lock_code} - ] - }, + Tagging={"TagSet": [{"Key": self._persistent_graph_lock_tag, "Value": lock_code}]}, **self.persistent_graph_location, ) self.logger.info( @@ -445,9 +431,7 @@ def put_persistent_graph(self, lock_code: str) -> None: ) if self.persistent_graph_lock_code != lock_code: - raise PersistentGraphLockCodeMismatch( - lock_code, self.persistent_graph_lock_code - ) + raise PersistentGraphLockCodeMismatch(lock_code, self.persistent_graph_lock_code) self.s3_client.put_object( Body=self.persistent_graph.dumps(4).encode(), @@ -457,9 +441,7 @@ def put_persistent_graph(self, lock_code: str) -> None: Tagging=f"{self._persistent_graph_lock_tag}={lock_code}", **self.persistent_graph_location, ) - self.logger.debug( - "persistent graph updated:\n%s", self.persistent_graph.dumps(indent=4) - ) + self.logger.debug("persistent graph updated:\n%s", self.persistent_graph.dumps(indent=4)) def set_hook_data(self, key: str, data: Any) -> None: """Set hook data for the given key. @@ -477,8 +459,7 @@ def set_hook_data(self, key: str, data: Any) -> None: if key in self.hook_data: raise KeyError( - f"Hook data for key {key} already exists, each hook " - "must have a unique data_key." + f"Hook data for key {key} already exists, each hook must have a unique data_key." ) self.hook_data[key] = data @@ -503,14 +484,10 @@ def unlock_persistent_graph(self, lock_code: str) -> bool: **self.persistent_graph_location, ) except self.s3_client.exceptions.NoSuchKey: - self.logger.info( - "persistent graph deleted; does not need to be unlocked" - ) + self.logger.info("persistent graph deleted; does not need to be unlocked") return True - self.logger.verbose( - 'unlocking persistent graph "%s"...', self.persistent_graph_location - ) + self.logger.verbose('unlocking persistent graph "%s"...', self.persistent_graph_location) if not self.persistent_graph_locked: raise PersistentGraphCannotUnlock( @@ -520,10 +497,8 @@ def unlock_persistent_graph(self, lock_code: str) -> bool: ) if self.persistent_graph_lock_code == lock_code: - try: + with contextlib.suppress(self.s3_client.exceptions.NoSuchKey): self.s3_client.delete_object_tagging(**self.persistent_graph_location) - except self.s3_client.exceptions.NoSuchKey: - pass self._persistent_graph_lock_code = None self.logger.info( 'unlocked persistent graph "%s/%s"', diff --git a/runway/context/_runway.py b/runway/context/_runway.py index 426e4977b..8758527de 100644 --- a/runway/context/_runway.py +++ b/runway/context/_runway.py @@ -4,7 +4,7 @@ import logging import sys -from typing import TYPE_CHECKING, Any, Optional, Union, cast +from typing import TYPE_CHECKING, Any, cast from ..compat import cached_property from ..core.components import DeployEnvironment @@ -19,7 +19,7 @@ LOGGER = cast("RunwayLogger", logging.getLogger(__name__)) -def str2bool(v: str): +def str2bool(v: str) -> bool: """Return boolean value of string.""" return v.lower() in ("yes", "true", "t", "1", "on", "y") @@ -27,16 +27,16 @@ def str2bool(v: str): class RunwayContext(BaseContext): """Runway context object.""" - command: Optional[RunwayActionTypeDef] + command: RunwayActionTypeDef | None """Runway command/action being run.""" def __init__( self, *, - command: Optional[RunwayActionTypeDef] = None, - deploy_environment: Optional[DeployEnvironment] = None, - logger: Union[PrefixAdaptor, RunwayLogger] = LOGGER, - work_dir: Optional[Path] = None, + command: RunwayActionTypeDef | None = None, + deploy_environment: DeployEnvironment | None = None, + logger: PrefixAdaptor | RunwayLogger = LOGGER, + work_dir: Path | None = None, **_: Any, ) -> None: """Instantiate class. diff --git a/runway/context/sys_info.py b/runway/context/sys_info.py index a0c12d2b5..52dcc7999 100644 --- a/runway/context/sys_info.py +++ b/runway/context/sys_info.py @@ -5,15 +5,16 @@ import os import platform import sys -from typing import Any, ClassVar, Optional, cast +from typing import Any, ClassVar, cast, final from ..compat import cached_property +@final class OsInfo: """Information about the operating system running on the current system.""" - __instance: ClassVar[Optional[OsInfo]] = None + __instance: ClassVar[OsInfo | None] = None def __new__(cls, *args: Any, **kwargs: Any) -> OsInfo: """Create a new instance of class. @@ -69,10 +70,11 @@ def clear_singleton(cls) -> None: cls.__instance = None +@final class SystemInfo: """Information about the system running Runway.""" - __instance: ClassVar[Optional[SystemInfo]] = None + __instance: ClassVar[SystemInfo | None] = None def __new__(cls, *args: Any, **kwargs: Any) -> SystemInfo: """Create a new instance of class. @@ -87,9 +89,7 @@ def __new__(cls, *args: Any, **kwargs: Any) -> SystemInfo: @cached_property def is_frozen(self) -> bool: """Whether or not Runway is running from a frozen package (Pyinstaller).""" - if getattr(sys, "frozen", False): - return True - return False + return bool(getattr(sys, "frozen", False)) @cached_property def os(self) -> OsInfo: diff --git a/runway/core/__init__.py b/runway/core/__init__.py index 508b67976..e74eb7b99 100644 --- a/runway/core/__init__.py +++ b/runway/core/__init__.py @@ -5,7 +5,7 @@ import logging as _logging import sys as _sys import traceback as _traceback -from typing import TYPE_CHECKING, Any, Dict, List, Optional, cast +from typing import TYPE_CHECKING, Any, cast import yaml as _yaml @@ -48,9 +48,7 @@ def __init__(self, config: RunwayConfig, context: RunwayContext) -> None: self.__assert_config_version() self.ctx.env.log_name() - def deploy( - self, deployments: Optional[List[RunwayDeploymentDefinition]] = None - ) -> None: + def deploy(self, deployments: list[RunwayDeploymentDefinition] | None = None) -> None: """Deploy action. Args: @@ -58,13 +56,9 @@ def deploy( all deployments in the config will be run. """ - self.__run_action( - "deploy", deployments if deployments is not None else self.deployments - ) + self.__run_action("deploy", deployments if deployments is not None else self.deployments) - def destroy( - self, deployments: Optional[List[RunwayDeploymentDefinition]] = None - ) -> None: + def destroy(self, deployments: list[RunwayDeploymentDefinition] | None = None) -> None: """Destroy action. Args: @@ -85,8 +79,8 @@ def destroy( self.reverse_deployments(self.deployments) def get_env_vars( - self, deployments: Optional[List[RunwayDeploymentDefinition]] = None - ) -> Dict[str, Any]: + self, deployments: list[RunwayDeploymentDefinition] | None = None + ) -> dict[str, Any]: """Get env_vars defined in the config. Args: @@ -97,7 +91,7 @@ def get_env_vars( """ deployments = deployments or self.deployments - result: Dict[str, str] = {} + result: dict[str, str] = {} for deployment in deployments: obj = components.Deployment( context=self.ctx, definition=deployment, variables=self.variables @@ -105,9 +99,7 @@ def get_env_vars( result.update(obj.env_vars_config) return result - def init( - self, deployments: Optional[List[RunwayDeploymentDefinition]] = None - ) -> None: + def init(self, deployments: list[RunwayDeploymentDefinition] | None = None) -> None: """Init action. Args: @@ -115,13 +107,9 @@ def init( all deployments in the config will be run. """ - self.__run_action( - "init", deployments if deployments is not None else self.deployments - ) + self.__run_action("init", deployments if deployments is not None else self.deployments) - def plan( - self, deployments: Optional[List[RunwayDeploymentDefinition]] = None - ) -> None: + def plan(self, deployments: list[RunwayDeploymentDefinition] | None = None) -> None: """Plan action. Args: @@ -129,14 +117,12 @@ def plan( all deployments in the config will be run. """ - self.__run_action( - "plan", deployments if deployments is not None else self.deployments - ) + self.__run_action("plan", deployments if deployments is not None else self.deployments) @staticmethod def reverse_deployments( - deployments: List[RunwayDeploymentDefinition], - ) -> List[RunwayDeploymentDefinition]: + deployments: list[RunwayDeploymentDefinition], + ) -> list[RunwayDeploymentDefinition]: """Reverse deployments and the modules within them. Args: @@ -146,7 +132,7 @@ def reverse_deployments( Deployments and modules in reverse order. """ - result: List[RunwayDeploymentDefinition] = [] + result: list[RunwayDeploymentDefinition] = [] for deployment in deployments: deployment.reverse() result.insert(0, deployment) @@ -180,7 +166,7 @@ def test(self) -> None: _sys.exit(1) self.ctx.command = "test" - failed_tests: List[str] = [] + failed_tests: list[str] = [] LOGGER.info("found %i test(s)", len(self.tests)) for tst in self.tests: @@ -198,7 +184,7 @@ def test(self) -> None: try: handler.handle(tst.name, tst.args) logger.success("running test (pass)") - except (Exception, SystemExit) as err: # pylint: disable=broad-except + except (Exception, SystemExit) as err: # for lack of an easy, better way to do this atm, assume # SystemExits are due to a test failure and the failure reason # has already been properly logged by the handler or the @@ -217,7 +203,7 @@ def test(self) -> None: _sys.exit(1) LOGGER.success("all tests passed") - def __assert_config_version(self): + def __assert_config_version(self) -> None: """Assert the config supports this version of Runway.""" if not self.required_version: LOGGER.debug("required Runway version not specified") @@ -245,7 +231,7 @@ def __assert_config_version(self): def __run_action( self, action: type_defs.RunwayActionTypeDef, - deployments: Optional[List[RunwayDeploymentDefinition]], + deployments: list[RunwayDeploymentDefinition] | None, ) -> None: """Run an action on a list of deployments. diff --git a/runway/core/components/_deploy_environment.py b/runway/core/components/_deploy_environment.py index 261d4a071..0097de7e7 100644 --- a/runway/core/components/_deploy_environment.py +++ b/runway/core/components/_deploy_environment.py @@ -7,7 +7,7 @@ import os import sys from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, Optional, cast +from typing import TYPE_CHECKING, Any, Optional, cast import click @@ -20,7 +20,7 @@ import git from git.exc import InvalidGitRepositoryError except ImportError: # cov: ignore - git = object # pylint: disable=invalid-name + git = object InvalidGitRepositoryError = AttributeError if TYPE_CHECKING: @@ -41,7 +41,7 @@ class DeployEnvironment(DelCachedPropMixin): def __init__( self, *, - environ: Optional[Dict[str, str]] = None, + environ: Optional[dict[str, str]] = None, explicit_name: Optional[str] = None, ignore_git_branch: bool = False, root_dir: Optional[Path] = None, @@ -82,9 +82,7 @@ def aws_profile(self, profile_name: str) -> None: @property def aws_region(self) -> str: """Get AWS region from environment variables.""" - return self.vars.get( - "AWS_REGION", self.vars.get("AWS_DEFAULT_REGION", "us-east-1") - ) + return self.vars.get("AWS_REGION", self.vars.get("AWS_DEFAULT_REGION", "us-east-1")) @aws_region.setter def aws_region(self, region: str) -> None: @@ -261,9 +259,7 @@ def name(self) -> str: else: self.name_derived_from = "directory" if self.root_dir.name.startswith("ENV-"): - LOGGER.verbose( - 'stripped "ENV-" from the directory name "%s"', self.root_dir.name - ) + LOGGER.verbose('stripped "ENV-" from the directory name "%s"', self.root_dir.name) name = self.root_dir.name[4:] else: name = self.root_dir.name @@ -307,9 +303,7 @@ def log_name(self) -> None: """Output name to log.""" name = self.name # resolve if not already resolved if self.name_derived_from == "explicit": - LOGGER.info( - 'deploy environment "%s" is explicitly defined in the environment', name - ) + LOGGER.info('deploy environment "%s" is explicitly defined in the environment', name) LOGGER.info( "if not correct, update the value or unset it to fall back " "to the name of the current git branch or parent directory" @@ -337,9 +331,7 @@ def _parse_branch_name(self) -> Optional[str]: """Parse branch name for use as deploy environment name.""" if self.branch_name: if self.branch_name.startswith("ENV-"): - LOGGER.verbose( - 'stripped "ENV-" from the branch name "%s"', self.branch_name - ) + LOGGER.verbose('stripped "ENV-" from the branch name "%s"', self.branch_name) return self.branch_name[4:] if self.branch_name == "master": LOGGER.verbose('translated branch name "master" to "common"') @@ -354,11 +346,11 @@ def _parse_branch_name(self) -> Optional[str]: return result return self.branch_name - def _update_vars(self, env_vars: Dict[str, str]) -> None: + def _update_vars(self, env_vars: dict[str, str]) -> None: """Update vars and log the change. Args: - env_vars (Dict[str, str]): Dict to update self.vars with. + env_vars: Dict to update self.vars with. """ self.vars.update(env_vars) diff --git a/runway/core/components/_deployment.py b/runway/core/components/_deployment.py index 882e402a9..a073dff3e 100644 --- a/runway/core/components/_deployment.py +++ b/runway/core/components/_deployment.py @@ -6,7 +6,7 @@ import logging import multiprocessing import sys -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union +from typing import TYPE_CHECKING, Any, Optional, Union from ..._logging import PrefixAdaptor from ...compat import cached_property @@ -57,13 +57,11 @@ def __init__( self.__merge_env_vars() @property - def assume_role_config(self) -> Dict[str, Union[bool, int, str]]: + def assume_role_config(self) -> dict[str, Union[bool, int, str]]: """Parse the definition to get assume role arguments.""" assume_role = self.definition.assume_role if not assume_role: - self.logger.debug( - "assume_role not configured for deployment: %s", self.name - ) + self.logger.debug("assume_role not configured for deployment: %s", self.name) return {} if isinstance(assume_role, str): # type: ignore self.logger.debug("role found: %s", assume_role) @@ -71,9 +69,7 @@ def assume_role_config(self) -> Dict[str, Union[bool, int, str]]: elif isinstance(assume_role, dict): # type: ignore assume_role = RunwayAssumeRoleDefinitionModel.parse_obj(assume_role) if not assume_role.arn: - self.logger.debug( - "assume_role not configured for deployment: %s", self.name - ) + self.logger.debug("assume_role not configured for deployment: %s", self.name) return {} return { "duration_seconds": assume_role.duration, @@ -83,23 +79,22 @@ def assume_role_config(self) -> Dict[str, Union[bool, int, str]]: } @property - def env_vars_config(self) -> Dict[str, str]: + def env_vars_config(self) -> dict[str, str]: """Parse the definition to get the correct env_vars configuration.""" try: if not self.definition.env_vars: return {} except UnresolvedVariable: - # pylint: disable=protected-access - if "env_vars" in self.definition._vars: - var = self.definition._vars["env_vars"] + if "env_vars" in self.definition._vars: # noqa: SLF001 + var = self.definition._vars["env_vars"] # noqa: SLF001 var.resolve(self.ctx, variables=self._variables) - self.definition._data["env_vars"] = var.value + self.definition._data["env_vars"] = var.value # noqa: SLF001 else: raise return flatten_path_lists(self.definition.env_vars, str(self.ctx.env.root_dir)) @cached_property - def regions(self) -> List[str]: + def regions(self) -> list[str]: """List of regions this deployment is associated with.""" return self.definition.parallel_regions or self.definition.regions @@ -114,9 +109,7 @@ def deploy(self) -> None: High level method for running a deployment. """ - self.logger.verbose( - "attempting to deploy to region(s): %s", ", ".join(self.regions) - ) + self.logger.verbose("attempting to deploy to region(s): %s", ", ".join(self.regions)) if self.use_async: return self.__async("deploy") return self.__sync("deploy") @@ -127,9 +120,7 @@ def destroy(self) -> None: High level method for running a deployment. """ - self.logger.verbose( - "attempting to destroy in region(s): %s", ", ".join(self.regions) - ) + self.logger.verbose("attempting to destroy in region(s): %s", ", ".join(self.regions)) if self.use_async: return self.__async("destroy") return self.__sync("destroy") @@ -140,9 +131,7 @@ def init(self) -> None: High level method for running a deployment. """ - self.logger.verbose( - "attempting to initialize region(s): %s", ", ".join(self.regions) - ) + self.logger.verbose("attempting to initialize region(s): %s", ", ".join(self.regions)) if self.use_async: return self.__async("init") return self.__sync("init") @@ -189,9 +178,7 @@ def run(self, action: RunwayActionTypeDef, region: str) -> None: variables=self._variables, ) - def validate_account_credentials( - self, context: Optional[RunwayContext] = None - ) -> None: + def validate_account_credentials(self, context: Optional[RunwayContext] = None) -> None: """Exit if requested deployment account doesn't match credentials. Args: @@ -213,7 +200,7 @@ def validate_account_credentials( ) sys.exit(1) self.logger.info( - "verified current AWS account matches required " + 'account id "%s"', + 'verified current AWS account matches required account id "%s"', self.definition.account_id, ) if self.definition.account_alias: @@ -236,9 +223,7 @@ def __merge_env_vars(self) -> None: self.logger.verbose( "environment variable overrides are being applied to this deployment" ) - self.logger.debug( - "environment variable overrides: %s", self.env_vars_config - ) + self.logger.debug("environment variable overrides: %s", self.env_vars_config) self.ctx.env.vars = merge_dicts(self.ctx.env.vars, self.env_vars_config) def __async(self, action: RunwayActionTypeDef) -> None: @@ -248,16 +233,12 @@ def __async(self, action: RunwayActionTypeDef) -> None: action: Name of action to run. """ - self.logger.info( - "processing regions in parallel... (output will be interwoven)" - ) + self.logger.info("processing regions in parallel... (output will be interwoven)") with concurrent.futures.ProcessPoolExecutor( max_workers=self.ctx.env.max_concurrent_regions, mp_context=multiprocessing.get_context("fork"), ) as executor: - futures = [ - executor.submit(self.run, *[action, region]) for region in self.regions - ] + futures = [executor.submit(self.run, *[action, region]) for region in self.regions] for job in futures: job.result() # raise exceptions / exit as needed @@ -278,7 +259,7 @@ def run_list( cls, action: RunwayActionTypeDef, context: RunwayContext, - deployments: List[RunwayDeploymentDefinition], + deployments: list[RunwayDeploymentDefinition], future: RunwayFutureDefinitionModel, variables: RunwayVariablesDefinition, ) -> None: diff --git a/runway/core/components/_module.py b/runway/core/components/_module.py index bc0e6cedc..73c2d8fe6 100644 --- a/runway/core/components/_module.py +++ b/runway/core/components/_module.py @@ -7,7 +7,7 @@ import logging import multiprocessing import sys -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast +from typing import TYPE_CHECKING, Any, Optional, Union, cast import yaml @@ -66,9 +66,7 @@ def __init__( """ self.__deployment = deployment self.__future = future or RunwayFutureDefinitionModel() - self.__variables = variables or RunwayVariablesDefinition( - RunwayVariablesDefinitionModel() - ) + self.__variables = variables or RunwayVariablesDefinition(RunwayVariablesDefinitionModel()) self.ctx = context.copy() # each module has it's own instance of context definition.resolve(self.ctx, variables=variables) self.definition = definition @@ -76,7 +74,7 @@ def __init__( self.logger = PrefixAdaptor(self.fqn, LOGGER) @cached_property - def child_modules(self) -> List[Module]: + def child_modules(self) -> list[Module]: """Return child modules.""" return [ self.__class__( @@ -109,14 +107,14 @@ def environments(self) -> RunwayEnvironmentsType: return tmp @cached_property - def fqn(self): + def fqn(self) -> str: """Fully qualified name.""" if not self.__deployment: return self.name return f"{self.__deployment.name}.{self.name}" @cached_property - def opts_from_file(self) -> Dict[str, Any]: + def opts_from_file(self) -> dict[str, Any]: """Load module options from local file.""" opts_file = self.path.module_root / "runway.module.yml" if opts_file.is_file(): @@ -134,9 +132,9 @@ def path(self) -> ModulePath: # lazy load the path ) @cached_property - def payload(self) -> Dict[str, Any]: # lazy load the payload + def payload(self) -> dict[str, Any]: # lazy load the payload """Return payload to be passed to module class handler class.""" - payload: Dict[str, Any] = {} + payload: dict[str, Any] = {} if self.__deployment: payload.update( { @@ -216,9 +214,7 @@ def plan(self) -> None: if not self.child_modules: return self.run("plan") if self.use_async: - self.logger.info( - "processing of modules will be done in parallel during deploy/destroy" - ) + self.logger.info("processing of modules will be done in parallel during deploy/destroy") return self.__sync("plan") def run(self, action: RunwayActionTypeDef) -> None: @@ -231,9 +227,7 @@ def run(self, action: RunwayActionTypeDef) -> None: """ LOGGER.info("") - self.logger.notice( - "processing module in %s (in progress)", self.ctx.env.aws_region - ) + self.logger.notice("processing module in %s (in progress)", self.ctx.env.aws_region) self.logger.verbose("module payload: %s", json.dumps(self.payload)) if self.should_skip: return @@ -248,9 +242,7 @@ def run(self, action: RunwayActionTypeDef) -> None: else: self.logger.error('"%s" is missing method "%s"', inst, action) sys.exit(1) - self.logger.success( - "processing module in %s (complete)", self.ctx.env.aws_region - ) + self.logger.success("processing module in %s (complete)", self.ctx.env.aws_region) def __async(self, action: RunwayActionTypeDef) -> None: """Execute asynchronously. @@ -259,9 +251,7 @@ def __async(self, action: RunwayActionTypeDef) -> None: action: Name of action to run. """ - self.logger.info( - "processing modules in parallel... (output will be interwoven)" - ) + self.logger.info("processing modules in parallel... (output will be interwoven)") # Can't use threading or ThreadPoolExecutor here because # we need to be able to do things like `cd` which is not # thread safe. @@ -269,9 +259,7 @@ def __async(self, action: RunwayActionTypeDef) -> None: max_workers=self.ctx.env.max_concurrent_modules, mp_context=multiprocessing.get_context("fork"), ) as executor: - futures = [ - executor.submit(child.run, *[action]) for child in self.child_modules - ] + futures = [executor.submit(child.run, *[action]) for child in self.child_modules] for job in futures: job.result() # raise exceptions / exit as needed @@ -294,9 +282,7 @@ def __merge_env_vars(self, env_vars: RunwayEnvVarsType) -> None: self.logger.verbose( "environment variable overrides are being applied to this module" ) - self.logger.debug( - "environment variable overrides: %s", resolved_env_vars - ) + self.logger.debug("environment variable overrides: %s", resolved_env_vars) self.ctx.env.vars = merge_dicts(self.ctx.env.vars, resolved_env_vars) @classmethod @@ -304,7 +290,7 @@ def run_list( cls, action: RunwayActionTypeDef, context: RunwayContext, - modules: List[RunwayModuleDefinition], + modules: list[RunwayModuleDefinition], variables: RunwayVariablesDefinition, deployment: RunwayDeploymentDefinition = None, future: Optional[RunwayFutureDefinitionModel] = None, @@ -341,7 +327,7 @@ def __getitem__(self, key: str) -> Any: def validate_environment( context: RunwayContext, - env_def: Optional[Union[bool, Dict[str, Any], int, str, List[str]]], + env_def: Optional[Union[bool, dict[str, Any], int, str, list[str]]], logger: Union[PrefixAdaptor, RunwayLogger] = LOGGER, ) -> Optional[bool]: """Check if an environment should be deployed to. diff --git a/runway/core/components/_module_path.py b/runway/core/components/_module_path.py index 29b8d16b2..4eff846a1 100644 --- a/runway/core/components/_module_path.py +++ b/runway/core/components/_module_path.py @@ -5,7 +5,7 @@ import logging import re from pathlib import Path -from typing import TYPE_CHECKING, ClassVar, Dict, Optional, Type, Union +from typing import TYPE_CHECKING, ClassVar from urllib.parse import parse_qs from typing_extensions import TypedDict @@ -25,7 +25,7 @@ class ModulePathMetadataTypeDef(TypedDict): """Type definition for ModulePath.metadata.""" - arguments: Dict[str, str] + arguments: dict[str, str] cache_dir: Path location: str source: str @@ -36,16 +36,16 @@ class ModulePath: """Handler for the ``path`` field of a Runway module.""" ARGS_REGEX: ClassVar[str] = r"(\?)(?P.*)$" - REMOTE_SOURCE_HANDLERS: ClassVar[Dict[str, Type[Source]]] = {"git": Git} + REMOTE_SOURCE_HANDLERS: ClassVar[dict[str, type[Source]]] = {"git": Git} SOURCE_REGEX: ClassVar[str] = r"(?P[a-z]+)(\:\:)" URI_REGEX: ClassVar[str] = r"(?P[a-z]+://[a-zA-Z0-9\./-]+?(?=//|\?|$))" def __init__( self, - definition: Optional[Union[Path, str]] = None, + definition: Path | str | None = None, *, cache_dir: Path, - deploy_environment: Optional[DeployEnvironment] = None, + deploy_environment: DeployEnvironment | None = None, ) -> None: """Instantiate class. @@ -60,24 +60,19 @@ def __init__( self.env = deploy_environment or DeployEnvironment() @cached_property - def arguments(self) -> Dict[str, str]: + def arguments(self) -> dict[str, str]: """Remote source arguments.""" if isinstance(self.definition, str): match = re.match(rf"^.*{self.ARGS_REGEX}", self.definition) if match: - return { - k: ",".join(v) for k, v in parse_qs(match.group("args")).items() - } + return {k: ",".join(v) for k, v in parse_qs(match.group("args")).items()} return {} @cached_property def location(self) -> str: """Location of the module.""" if isinstance(self.definition, str): - if ( - re.match(r"^(/|//|\.|\./)", self.definition) - or "::" not in self.definition - ): + if re.match(r"^(/|//|\.|\./)", self.definition) or "::" not in self.definition: return re.sub(self.ARGS_REGEX, "", self.definition) no_src = re.sub(rf"^{self.SOURCE_REGEX}", "", self.definition) no_uri = re.sub(rf"^{self.URI_REGEX}", "", no_src) @@ -141,12 +136,10 @@ def _fetch_remote_source(self) -> Path: @classmethod def parse_obj( cls, - obj: Optional[ - Union[Path, RunwayModuleDefinition, RunwayModuleDefinitionModel, str] - ], + obj: Path | RunwayModuleDefinition | RunwayModuleDefinitionModel | str | None, *, cache_dir: Path, - deploy_environment: Optional[DeployEnvironment] = None, + deploy_environment: DeployEnvironment | None = None, ) -> ModulePath: """Parse object. diff --git a/runway/core/components/_module_type.py b/runway/core/components/_module_type.py index 31abc8c58..8b6d5c00a 100644 --- a/runway/core/components/_module_type.py +++ b/runway/core/components/_module_type.py @@ -5,14 +5,15 @@ import logging import os import sys -from pathlib import Path -from typing import TYPE_CHECKING, ClassVar, Dict, Optional, Type, cast +from typing import TYPE_CHECKING, ClassVar, cast from typing_extensions import Literal from ...utils import load_object_from_string if TYPE_CHECKING: + from pathlib import Path + from ...config.models.runway import RunwayModuleTypeTypeDef from ...module.base import RunwayModule @@ -60,7 +61,7 @@ class RunwayModuleType: """ - EXTENSION_MAP: ClassVar[Dict[str, str]] = { + EXTENSION_MAP: ClassVar[dict[str, str]] = { "cdk": "runway.module.cdk.CloudDevelopmentKit", "cfn": "runway.module.cloudformation.CloudFormation", "k8s": "runway.module.k8s.K8s", @@ -69,7 +70,7 @@ class RunwayModuleType: "web": "runway.module.staticsite.handler.StaticSite", } - TYPE_MAP: ClassVar[Dict[str, str]] = { + TYPE_MAP: ClassVar[dict[str, str]] = { "cdk": EXTENSION_MAP["cdk"], "cloudformation": EXTENSION_MAP["cfn"], "kubernetes": EXTENSION_MAP["k8s"], @@ -81,8 +82,8 @@ class RunwayModuleType: def __init__( self, path: Path, - class_path: Optional[str] = None, - type_str: Optional[RunwayModuleTypeTypeDef] = None, + class_path: str | None = None, + type_str: RunwayModuleTypeTypeDef | None = None, ) -> None: """Instantiate class. @@ -97,7 +98,7 @@ def __init__( self.type_str = type_str self.module_class = self._determine_module_class() - def _determine_module_class(self) -> Type[RunwayModule]: + def _determine_module_class(self) -> type[RunwayModule]: """Determine type of module and return deployment module class. Returns: @@ -113,16 +114,12 @@ def _determine_module_class(self) -> Type[RunwayModule]: if not self.class_path and self.type_str: self.class_path = self.TYPE_MAP.get(self.type_str, None) if self.class_path: - LOGGER.debug( - 'module class "%s" determined from explicit type', self.class_path - ) + LOGGER.debug('module class "%s" determined from explicit type', self.class_path) if not self.class_path: self._set_class_path_based_on_extension() if self.class_path: - LOGGER.debug( - 'module class "%s" determined from path extension', self.class_path - ) + LOGGER.debug('module class "%s" determined from path extension', self.class_path) if not self.class_path: self._set_class_path_based_on_autodetection() @@ -130,15 +127,15 @@ def _determine_module_class(self) -> Type[RunwayModule]: if not self.class_path: LOGGER.error( 'module class could not be determined from path "%s"', - os.path.basename(self.path), + self.path.name, ) sys.exit(1) - return cast(Type["RunwayModule"], load_object_from_string(self.class_path)) + return cast(type["RunwayModule"], load_object_from_string(self.class_path)) def _set_class_path_based_on_extension(self) -> None: """Based on the directory suffix set the class_path.""" - basename = os.path.basename(self.path) + basename = self.path.name basename_split = basename.split(".") extension = basename_split[len(basename_split) - 1] self.class_path = self.EXTENSION_MAP.get(extension, None) @@ -161,9 +158,7 @@ def _set_class_path_based_on_autodetection(self) -> None: self.class_path = self.TYPE_MAP.get("serverless", None) elif next(self.path.glob("*.tf"), None): self.class_path = self.TYPE_MAP.get("terraform", None) - elif (self.path / "cdk.json").is_file() and ( - self.path / "package.json" - ).is_file(): + elif (self.path / "cdk.json").is_file() and (self.path / "package.json").is_file(): self.class_path = self.TYPE_MAP.get("cdk", None) elif (self.path / "overlays").is_dir() and self._find_kustomize_files(): self.class_path = self.TYPE_MAP.get("kubernetes", None) @@ -174,9 +169,7 @@ def _set_class_path_based_on_autodetection(self) -> None: ): self.class_path = self.TYPE_MAP.get("cloudformation", None) if self.class_path: - LOGGER.debug( - 'module class "%s" determined from autodetection', self.class_path - ) + LOGGER.debug('module class "%s" determined from autodetection', self.class_path) def _find_kustomize_files(self) -> bool: """Return true if kustomize yaml file found. diff --git a/runway/core/providers/aws/_account.py b/runway/core/providers/aws/_account.py index 5d6c0cd4f..d5f8b4945 100644 --- a/runway/core/providers/aws/_account.py +++ b/runway/core/providers/aws/_account.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, List, Union +from typing import TYPE_CHECKING, Union from ....compat import cached_property @@ -25,12 +25,12 @@ def __init__(self, context: Union[CfnginContext, RunwayContext]) -> None: self.__ctx = context @cached_property - def aliases(self) -> List[str]: + def aliases(self) -> list[str]: """Get the aliases of the AWS account.""" # Super overkill here using pagination when an account can only # have a single alias, but at least this implementation should be # future-proof. - aliases: List[str] = [] + aliases: list[str] = [] paginator = self.__session.client("iam").get_paginator("list_account_aliases") response_iterator = paginator.paginate() for page in response_iterator: diff --git a/runway/core/providers/aws/_assume_role.py b/runway/core/providers/aws/_assume_role.py index e49c5a998..ae03ba32d 100644 --- a/runway/core/providers/aws/_assume_role.py +++ b/runway/core/providers/aws/_assume_role.py @@ -3,8 +3,9 @@ from __future__ import annotations import logging +from contextlib import AbstractContextManager from datetime import datetime -from typing import TYPE_CHECKING, ContextManager, Optional, Type, cast +from typing import TYPE_CHECKING, cast from typing_extensions import TypedDict @@ -12,6 +13,7 @@ from types import TracebackType from mypy_boto3_sts.type_defs import AssumedRoleUserTypeDef, CredentialsTypeDef + from typing_extensions import Self from ...._logging import RunwayLogger from ....context import RunwayContext @@ -19,12 +21,14 @@ LOGGER = cast("RunwayLogger", logging.getLogger(__name__.replace("._", "."))) -_KwargsTypeDef = TypedDict( - "_KwargsTypeDef", DurationSeconds=int, RoleArn=str, RoleSessionName=str -) +class _KwargsTypeDef(TypedDict): + DurationSeconds: int + RoleArn: str + RoleSessionName: str -class AssumeRole(ContextManager["AssumeRole"]): + +class AssumeRole(AbstractContextManager["AssumeRole"]): """Context manager for assuming an AWS role.""" assumed_role_user: AssumedRoleUserTypeDef @@ -37,11 +41,11 @@ class AssumeRole(ContextManager["AssumeRole"]): def __init__( self, context: RunwayContext, - role_arn: Optional[str] = None, - duration_seconds: Optional[int] = None, + role_arn: str | None = None, + duration_seconds: int | None = None, revert_on_exit: bool = True, - session_name: Optional[str] = None, - ): + session_name: str | None = None, + ) -> None: """Instantiate class. Args: @@ -108,7 +112,7 @@ def restore_existing_iam_env_vars(self) -> None: if not self.role_arn: LOGGER.debug("no role was assumed; not reverting credentials") return - for k in self.ctx.current_aws_creds.keys(): + for k in self.ctx.current_aws_creds: old = "OLD_" + k if self.ctx.env.vars.get(old): self.ctx.env.vars[k] = self.ctx.env.vars.pop(old) @@ -124,7 +128,7 @@ def save_existing_iam_env_vars(self) -> None: LOGGER.debug('saving environment variable "%s" as "%s"', k, new) self.ctx.env.vars[new] = cast(str, v) - def __enter__(self) -> AssumeRole: + def __enter__(self) -> Self: """Enter the context manager.""" LOGGER.debug("entering aws.AssumeRole context manager...") self.assume() @@ -132,9 +136,9 @@ def __enter__(self) -> AssumeRole: def __exit__( self, - exc_type: Optional[Type[BaseException]], - exc_value: Optional[BaseException], - traceback: Optional[TracebackType], + exc_type: type[BaseException] | None, + exc_value: BaseException | None, + traceback: TracebackType | None, ) -> None: """Exit the context manager.""" if self.revert_on_exit: diff --git a/runway/core/providers/aws/_response.py b/runway/core/providers/aws/_response.py index 41778a31d..7e00d7039 100644 --- a/runway/core/providers/aws/_response.py +++ b/runway/core/providers/aws/_response.py @@ -1,7 +1,7 @@ """Base class for AWS responses.""" from http import HTTPStatus -from typing import Any, Dict +from typing import Any, Dict # noqa: UP035 from pydantic import Field @@ -45,7 +45,7 @@ class ResponseMetadata(BaseModel): host_id: str = Field(default="", alias="HostId") """Host ID data.""" - https_headers: Dict[str, Any] = Field(default={}, alias="HTTPHeaders") + https_headers: Dict[str, Any] = Field(default={}, alias="HTTPHeaders") # noqa: UP006 """A map of response header keys and their respective values.""" http_status_code: int = Field(default=200, alias="HTTPStatusCode") @@ -83,7 +83,5 @@ class BaseResponse(BaseModel): error: ResponseError = Field(default=ResponseError(), alias="Error") """Information about a service or networking error.""" - metadata: ResponseMetadata = Field( - default=ResponseMetadata(), alias="ResponseMetadata" - ) + metadata: ResponseMetadata = Field(default=ResponseMetadata(), alias="ResponseMetadata") """Information about the request.""" diff --git a/runway/core/providers/aws/s3/_bucket.py b/runway/core/providers/aws/s3/_bucket.py index 48a2da3d3..4d22b18d8 100644 --- a/runway/core/providers/aws/s3/_bucket.py +++ b/runway/core/providers/aws/s3/_bucket.py @@ -4,7 +4,7 @@ import json import logging -from typing import TYPE_CHECKING, Any, List, Optional, Union +from typing import TYPE_CHECKING, Any from botocore.exceptions import ClientError @@ -31,9 +31,9 @@ class Bucket(DelCachedPropMixin): def __init__( self, - context: Union[CfnginContext, RunwayContext], + context: CfnginContext | RunwayContext, name: str, - region: Optional[str] = None, + region: str | None = None, ) -> None: """Instantiate class. @@ -63,7 +63,7 @@ def forbidden(self) -> bool: return self.head.metadata.forbidden @cached_property - def head(self): + def head(self) -> BaseResponse: """Check if a bucket exists and you have permission to access it. To use this operation, the user must have permissions to perform the @@ -92,7 +92,7 @@ def session(self) -> boto3.Session: """Create cached boto3 session.""" return self.__ctx.get_session(region=self._region) - def create(self, **kwargs: Any) -> Optional[CreateBucketOutputTypeDef]: + def create(self, **kwargs: Any) -> CreateBucketOutputTypeDef | None: """Create an S3 Bucket if it does not already exist. Bucket creation will be skipped if it already exists or access is forbidden. @@ -139,9 +139,7 @@ def enable_versioning(self) -> None: ) LOGGER.debug('enabled versioning for bucket "%s"', self.name) - def format_bucket_path_uri( - self, *, key: Optional[str] = None, prefix: Optional[str] = None - ) -> str: + def format_bucket_path_uri(self, *, key: str | None = None, prefix: str | None = None) -> str: """Format bucket path URI. Args: @@ -176,10 +174,10 @@ def sync_from_local( src_directory: str, *, delete: bool = False, - exclude: Optional[List[str]] = None, + exclude: list[str] | None = None, follow_symlinks: bool = False, - include: Optional[List[str]] = None, - prefix: Optional[str] = None, + include: list[str] | None = None, + prefix: str | None = None, ) -> None: """Sync local directory to the S3 Bucket. @@ -209,10 +207,10 @@ def sync_to_local( dest_directory: str, *, delete: bool = False, - exclude: Optional[List[str]] = None, + exclude: list[str] | None = None, follow_symlinks: bool = False, - include: Optional[List[str]] = None, - prefix: Optional[str] = None, + include: list[str] | None = None, + prefix: str | None = None, ) -> None: """Sync S3 bucket to local directory. diff --git a/runway/core/providers/aws/s3/_helpers/action_architecture.py b/runway/core/providers/aws/s3/_helpers/action_architecture.py index 577fc0915..d778c384e 100644 --- a/runway/core/providers/aws/s3/_helpers/action_architecture.py +++ b/runway/core/providers/aws/s3/_helpers/action_architecture.py @@ -9,7 +9,7 @@ import logging from queue import Queue -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple +from typing import TYPE_CHECKING, Any from typing_extensions import Literal, TypedDict @@ -50,12 +50,12 @@ class _CommandDictTypeDef(TypedDict): """Type definition for command_dict.""" - comparator: List[Comparator] - file_generator: List[FileGenerator] - file_info_builder: List[FileInfoBuilder] - filters: List[Any] - s3_handler: List[S3TransferHandler] - setup: List[FormatPathResult] + comparator: list[Comparator] + file_generator: list[FileGenerator] + file_info_builder: list[FileInfoBuilder] + filters: list[Any] + s3_handler: list[S3TransferHandler] + setup: list[FormatPathResult] class ActionArchitecture: @@ -76,7 +76,7 @@ def __init__( botocore_session: Session, action: Literal["sync"], parameters: ParametersDataModel, - runtime_config: Optional[TransferConfigDict] = None, + runtime_config: TransferConfigDict | None = None, ) -> None: """Instantiate class.""" self.botocore_session = botocore_session @@ -92,7 +92,7 @@ def client(self) -> S3Client: return self.session.client("s3") @cached_property - def instructions(self) -> List[_InstructionTypeDef]: + def instructions(self) -> list[_InstructionTypeDef]: """Create the instructions based on the command name and parameters. Note that all commands must have an s3_handler instruction in the @@ -100,7 +100,7 @@ def instructions(self) -> List[_InstructionTypeDef]: sends the request to S3 and does not yield anything. """ - result: List[_InstructionTypeDef] = ["file_generator"] + result: list[_InstructionTypeDef] = ["file_generator"] if self.parameters.exclude or self.parameters.include: result.append("filters") if self.action == "sync": @@ -109,7 +109,7 @@ def instructions(self) -> List[_InstructionTypeDef]: result.append("s3_handler") return result - def choose_sync_strategies(self) -> Dict[str, BaseSync]: + def choose_sync_strategies(self) -> dict[str, BaseSync]: """Determine the sync strategy for the command. It defaults to the default sync strategies but a customizable sync @@ -117,14 +117,14 @@ def choose_sync_strategies(self) -> Dict[str, BaseSync]: of its self when the event is emitted. """ - sync_strategies: Dict[str, BaseSync] = { + sync_strategies: dict[str, BaseSync] = { "file_at_src_and_dest_sync_strategy": SizeAndLastModifiedSync(), "file_not_at_dest_sync_strategy": MissingFileSync(), "file_not_at_src_sync_strategy": NeverSync(), } # Determine what strategies to override if any. - responses: Optional[List[Tuple[Any, BaseSync]]] = self.botocore_session.emit( + responses: list[tuple[Any, BaseSync]] | None = self.botocore_session.emit( "choosing-s3-sync-strategy", params=self.parameters ) if responses is not None: @@ -137,7 +137,7 @@ def choose_sync_strategies(self) -> Dict[str, BaseSync]: return sync_strategies - def run(self): + def run(self) -> Literal[1, 2, 0]: """Wire together all of the generators and completes the action. First a dictionary is created that is indexed first by @@ -170,7 +170,7 @@ def run(self): "s3local": "download", "s3": "delete", } - result_queue: "Queue[Any]" = Queue() + result_queue: Queue[Any] = Queue() operation_name = action_translation[paths_type] file_generator = FileGenerator( @@ -189,9 +189,7 @@ def run(self): result_queue=result_queue, request_parameters=self._get_file_generator_request_parameters_skeleton(), ) - file_info_builder = FileInfoBuilder( - client=self.client, parameters=self.parameters - ) + file_info_builder = FileInfoBuilder(client=self.client, parameters=self.parameters) s3_transfer_handler = S3TransferHandlerFactory( config_params=self.parameters, runtime_config=self._runtime_config )(self.client, result_queue) @@ -243,5 +241,5 @@ def run(self): return return_code @staticmethod - def _get_file_generator_request_parameters_skeleton() -> Dict[str, Dict[str, Any]]: + def _get_file_generator_request_parameters_skeleton() -> dict[str, dict[str, Any]]: return {"HeadObject": {}, "ListObjects": {}, "ListObjectsV2": {}} diff --git a/runway/core/providers/aws/s3/_helpers/comparator.py b/runway/core/providers/aws/s3/_helpers/comparator.py index 06ee42dc0..51d581cca 100644 --- a/runway/core/providers/aws/s3/_helpers/comparator.py +++ b/runway/core/providers/aws/s3/_helpers/comparator.py @@ -8,9 +8,11 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Generator, Iterator, Optional, cast +from typing import TYPE_CHECKING, cast if TYPE_CHECKING: + from collections.abc import Generator, Iterator + from .file_generator import FileStats from .sync_strategy.base import BaseSync @@ -26,13 +28,13 @@ def __init__( file_at_src_and_dest_sync_strategy: BaseSync, file_not_at_dest_sync_strategy: BaseSync, file_not_at_src_sync_strategy: BaseSync, - ): + ) -> None: """Instantiate class.""" self._sync_strategy = file_at_src_and_dest_sync_strategy self._not_at_dest_sync_strategy = file_not_at_dest_sync_strategy self._not_at_src_sync_strategy = file_not_at_src_sync_strategy - def call( # pylint: disable=too-many-statements + def call( # noqa: C901, PLR0912, PLR0915 self, src_files: Iterator[FileStats], dest_files: Iterator[FileStats] ) -> Generator[FileStats, None, None]: """Preform the actual comparisons. @@ -70,10 +72,10 @@ def call( # pylint: disable=too-many-statements Yields the FilInfo objects of the files that need to be operated on. """ - dest_file: Optional[FileStats] = None + dest_file: FileStats | None = None dest_done = False # True if there are no more files form the dest left. dest_take = True # Take the next dest file from the generated files if true - src_file: Optional[FileStats] = None + src_file: FileStats | None = None src_done = False # True if there are no more files from the source left. src_take = True # Take the next source file from the generated files if true while True: @@ -97,9 +99,7 @@ def call( # pylint: disable=too-many-statements compare_keys = self.compare_comp_key(src_file, dest_file) if compare_keys == "equal": - should_sync = self._sync_strategy.determine_should_sync( - src_file, dest_file - ) + should_sync = self._sync_strategy.determine_should_sync(src_file, dest_file) if should_sync: yield cast("FileStats", src_file) elif compare_keys == "less_than": @@ -121,25 +121,19 @@ def call( # pylint: disable=too-many-statements elif (not src_done) and dest_done: src_take = True - should_sync = self._not_at_dest_sync_strategy.determine_should_sync( - src_file, None - ) + should_sync = self._not_at_dest_sync_strategy.determine_should_sync(src_file, None) if should_sync: yield cast("FileStats", src_file) elif src_done and (not dest_done): dest_take = True - should_sync = self._not_at_src_sync_strategy.determine_should_sync( - None, dest_file - ) + should_sync = self._not_at_src_sync_strategy.determine_should_sync(None, dest_file) if should_sync: yield cast("FileStats", dest_file) else: break # cov: ignore @staticmethod - def compare_comp_key( - src_file: Optional[FileStats], dest_file: Optional[FileStats] - ) -> str: + def compare_comp_key(src_file: FileStats | None, dest_file: FileStats | None) -> str: """Compare the source & destination compare_key.""" src_comp_key = (src_file.compare_key if src_file else None) or "" dest_comp_key = (dest_file.compare_key if dest_file else None) or "" diff --git a/runway/core/providers/aws/s3/_helpers/file_generator.py b/runway/core/providers/aws/s3/_helpers/file_generator.py index 9ba2503bb..8c37e2438 100644 --- a/runway/core/providers/aws/s3/_helpers/file_generator.py +++ b/runway/core/providers/aws/s3/_helpers/file_generator.py @@ -7,7 +7,6 @@ from __future__ import annotations -import datetime import os import stat from copy import deepcopy @@ -17,11 +16,7 @@ from typing import ( TYPE_CHECKING, Any, - Dict, - Generator, - List, Optional, - Tuple, Union, cast, ) @@ -41,6 +36,9 @@ ) if TYPE_CHECKING: + import datetime + from collections.abc import Generator + from mypy_boto3_s3.client import S3Client from mypy_boto3_s3.type_defs import HeadObjectOutputTypeDef, ObjectTypeDef @@ -62,7 +60,7 @@ def is_readable(path: Path) -> bool: return False else: try: - with open(path, "r", encoding="utf-8"): + with open(path, encoding="utf-8"): # noqa: PTH123 pass except OSError: return False @@ -87,23 +85,19 @@ def is_special_file(path: Path) -> bool: if stat.S_ISFIFO(mode): return True # Socket. - if stat.S_ISSOCK(mode): - return True - return False - - -FileStatsDict = TypedDict( - "FileStatsDict", - src="AnyPath", - compare_key=Optional[str], - dest_type=Optional["SupportedPathType"], - dest=Optional[str], - last_update=datetime.datetime, - operation_name=Optional[str], - response_data=Optional[Union["HeadObjectOutputTypeDef", "ObjectTypeDef"]], - size=Optional[int], - src_type=Optional["SupportedPathType"], -) + return bool(stat.S_ISSOCK(mode)) + + +class FileStatsDict(TypedDict): + src: AnyPath + compare_key: str | None + dest_type: SupportedPathType | None + dest: str | None + last_update: datetime.datetime + operation_name: str | None + response_data: HeadObjectOutputTypeDef | ObjectTypeDef | None + size: int | None + src_type: SupportedPathType | None @dataclass @@ -126,23 +120,23 @@ class FileStats: """ src: AnyPath - compare_key: Optional[str] = None - dest: Optional[str] = None - dest_type: Optional[SupportedPathType] = None + compare_key: str | None = None + dest: str | None = None + dest_type: SupportedPathType | None = None last_update: datetime.datetime = EPOCH_TIME - operation_name: Optional[str] = None - response_data: Optional[Union[HeadObjectOutputTypeDef, ObjectTypeDef]] = None - size: Optional[int] = None - src_type: Optional[SupportedPathType] = None + operation_name: str | None = None + response_data: HeadObjectOutputTypeDef | ObjectTypeDef | None = None + size: int | None = None + src_type: SupportedPathType | None = None def dict(self) -> FileStatsDict: """Dump contents of object to a dict.""" return deepcopy(cast(FileStatsDict, self.__dict__)) -_LastModifiedAndSize = TypedDict( - "_LastModifiedAndSize", Size=int, LastModified=datetime.datetime -) +class _LastModifiedAndSize(TypedDict): + Size: int + LastModified: datetime.datetime class FileGenerator: @@ -153,17 +147,17 @@ class FileGenerator: """ - result_queue: "Queue[Any]" + result_queue: Queue[Any] def __init__( self, client: S3Client, operation_name: str, follow_symlinks: bool = True, - page_size: Optional[int] = None, - result_queue: Optional["Queue[Any]"] = None, + page_size: int | None = None, + result_queue: Queue[Any] | None = None, request_parameters: Any = None, - ): + ) -> None: """Instantiate class. Args: @@ -187,9 +181,7 @@ def __init__( def call(self, files: FormatPathResult) -> Generator[FileStats, None, None]: """Generalized function to yield the ``FileInfo`` objects.""" function_table = {"s3": self.list_objects, "local": self.list_files} - file_iterator = function_table[files["src"]["type"]]( - files["src"]["path"], files["dir_op"] - ) + file_iterator = function_table[files["src"]["type"]](files["src"]["path"], files["dir_op"]) for src_path, extra_information in file_iterator: dest_path, compare_key = find_dest_path_comp_key(files, src_path) file_stat_kwargs: FileStatsDict = { @@ -212,7 +204,7 @@ def call(self, files: FormatPathResult) -> Generator[FileStats, None, None]: def list_files( self, path: AnyPath, dir_op: bool - ) -> Generator[Tuple[Path, _LastModifiedAndSize], None, None]: + ) -> Generator[tuple[Path, _LastModifiedAndSize], None, None]: """Yield the appropriate local file or local files under a directory. For directories a depth first search is implemented in order to @@ -232,24 +224,23 @@ def list_files( # using os.listdir instead of Path.iterdir so we can sort the list # but not load the entire tree into memory listdir_names = os.listdir(path) - names: List[str] = [] + names: list[str] = [] for name in listdir_names: if (path / name).is_dir(): - name = name + os.path.sep + name = name + os.path.sep # noqa: PLW2901 names.append(name) self.normalize_sort(names, os.sep, "/") for name in names: file_path = path / name if file_path.is_dir(): - for result in self.list_files(file_path, dir_op): - yield result + yield from self.list_files(file_path, dir_op) else: stats = self.safely_get_file_stats(file_path) if stats: yield stats @staticmethod - def normalize_sort(names: List[str], os_sep: str, character: str) -> None: + def normalize_sort(names: list[str], os_sep: str, character: str) -> None: """Ensure that the same path separator is used when sorting. On Windows, the path operator is a backslash as opposed to a forward slash @@ -263,9 +254,7 @@ def normalize_sort(names: List[str], os_sep: str, character: str) -> None: """ names.sort(key=lambda item: item.replace(os_sep, character)) - def safely_get_file_stats( - self, path: Path - ) -> Optional[Tuple[Path, _LastModifiedAndSize]]: + def safely_get_file_stats(self, path: Path) -> tuple[Path, _LastModifiedAndSize] | None: """Get file stats with handling for some common errors. Args: @@ -282,14 +271,13 @@ def safely_get_file_stats( return None def _validate_update_time( - self, update_time: Optional[datetime.datetime], path: Path + self, update_time: datetime.datetime | None, path: Path ) -> datetime.datetime: """Handle missing last modified time.""" if update_time is None: warning = create_warning( path=path, - error_message="File has an invalid timestamp. Passing epoch " - "time as timestamp.", + error_message="File has an invalid timestamp. Passing epoch time as timestamp.", skip_file=False, ) self.result_queue.put(warning) @@ -303,14 +291,11 @@ def should_ignore_file(self, path: Path) -> bool: warnings. """ - if not self.follow_symlinks: - if path.is_dir() and path.is_symlink(): - # is_symlink returns False if it does not exist - return True - warning_triggered = self.triggers_warning(path) - if warning_triggered: + if not self.follow_symlinks and path.is_dir() and path.is_symlink(): + # is_symlink returns False if it does not exist return True - return False + warning_triggered = self.triggers_warning(path) + return bool(warning_triggered) def triggers_warning(self, path: Path) -> bool: """Check the specific types and properties of a file. @@ -330,10 +315,7 @@ def triggers_warning(self, path: Path) -> bool: if is_special_file(path): warning = create_warning( path, - ( - "File is character special device, " - "block special device, FIFO, or socket." - ), + ("File is character special device, block special device, FIFO, or socket."), ) self.result_queue.put(warning) return True @@ -345,9 +327,7 @@ def triggers_warning(self, path: Path) -> bool: def list_objects( self, s3_path: str, dir_op: bool - ) -> Generator[ - Tuple[str, Union[HeadObjectOutputTypeDef, ObjectTypeDef]], None, None - ]: + ) -> Generator[tuple[str, HeadObjectOutputTypeDef | ObjectTypeDef], None, None]: """Yield the appropriate object or objects under a common prefix. It yields the file's source path, size, and last update. @@ -387,7 +367,7 @@ def list_objects( else: yield source_path, response_data - def _list_single_object(self, s3_path: str) -> Tuple[str, HeadObjectOutputTypeDef]: + def _list_single_object(self, s3_path: str) -> tuple[str, HeadObjectOutputTypeDef]: """List single object.""" # When we know we're dealing with a single object, we can avoid # a ListObjects operation (which causes concern for anyone setting @@ -401,7 +381,7 @@ def _list_single_object(self, s3_path: str) -> Tuple[str, HeadObjectOutputTypeDe return s3_path, {"Size": None, "LastModified": None} # type: ignore bucket, key = find_bucket_key(s3_path) try: - params: Dict[str, Any] = {"Bucket": bucket, "Key": key} + params: dict[str, Any] = {"Bucket": bucket, "Key": key} # params.update(self.request_parameters.get("HeadObject", {})) response = self._client.head_object(**params) except ClientError as exc: diff --git a/runway/core/providers/aws/s3/_helpers/file_info.py b/runway/core/providers/aws/s3/_helpers/file_info.py index a0823e07b..1d27d1da5 100644 --- a/runway/core/providers/aws/s3/_helpers/file_info.py +++ b/runway/core/providers/aws/s3/_helpers/file_info.py @@ -7,7 +7,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any, Dict, Optional, Union +from typing import TYPE_CHECKING, Any from ......compat import cached_property from .utils import EPOCH_TIME @@ -35,18 +35,18 @@ def __init__( self, src: AnyPath, *, - client: Optional[S3Client] = None, - compare_key: Optional[str] = None, - dest_type: Optional[SupportedPathType] = None, - dest: Optional[AnyPath] = None, + client: S3Client | None = None, + compare_key: str | None = None, + dest_type: SupportedPathType | None = None, + dest: AnyPath | None = None, is_stream: bool = False, - last_update: Optional[datetime.datetime] = None, - operation_name: Optional[str] = None, - parameters: Optional[Dict[str, Any]] = None, - response_data: Optional[Union[HeadObjectOutputTypeDef, ObjectTypeDef]] = None, - size: Optional[int] = None, - source_client: Optional[S3Client] = None, - src_type: Optional[SupportedPathType] = None, + last_update: datetime.datetime | None = None, + operation_name: str | None = None, + parameters: dict[str, Any] | None = None, + response_data: HeadObjectOutputTypeDef | ObjectTypeDef | None = None, + size: int | None = None, + source_client: S3Client | None = None, + src_type: SupportedPathType | None = None, ) -> None: """Instantiate class. @@ -108,21 +108,18 @@ def is_glacier_compatible(self) -> bool: return True def _is_glacier_object( - self, response_data: Optional[Union[HeadObjectOutputTypeDef, ObjectTypeDef]] + self, response_data: HeadObjectOutputTypeDef | ObjectTypeDef | None ) -> bool: """Determine if a file info object is glacier compatible.""" glacier_storage_classes = ["GLACIER", "DEEP_ARCHIVE"] - if response_data: - if response_data.get( - "StorageClass" - ) in glacier_storage_classes and not self._is_restored(response_data): - return True - return False + return bool( + response_data + and response_data.get("StorageClass") in glacier_storage_classes + and not self._is_restored(response_data) + ) @staticmethod - def _is_restored( - response_data: Union[HeadObjectOutputTypeDef, ObjectTypeDef] - ) -> bool: + def _is_restored(response_data: HeadObjectOutputTypeDef | ObjectTypeDef) -> bool: """Return True is this is a glacier object that has been restored back to S3.""" # 'Restore' looks like: 'ongoing-request="false", expiry-date="..."' return 'ongoing-request="false"' in response_data.get("Restore", "") diff --git a/runway/core/providers/aws/s3/_helpers/file_info_builder.py b/runway/core/providers/aws/s3/_helpers/file_info_builder.py index e60907d00..9a81f88e3 100644 --- a/runway/core/providers/aws/s3/_helpers/file_info_builder.py +++ b/runway/core/providers/aws/s3/_helpers/file_info_builder.py @@ -7,11 +7,13 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any, Generator, Iterable, Optional +from typing import TYPE_CHECKING, Any from .file_info import FileInfo if TYPE_CHECKING: + from collections.abc import Generator, Iterable + from mypy_boto3_s3.client import S3Client from .file_generator import FileStats @@ -26,8 +28,8 @@ def __init__( *, client: S3Client, is_stream: bool = False, - parameters: Optional[ParametersDataModel] = None, - source_client: Optional[Any] = None, + parameters: ParametersDataModel | None = None, + source_client: Any | None = None, ) -> None: """Instantiate class. diff --git a/runway/core/providers/aws/s3/_helpers/filters.py b/runway/core/providers/aws/s3/_helpers/filters.py index 73e3cbe94..dbe57d4e2 100644 --- a/runway/core/providers/aws/s3/_helpers/filters.py +++ b/runway/core/providers/aws/s3/_helpers/filters.py @@ -13,14 +13,7 @@ from typing import ( TYPE_CHECKING, ClassVar, - Generator, - Iterable, - Iterator, - List, NamedTuple, - Optional, - Set, - Tuple, cast, ) @@ -29,6 +22,8 @@ from .utils import split_s3_bucket_key if TYPE_CHECKING: + from collections.abc import Generator, Iterable, Iterator + from .file_generator import FileStats from .parameters import ParametersDataModel @@ -36,14 +31,22 @@ _FilterType = Literal["exclude", "include"] -FileStatus = NamedTuple("FileStatus", [("file_stats", "FileStats"), ("include", bool)]) -FilterPattern = NamedTuple("FilterPattern", [("type", _FilterType), ("pattern", str)]) + + +class FileStatus(NamedTuple): + file_stats: FileStats + include: bool + + +class FilterPattern(NamedTuple): + type: _FilterType + pattern: str class Filter: """Universal exclude/include filter.""" - FILTER_TYPES: ClassVar[Tuple[_FilterType, ...]] = ( + FILTER_TYPES: ClassVar[tuple[_FilterType, ...]] = ( "exclude", "include", ) @@ -51,8 +54,8 @@ class Filter: def __init__( self, patterns: Iterable[FilterPattern], - src_rootdir: Optional[str], - dest_rootdir: Optional[str], + src_rootdir: str | None, + dest_rootdir: str | None, ) -> None: """Instantiate class. @@ -70,8 +73,8 @@ def __init__( @staticmethod def _full_path_patterns( - patterns: Iterable[FilterPattern], rootdir: Optional[str] - ) -> List[FilterPattern]: + patterns: Iterable[FilterPattern], rootdir: str | None + ) -> list[FilterPattern]: """Prefix each pattern with the root directory. Args: @@ -82,7 +85,9 @@ def _full_path_patterns( if rootdir: return sorted( # sort for consistency [ - FilterPattern(type=f.type, pattern=os.path.join(rootdir, f.pattern)) + FilterPattern( + type=f.type, pattern=os.path.join(rootdir, f.pattern) # noqa: PTH118 + ) for f in patterns ] ) @@ -119,9 +124,7 @@ def call(self, files: Iterator[FileStats]) -> Generator[FileStats, None, None]: yield file_stats @staticmethod - def _match_pattern( - filter_pattern: FilterPattern, file_stats: FileStats - ) -> Optional[FileStatus]: + def _match_pattern(filter_pattern: FilterPattern, file_stats: FileStats) -> FileStatus | None: """Match file to pattern. Args: @@ -155,12 +158,10 @@ def parse_params(cls, parameters: ParametersDataModel) -> Filter: """Parse parameters to create a Filter instance.""" if not (parameters.exclude or parameters.include): return Filter([], None, None) - filter_patterns: Set[FilterPattern] = set() + filter_patterns: set[FilterPattern] = set() for filter_type in cls.FILTER_TYPES: for pat in parameters[filter_type]: - filter_patterns.add( - FilterPattern(type=cast(_FilterType, filter_type), pattern=pat) - ) + filter_patterns.add(FilterPattern(type=cast(_FilterType, filter_type), pattern=pat)) return Filter( filter_patterns, cls.parse_rootdir(parameters.src), @@ -190,8 +191,8 @@ def _parse_rootdir_local(path: str, dir_op: bool = True) -> str: """ if dir_op: - return os.path.abspath(path) - return os.path.abspath(os.path.dirname(path)) + return os.path.abspath(path) # noqa: PTH100 + return os.path.abspath(os.path.dirname(path)) # noqa: PTH100, PTH120 @staticmethod def _parse_rootdir_s3(path: str, dir_op: bool = True) -> str: @@ -205,4 +206,4 @@ def _parse_rootdir_s3(path: str, dir_op: bool = True) -> str: bucket, key = split_s3_bucket_key(path) if not (dir_op or key.endswith("/")): key = "/".join(key.split("/")[:-1]) - return "/".join([bucket, key]) + return f"{bucket}/{key}" diff --git a/runway/core/providers/aws/s3/_helpers/format_path.py b/runway/core/providers/aws/s3/_helpers/format_path.py index 818000849..cacdd021f 100644 --- a/runway/core/providers/aws/s3/_helpers/format_path.py +++ b/runway/core/providers/aws/s3/_helpers/format_path.py @@ -9,21 +9,22 @@ import os from pathlib import Path -from typing import Tuple from typing_extensions import Literal, TypedDict SupportedPathType = Literal["local", "s3"] -FormattedPathDetails = TypedDict( - "FormattedPathDetails", path=str, type=SupportedPathType -) -FormatPathResult = TypedDict( - "FormattedPaths", - dest=FormattedPathDetails, - dir_op=bool, - src=FormattedPathDetails, - use_src_name=bool, -) + + +class FormattedPathDetails(TypedDict): + path: str + type: SupportedPathType + + +class FormatPathResult(TypedDict): + dest: FormattedPathDetails + dir_op: bool + src: FormattedPathDetails + use_src_name: bool class FormatPath: @@ -47,7 +48,7 @@ def format(cls, src: str, dest: str) -> FormatPathResult: } @staticmethod - def format_local_path(path: str, dir_op: bool = True) -> Tuple[str, bool]: + def format_local_path(path: str, dir_op: bool = True) -> tuple[str, bool]: """Format the path of local files. Returns whether the destination will keep its own name or take the @@ -80,7 +81,7 @@ def format_local_path(path: str, dir_op: bool = True) -> Tuple[str, bool]: return str(full_path), False @staticmethod - def format_s3_path(path: str, dir_op: bool = True) -> Tuple[str, bool]: + def format_s3_path(path: str, dir_op: bool = True) -> tuple[str, bool]: """Format the path of S3 files. Returns whether the destination will keep its own name or take the @@ -110,7 +111,7 @@ def format_s3_path(path: str, dir_op: bool = True) -> Tuple[str, bool]: return path, False @staticmethod - def identify_path_type(path: str) -> Tuple[SupportedPathType, str]: + def identify_path_type(path: str) -> tuple[SupportedPathType, str]: """Parse path. Args: diff --git a/runway/core/providers/aws/s3/_helpers/parameters.py b/runway/core/providers/aws/s3/_helpers/parameters.py index 027d0b397..6b9c8bcbc 100644 --- a/runway/core/providers/aws/s3/_helpers/parameters.py +++ b/runway/core/providers/aws/s3/_helpers/parameters.py @@ -1,9 +1,10 @@ """Parameters.""" +# ruff: noqa: UP006, UP035 from __future__ import annotations from pathlib import Path -from typing import Any, Dict, List, Optional, Union, cast +from typing import Any, List, Optional, cast from pydantic import validator from typing_extensions import Literal @@ -77,8 +78,8 @@ class ParametersDataModel(BaseModel): @classmethod def _determine_paths_type( cls, - v: Optional[str], # pylint: disable=unused-argument - values: Dict[str, Any], + v: str | None, # noqa: ARG003 + values: dict[str, Any], ) -> PathsType: """Determine paths type for the given src and dest.""" # these have already been validated so it's "safe" to cast them @@ -102,9 +103,7 @@ def _normalize_s3_trailing_slash(cls, v: str) -> str: class Parameters: """Initial error based on the parameters and arguments passed to sync.""" - def __init__( - self, action: str, parameters: Union[Dict[str, Any], ParametersDataModel] - ): + def __init__(self, action: str, parameters: dict[str, Any] | ParametersDataModel) -> None: """Instantiate class. Args: @@ -139,8 +138,6 @@ def _validate_path_args(self) -> None: def _same_path(self) -> bool: """Evaluate if the src and dest are the same path.""" - if not self.data.paths_type == "s3s3": + if self.data.paths_type != "s3s3": return False - if self.data.src == self.data.dest: - return True - return False + return self.data.src == self.data.dest diff --git a/runway/core/providers/aws/s3/_helpers/results.py b/runway/core/providers/aws/s3/_helpers/results.py index 8ee70af9d..042dc659f 100644 --- a/runway/core/providers/aws/s3/_helpers/results.py +++ b/runway/core/providers/aws/s3/_helpers/results.py @@ -19,19 +19,13 @@ Any, Callable, ClassVar, - Dict, - List, NamedTuple, - Optional, TextIO, - Tuple, - Type, Union, cast, ) from s3transfer.exceptions import FatalError -from typing_extensions import Literal from ......utils import ensure_string from .utils import ( @@ -46,6 +40,7 @@ from types import TracebackType from s3transfer.futures import TransferFuture + from typing_extensions import Literal, Self from ......_logging import RunwayLogger from ......type_defs import AnyPath @@ -59,53 +54,53 @@ class CommandResult(NamedTuple): num_tasks_failed: int num_tasks_warned: int - dest: Optional[str] = None - src: Optional[str] = None - transfer_type: Optional[str] = None + dest: str | None = None + src: str | None = None + transfer_type: str | None = None class CtrlCResult(NamedTuple): """Keyboard exit.""" exception: Exception - dest: Optional[str] = None - src: Optional[str] = None - transfer_type: Optional[str] = None + dest: str | None = None + src: str | None = None + transfer_type: str | None = None class DryRunResult(NamedTuple): """Dry run result.""" - dest: Optional[str] = None - src: Optional[str] = None - transfer_type: Optional[str] = None + dest: str | None = None + src: str | None = None + transfer_type: str | None = None class ErrorResult(NamedTuple): """Error.""" exception: BaseException - dest: Optional[str] = None - src: Optional[str] = None - transfer_type: Optional[str] = None + dest: str | None = None + src: str | None = None + transfer_type: str | None = None class FailureResult(NamedTuple): """Failure.""" exception: Exception - dest: Optional[str] = None - src: Optional[str] = None - transfer_type: Optional[str] = None + dest: str | None = None + src: str | None = None + transfer_type: str | None = None class FinalTotalSubmissionsResult(NamedTuple): """Final total submissions.""" total_submissions: int - dest: Optional[str] = None - src: Optional[str] = None - transfer_type: Optional[str] = None + dest: str | None = None + src: str | None = None + transfer_type: str | None = None class ProgressResult(NamedTuple): @@ -114,26 +109,26 @@ class ProgressResult(NamedTuple): bytes_transferred: int timestamp: float total_transfer_size: int - dest: Optional[str] = None - src: Optional[str] = None - transfer_type: Optional[str] = None + dest: str | None = None + src: str | None = None + transfer_type: str | None = None class SuccessResult(NamedTuple): """Success.""" - dest: Optional[str] = None - src: Optional[str] = None - transfer_type: Optional[str] = None + dest: str | None = None + src: str | None = None + transfer_type: str | None = None class QueuedResult(NamedTuple): """Queued.""" total_transfer_size: int - dest: Optional[str] = None - src: Optional[str] = None - transfer_type: Optional[str] = None + dest: str | None = None + src: str | None = None + transfer_type: str | None = None AllResultTypes = ( @@ -167,11 +162,9 @@ class ShutdownThreadRequest: class BaseResultSubscriber(OnDoneFilteredSubscriber): """Base result subscriber.""" - TRANSFER_TYPE: ClassVar[Optional[str]] = None + TRANSFER_TYPE: ClassVar[str | None] = None - def __init__( - self, result_queue: "queue.Queue[Any]", transfer_type: Optional[str] = None - ): + def __init__(self, result_queue: queue.Queue[Any], transfer_type: str | None = None) -> None: """Send result notifications during transfer process. Args: @@ -181,7 +174,7 @@ def __init__( """ self._result_queue = result_queue - self._result_kwargs_cache: Dict[str, Any] = {} + self._result_kwargs_cache: dict[str, Any] = {} self._transfer_type = transfer_type if transfer_type is None: self._transfer_type = self.TRANSFER_TYPE @@ -193,12 +186,10 @@ def on_queued(self, future: TransferFuture, **_: Any) -> None: queued_result = QueuedResult(**result_kwargs) self._result_queue.put(queued_result) - def on_progress( - self, future: TransferFuture, bytes_transferred: int, **_: Any - ) -> None: + def on_progress(self, future: TransferFuture, bytes_transferred: int, **_: Any) -> None: """On progress.""" - result_kwargs: Dict[str, Any] = self._result_kwargs_cache.get( - cast(str, future.meta.transfer_id), cast(Dict[str, Any], {}) + result_kwargs: dict[str, Any] = self._result_kwargs_cache.get( + cast(str, future.meta.transfer_id), cast("dict[str, Any]", {}) ) progress_result = ProgressResult( bytes_transferred=bytes_transferred, timestamp=time.time(), **result_kwargs @@ -232,17 +223,15 @@ def _add_to_result_kwargs_cache(self, future: TransferFuture) -> None: } self._result_kwargs_cache[cast(str, future.meta.transfer_id)] = result_kwargs - def _on_done_pop_from_result_kwargs_cache( - self, future: TransferFuture - ) -> Dict[str, Any]: + def _on_done_pop_from_result_kwargs_cache(self, future: TransferFuture) -> dict[str, Any]: """On done, pop from results cache.""" - result_kwargs: Dict[str, Any] = self._result_kwargs_cache.pop( + result_kwargs: dict[str, Any] = self._result_kwargs_cache.pop( cast(str, future.meta.transfer_id) ) result_kwargs.pop("total_transfer_size") return result_kwargs - def _get_src_dest(self, future: TransferFuture) -> Tuple[str, str]: + def _get_src_dest(self, future: TransferFuture) -> tuple[str, str]: """Get source destination.""" raise NotImplementedError("_get_src_dest()") @@ -252,7 +241,7 @@ class UploadResultSubscriber(BaseResultSubscriber): TRANSFER_TYPE: ClassVar[Literal["upload"]] = "upload" - def _get_src_dest(self, future: TransferFuture) -> Tuple[str, str]: + def _get_src_dest(self, future: TransferFuture) -> tuple[str, str]: call_args = future.meta.call_args src = self._get_src(call_args.fileobj) dest = "s3://" + call_args.bucket + "/" + call_args.key @@ -265,7 +254,7 @@ def _get_src(self, fileobj: AnyPath) -> str: class UploadStreamResultSubscriber(UploadResultSubscriber): """Upload stream result subscriber.""" - def _get_src(self, fileobj: AnyPath) -> str: + def _get_src(self, fileobj: AnyPath) -> str: # noqa: ARG002 return "-" @@ -274,7 +263,7 @@ class DownloadResultSubscriber(BaseResultSubscriber): TRANSFER_TYPE: ClassVar[Literal["download"]] = "download" - def _get_src_dest(self, future: TransferFuture) -> Tuple[str, str]: + def _get_src_dest(self, future: TransferFuture) -> tuple[str, str]: call_args = future.meta.call_args src = "s3://" + call_args.bucket + "/" + call_args.key dest = self._get_dest(call_args.fileobj) @@ -287,7 +276,7 @@ def _get_dest(self, fileobj: AnyPath) -> str: class DownloadStreamResultSubscriber(DownloadResultSubscriber): """Download stream result subscriber.""" - def _get_dest(self, fileobj: AnyPath) -> str: + def _get_dest(self, fileobj: AnyPath) -> str: # noqa: ARG002 return "-" @@ -296,7 +285,7 @@ class CopyResultSubscriber(BaseResultSubscriber): TRANSFER_TYPE: ClassVar[Literal["copy"]] = "copy" - def _get_src_dest(self, future: TransferFuture) -> Tuple[str, str]: + def _get_src_dest(self, future: TransferFuture) -> tuple[str, str]: call_args = future.meta.call_args copy_source = call_args.copy_source src = "s3://" + copy_source["Bucket"] + "/" + copy_source["Key"] @@ -309,7 +298,7 @@ class DeleteResultSubscriber(BaseResultSubscriber): TRANSFER_TYPE: ClassVar[Literal["delete"]] = "delete" - def _get_src_dest(self, future: TransferFuture) -> Tuple[str, None]: # type: ignore + def _get_src_dest(self, future: TransferFuture) -> tuple[str, None]: # type: ignore call_args = future.meta.call_args src = "s3://" + call_args.bucket + "/" + call_args.key return src, None @@ -326,7 +315,7 @@ def __call__(self, result: Any) -> None: class ResultRecorder(BaseResultHandler): """Record and track transfer statistics based on results received.""" - def __init__(self): + def __init__(self) -> None: """Instantiate class.""" self.bytes_transferred = 0 self.bytes_failed_to_transfer = 0 @@ -342,7 +331,7 @@ def __init__(self): self.bytes_transfer_speed = 0 self._ongoing_progress = defaultdict(int) - self._ongoing_total_sizes: Dict[str, int] = {} + self._ongoing_total_sizes: dict[str, int] = {} self._result_handler_map = { QueuedResult: self._record_queued_result, @@ -364,22 +353,20 @@ def __call__(self, result: Any) -> None: self._result_handler_map.get(type(result), self._record_noop)(result=result) @staticmethod - def _get_ongoing_dict_key(result: Union[AnyResult, object]) -> str: + def _get_ongoing_dict_key(result: AnyResult | object) -> str: if not isinstance(result, AllResultTypes): raise TypeError( "Any result using _get_ongoing_dict_key must be one of " f"{', '.join(str(i) for i in AllResultTypes)}. " f"Provided result is of type: {type(result)}" ) - key_parts: List[str] = [] + key_parts: list[str] = [] for result_property in [result.transfer_type, result.src, result.dest]: if result_property is not None: - key_parts.append(ensure_string(result_property)) + key_parts.append(ensure_string(result_property)) # noqa: PERF401 return ":".join(key_parts) - def _pop_result_from_ongoing_dicts( - self, result: AnyResult - ) -> Tuple[int, Optional[int]]: + def _pop_result_from_ongoing_dicts(self, result: AnyResult) -> tuple[int, int | None]: ongoing_key = self._get_ongoing_dict_key(result) total_progress = self._ongoing_progress.pop(ongoing_key, 0) total_file_size = self._ongoing_total_sizes.pop(ongoing_key, None) @@ -392,9 +379,7 @@ def _record_queued_result(self, result: QueuedResult, **_: Any) -> None: if self.start_time is None: self.start_time = time.time() total_transfer_size = result.total_transfer_size - self._ongoing_total_sizes[self._get_ongoing_dict_key(result)] = ( - total_transfer_size - ) + self._ongoing_total_sizes[self._get_ongoing_dict_key(result)] = total_transfer_size # The total transfer size can be None if we do not know the size # immediately so do not add to the total right away. if total_transfer_size: @@ -462,9 +447,7 @@ def _record_warning_result(self, **_: Any) -> None: def _record_error_result(self, **_: Any) -> None: self.errors += 1 - def _record_final_expected_files( - self, result: FinalTotalSubmissionsResult, **_: Any - ) -> None: + def _record_final_expected_files(self, result: FinalTotalSubmissionsResult, **_: Any) -> None: self.final_expected_files_transferred = result.total_submissions @@ -483,9 +466,7 @@ class ResultPrinter(BaseResultHandler): ) SUCCESS_FORMAT: ClassVar[str] = "{transfer_type}: {transfer_location}" DRY_RUN_FORMAT: ClassVar[str] = "(dryrun) " + SUCCESS_FORMAT - FAILURE_FORMAT: ClassVar[str] = ( - "{transfer_type} failed: {transfer_location} {exception}" - ) + FAILURE_FORMAT: ClassVar[str] = "{transfer_type} failed: {transfer_location} {exception}" WARNING_FORMAT: ClassVar[str] = "{message}" ERROR_FORMAT: ClassVar[str] = "fatal error: {exception}" CTRL_C_MSG: ClassVar[str] = "cancelled: ctrl-c received" @@ -497,9 +478,9 @@ def __init__( self, result_recorder: ResultRecorder, *, - out_file: Optional[TextIO] = None, - error_file: Optional[TextIO] = None, - ): + out_file: TextIO | None = None, + error_file: TextIO | None = None, + ) -> None: """Instantiate class. Args: @@ -566,19 +547,15 @@ def _print_warning(self, result: Any, **_: Any) -> None: self._redisplay_progress() def _print_error(self, result: ErrorResult, **_: Any) -> None: - # pylint: disable=logging-format-interpolation LOGGER.error(self.ERROR_FORMAT.format(exception=result.exception)) - # pylint: disable=unused-argument - def _print_ctrl_c(self, result: CtrlCResult, **_: Any) -> None: + def _print_ctrl_c(self, result: CtrlCResult, **_: Any) -> None: # noqa: ARG002 LOGGER.warning(self.CTRL_C_MSG) def _get_transfer_location(self, result: AnyResult) -> str: if result.dest is None: return self.SRC_TRANSFER_LOCATION_FORMAT.format(src=result.src) - return self.SRC_DEST_TRANSFER_LOCATION_FORMAT.format( - src=result.src, dest=result.dest - ) + return self.SRC_DEST_TRANSFER_LOCATION_FORMAT.format(src=result.src, dest=result.dest) def _redisplay_progress(self) -> None: # Reset to zero because done statements are printed with new lines @@ -611,8 +588,7 @@ def _print_progress(self, **_: Any) -> None: ) transfer_speed = ( - human_readable_size(self._result_recorder.bytes_transfer_speed) - or "0 Bytes" + human_readable_size(self._result_recorder.bytes_transfer_speed) or "0 Bytes" ) + "/s" progress_statement = self.BYTE_PROGRESS_FORMAT.format( bytes_completed=bytes_completed, @@ -632,9 +608,7 @@ def _print_progress(self, **_: Any) -> None: progress_statement += self._STILL_CALCULATING_TOTALS # Make sure that it overrides any previous progress bar. - progress_statement = self._adjust_statement_padding( - progress_statement, ending_char="\r" - ) + progress_statement = self._adjust_statement_padding(progress_statement, ending_char="\r") # We do not want to include the carriage return in this calculation # as progress length is used for determining whitespace padding. # So we subtract one off of the length. @@ -643,14 +617,12 @@ def _print_progress(self, **_: Any) -> None: # Print the progress out. self._print_to_out_file(progress_statement) - def _get_expected_total(self, expected_total: Optional[str]) -> Optional[str]: + def _get_expected_total(self, expected_total: str | None) -> str | None: if not self._result_recorder.expected_totals_are_final(): return self._ESTIMATED_EXPECTED_TOTAL.format(expected_total=expected_total) return expected_total - def _adjust_statement_padding( - self, print_statement: str, ending_char: str = "\n" - ) -> str: + def _adjust_statement_padding(self, print_statement: str, ending_char: str = "\n") -> str: print_statement = print_statement.ljust(self._progress_length, " ") return print_statement + ending_char @@ -695,8 +667,8 @@ class ResultProcessor(threading.Thread): def __init__( self, - result_queue: "queue.Queue[Any]", - result_handlers: Optional[List[Callable[..., Any]]] = None, + result_queue: queue.Queue[Any], + result_handlers: list[Callable[..., Any]] | None = None, ) -> None: """Instantiate class. @@ -738,7 +710,7 @@ def _process_result(self, result: AnyResult) -> None: for result_handler in self._result_handlers: try: result_handler(result) - except Exception as exc: # pylint: disable=broad-except + except Exception as exc: # noqa: BLE001 LOGGER.debug( "Error processing result %s with handler %s: %s", result, @@ -758,7 +730,7 @@ class CommandResultRecorder: def __init__( self, - result_queue: "queue.Queue[Any]", + result_queue: queue.Queue[Any], result_recorder: ResultRecorder, result_processor: ResultProcessor, ) -> None: @@ -789,8 +761,7 @@ def shutdown(self) -> None: def get_command_result(self) -> CommandResult: """Get the CommandResult representing the result of a command.""" return CommandResult( - num_tasks_failed=self._result_recorder.files_failed - + self._result_recorder.errors, + num_tasks_failed=self._result_recorder.files_failed + self._result_recorder.errors, num_tasks_warned=self._result_recorder.files_warned, ) @@ -798,7 +769,7 @@ def notify_total_submissions(self, total: int) -> None: """Notify total submissions.""" self.result_queue.put(FinalTotalSubmissionsResult(total_submissions=total)) - def __enter__(self) -> CommandResultRecorder: + def __enter__(self) -> Self: """Enter the context manager. Returns: @@ -810,10 +781,10 @@ def __enter__(self) -> CommandResultRecorder: def __exit__( self, - exc_type: Optional[Type[BaseException]], - exc_value: Optional[BaseException], - traceback: Optional[TracebackType], - ) -> Optional[bool]: + exc_type: type[BaseException] | None, + exc_value: BaseException | None, + traceback: TracebackType | None, + ) -> bool | None: """Exit the context manager.""" if exc_type: LOGGER.debug( diff --git a/runway/core/providers/aws/s3/_helpers/s3handler.py b/runway/core/providers/aws/s3/_helpers/s3handler.py index 8666b6605..a580b1f3d 100644 --- a/runway/core/providers/aws/s3/_helpers/s3handler.py +++ b/runway/core/providers/aws/s3/_helpers/s3handler.py @@ -10,17 +10,12 @@ import logging import os import sys +from pathlib import Path from typing import ( TYPE_CHECKING, Any, Callable, ClassVar, - Dict, - Iterator, - List, - Optional, - Tuple, - Type, cast, ) @@ -66,6 +61,7 @@ ) if TYPE_CHECKING: + from collections.abc import Iterator from queue import Queue from mypy_boto3_s3.client import S3Client @@ -109,9 +105,7 @@ def __init__( self._config_params = config_params self._runtime_config = runtime_config - def __call__( - self, client: S3Client, result_queue: "Queue[Any]" - ) -> S3TransferHandler: + def __call__(self, client: S3Client, result_queue: Queue[Any]) -> S3TransferHandler: """Create a S3TransferHandler instance. Args: @@ -120,9 +114,7 @@ def __call__( for the S3TransferHandler. """ - transfer_config = create_transfer_config_from_runtime_config( - self._runtime_config - ) + transfer_config = create_transfer_config_from_runtime_config(self._runtime_config) transfer_config.max_in_memory_upload_chunks = self.MAX_IN_MEMORY_CHUNKS transfer_config.max_in_memory_download_chunks = self.MAX_IN_MEMORY_CHUNKS @@ -134,7 +126,7 @@ def __call__( transfer_config.multipart_chunksize, ) result_recorder = ResultRecorder() - result_processor_handlers: List[Any] = [result_recorder] + result_processor_handlers: list[Any] = [result_recorder] self._add_result_printer(result_recorder, result_processor_handlers) result_processor = ResultProcessor( result_queue=result_queue, result_handlers=result_processor_handlers @@ -154,7 +146,7 @@ def __call__( def _add_result_printer( self, result_recorder: ResultRecorder, - result_processor_handlers: List[ + result_processor_handlers: list[ Union[ NoProgressResultPrinter, OnlyShowErrorsResultPrinter, @@ -165,9 +157,7 @@ def _add_result_printer( ) -> None: if self._config_params.quiet: return - if self._config_params.only_show_errors: - result_printer = OnlyShowErrorsResultPrinter(result_recorder) - elif self._config_params.is_stream: + if self._config_params.only_show_errors or self._config_params.is_stream: result_printer = OnlyShowErrorsResultPrinter(result_recorder) elif self._config_params.no_progress: result_printer = NoProgressResultPrinter(result_recorder) @@ -225,18 +215,15 @@ def call(self, fileinfos: Iterator[FileInfo]) -> CommandResult: failures and warnings encountered. """ - with self._result_command_recorder: - with self._transfer_manager: - total_submissions = 0 - for fileinfo in fileinfos: - for submitter in self._submitters: - if submitter.can_submit(fileinfo): - if submitter.submit(fileinfo): - total_submissions += 1 - break - self._result_command_recorder.notify_total_submissions( - total_submissions - ) + with self._result_command_recorder, self._transfer_manager: + total_submissions = 0 + for fileinfo in fileinfos: + for submitter in self._submitters: + if submitter.can_submit(fileinfo): + if submitter.submit(fileinfo): + total_submissions += 1 + break + self._result_command_recorder.notify_total_submissions(total_submissions) return self._result_command_recorder.get_command_result() @@ -249,17 +236,15 @@ class BaseTransferRequestSubmitter: """ - REQUEST_MAPPER_METHOD: ClassVar[ - Optional[Callable[[Dict[Any, Any], Dict[Any, Any]], Any]] - ] = None - RESULT_SUBSCRIBER_CLASS: ClassVar[Optional[Type[BaseSubscriber]]] = None + REQUEST_MAPPER_METHOD: ClassVar[Callable[[dict[Any, Any], dict[Any, Any]], Any] | None] = None + RESULT_SUBSCRIBER_CLASS: ClassVar[type[BaseSubscriber] | None] = None def __init__( self, transfer_manager: TransferManager, - result_queue: "Queue[Any]", + result_queue: Queue[Any], config_params: ParametersDataModel, - ): + ) -> None: """Instantiate class. Args: @@ -273,7 +258,7 @@ def __init__( self._result_queue = result_queue self._config_params = config_params - def submit(self, fileinfo: FileInfo) -> Optional[TransferFuture]: + def submit(self, fileinfo: FileInfo) -> TransferFuture | None: """Submit a transfer request based on the FileInfo provided. There is no guarantee that the transfer request will be made on @@ -309,23 +294,21 @@ def can_submit(self, fileinfo: FileInfo) -> bool: """ raise NotImplementedError("can_submit()") - def _do_submit(self, fileinfo: FileInfo) -> Optional[TransferFuture]: + def _do_submit(self, fileinfo: FileInfo) -> TransferFuture | None: """Do submit.""" - extra_args: Dict[Any, Any] = {} + extra_args: dict[Any, Any] = {} if self.REQUEST_MAPPER_METHOD: - # pylint: disable=not-callable - # TODO revisit in future releases of pyright - not seeing second arg + # TODO (kyle): revisit in future releases of pyright - not seeing second arg self.REQUEST_MAPPER_METHOD(extra_args, self._config_params.dict()) # type: ignore - subscribers: List[BaseSubscriber] = [] + subscribers: list[BaseSubscriber] = [] self._add_additional_subscribers(subscribers, fileinfo) # The result subscriber class should always be the last registered # subscriber to ensure it is not missing any information that # may have been added in a different subscriber such as size. if self.RESULT_SUBSCRIBER_CLASS: - result_kwargs: Dict[str, Any] = {"result_queue": self._result_queue} + result_kwargs: dict[str, Any] = {"result_queue": self._result_queue} if self._config_params.is_move: result_kwargs["transfer_type"] = "move" - # pylint: disable=not-callable subscribers.append(self.RESULT_SUBSCRIBER_CLASS(**result_kwargs)) if not self._config_params.dryrun: @@ -338,36 +321,27 @@ def _submit_dryrun(self, fileinfo: FileInfo) -> None: if self._config_params.is_move: transfer_type = "move" src, dest = self._format_src_dest(fileinfo) - self._result_queue.put( - DryRunResult(transfer_type=transfer_type, src=src, dest=dest) - ) + self._result_queue.put(DryRunResult(transfer_type=transfer_type, src=src, dest=dest)) def _add_additional_subscribers( - self, subscribers: List[BaseSubscriber], fileinfo: FileInfo + self, subscribers: list[BaseSubscriber], fileinfo: FileInfo ) -> None: """Add additional subscribers.""" def _submit_transfer_request( self, fileinfo: FileInfo, - extra_args: Dict[str, Any], - subscribers: List[BaseSubscriber], + extra_args: dict[str, Any], + subscribers: list[BaseSubscriber], ) -> TransferFuture: """Submit transfer request.""" raise NotImplementedError("_submit_transfer_request()") def _warn_and_signal_if_skip(self, fileinfo: FileInfo) -> bool: """Warn and signal if skip.""" - for warning_handler in self._get_warning_handlers(): - if warning_handler(fileinfo): - # On the first warning handler that returns a signal to skip - # immediately propagate this signal and no longer check - # the other warning handlers as no matter what the file will - # be skipped. - return True - return False + return any(warning_handler(fileinfo) for warning_handler in self._get_warning_handlers()) - def _get_warning_handlers(self) -> List[Callable[[FileInfo], Any]]: + def _get_warning_handlers(self) -> list[Callable[[FileInfo], Any]]: """Return a list of warning handlers, which are callables. Handlers take in a single parameter representing a FileInfo. @@ -379,32 +353,28 @@ def _get_warning_handlers(self) -> List[Callable[[FileInfo], Any]]: def _should_inject_content_type(self) -> bool: """If should inject content type.""" - return bool( - self._config_params.guess_mime_type and not self._config_params.content_type - ) + return bool(self._config_params.guess_mime_type and not self._config_params.content_type) def _warn_glacier(self, fileinfo: FileInfo) -> bool: """Warn glacier.""" - if not self._config_params.force_glacier_transfer: - if not fileinfo.is_glacier_compatible: - LOGGER.debug( - "Encountered glacier object s3://%s. Not performing " - "%s on object.", - fileinfo.src, - fileinfo.operation_name, + if not self._config_params.force_glacier_transfer and not fileinfo.is_glacier_compatible: + LOGGER.debug( + "Encountered glacier object s3://%s. Not performing %s on object.", + fileinfo.src, + fileinfo.operation_name, + ) + if not self._config_params.ignore_glacier_warnings: + warning = create_warning( + f"s3://{fileinfo.src}", + "Object is of storage class GLACIER. Unable to " + f"perform {fileinfo.operation_name} operations on GLACIER objects. " + "You must restore the object to be able to perform the " + f"operation. See aws s3 {fileinfo.operation_name} help " + "for additional parameter options to ignore or force these " + "transfers.", ) - if not self._config_params.ignore_glacier_warnings: - warning = create_warning( - f"s3://{fileinfo.src}", - "Object is of storage class GLACIER. Unable to " - f"perform {fileinfo.operation_name} operations on GLACIER objects. " - "You must restore the object to be able to perform the " - f"operation. See aws s3 {fileinfo.operation_name} help " - "for additional parameter options to ignore or force these " - "transfers.", - ) - self._result_queue.put(warning) - return True + self._result_queue.put(warning) + return True return False def _warn_parent_reference(self, fileinfo: FileInfo) -> bool: @@ -418,24 +388,20 @@ def _warn_parent_reference(self, fileinfo: FileInfo) -> bool: else False ) if escapes_cwd: - warning = create_warning( - fileinfo.compare_key, "File references a parent directory." - ) + warning = create_warning(fileinfo.compare_key, "File references a parent directory.") self._result_queue.put(warning) return True return False - def _format_src_dest( - self, fileinfo: FileInfo - ) -> Tuple[Optional[str], Optional[str]]: + def _format_src_dest(self, fileinfo: FileInfo) -> tuple[str | None, str | None]: """Return formatted versions of a fileinfos source and destination.""" raise NotImplementedError("_format_src_dest()") - def _format_local_path(self, path: Optional[AnyPath]) -> Optional[str]: + def _format_local_path(self, path: AnyPath | None) -> str | None: """Format local path.""" return relative_path(path) - def _format_s3_path(self, path: Optional[AnyPath]) -> Optional[str]: + def _format_s3_path(self, path: AnyPath | None) -> str | None: """Format s3 path.""" if not path: return None @@ -448,12 +414,10 @@ def _format_s3_path(self, path: Optional[AnyPath]) -> Optional[str]: class UploadRequestSubmitter(BaseTransferRequestSubmitter): """Upload request submitter.""" - REQUEST_MAPPER_METHOD: ClassVar[Callable[[Dict[Any, Any], Dict[Any, Any]], Any]] = ( + REQUEST_MAPPER_METHOD: ClassVar[Callable[[dict[Any, Any], dict[Any, Any]], Any]] = ( RequestParamsMapper.map_put_object_params ) - RESULT_SUBSCRIBER_CLASS: ClassVar[Type[UploadResultSubscriber]] = ( - UploadResultSubscriber - ) + RESULT_SUBSCRIBER_CLASS: ClassVar[type[UploadResultSubscriber]] = UploadResultSubscriber def can_submit(self, fileinfo: FileInfo) -> bool: """Check whether it can submit a particular FileInfo. @@ -470,7 +434,7 @@ def can_submit(self, fileinfo: FileInfo) -> bool: return fileinfo.operation_name == "upload" def _add_additional_subscribers( - self, subscribers: List[BaseSubscriber], fileinfo: FileInfo + self, subscribers: list[BaseSubscriber], fileinfo: FileInfo ) -> None: """Add additional subscribers.""" subscribers.append(ProvideSizeSubscriber(fileinfo.size)) @@ -482,8 +446,8 @@ def _add_additional_subscribers( def _submit_transfer_request( self, fileinfo: FileInfo, - extra_args: Dict[str, Any], - subscribers: List[BaseSubscriber], + extra_args: dict[str, Any], + subscribers: list[BaseSubscriber], ) -> TransferFuture: """Submit transfer request.""" bucket, key = find_bucket_key(str(fileinfo.dest)) @@ -501,7 +465,7 @@ def _get_filein(fileinfo: FileInfo) -> str: """Get file in.""" return str(fileinfo.src) - def _get_warning_handlers(self) -> List[Callable[[FileInfo], Any]]: + def _get_warning_handlers(self) -> list[Callable[[FileInfo], Any]]: """Get warning handlers.""" return [self._warn_if_too_large] @@ -516,9 +480,7 @@ def _warn_if_too_large(self, fileinfo: FileInfo) -> None: warning = create_warning(file_path, warning_message, skip_file=False) self._result_queue.put(warning) - def _format_src_dest( - self, fileinfo: FileInfo - ) -> Tuple[Optional[str], Optional[str]]: + def _format_src_dest(self, fileinfo: FileInfo) -> tuple[str | None, str | None]: """Return formatted versions of a fileinfos source and destination.""" src = self._format_local_path(fileinfo.src) dest = self._format_s3_path(fileinfo.dest) @@ -528,12 +490,10 @@ def _format_src_dest( class DownloadRequestSubmitter(BaseTransferRequestSubmitter): """Download request submitter.""" - REQUEST_MAPPER_METHOD: ClassVar[Callable[[Dict[Any, Any], Dict[Any, Any]], Any]] = ( + REQUEST_MAPPER_METHOD: ClassVar[Callable[[dict[Any, Any], dict[Any, Any]], Any]] = ( RequestParamsMapper.map_get_object_params ) - RESULT_SUBSCRIBER_CLASS: ClassVar[Type[DownloadResultSubscriber]] = ( - DownloadResultSubscriber - ) + RESULT_SUBSCRIBER_CLASS: ClassVar[type[DownloadResultSubscriber]] = DownloadResultSubscriber def can_submit(self, fileinfo: FileInfo) -> bool: """Check whether it can submit a particular FileInfo. @@ -550,7 +510,7 @@ def can_submit(self, fileinfo: FileInfo) -> bool: return fileinfo.operation_name == "download" def _add_additional_subscribers( - self, subscribers: List[BaseSubscriber], fileinfo: FileInfo + self, subscribers: list[BaseSubscriber], fileinfo: FileInfo ) -> None: """Add additional subscribers.""" subscribers.append(ProvideSizeSubscriber(fileinfo.size)) @@ -559,15 +519,13 @@ def _add_additional_subscribers( ProvideLastModifiedTimeSubscriber(fileinfo.last_update, self._result_queue) ) if self._config_params.is_move: - subscribers.append( - DeleteSourceObjectSubscriber(fileinfo.source_client) # type: ignore - ) + subscribers.append(DeleteSourceObjectSubscriber(fileinfo.source_client)) # type: ignore def _submit_transfer_request( self, fileinfo: FileInfo, - extra_args: Dict[str, Any], - subscribers: List[BaseSubscriber], + extra_args: dict[str, Any], + subscribers: list[BaseSubscriber], ) -> TransferFuture: """Submit transfer request.""" bucket, key = find_bucket_key(str(fileinfo.src)) @@ -584,13 +542,11 @@ def _get_fileout(fileinfo: FileInfo) -> str: """Get file out.""" return str(fileinfo.dest) - def _get_warning_handlers(self) -> List[Callable[[FileInfo], Any]]: + def _get_warning_handlers(self) -> list[Callable[[FileInfo], Any]]: """Get warning handlers.""" return [self._warn_glacier, self._warn_parent_reference] - def _format_src_dest( - self, fileinfo: FileInfo - ) -> Tuple[Optional[str], Optional[str]]: + def _format_src_dest(self, fileinfo: FileInfo) -> tuple[str | None, str | None]: """Return formatted versions of a fileinfos source and destination.""" src = self._format_s3_path(fileinfo.src) dest = self._format_local_path(fileinfo.dest) @@ -600,10 +556,10 @@ def _format_src_dest( class CopyRequestSubmitter(BaseTransferRequestSubmitter): """Copy request submitter.""" - REQUEST_MAPPER_METHOD: ClassVar[Callable[[Dict[Any, Any], Dict[Any, Any]], Any]] = ( + REQUEST_MAPPER_METHOD: ClassVar[Callable[[dict[Any, Any], dict[Any, Any]], Any]] = ( RequestParamsMapper.map_copy_object_params ) - RESULT_SUBSCRIBER_CLASS: ClassVar[Type[CopyResultSubscriber]] = CopyResultSubscriber + RESULT_SUBSCRIBER_CLASS: ClassVar[type[CopyResultSubscriber]] = CopyResultSubscriber def can_submit(self, fileinfo: FileInfo) -> bool: """Check whether it can submit a particular FileInfo. @@ -620,7 +576,7 @@ def can_submit(self, fileinfo: FileInfo) -> bool: return fileinfo.operation_name == "copy" def _add_additional_subscribers( - self, subscribers: List[BaseSubscriber], fileinfo: FileInfo + self, subscribers: list[BaseSubscriber], fileinfo: FileInfo ) -> None: """Add additional subscribers.""" subscribers.append(ProvideSizeSubscriber(fileinfo.size)) @@ -634,8 +590,8 @@ def _add_additional_subscribers( def _submit_transfer_request( self, fileinfo: FileInfo, - extra_args: Dict[str, Any], - subscribers: List[BaseSubscriber], + extra_args: dict[str, Any], + subscribers: list[BaseSubscriber], ) -> TransferFuture: """Submit transfer request.""" bucket, key = find_bucket_key(str(fileinfo.dest)) @@ -650,13 +606,11 @@ def _submit_transfer_request( source_client=cast("S3Client", fileinfo.source_client), ) - def _get_warning_handlers(self) -> List[Callable[[FileInfo], Any]]: + def _get_warning_handlers(self) -> list[Callable[[FileInfo], Any]]: """Get warning handlers.""" return [self._warn_glacier] - def _format_src_dest( - self, fileinfo: FileInfo - ) -> Tuple[Optional[str], Optional[str]]: + def _format_src_dest(self, fileinfo: FileInfo) -> tuple[str | None, str | None]: """Return formatted versions of a fileinfos source and destination.""" src = self._format_s3_path(fileinfo.src) dest = self._format_s3_path(fileinfo.dest) @@ -666,7 +620,7 @@ def _format_src_dest( class UploadStreamRequestSubmitter(UploadRequestSubmitter): """Upload stream request submitter.""" - RESULT_SUBSCRIBER_CLASS: ClassVar[Type[UploadStreamResultSubscriber]] = ( + RESULT_SUBSCRIBER_CLASS: ClassVar[type[UploadStreamResultSubscriber]] = ( UploadStreamResultSubscriber ) @@ -682,12 +636,10 @@ def can_submit(self, fileinfo: FileInfo) -> bool: request to the underlying transfer manager. False, otherwise. """ - return bool( - fileinfo.operation_name == "upload" and self._config_params.is_stream - ) + return bool(fileinfo.operation_name == "upload" and self._config_params.is_stream) def _add_additional_subscribers( - self, subscribers: List[BaseSubscriber], fileinfo: FileInfo + self, subscribers: list[BaseSubscriber], fileinfo: FileInfo # noqa: ARG002 ) -> None: """Add additional subscribers.""" expected_size = self._config_params.expected_size @@ -695,13 +647,13 @@ def _add_additional_subscribers( subscribers.append(ProvideSizeSubscriber(int(expected_size))) @staticmethod - def _get_filein(fileinfo: FileInfo) -> NonSeekableStream: # type: ignore + def _get_filein(fileinfo: FileInfo) -> NonSeekableStream: # type: ignore # noqa: ARG004 """Get file in.""" if sys.stdin is None: - raise StdinMissingError() + raise StdinMissingError return NonSeekableStream(sys.stdin.buffer) - def _format_local_path(self, path: Optional[AnyPath]) -> str: + def _format_local_path(self, path: AnyPath | None) -> str: # noqa: ARG002 """Format local path.""" return "-" @@ -709,7 +661,7 @@ def _format_local_path(self, path: Optional[AnyPath]) -> str: class DownloadStreamRequestSubmitter(DownloadRequestSubmitter): """Download stream result subscriber.""" - RESULT_SUBSCRIBER_CLASS: ClassVar[Type[DownloadStreamResultSubscriber]] = ( + RESULT_SUBSCRIBER_CLASS: ClassVar[type[DownloadStreamResultSubscriber]] = ( DownloadStreamResultSubscriber ) @@ -725,21 +677,19 @@ def can_submit(self, fileinfo: FileInfo) -> bool: request to the underlying transfer manager. False, otherwise. """ - return bool( - fileinfo.operation_name == "download" and self._config_params.is_stream - ) + return bool(fileinfo.operation_name == "download" and self._config_params.is_stream) def _add_additional_subscribers( - self, subscribers: List[BaseSubscriber], fileinfo: FileInfo + self, subscribers: list[BaseSubscriber], fileinfo: FileInfo ) -> None: """Add additional subscribers.""" @staticmethod - def _get_fileout(fileinfo: FileInfo) -> StdoutBytesWriter: # type: ignore + def _get_fileout(fileinfo: FileInfo) -> StdoutBytesWriter: # type: ignore # noqa: ARG004 """Get file out.""" return StdoutBytesWriter() - def _format_local_path(self, path: Optional[AnyPath]) -> str: + def _format_local_path(self, path: AnyPath | None) -> str: # noqa: ARG002 """Format local path.""" return "-" @@ -747,12 +697,10 @@ def _format_local_path(self, path: Optional[AnyPath]) -> str: class DeleteRequestSubmitter(BaseTransferRequestSubmitter): """Delete request submitter.""" - REQUEST_MAPPER_METHOD: ClassVar[Callable[[Dict[Any, Any], Dict[Any, Any]], Any]] = ( + REQUEST_MAPPER_METHOD: ClassVar[Callable[[dict[Any, Any], dict[Any, Any]], Any]] = ( RequestParamsMapper.map_delete_object_params ) - RESULT_SUBSCRIBER_CLASS: ClassVar[Type[DeleteResultSubscriber]] = ( - DeleteResultSubscriber - ) + RESULT_SUBSCRIBER_CLASS: ClassVar[type[DeleteResultSubscriber]] = DeleteResultSubscriber def can_submit(self, fileinfo: FileInfo) -> bool: """Check whether it can submit a particular FileInfo. @@ -771,8 +719,8 @@ def can_submit(self, fileinfo: FileInfo) -> bool: def _submit_transfer_request( self, fileinfo: FileInfo, - extra_args: Dict[str, Any], - subscribers: List[BaseSubscriber], + extra_args: dict[str, Any], + subscribers: list[BaseSubscriber], ) -> TransferFuture: """Submit transfer request.""" bucket, key = find_bucket_key(str(fileinfo.src)) @@ -780,9 +728,7 @@ def _submit_transfer_request( bucket=bucket, key=key, extra_args=extra_args, subscribers=subscribers ) - def _format_src_dest( - self, fileinfo: FileInfo - ) -> Tuple[Optional[str], Optional[str]]: + def _format_src_dest(self, fileinfo: FileInfo) -> tuple[str | None, str | None]: """Return formatted versions of a fileinfos source and destination.""" return self._format_s3_path(fileinfo.src), None @@ -790,10 +736,8 @@ def _format_src_dest( class LocalDeleteRequestSubmitter(BaseTransferRequestSubmitter): """Local delete request submitter.""" - REQUEST_MAPPER_METHOD: ClassVar[ - Optional[Callable[[Dict[Any, Any], Dict[Any, Any]], Any]] - ] = None - RESULT_SUBSCRIBER_CLASS: ClassVar[Optional[Type[BaseSubscriber]]] = None + REQUEST_MAPPER_METHOD: ClassVar[Callable[[dict[Any, Any], dict[Any, Any]], Any] | None] = None + RESULT_SUBSCRIBER_CLASS: ClassVar[type[BaseSubscriber] | None] = None def can_submit(self, fileinfo: FileInfo) -> bool: """Check whether it can submit a particular FileInfo. @@ -812,8 +756,8 @@ def can_submit(self, fileinfo: FileInfo) -> bool: def _submit_transfer_request( # type: ignore self, fileinfo: FileInfo, - extra_args: Dict[str, Any], - subscribers: List[BaseSubscriber], + extra_args: dict[str, Any], # noqa: ARG002 + subscribers: list[BaseSubscriber], # noqa: ARG002 ) -> bool: """Submit transfer request. @@ -835,13 +779,11 @@ def _submit_transfer_request( # type: ignore result_kwargs = {"transfer_type": "delete", "src": src, "dest": dest} try: self._result_queue.put(QueuedResult(total_transfer_size=0, **result_kwargs)) - os.remove(fileinfo.src) + Path(fileinfo.src).unlink() self._result_queue.put(SuccessResult(**result_kwargs)) - except Exception as exc: # pylint: disable=broad-except + except Exception as exc: # noqa: BLE001 self._result_queue.put(FailureResult(exception=exc, **result_kwargs)) return True - def _format_src_dest( - self, fileinfo: FileInfo - ) -> Tuple[Optional[str], Optional[str]]: + def _format_src_dest(self, fileinfo: FileInfo) -> tuple[str | None, str | None]: return self._format_local_path(fileinfo.src), None diff --git a/runway/core/providers/aws/s3/_helpers/sync_strategy/base.py b/runway/core/providers/aws/s3/_helpers/sync_strategy/base.py index 9cfcff080..3fe1ecf41 100644 --- a/runway/core/providers/aws/s3/_helpers/sync_strategy/base.py +++ b/runway/core/providers/aws/s3/_helpers/sync_strategy/base.py @@ -8,9 +8,9 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, ClassVar, List, Optional +from typing import TYPE_CHECKING, Any, ClassVar -from typing_extensions import Literal +from typing_extensions import Literal, Self if TYPE_CHECKING: from botocore.session import Session @@ -22,7 +22,7 @@ LOGGER = logging.getLogger(__name__.replace("._", ".")) ValidSyncType = Literal["file_at_src_and_dest", "file_not_at_dest", "file_not_at_src"] -VALID_SYNC_TYPES: List[ValidSyncType] = [ +VALID_SYNC_TYPES: list[ValidSyncType] = [ "file_at_src_and_dest", "file_not_at_dest", "file_not_at_src", @@ -36,7 +36,7 @@ class BaseSync: """ - NAME: ClassVar[Optional[str]] = None + NAME: ClassVar[str | None] = None sync_type: ValidSyncType @@ -52,7 +52,7 @@ def __init__(self, sync_type: ValidSyncType = "file_at_src_and_dest") -> None: self.sync_type = sync_type @property - def name(self) -> Optional[str]: + def name(self) -> str | None: """Retrieve the ``name`` of the sync strategy's ``ARGUMENT``.""" return self.NAME @@ -68,7 +68,7 @@ def register_strategy(self, session: Session) -> None: session.register("choosing-s3-sync-strategy", self.use_sync_strategy) def determine_should_sync( - self, src_file: Optional[FileStats], dest_file: Optional[FileStats] + self, src_file: FileStats | None, dest_file: FileStats | None ) -> bool: """Determine if file should sync. @@ -104,7 +104,7 @@ def determine_should_sync( """ raise NotImplementedError("determine_should_sync") - def use_sync_strategy(self, params: ParametersDataModel, **_) -> Optional[BaseSync]: + def use_sync_strategy(self, params: ParametersDataModel, **_: Any) -> Self | None: """Determine which sync strategy to use. The sync strategy object must be returned by this method @@ -114,24 +114,19 @@ def use_sync_strategy(self, params: ParametersDataModel, **_) -> Optional[BaseSy params: All arguments that a sync strategy is able to process. """ - if self.name: - if params.get(self.name): - # Return the sync strategy object to be used for syncing. - return self + if self.name and params.get(self.name): + # Return the sync strategy object to be used for syncing. + return self return None @staticmethod - def compare_size( - src_file: Optional[FileStats], dest_file: Optional[FileStats] - ) -> bool: + def compare_size(src_file: FileStats | None, dest_file: FileStats | None) -> bool: """Compare the size of two FileStats objects.""" if not (src_file and dest_file): raise ValueError("src_file and dest_file must not be None") return src_file.size == dest_file.size - def compare_time( - self, src_file: Optional[FileStats], dest_file: Optional[FileStats] - ) -> bool: + def compare_time(self, src_file: FileStats | None, dest_file: FileStats | None) -> bool: """Compare modified time of two FileStats objects. Returns: @@ -145,22 +140,14 @@ def compare_time( delta = dest_file.last_update - src_file.last_update cmd = src_file.operation_name if cmd in ["copy", "upload"]: - if delta.total_seconds() >= 0: - # Destination is newer than source. - return True - return False - if cmd == "download": - if delta.total_seconds() <= 0: - return True - return False + return delta.total_seconds() >= 0 + return bool(cmd == "download" and delta.total_seconds() <= 0) class MissingFileSync(BaseSync): """File is missing from destination.""" - def __init__( - self, sync_type: Literal["file_not_at_dest"] = "file_not_at_dest" - ) -> None: + def __init__(self, sync_type: Literal["file_not_at_dest"] = "file_not_at_dest") -> None: """Instantiate class. Args: @@ -171,7 +158,7 @@ def __init__( super().__init__(sync_type) def determine_should_sync( - self, src_file: Optional[FileStats], dest_file: Optional[FileStats] + self, src_file: FileStats | None, dest_file: FileStats | None # noqa: ARG002 ) -> bool: """Determine if file should sync.""" LOGGER.debug( @@ -185,9 +172,7 @@ def determine_should_sync( class NeverSync(BaseSync): """Never sync file.""" - def __init__( - self, sync_type: Literal["file_not_at_src"] = "file_not_at_src" - ) -> None: + def __init__(self, sync_type: Literal["file_not_at_src"] = "file_not_at_src") -> None: """Instantiate class. Args: @@ -198,7 +183,7 @@ def __init__( super().__init__(sync_type) def determine_should_sync( - self, src_file: Optional[FileStats], dest_file: Optional[FileStats] + self, src_file: FileStats | None, dest_file: FileStats | None # noqa: ARG002 ) -> bool: """Determine if file should sync.""" return False @@ -208,7 +193,7 @@ class SizeAndLastModifiedSync(BaseSync): """Sync based on size and last modified date.""" def determine_should_sync( - self, src_file: Optional[FileStats], dest_file: Optional[FileStats] + self, src_file: FileStats | None, dest_file: FileStats | None ) -> bool: """Determine if file should sync.""" same_size = self.compare_size(src_file, dest_file) diff --git a/runway/core/providers/aws/s3/_helpers/sync_strategy/delete.py b/runway/core/providers/aws/s3/_helpers/sync_strategy/delete.py index bcc0656a7..a7ccd305b 100644 --- a/runway/core/providers/aws/s3/_helpers/sync_strategy/delete.py +++ b/runway/core/providers/aws/s3/_helpers/sync_strategy/delete.py @@ -8,13 +8,13 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, ClassVar, Optional - -from typing_extensions import Literal +from typing import TYPE_CHECKING, ClassVar from .base import BaseSync if TYPE_CHECKING: + from typing_extensions import Literal + from ..file_generator import FileStats @@ -27,7 +27,7 @@ class DeleteSync(BaseSync): NAME: ClassVar[Literal["delete"]] = "delete" def determine_should_sync( - self, src_file: Optional[FileStats], dest_file: Optional[FileStats] + self, src_file: FileStats | None, dest_file: FileStats | None # noqa: ARG002 ) -> bool: """Determine if file should sync.""" if dest_file: diff --git a/runway/core/providers/aws/s3/_helpers/sync_strategy/exact_timestamps.py b/runway/core/providers/aws/s3/_helpers/sync_strategy/exact_timestamps.py index 372c8a91f..75d7fc89f 100644 --- a/runway/core/providers/aws/s3/_helpers/sync_strategy/exact_timestamps.py +++ b/runway/core/providers/aws/s3/_helpers/sync_strategy/exact_timestamps.py @@ -8,13 +8,13 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, ClassVar, Optional - -from typing_extensions import Literal +from typing import TYPE_CHECKING, ClassVar from .base import SizeAndLastModifiedSync if TYPE_CHECKING: + from typing_extensions import Literal + from ..file_generator import FileStats LOGGER = logging.getLogger(__name__.replace("._", ".")) @@ -25,9 +25,7 @@ class ExactTimestampsSync(SizeAndLastModifiedSync): NAME: ClassVar[Literal["exact_timestamps"]] = "exact_timestamps" - def compare_time( - self, src_file: Optional[FileStats], dest_file: Optional[FileStats] - ) -> bool: + def compare_time(self, src_file: FileStats | None, dest_file: FileStats | None) -> bool: """Compare modified time of two FileStats objects. Returns: diff --git a/runway/core/providers/aws/s3/_helpers/sync_strategy/register.py b/runway/core/providers/aws/s3/_helpers/sync_strategy/register.py index 6a9af7a7c..cc359f51e 100644 --- a/runway/core/providers/aws/s3/_helpers/sync_strategy/register.py +++ b/runway/core/providers/aws/s3/_helpers/sync_strategy/register.py @@ -7,7 +7,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any, Type +from typing import TYPE_CHECKING, Any from .delete import DeleteSync from .exact_timestamps import ExactTimestampsSync @@ -21,9 +21,9 @@ def register_sync_strategy( session: Session, - strategy_cls: Type[BaseSync], + strategy_cls: type[BaseSync], sync_type: ValidSyncType = "file_at_src_and_dest", -): +) -> None: """Register a single sync strategy. Args: diff --git a/runway/core/providers/aws/s3/_helpers/sync_strategy/size_only.py b/runway/core/providers/aws/s3/_helpers/sync_strategy/size_only.py index c157b98f6..e8acafd7e 100644 --- a/runway/core/providers/aws/s3/_helpers/sync_strategy/size_only.py +++ b/runway/core/providers/aws/s3/_helpers/sync_strategy/size_only.py @@ -8,13 +8,13 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, ClassVar, Optional - -from typing_extensions import Literal +from typing import TYPE_CHECKING, ClassVar from .base import BaseSync if TYPE_CHECKING: + from typing_extensions import Literal + from ..file_generator import FileStats @@ -27,7 +27,7 @@ class SizeOnlySync(BaseSync): NAME: ClassVar[Literal["size_only"]] = "size_only" def determine_should_sync( - self, src_file: Optional[FileStats], dest_file: Optional[FileStats] + self, src_file: FileStats | None, dest_file: FileStats | None ) -> bool: """Determine if file should sync.""" same_size = self.compare_size(src_file, dest_file) diff --git a/runway/core/providers/aws/s3/_helpers/transfer_config.py b/runway/core/providers/aws/s3/_helpers/transfer_config.py index 63f57f47d..94316de32 100644 --- a/runway/core/providers/aws/s3/_helpers/transfer_config.py +++ b/runway/core/providers/aws/s3/_helpers/transfer_config.py @@ -7,24 +7,24 @@ from __future__ import annotations -from typing import Any, ClassVar, Dict, List, NoReturn, Optional, Union +from typing import Any, ClassVar, NoReturn from s3transfer.manager import TransferConfig from typing_extensions import TypedDict from .utils import human_readable_to_bytes + # If the user does not specify any overrides, # these are the default values we use for the s3 transfer # commands. -TransferConfigDict = TypedDict( - "TransferConfigDict", - max_bandwidth=Optional[Union[int, str]], - max_concurrent_requests=int, - max_queue_size=int, - multipart_chunksize=Union[int, str], - multipart_threshold=Union[int, str], -) +class TransferConfigDict(TypedDict): + max_bandwidth: int | str | None + max_concurrent_requests: int + max_queue_size: int + multipart_chunksize: int | str + multipart_threshold: int | str + DEFAULTS: TransferConfigDict = { "max_bandwidth": None, @@ -42,18 +42,18 @@ class InvalidConfigError(Exception): class RuntimeConfig: """Runtime configuration.""" - POSITIVE_INTEGERS: ClassVar[List[str]] = [ + POSITIVE_INTEGERS: ClassVar[list[str]] = [ "max_bandwidth", "max_concurrent_requests", "max_queue_size", "multipart_chunksize", "multipart_threshold", ] - HUMAN_READABLE_SIZES: ClassVar[List[str]] = [ + HUMAN_READABLE_SIZES: ClassVar[list[str]] = [ "multipart_chunksize", "multipart_threshold", ] - HUMAN_READABLE_RATES: ClassVar[List[str]] = ["max_bandwidth"] + HUMAN_READABLE_RATES: ClassVar[list[str]] = ["max_bandwidth"] @staticmethod def defaults() -> TransferConfigDict: @@ -64,11 +64,11 @@ def defaults() -> TransferConfigDict: def build_config( cls, *, - max_bandwidth: Optional[Union[int, str]] = None, - max_concurrent_requests: Optional[Union[int, str]] = None, - max_queue_size: Optional[Union[int, str]] = None, - multipart_chunksize: Optional[Union[int, str]] = None, - multipart_threshold: Optional[Union[int, str]] = None, + max_bandwidth: int | str | None = None, + max_concurrent_requests: int | str | None = None, + max_queue_size: int | str | None = None, + multipart_chunksize: int | str | None = None, + multipart_threshold: int | str | None = None, ) -> TransferConfigDict: """Create and convert a runtime config dictionary. @@ -85,9 +85,7 @@ def build_config( "multipart_chunksize": multipart_chunksize, "multipart_threshold": multipart_threshold, } - runtime_config.update( - {k: v for k, v in kwargs.items() if v is not None} # type: ignore - ) + runtime_config.update({k: v for k, v in kwargs.items() if v is not None}) # type: ignore cls._convert_human_readable_sizes(runtime_config) cls._convert_human_readable_rates(runtime_config) cls._validate_config(runtime_config) @@ -127,9 +125,7 @@ def _validate_config(cls, runtime_config: TransferConfigDict) -> None: @staticmethod def _error_positive_value(name: str, value: int) -> NoReturn: - raise InvalidConfigError( - f"Value for {name} must be a positive integer: {value}" - ) + raise InvalidConfigError(f"Value for {name} must be a positive integer: {value}") def create_transfer_config_from_runtime_config( @@ -151,7 +147,7 @@ def create_transfer_config_from_runtime_config( "multipart_chunksize": "multipart_chunksize", "multipart_threshold": "multipart_threshold", } - kwargs: Dict[str, Any] = {} + kwargs: dict[str, Any] = {} for key, value in runtime_config.items(): if key not in translation_map: continue diff --git a/runway/core/providers/aws/s3/_helpers/utils.py b/runway/core/providers/aws/s3/_helpers/utils.py index 85f81f57d..2c22fb4e2 100644 --- a/runway/core/providers/aws/s3/_helpers/utils.py +++ b/runway/core/providers/aws/s3/_helpers/utils.py @@ -23,13 +23,8 @@ Any, BinaryIO, Callable, - Dict, - Generator, NamedTuple, - Optional, TextIO, - Tuple, - Union, overload, ) @@ -38,6 +33,7 @@ from s3transfer.subscribers import BaseSubscriber if TYPE_CHECKING: + from collections.abc import Generator from queue import Queue from mypy_boto3_s3.client import S3Client @@ -67,8 +63,7 @@ } _S3_ACCESSPOINT_TO_BUCKET_KEY_REGEX = re.compile( - r"^(?Parn:(aws).*:s3:[a-z\-0-9]+:[0-9]{12}:accesspoint[:/][^/]+)/?" - r"(?P.*)$" + r"^(?Parn:(aws).*:s3:[a-z\-0-9]+:[0-9]{12}:accesspoint[:/][^/]+)/?(?P.*)$" ) _S3_OUTPOST_TO_BUCKET_KEY_REGEX = re.compile( r"^(?Parn:(aws).*:s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:]" @@ -93,7 +88,7 @@ def _get_filename(self, future: TransferFuture) -> str: raise NotImplementedError("_get_filename()") -def _date_parser(date_string: Union[datetime, str]) -> datetime: +def _date_parser(date_string: datetime | str) -> datetime: """Parse date string into a datetime object.""" if isinstance(date_string, datetime): return date_string @@ -106,7 +101,7 @@ class BucketLister: def __init__( self, client: S3Client, - date_parser: Callable[[Union[datetime, str]], datetime] = _date_parser, + date_parser: Callable[[datetime | str], datetime] = _date_parser, ) -> None: """Instantiate class. @@ -121,10 +116,10 @@ def __init__( def list_objects( self, bucket: str, - prefix: Optional[str] = None, - page_size: Optional[int] = None, + prefix: str | None = None, + page_size: int | None = None, extra_args: Any = None, - ) -> Generator[Tuple[str, ObjectTypeDef], None, None]: + ) -> Generator[tuple[str, ObjectTypeDef], None, None]: """List objects in S3 bucket. Args: @@ -163,7 +158,7 @@ def on_done(self, future: TransferFuture, **_: Any) -> None: """On done.""" try: future.result() - except Exception as exc: # pylint: disable=broad-except + except Exception as exc: # noqa: BLE001 self._on_failure(future, exc) else: self._on_success(future) @@ -181,7 +176,7 @@ class DeleteSourceSubscriber(OnDoneFilteredSubscriber): def _on_success(self, future: TransferFuture) -> None: try: self._delete_source(future) - except Exception as exc: # pylint: disable=broad-except + except Exception as exc: # noqa: BLE001 future.set_exception(exc) def _delete_source(self, future: TransferFuture) -> None: @@ -192,13 +187,13 @@ class DeleteSourceFileSubscriber(DeleteSourceSubscriber): """A subscriber which deletes a file.""" def _delete_source(self, future: TransferFuture) -> None: - os.remove(future.meta.call_args.fileobj) + Path(future.meta.call_args.fileobj).unlink() class DeleteSourceObjectSubscriber(DeleteSourceSubscriber): """A subscriber which deletes an object.""" - def __init__(self, client: S3Client): + def __init__(self, client: S3Client) -> None: """Instantiate class.""" self._client = client @@ -243,16 +238,15 @@ class CreateDirectoryError(Exception): class DirectoryCreatorSubscriber(BaseSubscriber): """Creates a directory to download if it does not exist.""" - def on_queued(self, future: TransferFuture, **_: Any): + def on_queued(self, future: TransferFuture, **_: Any) -> None: """On queued.""" - dirname = os.path.dirname(str(future.meta.call_args.fileobj)) + dirname = Path(future.meta.call_args.fileobj).parent try: - if not os.path.exists(dirname): - os.makedirs(dirname) + dirname.mkdir(exist_ok=True, parents=True) except OSError as exc: if exc.errno != errno.EEXIST: raise CreateDirectoryError( - f"Could not create directory {dirname}: {exc}" + f"Could not create directory {dirname.name}: {exc}" ) from exc @@ -275,11 +269,11 @@ class NonSeekableStream: """ - def __init__(self, fileobj: BinaryIO): + def __init__(self, fileobj: BinaryIO) -> None: """Instantiate class.""" self._fileobj = fileobj - def read(self, amt: Optional[int] = None) -> bytes: + def read(self, amt: int | None = None) -> bytes: """Read.""" if amt is None: return self._fileobj.read() @@ -300,7 +294,7 @@ class PrintTask(NamedTuple): message: str error: bool = False - total_parts: Optional[int] = None + total_parts: int | None = None warning: bool = False @@ -314,9 +308,7 @@ def _get_filename(self, future: TransferFuture) -> str: class ProvideLastModifiedTimeSubscriber(OnDoneFilteredSubscriber): """Sets utime for a downloaded file.""" - def __init__( - self, last_modified_time: datetime, result_queue: "Queue[Any]" - ) -> None: + def __init__(self, last_modified_time: datetime, result_queue: Queue[Any]) -> None: """Instantiate class.""" self._last_modified_time = last_modified_time self._result_queue = result_queue @@ -327,7 +319,7 @@ def _on_success(self, future: TransferFuture, **_: Any) -> None: last_update_tuple = self._last_modified_time.timetuple() mod_timestamp = time.mktime(last_update_tuple) set_file_utime(filename, int(mod_timestamp)) - except Exception as exc: # pylint: disable=broad-except + except Exception as exc: # noqa: BLE001 warning_message = ( f"Successfully Downloaded {filename} but was unable to update the " f"last modified time. {exc}" @@ -338,7 +330,7 @@ def _on_success(self, future: TransferFuture, **_: Any) -> None: class ProvideSizeSubscriber(BaseSubscriber): """A subscriber which provides the transfer size before it's queued.""" - def __init__(self, size: Optional[int]): + def __init__(self, size: int | None) -> None: """Instantiate class.""" self.size = size or 0 @@ -377,7 +369,7 @@ class RequestParamsMapper: @classmethod def map_copy_object_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Map config params to CopyObject request params. @@ -399,7 +391,7 @@ def map_copy_object_params( @classmethod def map_create_multipart_upload_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Map config params to CreateMultipartUpload request params. @@ -419,7 +411,7 @@ def map_create_multipart_upload_params( @classmethod def map_delete_object_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Map config params to DeleteObject request params. @@ -435,7 +427,7 @@ def map_delete_object_params( @classmethod def map_get_object_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Map config params to GetObject request params. @@ -452,7 +444,7 @@ def map_get_object_params( @classmethod def map_head_object_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Map config params to HeadObject request params. @@ -469,7 +461,7 @@ def map_head_object_params( @classmethod def map_list_objects_v2_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Map config params to DeleteObjectV2 request params. @@ -485,7 +477,7 @@ def map_list_objects_v2_params( @classmethod def map_put_object_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Map config params to PutObject request params. @@ -505,7 +497,7 @@ def map_put_object_params( @classmethod def map_upload_part_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Map config params to UploadPart request params. @@ -522,7 +514,7 @@ def map_upload_part_params( @classmethod def map_upload_part_copy_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Map config params to UploadPartCopy request params. @@ -538,11 +530,9 @@ def map_upload_part_copy_params( cls._set_request_payer_param(request_params, config_params) @classmethod - def _auto_populate_metadata_directive(cls, request_params: Dict[Any, Any]) -> None: + def _auto_populate_metadata_directive(cls, request_params: dict[Any, Any]) -> None: """Auto populate metadata directive.""" - if request_params.get("Metadata") and not request_params.get( - "MetadataDirective" - ): + if request_params.get("Metadata") and not request_params.get("MetadataDirective"): request_params["MetadataDirective"] = "REPLACE" @classmethod @@ -560,8 +550,8 @@ def _permission_to_param(cls, permission: str) -> str: @classmethod def _set_general_object_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] - ): + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] + ) -> None: """Set general object params. Parameters set in this method should be applicable to the following @@ -588,7 +578,7 @@ def _set_general_object_params( @classmethod def _set_grant_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Set grant params.""" if config_params.get("grants"): @@ -596,14 +586,12 @@ def _set_grant_params( try: permission, grantee = grant.split("=", 1) except ValueError: - raise ValueError( - "grants should be of the form permission=principal" - ) from None + raise ValueError("grants should be of the form permission=principal") from None request_params[cls._permission_to_param(permission)] = grantee @classmethod def _set_metadata_directive_param( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Set metadata directive param.""" if config_params.get("metadata_directive"): @@ -611,7 +599,7 @@ def _set_metadata_directive_param( @classmethod def _set_metadata_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Get metadata params.""" if config_params.get("metadata"): @@ -619,15 +607,15 @@ def _set_metadata_params( @classmethod def _set_request_payer_param( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] - ): + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] + ) -> None: """Set request payer param.""" if config_params.get("request_payer"): request_params["RequestPayer"] = config_params["request_payer"] @classmethod def _set_sse_c_and_copy_source_request_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Set SSE-C and copy source request params.""" cls._set_sse_c_request_params(request_params, config_params) @@ -635,19 +623,15 @@ def _set_sse_c_and_copy_source_request_params( @classmethod def _set_sse_c_copy_source_request_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: if config_params.get("sse_c_copy_source"): - request_params["CopySourceSSECustomerAlgorithm"] = config_params[ - "sse_c_copy_source" - ] - request_params["CopySourceSSECustomerKey"] = config_params[ - "sse_c_copy_source_key" - ] + request_params["CopySourceSSECustomerAlgorithm"] = config_params["sse_c_copy_source"] + request_params["CopySourceSSECustomerKey"] = config_params["sse_c_copy_source_key"] @classmethod def _set_sse_c_request_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Set SSE-C request params.""" if config_params.get("sse_c"): @@ -656,7 +640,7 @@ def _set_sse_c_request_params( @classmethod def _set_sse_request_params( - cls, request_params: Dict[Any, Any], config_params: Dict[Any, Any] + cls, request_params: dict[Any, Any], config_params: dict[Any, Any] ) -> None: """Set SSE request params.""" if config_params.get("sse"): @@ -668,7 +652,7 @@ def _set_sse_request_params( class StdoutBytesWriter: """Acts as a file-like object that performs the bytes_print function on write.""" - def __init__(self, stdout: Optional[TextIO] = None) -> None: + def __init__(self, stdout: TextIO | None = None) -> None: """Instantiate class.""" self._stdout = stdout @@ -692,9 +676,7 @@ def block_s3_object_lambda(s3_path: str) -> None: raise ValueError("S3 action does not support S3 Object Lambda resources") -def create_warning( - path: Optional[AnyPath], error_message: str, skip_file: bool = True -) -> PrintTask: +def create_warning(path: AnyPath | None, error_message: str, skip_file: bool = True) -> PrintTask: """Create a ``PrintTask`` for whenever a warning is to be thrown.""" print_string = "warning: " if skip_file: @@ -703,7 +685,7 @@ def create_warning( return PrintTask(message=print_string, error=False, warning=True) -def find_bucket_key(s3_path: str) -> Tuple[str, str]: +def find_bucket_key(s3_path: str) -> tuple[str, str]: """Given an S3 path return the bucket and the key represented by the S3 path. Args: @@ -726,8 +708,8 @@ def find_bucket_key(s3_path: str) -> Tuple[str, str]: def find_dest_path_comp_key( - files: FormatPathResult, src_path: Optional[AnyPath] = None -) -> Tuple[str, str]: + files: FormatPathResult, src_path: AnyPath | None = None +) -> tuple[str, str]: """Determine destination path and compare key. Args: @@ -742,17 +724,13 @@ def find_dest_path_comp_key( if src_path is None: src_path = src["path"] if isinstance(src_path, Path): # convert path to absolute path str - if src_path.is_dir(): - src_path = f"{src_path.resolve()}{os.sep}" - else: - src_path = str(src_path.resolve()) + src_path = f"{src_path.resolve()}{os.sep}" if src_path.is_dir() else str(src_path.resolve()) sep_table = {"s3": "/", "local": os.sep} - if files["dir_op"]: - rel_path = src_path[len(src["path"]) :] - else: - rel_path = src_path.split(sep_table[src_type])[-1] + rel_path = ( + src_path[len(src["path"]) :] if files["dir_op"] else src_path.split(sep_table[src_type])[-1] + ) compare_key = rel_path.replace(sep_table[src_type], "/") if files["use_src_name"]: dest_path = dest["path"] @@ -762,11 +740,11 @@ def find_dest_path_comp_key( return dest_path, compare_key -def get_file_stat(path: Path) -> Tuple[int, Optional[datetime]]: +def get_file_stat(path: Path) -> tuple[int, datetime | None]: """Get size of file in bytes and last modified time stamp.""" try: stats = path.stat() - except IOError as exc: + except OSError as exc: raise ValueError(f"Could not retrieve file stat of {path}: {exc}") from exc try: @@ -777,7 +755,7 @@ def get_file_stat(path: Path) -> Tuple[int, Optional[datetime]]: return stats.st_size, update_time -def guess_content_type(filename: AnyPath) -> Optional[str]: +def guess_content_type(filename: AnyPath) -> str | None: """Given a filename, guess it's content type. If the type cannot be guessed, a value of None is returned. @@ -794,7 +772,7 @@ def guess_content_type(filename: AnyPath) -> Optional[str]: return None -def human_readable_size(value: float) -> Optional[str]: +def human_readable_size(value: float) -> str | None: """Convert a size in bytes into a human readable format. For example:: @@ -843,11 +821,7 @@ def human_readable_to_bytes(value: str) -> int: """ value = value.lower() - if value[-2:] == "ib": - # Assume IEC suffix. - suffix = value[-3:].lower() - else: - suffix = value[-2:].lower() + suffix = value[-3:].lower() if value[-2:] == "ib" else value[-2:].lower() has_size_identifier = len(value) >= 2 and suffix in SIZE_SUFFIX if not has_size_identifier: try: @@ -868,14 +842,10 @@ def relative_path(filename: None, start: AnyPath = ...) -> None: ... @overload -def relative_path( - filename: Optional[AnyPath], start: AnyPath = ... -) -> Optional[str]: ... +def relative_path(filename: AnyPath | None, start: AnyPath = ...) -> str | None: ... -def relative_path( - filename: Optional[AnyPath], start: AnyPath = os.path.curdir -) -> Optional[str]: +def relative_path(filename: AnyPath | None, start: AnyPath = os.path.curdir) -> str | None: """Cross platform relative path of a filename. If no relative path can be calculated (i.e different @@ -888,16 +858,16 @@ def relative_path( try: dirname, basename = os.path.split(str(filename)) relative_dir = os.path.relpath(dirname, start) - return os.path.join(relative_dir, basename) + return os.path.join(relative_dir, basename) # noqa: PTH118 except ValueError: - return os.path.abspath(str(filename)) + return os.path.abspath(str(filename)) # noqa: PTH100 class SetFileUtimeError(Exception): """Set file update time error.""" -def set_file_utime(filename: AnyPath, desired_time: float): +def set_file_utime(filename: AnyPath, desired_time: float) -> None: """Set the utime of a file, and if it fails, raise a more explicit error. Args: @@ -921,7 +891,7 @@ def set_file_utime(filename: AnyPath, desired_time: float): ) from exc -def split_s3_bucket_key(s3_path: str) -> Tuple[str, str]: +def split_s3_bucket_key(s3_path: str) -> tuple[str, str]: """Split s3 path into bucket and key prefix. This will also handle the s3:// prefix. @@ -938,7 +908,7 @@ def split_s3_bucket_key(s3_path: str) -> Tuple[str, str]: return find_bucket_key(s3_path) -def uni_print(statement: str, out_file: Optional[TextIO] = None) -> None: +def uni_print(statement: str, out_file: TextIO | None = None) -> None: """Write unicode to a file, usually stdout or stderr. Ensures that the proper encoding is used if the statement is not a string type. diff --git a/runway/core/providers/aws/s3/_sync_handler.py b/runway/core/providers/aws/s3/_sync_handler.py index 9f4d0b528..c0aa23254 100644 --- a/runway/core/providers/aws/s3/_sync_handler.py +++ b/runway/core/providers/aws/s3/_sync_handler.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, List, Optional, Union +from typing import TYPE_CHECKING from .....compat import cached_property from ._helpers.action_architecture import ActionArchitecture @@ -23,15 +23,15 @@ class S3SyncHandler: def __init__( self, - context: Union[CfnginContext, RunwayContext], + context: CfnginContext | RunwayContext, *, delete: bool = False, dest: str, - exclude: Optional[List[str]] = None, + exclude: list[str] | None = None, follow_symlinks: bool = False, - include: Optional[List[str]] = None, - page_size: Optional[int] = None, - session: Optional[boto3.Session] = None, + include: list[str] | None = None, + page_size: int | None = None, + session: boto3.Session | None = None, src: str, ) -> None: """Instantiate class. diff --git a/runway/core/providers/aws/type_defs.py b/runway/core/providers/aws/type_defs.py index 4c44ad68f..c6efd8484 100644 --- a/runway/core/providers/aws/type_defs.py +++ b/runway/core/providers/aws/type_defs.py @@ -2,8 +2,6 @@ from __future__ import annotations -from typing import List - from typing_extensions import TypedDict @@ -14,4 +12,4 @@ class TagTypeDef(TypedDict): Value: str -TagSetTypeDef = List[TagTypeDef] +TagSetTypeDef = list[TagTypeDef] diff --git a/runway/dependency_managers/_pip.py b/runway/dependency_managers/_pip.py index 6d479c557..1480f5a1f 100644 --- a/runway/dependency_managers/_pip.py +++ b/runway/dependency_managers/_pip.py @@ -6,9 +6,7 @@ import re import subprocess from pathlib import Path -from typing import TYPE_CHECKING, Any, Iterable, List, Optional, Tuple, Union, cast - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Final, Optional, cast from ..compat import cached_property, shlex_join from ..exceptions import RunwayError @@ -16,7 +14,10 @@ from .base_classes import DependencyManager if TYPE_CHECKING: + from collections.abc import Iterable + from _typeshed import StrPath + from typing_extensions import Literal from .._logging import RunwayLogger @@ -30,8 +31,7 @@ class PipInstallFailedError(RunwayError): def __init__(self, *args: Any, **kwargs: Any) -> None: """Instantiate class. All args/kwargs are passed to parent method.""" self.message = ( - "pip failed to install dependencies; " - "review pip's output above to troubleshoot" + "pip failed to install dependencies; review pip's output above to troubleshoot" ) super().__init__(*args, **kwargs) @@ -39,7 +39,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: class Pip(DependencyManager): """pip CLI interface.""" - CONFIG_FILES: Final[Tuple[Literal["requirements.txt"]]] = ("requirements.txt",) + CONFIG_FILES: Final[tuple[Literal["requirements.txt"]]] = ("requirements.txt",) """Configuration files used by pip.""" EXECUTABLE: Final[Literal["pip"]] = "pip" @@ -51,9 +51,7 @@ def python_version(self) -> Version: cmd_output = self._run_command([self.EXECUTABLE, "--version"]) match = re.search(r"^pip \S* from .+ \(python (?P\S*)\)$", cmd_output) if not match: - LOGGER.warning( - "unable to parse Python version from output:\n%s", cmd_output - ) + LOGGER.warning("unable to parse Python version from output:\n%s", cmd_output) return Version("0.0.0") return Version(match.group("version")) @@ -73,13 +71,12 @@ def dir_is_project(cls, directory: StrPath, **kwargs: Any) -> bool: Args: directory: Directory to check. + **kwargs: Arbitrary keyword arguments. """ kwargs.setdefault("file_name", cls.CONFIG_FILES[0]) requirements_txt = Path(directory) / kwargs["file_name"] - if requirements_txt.is_file(): - return True - return False + return bool(requirements_txt.is_file()) @classmethod def generate_install_command( @@ -90,7 +87,7 @@ def generate_install_command( no_deps: bool = False, requirements: StrPath, target: StrPath, - ) -> List[str]: + ) -> list[str]: """Generate the command that when run will install dependencies. This method is exposed to easily format the command to be run by with @@ -119,7 +116,7 @@ def install( self, *, cache_dir: Optional[StrPath] = None, - extend_args: Optional[List[str]] = None, + extend_args: Optional[list[str]] = None, no_cache_dir: bool = False, no_deps: bool = False, requirements: StrPath, @@ -165,14 +162,15 @@ def install( @classmethod def generate_command( cls, - command: Union[List[str], str], - **kwargs: Optional[Union[bool, Iterable[str], str]], - ) -> List[str]: + command: list[str] | str, + **kwargs: bool | Iterable[str] | str | None, + ) -> list[str]: """Generate command to be executed and log it. Args: command: Command to run. args: Additional args to pass to the command. + **kwargs: Arbitrary keyword arguments. Returns: The full command to be passed into a subprocess. diff --git a/runway/dependency_managers/_pipenv.py b/runway/dependency_managers/_pipenv.py index 031f18452..e6921c04c 100644 --- a/runway/dependency_managers/_pipenv.py +++ b/runway/dependency_managers/_pipenv.py @@ -7,9 +7,7 @@ import re import subprocess from pathlib import Path -from typing import TYPE_CHECKING, Any, Tuple - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Final from ..compat import cached_property from ..exceptions import RunwayError @@ -18,6 +16,7 @@ if TYPE_CHECKING: from _typeshed import StrPath + from typing_extensions import Literal LOGGER = logging.getLogger(__name__) @@ -50,7 +49,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: class Pipenv(DependencyManager): """Pipenv dependency manager.""" - CONFIG_FILES: Final[Tuple[Literal["Pipfile"], Literal["Pipfile.lock"]]] = ( + CONFIG_FILES: Final[tuple[Literal["Pipfile"], Literal["Pipfile.lock"]]] = ( "Pipfile", "Pipfile.lock", ) @@ -65,9 +64,7 @@ def version(self) -> Version: cmd_output = self._run_command([self.EXECUTABLE, "--version"]) match = re.search(r"^pipenv, version (?P\S*)", cmd_output) if not match: - LOGGER.warning( - "unable to parse pipenv version from output:\n%s", cmd_output - ) + LOGGER.warning("unable to parse pipenv version from output:\n%s", cmd_output) return Version("0.0.0") return Version(match.group("version")) @@ -111,8 +108,5 @@ def export(self, *, dev: bool = False, output: StrPath) -> Path: except subprocess.CalledProcessError as exc: raise PipenvExportFailedError from exc output.parent.mkdir(exist_ok=True, parents=True) # ensure directory exists - # python3.7 w/ pylint 2.12.[12] crashes if result is not wrapped in str() - output.write_text( - str(result), encoding=locale.getpreferredencoding(do_setlocale=False) - ) + output.write_text(str(result), encoding=locale.getpreferredencoding(do_setlocale=False)) return output diff --git a/runway/dependency_managers/_poetry.py b/runway/dependency_managers/_poetry.py index ebe109fe6..27d3744c1 100644 --- a/runway/dependency_managers/_poetry.py +++ b/runway/dependency_managers/_poetry.py @@ -6,10 +6,9 @@ import re import subprocess from pathlib import Path -from typing import TYPE_CHECKING, Any, List, Optional, Tuple +from typing import TYPE_CHECKING, Any, Final, Optional import tomli -from typing_extensions import Final, Literal from ..compat import cached_property from ..exceptions import RunwayError @@ -18,6 +17,7 @@ if TYPE_CHECKING: from _typeshed import StrPath + from typing_extensions import Literal LOGGER = logging.getLogger(__name__) @@ -30,6 +30,8 @@ def __init__(self, output: str, *args: Any, **kwargs: Any) -> None: Args: output: The output from running ``poetry export``. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.message = f"poetry export failed with the following output:\n{output}" @@ -52,7 +54,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: class Poetry(DependencyManager): """Poetry dependency manager.""" - CONFIG_FILES: Final[Tuple[Literal["poetry.lock"], Literal["pyproject.toml"]]] = ( + CONFIG_FILES: Final[tuple[Literal["poetry.lock"], Literal["pyproject.toml"]]] = ( "poetry.lock", "pyproject.toml", ) @@ -67,9 +69,7 @@ def version(self) -> Version: cmd_output = self._run_command([self.EXECUTABLE, "--version"]) match = re.search(r"^Poetry version (?P\S*)", cmd_output) if not match: - LOGGER.warning( - "unable to parse poetry version from output:\n%s", cmd_output - ) + LOGGER.warning("unable to parse poetry version from output:\n%s", cmd_output) return Version("0.0.0") return Version(match.group("version")) @@ -88,9 +88,9 @@ def dir_is_project(cls, directory: StrPath, **__kwargs: Any) -> bool: # check for PEP-517 definition pyproject = tomli.loads(pyproject_path.read_text()) - build_system_requires: Optional[List[str]] = pyproject.get( - "build-system", {} - ).get("requires") + build_system_requires: Optional[list[str]] = pyproject.get("build-system", {}).get( + "requires" + ) if build_system_requires: for req in build_system_requires: @@ -103,7 +103,7 @@ def export( self, *, dev: bool = False, - extras: Optional[List[str]] = None, + extras: Optional[list[str]] = None, output: StrPath, output_format: str = "requirements.txt", with_credentials: bool = True, diff --git a/runway/dependency_managers/base_classes.py b/runway/dependency_managers/base_classes.py index a40bc457e..41509f1d7 100644 --- a/runway/dependency_managers/base_classes.py +++ b/runway/dependency_managers/base_classes.py @@ -3,7 +3,7 @@ from __future__ import annotations from pathlib import Path -from typing import TYPE_CHECKING, Any, ClassVar, Tuple, Union +from typing import TYPE_CHECKING, Any, ClassVar, Union from ..compat import cached_property from ..mixins import CliInterfaceMixin @@ -24,12 +24,10 @@ class DependencyManager(CliInterfaceMixin): """ - CONFIG_FILES: ClassVar[Tuple[str, ...]] + CONFIG_FILES: ClassVar[tuple[str, ...]] """Configuration files used by the dependency manager.""" - def __init__( - self, context: Union[CfnginContext, RunwayContext], cwd: StrPath - ) -> None: + def __init__(self, context: Union[CfnginContext, RunwayContext], cwd: StrPath) -> None: """Instantiate class. Args: diff --git a/runway/env_mgr/__init__.py b/runway/env_mgr/__init__.py index be75f02fb..6e110c575 100644 --- a/runway/env_mgr/__init__.py +++ b/runway/env_mgr/__init__.py @@ -8,12 +8,13 @@ import shutil import sys from pathlib import Path -from typing import TYPE_CHECKING, Generator, Optional, Union, cast +from typing import TYPE_CHECKING, Optional, Union, cast from ..compat import cached_property from ..mixins import DelCachedPropMixin if TYPE_CHECKING: + from collections.abc import Generator from urllib.error import URLError from .._logging import RunwayLogger @@ -71,9 +72,7 @@ class EnvManager(DelCachedPropMixin): env_dir_name: str path: Path - def __init__( - self, bin_name: str, dir_name: str, path: Optional[Path] = None - ) -> None: + def __init__(self, bin_name: str, dir_name: str, path: Optional[Path] = None) -> None: """Initialize class. Args: @@ -85,10 +84,8 @@ def __init__( """ self._bin_name = bin_name + self.command_suffix self.current_version = None - self.env_dir_name = ( - dir_name if platform.system() == "Windows" else "." + dir_name - ) - self.path = Path.cwd() if not path else path + self.env_dir_name = dir_name if platform.system() == "Windows" else "." + dir_name + self.path = path if path else Path.cwd() @property def bin(self) -> Path: diff --git a/runway/env_mgr/kbenv.py b/runway/env_mgr/kbenv.py index bc90cd8a3..4c9808375 100644 --- a/runway/env_mgr/kbenv.py +++ b/runway/env_mgr/kbenv.py @@ -11,12 +11,11 @@ import shutil import sys import tempfile -from typing import TYPE_CHECKING, Generator, Optional, cast +from typing import TYPE_CHECKING, Final, Optional, cast from urllib.error import URLError from urllib.request import urlretrieve import requests -from typing_extensions import Final from ..compat import cached_property from ..exceptions import KubectlVersionNotSpecified @@ -24,6 +23,7 @@ from . import EnvManager, handle_bin_download_error if TYPE_CHECKING: + from collections.abc import Generator from pathlib import Path from .._logging import RunwayLogger @@ -50,11 +50,11 @@ def verify_kb_release(kb_url: str, download_dir: str, filename: str) -> None: # the ridiculousness should be short-lived as md5 & sha1 support won't last # long. try: - hash_alg: "hashlib._Hash" = hashlib.sha512() + hash_alg: hashlib._Hash = hashlib.sha512() checksum_filename = filename + "." + hash_alg.name LOGGER.debug("attempting download of kubectl %s checksum...", hash_alg.name) download_request = requests.get( - kb_url + "/" + checksum_filename, allow_redirects=True + kb_url + "/" + checksum_filename, allow_redirects=True, timeout=30 ) download_request.raise_for_status() except requests.exceptions.HTTPError: @@ -63,42 +63,35 @@ def verify_kb_release(kb_url: str, download_dir: str, filename: str) -> None: checksum_filename = filename + "." + hash_alg.name LOGGER.debug("attempting download of kubectl %s checksum...", hash_alg.name) download_request = requests.get( - kb_url + "/" + checksum_filename, allow_redirects=True + kb_url + "/" + checksum_filename, allow_redirects=True, timeout=30 ) download_request.raise_for_status() except requests.exceptions.HTTPError: try: - hash_alg = hashlib.sha1() + hash_alg = hashlib.sha1() # noqa: S324 checksum_filename = filename + "." + hash_alg.name - LOGGER.debug( - "attempting download of kubectl %s checksum...", hash_alg.name - ) + LOGGER.debug("attempting download of kubectl %s checksum...", hash_alg.name) download_request = requests.get( - kb_url + "/" + checksum_filename, allow_redirects=True + kb_url + "/" + checksum_filename, allow_redirects=True, timeout=30 ) download_request.raise_for_status() except requests.exceptions.HTTPError: try: - hash_alg = hashlib.md5() + hash_alg = hashlib.md5() # noqa: S324 checksum_filename = filename + "." + hash_alg.name - LOGGER.debug( - "attempting download of kubectl %s checksum...", hash_alg.name - ) + LOGGER.debug("attempting download of kubectl %s checksum...", hash_alg.name) download_request = requests.get( - kb_url + "/" + checksum_filename, allow_redirects=True + kb_url + "/" + checksum_filename, allow_redirects=True, timeout=30 ) download_request.raise_for_status() except requests.exceptions.HTTPError: LOGGER.error("Unable to retrieve kubectl checksum file") sys.exit(1) - if sys.version_info < (3, 0): - kb_hash = download_request.content.rstrip("\n") - else: - kb_hash = download_request.content.decode().rstrip("\n") + kb_hash = download_request.content.decode().rstrip("\n") checksum = FileHash(hash_alg) - checksum.add_file(os.path.join(download_dir, filename)) + checksum.add_file(os.path.join(download_dir, filename)) # noqa: PTH118 if kb_hash != checksum.hexdigest: LOGGER.error( "downloaded kubectl %s does not match %s checksum %s", @@ -142,14 +135,16 @@ def download_kb_release( try: LOGGER.verbose("downloading kubectl from %s...", kb_url) - urlretrieve(kb_url + "/" + filename, os.path.join(download_dir, filename)) + urlretrieve( # noqa: S310 + kb_url + "/" + filename, os.path.join(download_dir, filename) # noqa: PTH118 + ) except URLError as exc: handle_bin_download_error(exc, "kubectl") verify_kb_release(kb_url, download_dir, filename) version_dir.mkdir(parents=True, exist_ok=True) - shutil.move(os.path.join(download_dir, filename), version_dir / filename) + shutil.move(os.path.join(download_dir, filename), version_dir / filename) # noqa: PTH118 shutil.rmtree(download_dir) result = version_dir / filename result.chmod(result.stat().st_mode | 0o0111) # ensure it is executable @@ -164,9 +159,7 @@ class KBEnvManager(EnvManager): VERSION_REGEX: Final[str] = r"^(v)?(?P[0-9]+\.[0-9]+\.[0-9]+\S*)" - def __init__( - self, path: Optional[Path] = None, *, overlay_path: Optional[Path] = None - ) -> None: + def __init__(self, path: Optional[Path] = None, *, overlay_path: Optional[Path] = None) -> None: """Initialize class. Args: @@ -237,9 +230,7 @@ def install(self, version_requested: Optional[str] = None) -> str: # Return early (i.e before reaching out to the internet) if the # matching version is already installed if (self.versions_dir / version_requested).is_dir(): - LOGGER.verbose( - "kubectl version %s already installed; using it...", version_requested - ) + LOGGER.verbose("kubectl version %s already installed; using it...", version_requested) self.current_version = version_requested return str(self.bin) @@ -285,7 +276,5 @@ def parse_version_string(cls, version: str) -> Version: """ match = re.search(cls.VERSION_REGEX, version) if not match: - raise ValueError( - f"provided version doesn't conform to regex: {cls.VERSION_REGEX}" - ) + raise ValueError(f"provided version doesn't conform to regex: {cls.VERSION_REGEX}") return Version(f"v{match.group('version')}") diff --git a/runway/env_mgr/tfenv.py b/runway/env_mgr/tfenv.py index 45ec70357..d78513b74 100644 --- a/runway/env_mgr/tfenv.py +++ b/runway/env_mgr/tfenv.py @@ -14,17 +14,7 @@ import sys import tempfile import zipfile -from typing import ( - TYPE_CHECKING, - Any, - Dict, - Generator, - List, - Optional, - Union, - cast, - overload, -) +from typing import TYPE_CHECKING, Any, Final, cast, overload from urllib.error import URLError from urllib.request import urlretrieve @@ -32,7 +22,6 @@ import hcl2 import requests from packaging.version import InvalidVersion -from typing_extensions import Final from ..compat import cached_property from ..exceptions import HclParserError @@ -40,6 +29,7 @@ from . import EnvManager, handle_bin_download_error if TYPE_CHECKING: + from collections.abc import Generator from pathlib import Path from types import ModuleType @@ -53,8 +43,8 @@ def download_tf_release( version: str, versions_dir: Path, command_suffix: str, - tf_platform: Optional[str] = None, - arch: Optional[str] = None, + tf_platform: str | None = None, + arch: str | None = None, ) -> None: """Download Terraform archive and return path to it.""" version_dir = versions_dir / version @@ -64,19 +54,15 @@ def download_tf_release( if tf_platform: tfver_os = tf_platform + "_" + arch + elif platform.system().startswith("Darwin"): + tfver_os = f"darwin_{arch}" + elif platform.system().startswith("Windows") or ( + platform.system().startswith("MINGW64") + or (platform.system().startswith("MSYS_NT") or platform.system().startswith("CYGWIN_NT")) + ): + tfver_os = f"windows_{arch}" else: - if platform.system().startswith("Darwin"): - tfver_os = f"darwin_{arch}" - elif platform.system().startswith("Windows") or ( - platform.system().startswith("MINGW64") - or ( - platform.system().startswith("MSYS_NT") - or platform.system().startswith("CYGWIN_NT") - ) - ): - tfver_os = f"windows_{arch}" - else: - tfver_os = f"linux_{arch}" + tfver_os = f"linux_{arch}" download_dir = tempfile.mkdtemp() filename = f"terraform_{version}_{tfver_os}.zip" @@ -86,20 +72,20 @@ def download_tf_release( try: LOGGER.verbose("downloading Terraform from %s...", tf_url) for i in [filename, shasums_name]: - urlretrieve(tf_url + "/" + i, os.path.join(download_dir, i)) + urlretrieve(tf_url + "/" + i, os.path.join(download_dir, i)) # noqa: PTH118, S310 except URLError as exc: handle_bin_download_error(exc, "Terraform") - tf_hash = get_hash_for_filename(filename, os.path.join(download_dir, shasums_name)) + tf_hash = get_hash_for_filename( + filename, os.path.join(download_dir, shasums_name) # noqa: PTH118 + ) checksum = FileHash(hashlib.sha256()) - checksum.add_file(os.path.join(download_dir, filename)) + checksum.add_file(os.path.join(download_dir, filename)) # noqa: PTH118 if tf_hash != checksum.hexdigest: - LOGGER.error( - "downloaded Terraform %s does not match sha256 %s", filename, tf_hash - ) + LOGGER.error("downloaded Terraform %s does not match sha256 %s", filename, tf_hash) sys.exit(1) - with zipfile.ZipFile(os.path.join(download_dir, filename)) as tf_zipfile: + with zipfile.ZipFile(os.path.join(download_dir, filename)) as tf_zipfile: # noqa: PTH118 version_dir.mkdir(parents=True, exist_ok=True) tf_zipfile.extractall(str(version_dir)) @@ -108,10 +94,10 @@ def download_tf_release( result.chmod(result.stat().st_mode | 0o0111) # ensure it is executable -def get_available_tf_versions(include_prerelease: bool = False) -> List[str]: +def get_available_tf_versions(include_prerelease: bool = False) -> list[str]: """Return available Terraform versions.""" tf_releases = json.loads( - requests.get("https://releases.hashicorp.com/index.json").text + requests.get("https://releases.hashicorp.com/index.json", timeout=30).text )["terraform"] # Remove versions that don't align with @@ -139,22 +125,22 @@ def get_latest_tf_version(include_prerelease: bool = False) -> str: return get_available_tf_versions(include_prerelease)[0] -def load_terraform_module(parser: ModuleType, path: Path) -> Dict[str, Any]: +def load_terraform_module(parser: ModuleType, path: Path) -> dict[str, Any]: """Load all Terraform files in a module into one dict. Args: - parser (Union[hcl, hcl2]): Parser to use when loading files. + parser: Parser to use when loading files. path: Terraform module path. All Terraform files in the path will be loaded. """ - result: Dict[str, Any] = {} + result: dict[str, Any] = {} LOGGER.debug("using %s parser to load module: %s", parser.__name__.upper(), path) for tf_file in path.glob("*.tf"): try: tf_config = parser.loads(tf_file.read_text()) # type: ignore - result = merge_dicts(result, cast(Dict[str, Any], tf_config)) - except Exception as exc: + result = merge_dicts(result, cast("dict[str, Any]", tf_config)) + except Exception as exc: # noqa: BLE001 raise HclParserError(exc, tf_file, parser) from None return result @@ -171,38 +157,36 @@ class TFEnvManager(EnvManager): r"^Terraform v(?P[0-9]*\.[0-9]*\.[0-9]*)(?P-.*)?" ) - def __init__(self, path: Optional[Path] = None) -> None: + def __init__(self, path: Path | None = None) -> None: """Initialize class.""" super().__init__("terraform", "tfenv", path) @cached_property - def backend(self) -> Dict[str, Any]: + def backend(self) -> dict[str, Any]: """Backend config of the Terraform module.""" # Terraform can only have one backend configured; this formats the # data to make it easier to work with - return [ + return next( {"type": k, "config": v} for k, v in self.terraform_block.get( - "backend", {None: cast(Dict[str, str], {})} + "backend", {None: cast("dict[str, str]", {})} ).items() - ][0] + ) @cached_property - def terraform_block(self) -> Dict[str, Any]: + def terraform_block(self) -> dict[str, Any]: # noqa: C901 """Collect Terraform configuration blocks from a Terraform module.""" @overload - def _flatten_lists(data: Dict[str, Any]) -> Dict[str, Any]: ... + def _flatten_lists(data: dict[str, Any]) -> dict[str, Any]: ... @overload - def _flatten_lists(data: List[Any]) -> List[Any]: ... + def _flatten_lists(data: list[Any]) -> list[Any]: ... @overload def _flatten_lists(data: str) -> str: ... - def _flatten_lists( - data: Union[Dict[str, Any], List[Any], Any] - ) -> Union[Dict[str, Any], Any]: + def _flatten_lists(data: dict[str, Any] | list[Any] | Any) -> dict[str, Any] | Any: """Flatten HCL2 list attributes until its fixed. python-hcl2 incorrectly turns all attributes into lists so we need @@ -216,28 +200,28 @@ def _flatten_lists( """ if not isinstance(data, dict): return data - copy_data = cast(Dict[str, Any], data.copy()) + copy_data = cast("dict[str, Any]", data.copy()) for attr, val in copy_data.items(): if isinstance(val, list): - if len(cast(List[Any], val)) == 1: + if len(cast("list[Any]", val)) == 1: # pull single values out of lists data[attr] = _flatten_lists(cast(Any, val[0])) else: - data[attr] = [_flatten_lists(v) for v in cast(List[Any], val)] + data[attr] = [_flatten_lists(v) for v in cast("list[Any]", val)] elif isinstance(val, dict): - data[attr] = _flatten_lists(cast(Dict[str, Any], val)) + data[attr] = _flatten_lists(cast("dict[str, Any]", val)) return data try: - result: Union[Dict[str, Any], List[Dict[str, Any]]] = load_terraform_module( + result: dict[str, Any] | list[dict[str, Any]] = load_terraform_module( hcl2, self.path - ).get("terraform", cast(Dict[str, Any], {})) + ).get("terraform", cast("dict[str, Any]", {})) except HclParserError as exc: LOGGER.warning(exc) LOGGER.warning("failed to parse as HCL2; trying HCL...") try: result = load_terraform_module(hcl, self.path).get( - "terraform", cast(Dict[str, Any], {}) + "terraform", cast("dict[str, Any]", {}) ) except HclParserError as exc2: LOGGER.warning(exc2) @@ -251,7 +235,7 @@ def _flatten_lists( return _flatten_lists(result) @cached_property - def version(self) -> Optional[Version]: + def version(self) -> Version | None: """Terraform version.""" version_requested = self.current_version or self.get_version_from_file() @@ -263,9 +247,7 @@ def version(self) -> Optional[Version]: version_requested = self.get_min_required() if re.match(r"^latest:.*$", version_requested): - regex = re.search(r"latest:(.*)", version_requested).group( # type: ignore - 1 - ) + regex = re.search(r"latest:(.*)", version_requested).group(1) # type: ignore include_prerelease_versions = False elif re.match(r"^latest$", version_requested): regex = r"^[0-9]+\.[0-9]+\.[0-9]+$" @@ -292,7 +274,7 @@ def version(self) -> Optional[Version]: return self.parse_version_string(self.current_version) @cached_property - def version_file(self) -> Optional[Path]: + def version_file(self) -> Path | None: """Find and return a ".terraform-version" file if one is present. Returns: @@ -334,7 +316,7 @@ def get_min_required(self) -> str: ) sys.exit(1) - def get_version_from_file(self, file_path: Optional[Path] = None) -> Optional[str]: + def get_version_from_file(self, file_path: Path | None = None) -> str | None: """Get Terraform version from a file. Args: @@ -349,7 +331,7 @@ def get_version_from_file(self, file_path: Optional[Path] = None) -> Optional[st LOGGER.debug("file path not provided and version file could not be found") return None - def install(self, version_requested: Optional[str] = None) -> str: + def install(self, version_requested: str | None = None) -> str: """Ensure Terraform is available.""" if version_requested: self.set_version(version_requested) @@ -362,9 +344,7 @@ def install(self, version_requested: Optional[str] = None) -> str: # Now that a version has been selected, skip downloading if it's # already been downloaded if (self.versions_dir / str(self.version)).is_dir(): - LOGGER.verbose( - "Terraform version %s already installed; using it...", self.version - ) + LOGGER.verbose("Terraform version %s already installed; using it...", self.version) return str(self.bin) LOGGER.info("downloading and using Terraform version %s ...", self.version) @@ -400,11 +380,11 @@ def set_version(self, version: str) -> None: @classmethod def get_version_from_executable( cls, - bin_path: Union[Path, str], + bin_path: Path | str, *, - cwd: Optional[Union[Path, str]] = None, - env: Optional[Dict[str, str]] = None, - ) -> Optional[Version]: + cwd: Path | str | None = None, + env: dict[str, str] | None = None, + ) -> Version | None: """Get Terraform version from an executable. Args: @@ -413,9 +393,7 @@ def get_version_from_executable( env: Environment variable overrides. """ - output = subprocess.check_output( - [str(bin_path), "-version"], cwd=cwd, env=env - ).decode() + output = subprocess.check_output([str(bin_path), "-version"], cwd=cwd, env=env).decode() match = re.search(cls.VERSION_OUTPUT_REGEX, output) if not match: return None @@ -432,7 +410,5 @@ def parse_version_string(cls, version: str) -> Version: """ match = re.search(cls.VERSION_REGEX, version) if not match: - raise ValueError( - f"provided version doesn't conform to regex: {cls.VERSION_REGEX}" - ) + raise ValueError(f"provided version doesn't conform to regex: {cls.VERSION_REGEX}") return Version(match.group("version")) diff --git a/runway/exceptions.py b/runway/exceptions.py index 8984e06d5..ea674e2d4 100644 --- a/runway/exceptions.py +++ b/runway/exceptions.py @@ -2,12 +2,12 @@ from __future__ import annotations -from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union +from typing import TYPE_CHECKING, Any from .utils import DOC_SITE if TYPE_CHECKING: + from pathlib import Path from types import ModuleType from .variables import ( @@ -35,11 +35,11 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: class ConfigNotFound(RunwayError): """Configuration file could not be found.""" - looking_for: List[str] + looking_for: list[str] message: str path: Path - def __init__(self, *, looking_for: Optional[List[str]] = None, path: Path) -> None: + def __init__(self, *, looking_for: list[str] | None = None, path: Path) -> None: """Instantiate class. Args: @@ -51,10 +51,7 @@ def __init__(self, *, looking_for: Optional[List[str]] = None, path: Path) -> No self.path = path if looking_for: - self.message = ( - f"config file not found at path {path}; " - f"looking for one of {looking_for}" - ) + self.message = f"config file not found at path {path}; looking for one of {looking_for}" else: self.message = f"config file not found at path {path}" super().__init__(self.path, self.looking_for) @@ -92,7 +89,7 @@ class DockerExecFailedError(RunwayError): exit_code: int """The ``StatusCode`` returned by Docker.""" - def __init__(self, response: Dict[str, Any]) -> None: + def __init__(self, response: dict[str, Any]) -> None: """Instantiate class. Args: @@ -103,7 +100,7 @@ def __init__(self, response: Dict[str, Any]) -> None: """ self.exit_code = response.get("StatusCode", 1) # we can assume this will be > 0 - error = response.get("Error") or {} # value from dict could be NoneType + error: dict[Any, Any] = response.get("Error") or {} # value from dict could be NoneType self.message = error.get("Message", "error message undefined") super().__init__() @@ -130,6 +127,8 @@ def __init__( lookup: The variable value lookup that was attempted and resulted in an exception being raised. cause: The exception that was raised. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.cause = cause @@ -156,13 +155,14 @@ def __init__( Args: variable: The variable containing the failed lookup. lookup_error: The exception that was raised directly before this one. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.cause = lookup_error self.variable = variable self.message = ( - f'Could not resolve lookup "{lookup_error.lookup}" ' - f'for variable "{variable.name}"' + f'Could not resolve lookup "{lookup_error.lookup}" for variable "{variable.name}"' ) super().__init__(*args, **kwargs) @@ -175,8 +175,8 @@ class HclParserError(RunwayError): def __init__( self, exc: Exception, - file_path: Union[Path, str], - parser: Optional[ModuleType] = None, + file_path: Path | str, + parser: ModuleType | None = None, ) -> None: """Instantiate class. @@ -189,9 +189,7 @@ def __init__( self.reason = exc self.file_path = file_path if parser: - self.message = ( - f"Unable to parse {file_path} as {parser.__name__.upper()}\n\n{exc}" - ) + self.message = f"Unable to parse {file_path} as {parser.__name__.upper()}\n\n{exc}" else: self.message = f"Unable to parse {file_path}\n\n{exc}" super().__init__() @@ -273,6 +271,8 @@ def __init__(self, stack_name: str, output: str, *args: Any, **kwargs: Any) -> N Args: stack_name: Name of the stack. output: The output that does not exist. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.stack_name = stack_name @@ -321,6 +321,8 @@ def __init__(self, lookup: VariableValueLookup, *args: Any, **kwargs: Any) -> No Args: lookup: Variable value lookup that could not find a handler. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.message = f'Unknown lookup type "{lookup.lookup_name.value}" in "{lookup}"' @@ -337,11 +339,11 @@ def __init__(self, variable: Variable, *args: Any, **kwargs: Any) -> None: Args: variable: The unresolved variable. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ - self.message = ( - f'Attempted to use variable "{variable.name}" before it was resolved' - ) + self.message = f'Attempted to use variable "{variable.name}" before it was resolved' self.variable = variable super().__init__(*args, **kwargs) @@ -363,6 +365,8 @@ def __init__(self, lookup: VariableValueLookup, *args: Any, **kwargs: Any) -> No Args: lookup: The variable value lookup that is not resolved. + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. """ self.lookup = lookup diff --git a/runway/lookups/handlers/base.py b/runway/lookups/handlers/base.py index 9238265c8..5e8f72339 100644 --- a/runway/lookups/handlers/base.py +++ b/runway/lookups/handlers/base.py @@ -4,18 +4,8 @@ import json import logging -from typing import ( - TYPE_CHECKING, - Any, - ClassVar, - Dict, - Optional, - Sequence, - Set, - Tuple, - Union, - cast, -) +from collections.abc import Sequence +from typing import TYPE_CHECKING, Any, ClassVar, cast import yaml from troposphere import BaseAWSObject @@ -34,7 +24,7 @@ TransformToTypeLiteral = Literal["bool", "str"] -def str2bool(v: str): +def str2bool(v: str) -> bool: """Return boolean value of string.""" return v.lower() in ("yes", "true", "t", "1", "on", "y") @@ -46,7 +36,7 @@ class LookupHandler: """Name that the Lookup is registered as.""" @classmethod - def dependencies(cls, __lookup_query: VariableValue) -> Set[str]: + def dependencies(cls, __lookup_query: VariableValue) -> set[str]: """Calculate any dependencies required to perform this lookup. Note that lookup_query may not be (completely) resolved at this time. @@ -58,9 +48,9 @@ def dependencies(cls, __lookup_query: VariableValue) -> Set[str]: def format_results( cls, value: Any, - get: Optional[str] = None, - load: Optional[str] = None, - transform: Optional[TransformToTypeLiteral] = None, + get: str | None = None, + load: str | None = None, + transform: TransformToTypeLiteral | None = None, **kwargs: Any, ) -> Any: """Format results to be returned by a lookup. @@ -72,6 +62,7 @@ def format_results( and ``transform`` method. transform: Convert the final value to a different data type before returning it. + **kwargs: Arbitrary keyword arguments. Raises: TypeError: If ``get`` is provided but the value value is not a @@ -95,9 +86,7 @@ def format_results( elif isinstance(value, dict): value = value.get(get) else: - raise TypeError( - f'value must be dict type to use "get"; got type "{type(value)}"' - ) + raise TypeError(f'value must be dict type to use "get"; got type "{type(value)}"') if ( isinstance(value, str) and value.lower() in ["none", "null"] @@ -115,9 +104,9 @@ def format_results( def handle( cls, __value: str, - context: Union[CfnginContext, RunwayContext], + context: CfnginContext | RunwayContext, *__args: Any, - provider: Optional[Provider] = None, + provider: Provider | None = None, **__kwargs: Any, ) -> Any: """Perform the lookup. @@ -131,7 +120,7 @@ def handle( raise NotImplementedError @classmethod - def parse(cls, value: str) -> Tuple[str, Dict[str, str]]: + def parse(cls, value: str) -> tuple[str, dict[str, str]]: """Parse the value passed to a lookup in a standardized way. Args: @@ -146,12 +135,12 @@ def parse(cls, value: str) -> Tuple[str, Dict[str, str]]: colon_split = raw_value.split("::", 1) query = colon_split.pop(0) - args: Dict[str, str] = cls._parse_args(colon_split[0]) if colon_split else {} + args: dict[str, str] = cls._parse_args(colon_split[0]) if colon_split else {} return query, args @classmethod - def _parse_args(cls, args: str) -> Dict[str, str]: + def _parse_args(cls, args: str) -> dict[str, str]: """Convert a string into an args dict. Each arg should be separated by ``,``. The key and value should @@ -167,12 +156,11 @@ def _parse_args(cls, args: str) -> Dict[str, str]: """ split_args = args.split(",") return { - key.strip(): value.strip() - for key, value in [arg.split("=", 1) for arg in split_args] + key.strip(): value.strip() for key, value in [arg.split("=", 1) for arg in split_args] } @classmethod - def load(cls, value: Any, parser: Optional[str] = None, **kwargs: Any) -> Any: + def load(cls, value: Any, parser: str | None = None, **kwargs: Any) -> Any: """Load a formatted string or object into a python data type. First action taken in :meth:`format_results`. @@ -183,6 +171,7 @@ def load(cls, value: Any, parser: Optional[str] = None, **kwargs: Any) -> Any: Args: value: What is being loaded. parser: Name of the parser to use. + **kwargs: Arbitrary keyword arguments. Returns: The loaded value. @@ -257,7 +246,7 @@ def transform( cls, value: Any, *, - to_type: Optional[TransformToTypeLiteral] = "str", + to_type: TransformToTypeLiteral | None = "str", **kwargs: Any, ) -> Any: """Transform the result of a lookup into another datatype. @@ -270,6 +259,7 @@ def transform( Args: value: What is to be transformed. to_type: The type the value will be transformed into. + **kwargs: Arbitrary keyword arguments. Returns: The transformed value. @@ -325,9 +315,7 @@ def _transform_to_string( value = value.data if isinstance(value, dict): # dumped twice for an escaped json dict - return json.dumps( - json.dumps(cast(Dict[str, Any], value), indent=int(indent)) - ) + return json.dumps(json.dumps(cast("dict[str, Any]", value), indent=int(indent))) if isinstance(value, bool): return json.dumps(str(value)) return str(value) diff --git a/runway/lookups/handlers/cfn.py b/runway/lookups/handlers/cfn.py index 6a7de8594..4f038925c 100644 --- a/runway/lookups/handlers/cfn.py +++ b/runway/lookups/handlers/cfn.py @@ -11,10 +11,9 @@ import json import logging -from typing import TYPE_CHECKING, Any, Dict, NamedTuple, Optional, Union, cast +from typing import TYPE_CHECKING, Any, Final, NamedTuple, cast from botocore.exceptions import ClientError -from typing_extensions import Final, Literal from ...cfngin.exceptions import StackDoesNotExist from ...exceptions import OutputDoesNotExist @@ -22,6 +21,7 @@ if TYPE_CHECKING: from mypy_boto3_cloudformation.client import CloudFormationClient + from typing_extensions import Literal from ...cfngin.providers.aws.default import Provider from ...context import CfnginContext, RunwayContext @@ -43,7 +43,7 @@ class CfnLookup(LookupHandler): """Name that the Lookup is registered as.""" @staticmethod - def should_use_provider(args: Dict[str, str], provider: Optional[Provider]) -> bool: + def should_use_provider(args: dict[str, str], provider: Provider | None) -> bool: """Determine if the provider should be used for the lookup. This will open happen when the lookup is used with CFNgin. @@ -81,12 +81,12 @@ def get_stack_output(client: CloudFormationClient, query: OutputQuery) -> str: return outputs[query.output_name] @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, - context: Union[CfnginContext, RunwayContext], + context: CfnginContext | RunwayContext, *, - provider: Optional[Provider] = None, + provider: Provider | None = None, **_: Any, ) -> Any: """Retrieve a value from CloudFormation Stack outputs. @@ -117,13 +117,9 @@ def handle( # pylint: disable=arguments-differ # args for testing to function correctly if cls.should_use_provider(args.copy(), provider): # this will only happen when used from cfngin - result = cast("Provider", provider).get_output( - query.stack_name, query.output_name - ) + result = cast("Provider", provider).get_output(query.stack_name, query.output_name) else: - cfn_client = context.get_session(region=args.get("region")).client( - "cloudformation" - ) + cfn_client = context.get_session(region=args.get("region")).client("cloudformation") result = cls.get_stack_output(cfn_client, query) except (ClientError, KeyError, StackDoesNotExist) as exc: # StackDoesNotExist is only raised by provider diff --git a/runway/lookups/handlers/ecr.py b/runway/lookups/handlers/ecr.py index 7625c31c2..f7d7bff27 100644 --- a/runway/lookups/handlers/ecr.py +++ b/runway/lookups/handlers/ecr.py @@ -4,14 +4,13 @@ import base64 import logging -from typing import TYPE_CHECKING, Any, Union - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Final from ...lookups.handlers.base import LookupHandler if TYPE_CHECKING: from mypy_boto3_ecr.client import ECRClient + from typing_extensions import Literal from ...context import CfnginContext, RunwayContext @@ -35,10 +34,10 @@ def get_login_password(client: ECRClient) -> str: return password @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, - context: Union[CfnginContext, RunwayContext], + context: CfnginContext | RunwayContext, *__args: Any, **__kwargs: Any, ) -> Any: diff --git a/runway/lookups/handlers/env.py b/runway/lookups/handlers/env.py index 1ae48e21d..8398abb19 100644 --- a/runway/lookups/handlers/env.py +++ b/runway/lookups/handlers/env.py @@ -3,13 +3,13 @@ # pyright: reportIncompatibleMethodOverride=none from __future__ import annotations -from typing import TYPE_CHECKING, Any, Union - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Final from .base import LookupHandler if TYPE_CHECKING: + from typing_extensions import Literal + from ...context import CfnginContext, RunwayContext @@ -20,10 +20,10 @@ class EnvLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, - context: Union[CfnginContext, RunwayContext], + context: CfnginContext | RunwayContext, *__args: Any, **__kwargs: Any, ) -> Any: diff --git a/runway/lookups/handlers/random_string.py b/runway/lookups/handlers/random_string.py index 1b1372b67..b9811a44b 100644 --- a/runway/lookups/handlers/random_string.py +++ b/runway/lookups/handlers/random_string.py @@ -6,14 +6,16 @@ import logging import secrets import string -from typing import TYPE_CHECKING, Any, Callable, List, Sequence, Union - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Callable, Final from ...utils import BaseModel from .base import LookupHandler if TYPE_CHECKING: + from collections.abc import Sequence + + from typing_extensions import Literal + from ...context import CfnginContext, RunwayContext LOGGER = logging.getLogger(__name__) @@ -83,7 +85,7 @@ def ensure_has_one_of(cls, args: ArgsDataModel, value: str) -> bool: value: Value to check. """ - checks: List[Callable[[str], bool]] = [] + checks: list[Callable[[str], bool]] = [] if args.digits: checks.append(cls.has_digit) if args.lowercase: @@ -95,10 +97,10 @@ def ensure_has_one_of(cls, args: ArgsDataModel, value: str) -> bool: return sum(c(value) for c in checks) == len(checks) @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, - context: Union[CfnginContext, RunwayContext], + context: CfnginContext | RunwayContext, # noqa: ARG003 *__args: Any, **__kwargs: Any, ) -> Any: diff --git a/runway/lookups/handlers/ssm.py b/runway/lookups/handlers/ssm.py index 07db5a1aa..d34edd27f 100644 --- a/runway/lookups/handlers/ssm.py +++ b/runway/lookups/handlers/ssm.py @@ -3,13 +3,13 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Union - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Final, Union from ...lookups.handlers.base import LookupHandler if TYPE_CHECKING: + from typing_extensions import Literal + from ...context import CfnginContext, RunwayContext LOGGER = logging.getLogger(__name__) @@ -22,7 +22,7 @@ class SsmLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, value: str, context: Union[CfnginContext, RunwayContext], @@ -46,9 +46,7 @@ def handle( # pylint: disable=arguments-differ client = session.client("ssm") try: - response = client.get_parameter(Name=query, WithDecryption=True)[ - "Parameter" - ] + response = client.get_parameter(Name=query, WithDecryption=True)["Parameter"] return cls.format_results( ( response["Value"].split(",") diff --git a/runway/lookups/handlers/var.py b/runway/lookups/handlers/var.py index 40cf0fe84..c33499dee 100644 --- a/runway/lookups/handlers/var.py +++ b/runway/lookups/handlers/var.py @@ -4,13 +4,13 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any - -from typing_extensions import Final, Literal +from typing import TYPE_CHECKING, Any, Final from .base import LookupHandler if TYPE_CHECKING: + from typing_extensions import Literal + from ...utils import MutableMap @@ -25,9 +25,7 @@ class VarLookup(LookupHandler): """Name that the Lookup is registered as.""" @classmethod - def handle( # pylint: disable=arguments-differ - cls, value: str, *__args: Any, variables: MutableMap, **__kwargs: Any - ) -> Any: + def handle(cls, value: str, *__args: Any, variables: MutableMap, **__kwargs: Any) -> Any: """Retrieve a variable from the variable definition. The value is retrieved from the variables passed to Runway using diff --git a/runway/lookups/registry.py b/runway/lookups/registry.py index d4b956f71..2c69015f5 100644 --- a/runway/lookups/registry.py +++ b/runway/lookups/registry.py @@ -3,7 +3,7 @@ from __future__ import annotations import logging -from typing import Dict, Type, Union, cast +from typing import cast from ..utils import load_object_from_string from .handlers.base import LookupHandler @@ -14,13 +14,11 @@ from .handlers.ssm import SsmLookup from .handlers.var import VarLookup -RUNWAY_LOOKUP_HANDLERS: Dict[str, Type[LookupHandler]] = {} +RUNWAY_LOOKUP_HANDLERS: dict[str, type[LookupHandler]] = {} LOGGER = logging.getLogger(__name__) -def register_lookup_handler( - lookup_type: str, handler_or_path: Union[str, Type[LookupHandler]] -) -> None: +def register_lookup_handler(lookup_type: str, handler_or_path: str | type[LookupHandler]) -> None: """Register a lookup handler. Args: @@ -39,7 +37,7 @@ def register_lookup_handler( if issubclass(handler, LookupHandler): RUNWAY_LOOKUP_HANDLERS[lookup_type] = handler return - except Exception: # pylint: disable=broad-except + except Exception: # noqa: BLE001 LOGGER.debug("failed to validate lookup handler", exc_info=True) raise TypeError( f"lookup {handler_or_path} must be a subclass of " diff --git a/runway/mixins.py b/runway/mixins.py index 2cb3a855d..79958ff74 100644 --- a/runway/mixins.py +++ b/runway/mixins.py @@ -6,26 +6,17 @@ import platform import shutil import subprocess +from collections.abc import Iterable from contextlib import suppress -from typing import ( - TYPE_CHECKING, - ClassVar, - Dict, - Iterable, - List, - Optional, - Union, - cast, - overload, -) - -from typing_extensions import Literal +from typing import TYPE_CHECKING, ClassVar, cast, overload from .compat import shlex_join if TYPE_CHECKING: from pathlib import Path + from typing_extensions import Literal + from ._logging import RunwayLogger from .context import CfnginContext, RunwayContext @@ -38,7 +29,7 @@ class CliInterfaceMixin: EXECUTABLE: ClassVar[str] """CLI executable.""" - ctx: Union[CfnginContext, RunwayContext] + ctx: CfnginContext | RunwayContext """CFNgin or Runway context object.""" cwd: Path @@ -52,21 +43,20 @@ def convert_to_cli_arg(arg_name: str, *, prefix: str = "--") -> str: @classmethod def found_in_path(cls) -> bool: """Determine if executable is found in $PATH.""" - if shutil.which(cls.EXECUTABLE): - return True - return False + return bool(shutil.which(cls.EXECUTABLE)) @classmethod def generate_command( cls, - command: Union[List[str], str], - **kwargs: Optional[Union[bool, Iterable[str], str]], - ) -> List[str]: + command: list[str] | str, + **kwargs: bool | Iterable[str] | str | None, + ) -> list[str]: """Generate command to be executed and log it. Args: command: Command to run. args: Additional args to pass to the command. + **kwargs: Arbitrary keyword arguments. Returns: The full command to be passed into a subprocess. @@ -79,10 +69,10 @@ def generate_command( @classmethod def _generate_command_handle_kwargs( - cls, **kwargs: Optional[Union[bool, Iterable[str], str]] - ) -> List[str]: + cls, **kwargs: bool | Iterable[str] | str | None + ) -> list[str]: """Handle kwargs passed to generate_command.""" - result: List[str] = [] + result: list[str] = [] for k, v in kwargs.items(): if isinstance(v, str): result.extend([cls.convert_to_cli_arg(k), v]) @@ -107,28 +97,28 @@ def list2cmdline(split_command: Iterable[str]) -> str: @overload def _run_command( self, - command: Union[Iterable[str], str], + command: Iterable[str] | str, *, - env: Optional[Dict[str, str]] = ..., + env: dict[str, str] | None = ..., suppress_output: Literal[True] = ..., ) -> str: ... @overload def _run_command( self, - command: Union[Iterable[str], str], + command: Iterable[str] | str, *, - env: Optional[Dict[str, str]] = ..., + env: dict[str, str] | None = ..., suppress_output: Literal[False] = ..., ) -> None: ... def _run_command( self, - command: Union[Iterable[str], str], + command: Iterable[str] | str, *, - env: Optional[Dict[str, str]] = None, + env: dict[str, str] | None = None, suppress_output: bool = True, - ) -> Optional[str]: + ) -> str | None: """Run command. Args: diff --git a/runway/module/base.py b/runway/module/base.py index a5cb0fe30..97350e4c8 100644 --- a/runway/module/base.py +++ b/runway/module/base.py @@ -4,14 +4,15 @@ import logging import subprocess -from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast +from typing import TYPE_CHECKING, Any, cast from ..exceptions import NpmNotFound from ..utils import which from .utils import NPM_BIN, format_npm_command_for_logging, use_npm_ci if TYPE_CHECKING: + from pathlib import Path + from .._logging import PrefixAdaptor, RunwayLogger from ..context import RunwayContext @@ -22,22 +23,22 @@ class RunwayModule: """Base class for Runway modules.""" ctx: RunwayContext - explicitly_enabled: Optional[bool] - logger: Union[PrefixAdaptor, RunwayLogger] + explicitly_enabled: bool | None + logger: PrefixAdaptor | RunwayLogger name: str - options: Union[Dict[str, Any], ModuleOptions] + options: dict[str, Any] | ModuleOptions region: str def __init__( self, context: RunwayContext, *, - explicitly_enabled: Optional[bool] = False, + explicitly_enabled: bool | None = False, logger: RunwayLogger = LOGGER, module_root: Path, - name: Optional[str] = None, - options: Optional[Union[Dict[str, Any], ModuleOptions]] = None, - parameters: Optional[Dict[str, Any]] = None, + name: str | None = None, + options: dict[str, Any] | ModuleOptions | None = None, + parameters: dict[str, Any] | None = None, **_: Any, ) -> None: """Instantiate class. @@ -92,19 +93,19 @@ def __getitem__(self, key: str) -> Any: return getattr(self, key) -class RunwayModuleNpm(RunwayModule): # pylint: disable=abstract-method +class RunwayModuleNpm(RunwayModule): """Base class for Runway modules that use npm.""" def __init__( self, context: RunwayContext, *, - explicitly_enabled: Optional[bool] = False, + explicitly_enabled: bool | None = False, logger: RunwayLogger = LOGGER, module_root: Path, - name: Optional[str] = None, - options: Optional[Union[Dict[str, Any], ModuleOptions]] = None, - parameters: Optional[Dict[str, Any]] = None, + name: str | None = None, + options: dict[str, Any] | ModuleOptions | None = None, + parameters: dict[str, Any] | None = None, **_: Any, ) -> None: """Instantiate class. @@ -136,7 +137,7 @@ def __init__( self.check_for_npm(logger=self.logger) # fail fast self.warn_on_boto_env_vars(self.ctx.env.vars, logger=logger) - def log_npm_command(self, command: List[str]) -> None: + def log_npm_command(self, command: list[str]) -> None: """Log an npm command that is going to be run. Args: @@ -174,9 +175,7 @@ def package_json_missing(self) -> bool: return False @staticmethod - def check_for_npm( - *, logger: Union[logging.Logger, PrefixAdaptor, RunwayLogger] = LOGGER - ) -> None: + def check_for_npm(*, logger: logging.Logger | PrefixAdaptor | RunwayLogger = LOGGER) -> None: """Ensure npm is installed and in the current path. Args: @@ -192,9 +191,9 @@ def check_for_npm( @staticmethod def warn_on_boto_env_vars( - env_vars: Dict[str, str], + env_vars: dict[str, str], *, - logger: Union[logging.Logger, PrefixAdaptor, RunwayLogger] = LOGGER, + logger: logging.Logger | PrefixAdaptor | RunwayLogger = LOGGER, ) -> None: """Inform user if boto-specific environment variables are in use. @@ -219,7 +218,7 @@ def get(self, name: str, default: Any = None) -> Any: """Get a value or return the default.""" return getattr(self, name, default) - def __eq__(self, other: Any) -> bool: + def __eq__(self, other: object) -> bool: """Assess equality.""" if isinstance(other, self.__class__): return self.__dict__ == other.__dict__ diff --git a/runway/module/cdk.py b/runway/module/cdk.py index 35f1300d3..df3ea2c0a 100644 --- a/runway/module/cdk.py +++ b/runway/module/cdk.py @@ -6,8 +6,7 @@ import platform import subprocess import sys -from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast +from typing import TYPE_CHECKING, Any, cast from typing_extensions import Literal @@ -19,6 +18,8 @@ from .utils import generate_node_command, run_module_command if TYPE_CHECKING: + from pathlib import Path + from .._logging import RunwayLogger from ..context import RunwayContext @@ -53,12 +54,12 @@ def __init__( self, context: RunwayContext, *, - explicitly_enabled: Optional[bool] = False, + explicitly_enabled: bool | None = False, logger: RunwayLogger = LOGGER, module_root: Path, - name: Optional[str] = None, - options: Optional[Union[Dict[str, Any], ModuleOptions]] = None, - parameters: Optional[Dict[str, Any]] = None, + name: str | None = None, + options: dict[str, Any] | ModuleOptions | None = None, + parameters: dict[str, Any] | None = None, **_: Any, ) -> None: """Instantiate class. @@ -92,9 +93,9 @@ def __init__( LOGGER.warning("%s:%s", self.name, self.DEPRECATION_MSG) @cached_property - def cli_args(self) -> List[str]: + def cli_args(self) -> list[str]: """Generate CLI args from self used in all CDK commands.""" - result: List[str] = [] + result: list[str] = [] if self.ctx.no_color: result.append("--no-color") if self.ctx.env.debug: @@ -104,9 +105,9 @@ def cli_args(self) -> List[str]: return result @cached_property - def cli_args_context(self) -> List[str]: + def cli_args_context(self) -> list[str]: """Generate CLI args from self passed to CDK commands as ``--context``.""" - result: List[str] = [] + result: list[str] = [] args = {"environment": self.ctx.env.name} args.update(self.parameters) for key, val in args.items(): @@ -157,7 +158,7 @@ def cdk_destroy(self) -> None: ) self.logger.info("destroy (complete)") - def cdk_diff(self, stack_name: Optional[str] = None) -> None: + def cdk_diff(self, stack_name: str | None = None) -> None: """Execute ``cdk diff`` command.""" self.logger.info("plan (in progress)") try: @@ -179,11 +180,11 @@ def cdk_diff(self, stack_name: Optional[str] = None) -> None: "is not enabled", stack_name, ) - # TODO raise error instead of sys.exit() when refactoring cli error handling + # TODO (kyle): raise error instead of sys.exit() when refactoring cli error handling sys.exit(exc.returncode) self.logger.info("plan (complete)") - def cdk_list(self) -> List[str]: + def cdk_list(self) -> list[str]: """Execute ``cdk list`` command.""" result = subprocess.check_output( self.gen_cmd("list", include_context=True), @@ -213,10 +214,10 @@ def destroy(self) -> None: def gen_cmd( self, command: CdkCommandTypeDef, - args_list: Optional[List[str]] = None, + args_list: list[str] | None = None, *, include_context: bool = False, - ) -> List[str]: + ) -> list[str]: """Generate and log a CDK command. This does not execute the command, only prepares it for use. @@ -231,7 +232,7 @@ def gen_cmd( The full command to be passed into a subprocess. """ - args = [command] + self.cli_args + args = [command, *self.cli_args] args.extend(args_list or []) if include_context: args.extend(self.cli_args_context) diff --git a/runway/module/cloudformation.py b/runway/module/cloudformation.py index cf74037ac..e46ef24e0 100644 --- a/runway/module/cloudformation.py +++ b/runway/module/cloudformation.py @@ -3,14 +3,15 @@ from __future__ import annotations import logging -from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, Optional, Union, cast +from typing import TYPE_CHECKING, Any, cast from .._logging import PrefixAdaptor from ..cfngin.cfngin import CFNgin from .base import RunwayModule if TYPE_CHECKING: + from pathlib import Path + from .._logging import RunwayLogger from ..context import RunwayContext from .base import ModuleOptions @@ -25,12 +26,12 @@ def __init__( self, context: RunwayContext, *, - explicitly_enabled: Optional[bool] = False, + explicitly_enabled: bool | None = False, logger: RunwayLogger = LOGGER, module_root: Path, - name: Optional[str] = None, - options: Optional[Union[Dict[str, Any], ModuleOptions]] = None, - parameters: Optional[Dict[str, Any]] = None, + name: str | None = None, + options: dict[str, Any] | ModuleOptions | None = None, + parameters: dict[str, Any] | None = None, **_: Any, ) -> None: """Instantiate class. diff --git a/runway/module/k8s.py b/runway/module/k8s.py index 344327331..901692e4c 100644 --- a/runway/module/k8s.py +++ b/runway/module/k8s.py @@ -6,14 +6,13 @@ import subprocess import sys from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast +from typing import TYPE_CHECKING, Any, cast from typing_extensions import Literal from .._logging import PrefixAdaptor from ..compat import cached_property from ..config.models.runway.options.k8s import RunwayK8sModuleOptionsDataModel -from ..core.components import DeployEnvironment from ..env_mgr.kbenv import KBEnvManager from ..exceptions import KubectlVersionNotSpecified from ..utils import which @@ -23,6 +22,7 @@ if TYPE_CHECKING: from .._logging import RunwayLogger from ..context import RunwayContext + from ..core.components import DeployEnvironment LOGGER = cast("RunwayLogger", logging.getLogger(__name__)) @@ -63,12 +63,12 @@ def __init__( self, context: RunwayContext, *, - explicitly_enabled: Optional[bool] = False, + explicitly_enabled: bool | None = False, logger: RunwayLogger = LOGGER, module_root: Path, - name: Optional[str] = None, - options: Optional[Union[Dict[str, Any], ModuleOptions]] = None, - parameters: Optional[Dict[str, Any]] = None, + name: str | None = None, + options: dict[str, Any] | ModuleOptions | None = None, + parameters: dict[str, Any] | None = None, **_: Any, ) -> None: """Instantiate class. @@ -116,9 +116,7 @@ def kubectl_bin(self) -> str: except KubectlVersionNotSpecified as exc: self.logger.verbose("kubectl version not specified; checking path") if not which("kubectl"): - self.logger.error( - "kubectl not available and a version to install not specified" - ) + self.logger.error("kubectl not available and a version to install not specified") self.logger.error(exc.message) sys.exit(1) return "kubectl" @@ -127,18 +125,14 @@ def kubectl_bin(self) -> str: def skip(self) -> bool: """Determine if the module should be skipped.""" if self.options.kustomize_config.is_file(): - LOGGER.info( - "processing kustomize overlay: %s", self.options.kustomize_config - ) + LOGGER.info("processing kustomize overlay: %s", self.options.kustomize_config) return False LOGGER.info( "skipped; kustomize overlay for this environment/region not" " found -- looking for one of: %s", ", ".join( str(self.path / "overlays" / i / "kustomization.yaml") - for i in self.options.gen_overlay_dirs( - self.ctx.env.name, self.ctx.env.aws_region - ) + for i in self.options.gen_overlay_dirs(self.ctx.env.name, self.ctx.env.aws_region) ), ) return True @@ -160,8 +154,8 @@ def destroy(self) -> None: def gen_cmd( self, command: KubectlCommandTypeDef, - args_list: Optional[List[str]] = None, - ) -> List[str]: + args_list: list[str] | None = None, + ) -> list[str]: """Generate and log a kubectl command. This does not execute the command, only prepares it for use. @@ -233,9 +227,7 @@ def plan(self) -> None: """Run kustomize build and display generated plan.""" if self.skip: return - self.logger.info( - "kustomized yaml generated by kubectl:\n\n%s", self.kubectl_kustomize() - ) + self.logger.info("kustomized yaml generated by kubectl:\n\n%s", self.kubectl_kustomize()) class K8sOptions(ModuleOptions): @@ -251,7 +243,7 @@ class K8sOptions(ModuleOptions): data: RunwayK8sModuleOptionsDataModel deploy_environment: DeployEnvironment - kubectl_version: Optional[str] + kubectl_version: str | None path: Path def __init__( @@ -290,7 +282,7 @@ def overlay_path(self) -> Path: ) @staticmethod - def gen_overlay_dirs(environment: str, region: str) -> List[str]: + def gen_overlay_dirs(environment: str, region: str) -> list[str]: """Generate possible overlay directories. Prefers more explicit directory name but falls back to environment name only. @@ -317,7 +309,7 @@ def parse_obj( cls, deploy_environment: DeployEnvironment, obj: object, - path: Optional[Path] = None, + path: Path | None = None, ) -> K8sOptions: """Parse options definition and return an options object. diff --git a/runway/module/serverless.py b/runway/module/serverless.py index 1cfaea6ed..8630e91cc 100644 --- a/runway/module/serverless.py +++ b/runway/module/serverless.py @@ -11,7 +11,7 @@ import tempfile import uuid from pathlib import Path -from typing import IO, TYPE_CHECKING, Any, Callable, Dict, List, Optional, Union, cast +from typing import IO, TYPE_CHECKING, Any, Callable, cast import yaml @@ -34,15 +34,15 @@ LOGGER = cast("RunwayLogger", logging.getLogger(__name__)) -def gen_sls_config_files(stage: str, region: str) -> List[str]: +def gen_sls_config_files(stage: str, region: str) -> list[str]: """Generate possible SLS config files names.""" - names: List[str] = [] + names: list[str] = [] for ext in ["yml", "json"]: # Give preference to explicit stage-region files - names.append(os.path.join("env", f"{stage}-{region}.{ext}")) + names.append(os.path.join("env", f"{stage}-{region}.{ext}")) # noqa: PTH118 names.append(f"config-{stage}-{region}.{ext}") # Fallback to stage name only - names.append(os.path.join("env", f"{stage}.{ext}")) + names.append(os.path.join("env", f"{stage}.{ext}")) # noqa: PTH118 names.append(f"config-{stage}.{ext}") return names @@ -56,12 +56,12 @@ def __init__( self, context: RunwayContext, *, - explicitly_enabled: Optional[bool] = False, + explicitly_enabled: bool | None = False, logger: RunwayLogger = LOGGER, module_root: Path, - name: Optional[str] = None, - options: Optional[Union[Dict[str, Any], ModuleOptions]] = None, - parameters: Optional[Dict[str, Any]] = None, + name: str | None = None, + options: dict[str, Any] | ModuleOptions | None = None, + parameters: dict[str, Any] | None = None, **_: Any, ) -> None: """Instantiate class. @@ -94,7 +94,7 @@ def __init__( self.stage = self.ctx.env.name @property - def cli_args(self) -> List[str]: + def cli_args(self) -> list[str]: """Generate CLI args from self used in all Serverless commands.""" result = ["--region", self.region, "--stage", self.stage] if "DEBUG" in self.ctx.env.vars: @@ -102,7 +102,7 @@ def cli_args(self) -> List[str]: return result @cached_property - def env_file(self) -> Optional[Path]: + def env_file(self) -> Path | None: """Find the environment file for the module.""" for name in gen_sls_config_files(self.stage, self.region): test_path = self.path / name @@ -117,8 +117,7 @@ def skip(self) -> bool: if self.parameters or self.explicitly_enabled or self.env_file: return False self.logger.info( - "skipped; config file for this stage/region not found" - " -- looking for one of: %s", + "skipped; config file for this stage/region not found -- looking for one of: %s", ", ".join(gen_sls_config_files(self.stage, self.region)), ) else: @@ -158,12 +157,11 @@ def extend_serverless_yml(self, func: Callable[..., None]) -> None: self.logger.debug("removed temporary Serverless config") except OSError: self.logger.debug( - "encountered an error when trying to delete the " - "temporary Serverless config", + "encountered an error when trying to delete the temporary Serverless config", exc_info=True, ) - def gen_cmd(self, command: str, args_list: Optional[List[str]] = None) -> List[str]: + def gen_cmd(self, command: str, args_list: list[str] | None = None) -> list[str]: """Generate and log a Serverless command. This does not execute the command, only prepares it for use. @@ -176,7 +174,7 @@ def gen_cmd(self, command: str, args_list: Optional[List[str]] = None) -> List[s The full command to be passed into a subprocess. """ - args = [command] + self.cli_args + self.options.args + args = [command, *self.cli_args, *self.options.args] args.extend(args_list or []) if command not in ["remove", "package", "print"] and self.ctx.is_noninteractive: args.append("--conceal") # hide secrets from serverless output @@ -200,9 +198,7 @@ def gen_cmd(self, command: str, args_list: Optional[List[str]] = None) -> List[s command="sls", command_opts=args, path=self.path, logger=self.logger ) - def sls_deploy( - self, *, package: Optional[AnyPath] = None, skip_install: bool = False - ) -> None: + def sls_deploy(self, *, package: AnyPath | None = None, skip_install: bool = False) -> None: """Execute ``sls deploy`` command. Args: @@ -224,9 +220,9 @@ def sls_deploy( def sls_package( self, *, - output_path: Optional[AnyPathConstrained] = None, + output_path: AnyPathConstrained | None = None, skip_install: bool = False, - ) -> Optional[AnyPathConstrained]: + ) -> AnyPathConstrained | None: """Execute ``sls package`` command. Args: @@ -248,8 +244,8 @@ def sls_package( return output_path def sls_print( - self, *, item_path: Optional[str] = None, skip_install: bool = False - ) -> Dict[str, Any]: + self, *, item_path: str | None = None, skip_install: bool = False + ) -> dict[str, Any]: """Execute ``sls print`` command. Keyword Args: @@ -294,7 +290,7 @@ def sls_remove(self, *, skip_install: bool = False) -> None: self.npm_install() stack_missing = False # track output for acceptable error self.logger.info("destroy (in progress)") - with subprocess.Popen( + with subprocess.Popen( # noqa: SIM117 self.gen_cmd("remove"), bufsize=1, env=self.ctx.env.vars, @@ -353,9 +349,7 @@ def destroy(self) -> None: def init(self) -> None: """Run init.""" - self.logger.warning( - "init not currently supported for %s", self.__class__.__name__ - ) + self.logger.warning("init not currently supported for %s", self.__class__.__name__) def plan(self) -> None: """Entrypoint for Runway's plan action.""" @@ -368,9 +362,9 @@ class ServerlessArtifact: def __init__( self, context: RunwayContext, - config: Dict[str, Any], + config: dict[str, Any], *, - logger: Union[PrefixAdaptor, RunwayLogger] = LOGGER, + logger: PrefixAdaptor | RunwayLogger = LOGGER, package_path: AnyPath, path: AnyPath, ) -> None: @@ -388,33 +382,27 @@ def __init__( self.ctx = context self.config = config self.logger = logger - self.package_path = ( - Path(package_path) if isinstance(package_path, str) else package_path - ) + self.package_path = Path(package_path) if isinstance(package_path, str) else package_path self.path = Path(path) if isinstance(path, str) else path @cached_property - def source_hash(self) -> Dict[str, str]: + def source_hash(self) -> dict[str, str]: """File hash(es) of each service's source code.""" if self.config.get("package", {"": ""}).get("individually"): return { name: get_hash_of_files( - self.path / os.path.dirname(detail.get("handler")) + self.path / os.path.dirname(detail.get("handler")) # noqa: PTH120 ) for name, detail in self.config.get("functions", {}).items() } - directories: List[Dict[str, Union[List[str], str]]] = [] - for _name, detail in self.config.get("functions", {}).items(): - func_path = {"path": os.path.dirname(detail.get("handler"))} + directories: list[dict[str, list[str] | str]] = [] + for detail in self.config.get("functions", {}).values(): + func_path = {"path": os.path.dirname(detail.get("handler"))} # noqa: PTH120 if func_path not in directories: directories.append(func_path) if isinstance(self.config["service"], dict): # handle sls<3.0.0 potential service property object notation - return { - self.config["service"]["name"]: get_hash_of_files( - self.path, directories - ) - } + return {self.config["service"]["name"]: get_hash_of_files(self.path, directories)} return {self.config["service"]: get_hash_of_files(self.path, directories)} def sync_with_s3(self, bucket_name: str) -> None: @@ -476,9 +464,7 @@ def __init__(self, data: RunwayServerlessModuleOptionsDataModel) -> None: """ self._arg_parser = self._create_arg_parser() - cli_args, self._unknown_cli_args = self._arg_parser.parse_known_args( - data.args.copy() - ) + cli_args, self._unknown_cli_args = self._arg_parser.parse_known_args(data.args.copy()) self._cli_args = vars(cli_args) # convert argparse.Namespace to dict self.data = data @@ -487,9 +473,9 @@ def __init__(self, data: RunwayServerlessModuleOptionsDataModel) -> None: self.skip_npm_ci = data.skip_npm_ci @property - def args(self) -> List[str]: + def args(self) -> list[str]: """List of CLI arguments/options to pass to the Serverless Framework CLI.""" - known_args: List[str] = [] + known_args: list[str] = [] for key, val in self._cli_args.items(): if isinstance(val, str): known_args.extend([f"--{key}", val]) diff --git a/runway/module/staticsite/handler.py b/runway/module/staticsite/handler.py index 4e9c0db82..7dab0d2c6 100644 --- a/runway/module/staticsite/handler.py +++ b/runway/module/staticsite/handler.py @@ -8,7 +8,7 @@ import sys import tempfile from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast +from typing import TYPE_CHECKING, Any, cast import yaml @@ -44,12 +44,12 @@ def __init__( self, context: RunwayContext, *, - explicitly_enabled: Optional[bool] = False, + explicitly_enabled: bool | None = False, logger: RunwayLogger = LOGGER, module_root: Path, - name: Optional[str] = None, - options: Optional[Union[Dict[str, Any], ModuleOptions]] = None, - parameters: Optional[Dict[str, Any]] = None, + name: str | None = None, + options: dict[str, Any] | ModuleOptions | None = None, + parameters: dict[str, Any] | None = None, **_: Any, ) -> None: """Instantiate class. @@ -78,9 +78,7 @@ def __init__( options=StaticSiteOptions.parse_obj(options or {}), parameters=parameters, ) - self.parameters = RunwayStaticSiteModuleParametersDataModel.parse_obj( - self.parameters - ) + self.parameters = RunwayStaticSiteModuleParametersDataModel.parse_obj(self.parameters) # logger needs to be created here to use the correct logger self.logger = PrefixAdaptor(self.name, LOGGER) LOGGER.warning("%s:%s", self.name, self.DEPRECATION_MSG) @@ -199,13 +197,11 @@ def _create_dependencies_yaml(self, module_dir: Path) -> Path: Path to the file that was created. """ - pre_deploy: List[Any] = [] + pre_deploy: list[Any] = [] pre_destroy = [ { - "args": { - "bucket_name": f"${{rxref {self.sanitized_name}-dependencies::{i}}}" - }, + "args": {"bucket_name": f"${{rxref {self.sanitized_name}-dependencies::{i}}}"}, "path": "runway.cfngin.hooks.cleanup_s3.purge_bucket", "required": True, } @@ -264,7 +260,7 @@ def _create_dependencies_yaml(self, module_dir: Path) -> Path: } ) - content: Dict[str, Any] = { + content: dict[str, Any] = { "cfngin_bucket": "", "namespace": "${namespace}", "pre_deploy": pre_deploy, @@ -279,11 +275,10 @@ def _create_dependencies_yaml(self, module_dir: Path) -> Path: } out_file = module_dir / "01-dependencies.yaml" - with open(out_file, "w", encoding="utf-8") as output_stream: - yaml.dump(content, output_stream, default_flow_style=False, sort_keys=True) - self.logger.debug( - "created %s:\n%s", out_file.name, yaml.dump(content, Dumper=YamlDumper) + out_file.write_text( + yaml.dump(content, default_flow_style=False, sort_keys=True), encoding="utf-8" ) + self.logger.debug("created %s:\n%s", out_file.name, yaml.dump(content, Dumper=YamlDumper)) return out_file def _create_staticsite_yaml(self, module_dir: Path) -> Path: @@ -300,12 +295,10 @@ def _create_staticsite_yaml(self, module_dir: Path) -> Path: """ # Default parameter name matches build_staticsite hook if not self.options.source_hashing.parameter: - self.options.source_hashing.parameter = ( - f"${{namespace}}-{self.sanitized_name}-hash" - ) + self.options.source_hashing.parameter = f"${{namespace}}-{self.sanitized_name}-hash" nonce_secret_param = f"${{namespace}}-{self.sanitized_name}-nonce-secret" - build_staticsite_args: Dict[str, Any] = { + build_staticsite_args: dict[str, Any] = { # ensures yaml.safe_load will work by using JSON to convert objects "options": json.loads(self.options.data.json(by_alias=True)) } @@ -314,9 +307,7 @@ def _create_staticsite_yaml(self, module_dir: Path) -> Path: ) build_staticsite_args["options"]["namespace"] = "${namespace}" build_staticsite_args["options"]["name"] = self.sanitized_name - build_staticsite_args["options"]["path"] = os.path.join( - os.path.realpath(self.ctx.env.root_dir), self.path - ) + build_staticsite_args["options"]["path"] = str(self.ctx.env.root_dir.resolve() / self.path) site_stack_variables = self._get_site_stack_variables() @@ -351,9 +342,7 @@ def _create_staticsite_yaml(self, module_dir: Path) -> Path: pre_destroy = [ { - "args": { - "bucket_name": f"${{rxref {self.sanitized_name}::BucketName}}" - }, + "args": {"bucket_name": f"${{rxref {self.sanitized_name}::BucketName}}"}, "path": "runway.cfngin.hooks.cleanup_s3.purge_bucket", "required": True, } @@ -453,11 +442,10 @@ def _create_staticsite_yaml(self, module_dir: Path) -> Path: } out_file = module_dir / "02-staticsite.yaml" - with open(out_file, "w", encoding="utf-8") as output_stream: - yaml.dump(content, output_stream, default_flow_style=False, sort_keys=True) - self.logger.debug( - "created 02-staticsite.yaml:\n%s", yaml.dump(content, Dumper=YamlDumper) + out_file.write_text( + yaml.dump(content, default_flow_style=False, sort_keys=True), encoding="utf-8" ) + self.logger.debug("created 02-staticsite.yaml:\n%s", yaml.dump(content, Dumper=YamlDumper)) return out_file def _create_cleanup_yaml(self, module_dir: Path) -> Path: @@ -478,23 +466,23 @@ def _create_cleanup_yaml(self, module_dir: Path) -> Path: "service_role": self.parameters.service_role, "stacks": { f"{self.sanitized_name}-cleanup": { - "template_path": os.path.join( - tempfile.gettempdir(), "thisfileisnotused.yaml" + "template_path": os.path.join( # noqa: PTH118 + tempfile.gettempdir(), + "thisfileisnotused.yaml", # cspell: disable-line ), } }, } out_file = module_dir / "03-cleanup.yaml" - with open(out_file, "w", encoding="utf-8") as output_stream: - yaml.dump(content, output_stream, default_flow_style=False, sort_keys=True) - self.logger.debug( - "created %s:\n%s", out_file.name, yaml.dump(content, Dumper=YamlDumper) + out_file.write_text( + yaml.dump(content, default_flow_style=False, sort_keys=True), encoding="utf-8" ) + self.logger.debug("created %s:\n%s", out_file.name, yaml.dump(content, Dumper=YamlDumper)) return out_file - def _get_site_stack_variables(self) -> Dict[str, Any]: - site_stack_variables: Dict[str, Any] = { + def _get_site_stack_variables(self) -> dict[str, Any]: + site_stack_variables: dict[str, Any] = { "Aliases": [], "Compress": self.parameters.compress, "DisableCloudFront": self.parameters.cf_disable, @@ -527,8 +515,7 @@ def _get_site_stack_variables(self) -> Dict[str, Any]: site_stack_variables["OAuthScopes"] = self.parameters.oauth_scopes else: site_stack_variables["custom_error_responses"] = [ - i.dict(exclude_none=True) - for i in self.parameters.custom_error_responses + i.dict(exclude_none=True) for i in self.parameters.custom_error_responses ] site_stack_variables["lambda_function_associations"] = [ i.dict() for i in self.parameters.lambda_function_associations @@ -536,8 +523,8 @@ def _get_site_stack_variables(self) -> Dict[str, Any]: return site_stack_variables - def _get_dependencies_variables(self) -> Dict[str, Any]: - variables: Dict[str, Any] = {"OAuthScopes": self.parameters.oauth_scopes} + def _get_dependencies_variables(self) -> dict[str, Any]: + variables: dict[str, Any] = {"OAuthScopes": self.parameters.oauth_scopes} if self.parameters.auth_at_edge: self._ensure_auth_at_edge_requirements() @@ -548,9 +535,7 @@ def _get_dependencies_variables(self) -> Dict[str, Any]: "RedirectPathSignIn": ( "${default staticsite_redirect_path_sign_in::/parseauth}" ), - "RedirectPathSignOut": ( - "${default staticsite_redirect_path_sign_out::/}" - ), + "RedirectPathSignOut": ("${default staticsite_redirect_path_sign_out::/}"), }, ) @@ -558,17 +543,15 @@ def _get_dependencies_variables(self) -> Dict[str, Any]: variables.update({"Aliases": self.parameters.aliases}) if self.parameters.additional_redirect_domains: variables.update( - { - "AdditionalRedirectDomains": self.parameters.additional_redirect_domains - } + {"AdditionalRedirectDomains": self.parameters.additional_redirect_domains} ) if self.parameters.create_user_pool: variables.update({"CreateUserPool": self.parameters.create_user_pool}) return variables - def _get_user_pool_id_retriever_variables(self) -> Dict[str, Any]: - args: Dict[str, Any] = { + def _get_user_pool_id_retriever_variables(self) -> dict[str, Any]: + args: dict[str, Any] = { "user_pool_arn": self.parameters.user_pool_arn, } @@ -579,7 +562,7 @@ def _get_user_pool_id_retriever_variables(self) -> Dict[str, Any]: return args - def _get_domain_updater_variables(self) -> Dict[str, str]: + def _get_domain_updater_variables(self) -> dict[str, str]: return { "client_id_output_lookup": f"{self.sanitized_name}-dependencies::AuthAtEdgeClient", "client_id": f"${{rxref {self.sanitized_name}-dependencies::AuthAtEdgeClient}}", @@ -587,10 +570,10 @@ def _get_domain_updater_variables(self) -> Dict[str, str]: def _get_lambda_config_variables( self, - site_stack_variables: Dict[str, Any], + site_stack_variables: dict[str, Any], nonce_secret_param: str, - required_group: Optional[str] = None, - ) -> Dict[str, Any]: + required_group: str | None = None, + ) -> dict[str, Any]: return { "client_id": f"${{rxref {self.sanitized_name}-dependencies::AuthAtEdgeClient}}", "bucket": f"${{rxref {self.sanitized_name}-dependencies::ArtifactsBucketName}}", @@ -605,12 +588,10 @@ def _get_lambda_config_variables( } def _get_client_updater_variables( - self, name: str, site_stack_variables: Dict[str, Any] - ) -> Dict[str, Any]: + self, name: str, site_stack_variables: dict[str, Any] + ) -> dict[str, Any]: return { - "alternate_domains": [ - add_url_scheme(x) for x in site_stack_variables["Aliases"] - ], + "alternate_domains": [add_url_scheme(x) for x in site_stack_variables["Aliases"]], "client_id": f"${{rxref {self.sanitized_name}-dependencies::AuthAtEdgeClient}}", "distribution_domain": f"${{rxref {name}::CFDistributionDomainName}}", "oauth_scopes": site_stack_variables["OAuthScopes"], @@ -641,8 +622,7 @@ def _ensure_cloudfront_with_auth_at_edge(self) -> None: """Exit if both the Auth@Edge and CloudFront disablement are true.""" if self.parameters.cf_disable and self.parameters.auth_at_edge: self.logger.error( - 'staticsite_cf_disable must be "false" if ' - 'staticsite_auth_at_edge is "true"' + 'staticsite_cf_disable must be "false" if staticsite_auth_at_edge is "true"' ) sys.exit(1) diff --git a/runway/module/staticsite/options/models.py b/runway/module/staticsite/options/models.py index 793e80071..9bc31ede3 100644 --- a/runway/module/staticsite/options/models.py +++ b/runway/module/staticsite/options/models.py @@ -1,9 +1,10 @@ """Runway static site Module options.""" +# ruff: noqa: UP006, UP035 from __future__ import annotations from pathlib import Path -from typing import Any, Dict, List, Optional, cast +from typing import Any, List, Optional, cast from pydantic import Extra, root_validator @@ -37,23 +38,19 @@ class Config(ConfigProperty.Config): title = "Runway static site Module extra_files option item." @root_validator - def _autofill_content_type( # pylint: disable=no-self-argument - cls, values: Dict[str, Any] - ) -> Dict[str, Any]: + def _autofill_content_type(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Attempt to fill content_type if not provided.""" if values.get("content_type"): return values name = cast(str, values.get("name", "")) if name.endswith(".json"): values["content_type"] = "application/json" - elif name.endswith(".yaml") or name.endswith(".yml"): + elif name.endswith((".yaml", ".yml")): values["content_type"] = "text/yaml" return values @root_validator(pre=True) - def _validate_content_or_file( # pylint: disable=no-self-argument - cls, values: Dict[str, Any] - ) -> Dict[str, Any]: + def _validate_content_or_file(cls, values: dict[str, Any]) -> dict[str, Any]: # noqa: N805 """Validate that content or file is provided.""" if all(i in values and values[i] for i in ["content", "file"]): raise ValueError("only one of content or file can be provided") diff --git a/runway/module/staticsite/parameters/models.py b/runway/module/staticsite/parameters/models.py index 4fca1a9df..cbd700359 100644 --- a/runway/module/staticsite/parameters/models.py +++ b/runway/module/staticsite/parameters/models.py @@ -1,9 +1,9 @@ """Runway static site Module parameters.""" -# pylint: disable=no-self-argument +# ruff: noqa: UP006, UP035 from __future__ import annotations -from typing import Dict, List, Optional, Union +from typing import Dict, List, Optional from pydantic import Extra, Field, validator @@ -45,7 +45,7 @@ class Config(ConfigProperty.Config): """Model configuration.""" extra = Extra.forbid - title = "Runway static site Module staticsite_lambda_function_associations parameter item." # noqa + title = "Runway static site Module staticsite_lambda_function_associations parameter item." class RunwayStaticSiteModuleParametersDataModel(ConfigProperty): @@ -129,9 +129,7 @@ class RunwayStaticSiteModuleParametersDataModel(ConfigProperty): "font-src 'self' 'unsafe-inline' 'unsafe-eval' data: https:; " "object-src 'none'; " "connect-src 'self' https://*.amazonaws.com https://*.amazoncognito.com", - "Strict-Transport-Security": "max-age=31536000; " - "includeSubdomains; " - "preload", + "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "Referrer-Policy": "same-origin", "X-XSS-Protection": "1; mode=block", "X-Frame-Options": "DENY", @@ -139,9 +137,9 @@ class RunwayStaticSiteModuleParametersDataModel(ConfigProperty): }, alias="staticsite_http_headers", ) - lambda_function_associations: List[ - RunwayStaticSiteLambdaFunctionAssociationDataModel - ] = Field(default=[], alias="staticsite_lambda_function_associations") + lambda_function_associations: List[RunwayStaticSiteLambdaFunctionAssociationDataModel] = Field( + default=[], alias="staticsite_lambda_function_associations" + ) namespace: str non_spa: bool = Field(default=False, alias="staticsite_non_spa") oauth_scopes: List[str] = Field( @@ -160,21 +158,13 @@ class RunwayStaticSiteModuleParametersDataModel(ConfigProperty): redirect_path_sign_in: str = Field( default="/parseauth", alias="staticsite_redirect_path_sign_in" ) - redirect_path_sign_out: str = Field( - default="/", alias="staticsite_redirect_path_sign_out" - ) - required_group: Optional[str] = Field( - default=None, alias="staticsite_required_group" - ) + redirect_path_sign_out: str = Field(default="/", alias="staticsite_redirect_path_sign_out") + required_group: Optional[str] = Field(default=None, alias="staticsite_required_group") rewrite_directory_index: Optional[str] = Field( default=None, alias="staticsite_rewrite_directory_index" ) - role_boundary_arn: Optional[str] = Field( - default=None, alias="staticsite_role_boundary_arn" - ) - service_role: Optional[str] = Field( - default=None, alias="cloudformation_service_role" - ) + role_boundary_arn: Optional[str] = Field(default=None, alias="staticsite_role_boundary_arn") + service_role: Optional[str] = Field(default=None, alias="cloudformation_service_role") sign_out_url: str = Field(default="/signout", alias="staticsite_sign_out_url") supported_identity_providers: List[str] = Field( default=["COGNITO"], alias="staticsite_supported_identity_providers" @@ -194,7 +184,7 @@ class Config(ConfigProperty.Config): "supported_identity_providers", pre=True, ) - def _convert_comma_delimited_list(cls, v: Union[List[str], str]) -> List[str]: + def _convert_comma_delimited_list(cls, v: list[str] | str) -> list[str]: # noqa: N805 """Convert comma delimited lists to a string.""" if isinstance(v, str): return [i.strip() for i in v.split(",")] diff --git a/runway/module/staticsite/utils.py b/runway/module/staticsite/utils.py index c157384a8..86c81cfe3 100644 --- a/runway/module/staticsite/utils.py +++ b/runway/module/staticsite/utils.py @@ -8,6 +8,6 @@ def add_url_scheme(url: str) -> str: url (str): The current url. """ - if url.startswith("https://") or url.startswith("http://"): + if url.startswith(("https://", "http://")): return url return f"https://{url}" diff --git a/runway/module/terraform.py b/runway/module/terraform.py index 2ff6f8569..63a17ca17 100644 --- a/runway/module/terraform.py +++ b/runway/module/terraform.py @@ -8,7 +8,7 @@ import subprocess import sys from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union, cast +from typing import TYPE_CHECKING, Any, cast import hcl from send2trash import send2trash @@ -34,7 +34,7 @@ LOGGER = cast("RunwayLogger", logging.getLogger(__name__)) -def gen_workspace_tfvars_files(environment: str, region: str) -> List[str]: +def gen_workspace_tfvars_files(environment: str, region: str) -> list[str]: """Generate possible Terraform workspace tfvars filenames.""" return [ # Give preference to explicit environment-region files @@ -45,16 +45,15 @@ def gen_workspace_tfvars_files(environment: str, region: str) -> List[str]: def update_env_vars_with_tf_var_values( - os_env_vars: Dict[str, str], - tf_vars: Dict[str, Union[Dict[str, Any], List[Any], str]], -) -> Dict[str, str]: + os_env_vars: dict[str, str], + tf_vars: dict[str, dict[str, Any] | list[Any] | str], +) -> dict[str, str]: """Return os_env_vars with TF_VAR values for each tf_var.""" # https://www.terraform.io/docs/commands/environment-variables.html#tf_var_name for key, val in tf_vars.items(): if isinstance(val, dict): value = ", ".join( - nestedkey + ' = "' + str(nestedval) + '"' - for (nestedkey, nestedval) in val.items() + nestedkey + ' = "' + str(nestedval) + '"' for (nestedkey, nestedval) in val.items() ) os_env_vars[f"TF_VAR_{key}"] = f"{{ {value} }}" elif isinstance(val, list): @@ -86,12 +85,12 @@ def __init__( self, context: RunwayContext, *, - explicitly_enabled: Optional[bool] = False, + explicitly_enabled: bool | None = False, logger: RunwayLogger = LOGGER, module_root: Path, - name: Optional[str] = None, - options: Optional[Union[Dict[str, Any], ModuleOptions]] = None, - parameters: Optional[Dict[str, Any]] = None, + name: str | None = None, + options: dict[str, Any] | ModuleOptions | None = None, + parameters: dict[str, Any] | None = None, **_: Any, ) -> None: """Instantiate class. @@ -150,12 +149,10 @@ def current_workspace(self) -> str: return self.terraform_workspace_show() @cached_property - def env_file(self) -> List[str]: + def env_file(self) -> list[str]: """Find the environment file for the module.""" - result: List[str] = [] - for name in gen_workspace_tfvars_files( - self.ctx.env.name, self.ctx.env.aws_region - ): + result: list[str] = [] + for name in gen_workspace_tfvars_files(self.ctx.env.name, self.ctx.env.aws_region): test_path = self.path / name if test_path.is_file(): result.append("-var-file=" + test_path.name) @@ -170,9 +167,7 @@ def skip(self) -> bool: self.logger.info( "skipped; tfvars file for this environment/region not found " "and no parameters provided -- looking for one of: %s", - ", ".join( - gen_workspace_tfvars_files(self.ctx.env.name, self.ctx.env.aws_region) - ), + ", ".join(gen_workspace_tfvars_files(self.ctx.env.name, self.ctx.env.aws_region)), ) return True @@ -188,14 +183,10 @@ def tf_bin(self) -> str: return self.tfenv.install(self.options.version) except ValueError: self.logger.debug("terraform install failed", exc_info=True) - self.logger.verbose( - "terraform version not specified; resorting to global install" - ) + self.logger.verbose("terraform version not specified; resorting to global install") if which("terraform"): return "terraform" - self.logger.error( - "terraform not available and a version to install not specified" - ) + self.logger.error("terraform not available and a version to install not specified") self.logger.error( "learn how to use Runway to manage Terraform versions at " "%s/page/terraform/advanced_features.html#version-management", @@ -231,8 +222,7 @@ def cleanup_dot_terraform(self) -> None: return self.logger.verbose( - ".terraform directory exists from a previous run; " - "removing some of its contents" + ".terraform directory exists from a previous run; removing some of its contents" ) for child in dot_terraform.iterdir(): if child.name == "plugins" and child.is_dir(): @@ -251,14 +241,15 @@ def destroy(self) -> None: def gen_command( self, - command: Union[List[str], str, Tuple[str, ...]], - args_list: Optional[List[str]] = None, - ) -> List[str]: + command: list[str] | str | tuple[str, ...], + args_list: list[str] | None = None, + ) -> list[str]: """Generate Terraform command.""" - if isinstance(command, (list, tuple)): - cmd = [self.tf_bin, *command] - else: - cmd = [self.tf_bin, command] + cmd = ( + [self.tf_bin, *command] + if isinstance(command, (list, tuple)) + else [self.tf_bin, command] + ) cmd.extend(args_list or []) if self.ctx.no_color: cmd.append("-no-color") @@ -273,8 +264,7 @@ def handle_backend(self) -> None: """ if not self.tfenv.backend["type"]: self.logger.info( - "unable to determine backend for module; no special handling " - "will be applied" + "unable to determine backend for module; no special handling will be applied" ) return handler = f"_{self.tfenv.backend['type']}_backend_handler" @@ -282,12 +272,8 @@ def handle_backend(self) -> None: self.tfenv.backend["config"].update( self.options.backend_config.get_full_configuration() ) - self.logger.debug( - "full backend config: %s", json.dumps(self.tfenv.backend["config"]) - ) - self.logger.verbose( - "handling use of backend config: %s", self.tfenv.backend["type"] - ) + self.logger.debug("full backend config: %s", json.dumps(self.tfenv.backend["config"])) + self.logger.verbose("handling use of backend config: %s", self.tfenv.backend["type"]) self[f"_{self.tfenv.backend['type']}_backend_handler"]() else: self.logger.verbose( @@ -313,9 +299,7 @@ def _remote_backend_handler(self) -> None: self.options.write_auto_tfvars = True if self.tfenv.backend["config"]["workspaces"].get("prefix"): - self.logger.verbose( - "handling use of backend config: remote.workspaces.prefix" - ) + self.logger.verbose("handling use of backend config: remote.workspaces.prefix") self.ctx.env.vars.update({"TF_WORKSPACE": self.ctx.env.name}) self.logger.verbose( 'set environment variable "TF_WORKSPACE" to avoid prompt ' @@ -323,9 +307,7 @@ def _remote_backend_handler(self) -> None: ) if self.tfenv.backend["config"]["workspaces"].get("name"): - self.logger.verbose( - "handling use of backend config: remote.workspaces.name" - ) + self.logger.verbose("handling use of backend config: remote.workspaces.name") # this can't be set or it will cause errors self.ctx.env.vars.pop("TF_WORKSPACE", None) self.required_workspace = "default" @@ -343,9 +325,7 @@ def handle_parameters(self) -> None: if self.auto_tfvars.exists(): return - self.ctx.env.vars = update_env_vars_with_tf_var_values( - self.ctx.env.vars, self.parameters - ) + self.ctx.env.vars = update_env_vars_with_tf_var_values(self.ctx.env.vars, self.parameters) def init(self) -> None: """Run init.""" @@ -391,7 +371,7 @@ def _terraform_destroy_12(self) -> None: """ return run_module_command( - self.gen_command("destroy", ["-auto-approve"] + self.env_file), + self.gen_command("destroy", ["-auto-approve", *self.env_file]), env_vars=self.ctx.env.vars, logger=self.logger, ) @@ -403,7 +383,7 @@ def _terraform_destroy_15_2(self) -> None: """ return run_module_command( - self.gen_command("apply", ["-destroy", "-auto-approve"] + self.env_file), + self.gen_command("apply", ["-destroy", "-auto-approve", *self.env_file]), env_vars=self.ctx.env.vars, logger=self.logger, ) @@ -415,7 +395,7 @@ def _terraform_destroy_legacy(self) -> None: """ return run_module_command( - self.gen_command("destroy", ["-force"] + self.env_file), + self.gen_command("destroy", ["-force", *self.env_file]), env_vars=self.ctx.env.vars, logger=self.logger, ) @@ -441,9 +421,7 @@ def terraform_init(self) -> None: """ cmd = self.gen_command( "init", - ["-reconfigure"] - + self.options.backend_config.init_args - + self.options.args.init, + ["-reconfigure", *self.options.backend_config.init_args, *self.options.args.init], ) try: run_module_command( @@ -533,9 +511,7 @@ def terraform_workspace_show(self) -> str: """ self.logger.debug("using Terraform to get the current workspace") workspace = ( - subprocess.check_output( - self.gen_command(["workspace", "show"]), env=self.ctx.env.vars - ) + subprocess.check_output(self.gen_command(["workspace", "show"]), env=self.ctx.env.vars) .strip() .decode() ) @@ -553,7 +529,7 @@ def run(self, action: TerraformActionTypeDef) -> None: self.logger.info("init (in progress)") self.terraform_init() if self.current_workspace != self.required_workspace: - if re.compile(f"^[*\\s]\\s{self.required_workspace}$", re.M).search( + if re.compile(f"^[*\\s]\\s{self.required_workspace}$", re.MULTILINE).search( self.terraform_workspace_list() ): self.terraform_workspace_select(self.required_workspace) @@ -590,7 +566,7 @@ def __init__( self, data: RunwayTerraformModuleOptionsDataModel, deploy_environment: DeployEnvironment, - path: Optional[Path] = None, + path: Path | None = None, ) -> None: """Instantiate class. @@ -622,7 +598,7 @@ def parse_obj( cls, deploy_environment: DeployEnvironment, obj: object, - path: Optional[Path] = None, + path: Path | None = None, ) -> TerraformOptions: """Parse options definition and return an options object. @@ -666,14 +642,14 @@ def __init__( self.region = data.region @cached_property - def config_file(self) -> Optional[Path]: + def config_file(self) -> Path | None: """Backend configuration file.""" return self.get_backend_file(self.path, self.env.name, self.env.aws_region) @cached_property - def init_args(self) -> List[str]: + def init_args(self) -> list[str]: """Return command line arguments for init.""" - result: List[str] = [] + result: list[str] = [] for k, v in self.data.dict(exclude_none=True).items(): result.extend(["-backend-config", f"{k}={v}"]) if not result: @@ -682,27 +658,23 @@ def init_args(self) -> List[str]: return [f"-backend-config={self.config_file.name}"] LOGGER.info( "backend file not found -- looking for one of: %s", - ", ".join( - self.gen_backend_filenames(self.env.name, self.env.aws_region) - ), + ", ".join(self.gen_backend_filenames(self.env.name, self.env.aws_region)), ) return [] LOGGER.info("using backend values from runway.yml") LOGGER.debug("provided backend values: %s", json.dumps(result)) return result - def get_full_configuration(self) -> Dict[str, str]: + def get_full_configuration(self) -> dict[str, str]: """Get full backend configuration.""" if not self.config_file: return self.data.dict(exclude_none=True) - result = cast(Dict[str, str], hcl.loads(self.config_file.read_text())) + result = cast(dict[str, str], hcl.loads(self.config_file.read_text())) result.update(self.data.dict(exclude_none=True)) return result @classmethod - def get_backend_file( - cls, path: Path, environment: str, region: str - ) -> Optional[Path]: + def get_backend_file(cls, path: Path, environment: str, region: str) -> Path | None: """Determine Terraform backend file. Args: @@ -719,7 +691,7 @@ def get_backend_file( return None @staticmethod - def gen_backend_filenames(environment: str, region: str) -> List[str]: + def gen_backend_filenames(environment: str, region: str) -> list[str]: """Generate possible Terraform backend filenames. Args: @@ -733,10 +705,10 @@ def gen_backend_filenames(environment: str, region: str) -> List[str]: "backend-{region}.{extension}", "backend.{extension}", ] - result: List[str] = [] + result: list[str] = [] for fmt in formats: for ext in ["hcl", "tfvars"]: - result.append( + result.append( # noqa: PERF401 fmt.format(environment=environment, extension=ext, region=region) ) return result @@ -746,7 +718,7 @@ def parse_obj( cls, deploy_environment: DeployEnvironment, obj: object, - path: Optional[Path] = None, + path: Path | None = None, ) -> TerraformBackendConfig: """Parse options definition and return an options object. diff --git a/runway/module/utils.py b/runway/module/utils.py index f80a813e5..d686c5217 100644 --- a/runway/module/utils.py +++ b/runway/module/utils.py @@ -7,12 +7,12 @@ import platform import subprocess import sys -from pathlib import Path -from typing import TYPE_CHECKING, Dict, List, Optional, Union, cast +from typing import TYPE_CHECKING, cast from ..utils import which if TYPE_CHECKING: + from pathlib import Path from typing import Any from .._logging import RunwayLogger @@ -22,24 +22,21 @@ NPX_BIN = "npx.cmd" if platform.system().lower() == "windows" else "npx" -def format_npm_command_for_logging(command: List[str]) -> str: +def format_npm_command_for_logging(command: list[str]) -> str: """Convert npm command list to string for display to user.""" - if platform.system().lower() == "windows" and ( - command[0] == "npx.cmd" and command[1] == "-c" - ): + if platform.system().lower() == "windows" and (command[0] == "npx.cmd" and command[1] == "-c"): return f'npx.cmd -c "{" ".join(command[2:])}"' return " ".join(command) -# type hint quoted b/c pylint 2.11.1 raises unsubscriptable-object def generate_node_command( command: str, - command_opts: List[str], + command_opts: list[str], path: Path, *, - logger: Union[logging.Logger, "logging.LoggerAdapter[Any]"] = LOGGER, - package: Optional[str] = None, -) -> List[str]: + logger: logging.Logger | logging.LoggerAdapter[Any] = LOGGER, + package: str | None = None, +) -> list[str]: """Return node bin command list for subprocess execution. Args: @@ -75,12 +72,11 @@ def generate_node_command( return cmd_list -# type hint b/c pylint 2.11.1 raises unsubscriptable-object def run_module_command( - cmd_list: List[str], - env_vars: Dict[str, str], + cmd_list: list[str], + env_vars: dict[str, str], exit_on_error: bool = True, - logger: Union[logging.Logger, "logging.LoggerAdapter[Any]"] = LOGGER, + logger: logging.Logger | logging.LoggerAdapter[Any] = LOGGER, ) -> None: """Shell out to provisioner command. @@ -107,12 +103,9 @@ def run_module_command( def use_npm_ci(path: Path) -> bool: """Return true if npm ci should be used in lieu of npm install.""" # https://docs.npmjs.com/cli/ci#description - with open(os.devnull, "w", encoding="utf-8") as fnull: + with open(os.devnull, "w", encoding="utf-8") as fnull: # noqa: PTH123 if ( - (path / "package-lock.json").is_file() - or (path / "npm-shrinkwrap.json").is_file() - ) and subprocess.call( - [NPM_BIN, "ci", "-h"], stdout=fnull, stderr=subprocess.STDOUT - ) == 0: + (path / "package-lock.json").is_file() or (path / "npm-shrinkwrap.json").is_file() + ) and subprocess.call([NPM_BIN, "ci", "-h"], stdout=fnull, stderr=subprocess.STDOUT) == 0: return True return False diff --git a/runway/s3_utils.py b/runway/s3_utils.py index e0a72abd1..36f36b8fa 100644 --- a/runway/s3_utils.py +++ b/runway/s3_utils.py @@ -6,12 +6,15 @@ import os import tempfile import zipfile -from typing import TYPE_CHECKING, Any, Dict, Iterator, Optional, Sequence, cast +from pathlib import Path +from typing import TYPE_CHECKING, Any, cast import boto3 from botocore.exceptions import ClientError if TYPE_CHECKING: + from collections.abc import Iterator, Sequence + from mypy_boto3_s3.client import S3Client from mypy_boto3_s3.service_resource import S3ServiceResource from mypy_boto3_s3.type_defs import ObjectTypeDef @@ -21,24 +24,20 @@ LOGGER = cast("RunwayLogger", logging.getLogger(__name__)) -def _get_client( - session: Optional[boto3.Session] = None, region: Optional[str] = None -) -> S3Client: +def _get_client(session: boto3.Session | None = None, region: str | None = None) -> S3Client: """Get S3 boto client.""" return session.client("s3") if session else boto3.client("s3", region_name=region) def _get_resource( - session: Optional[boto3.Session] = None, region: Optional[str] = None + session: boto3.Session | None = None, region: str | None = None ) -> S3ServiceResource: """Get S3 boto resource.""" - return ( - session.resource("s3") if session else boto3.resource("s3", region_name=region) - ) + return session.resource("s3") if session else boto3.resource("s3", region_name=region) def purge_and_delete_bucket( - bucket_name: str, region: str = "us-east-1", session: Optional[boto3.Session] = None + bucket_name: str, region: str = "us-east-1", session: boto3.Session | None = None ) -> None: """Delete all objects and versions in bucket, then delete bucket.""" purge_bucket(bucket_name, region, session) @@ -46,7 +45,7 @@ def purge_and_delete_bucket( def purge_bucket( - bucket_name: str, region: str = "us-east-1", session: Optional[boto3.Session] = None + bucket_name: str, region: str = "us-east-1", session: boto3.Session | None = None ) -> None: """Delete all objects and versions in bucket.""" if does_bucket_exist(bucket_name, region, session): @@ -58,7 +57,7 @@ def purge_bucket( def delete_bucket( - bucket_name: str, region: str = "us-east-1", session: Optional[boto3.Session] = None + bucket_name: str, region: str = "us-east-1", session: boto3.Session | None = None ) -> None: """Delete bucket.""" if does_bucket_exist(bucket_name, region, session): @@ -72,7 +71,7 @@ def delete_bucket( def does_bucket_exist( - bucket_name: str, region: str = "us-east-1", session: Optional[boto3.Session] = None + bucket_name: str, region: str = "us-east-1", session: boto3.Session | None = None ) -> bool: """Check if bucket exists in S3.""" s3_resource = _get_resource(session, region) @@ -84,26 +83,22 @@ def does_bucket_exist( LOGGER.info('bucket "%s" does not exist', bucket_name) return False if exc.response["Error"]["Message"] == "Forbidden": - LOGGER.exception( - 'access denied for bucket "%s" (permissions?)', bucket_name - ) + LOGGER.exception('access denied for bucket "%s" (permissions?)', bucket_name) raise return False def ensure_bucket_exists( - bucket_name: str, region: str = "us-east-1", session: Optional[boto3.Session] = None + bucket_name: str, region: str = "us-east-1", session: boto3.Session | None = None ) -> None: """Ensure S3 bucket exists.""" if not does_bucket_exist(bucket_name, region, session): LOGGER.info('creating bucket "%s" (in progress)', bucket_name) s3_client = _get_client(session, region) if region == "us-east-1": - create_bucket_opts: Dict[str, Any] = {} + create_bucket_opts: dict[str, Any] = {} else: - create_bucket_opts = { - "CreateBucketConfiguration": {"LocationConstraint": region} - } + create_bucket_opts = {"CreateBucketConfiguration": {"LocationConstraint": region}} s3_client.create_bucket(Bucket=bucket_name, **create_bucket_opts) # sometimes when creating the bucket it can take a few moments before @@ -116,9 +111,7 @@ def ensure_bucket_exists( s3_client.put_bucket_encryption( Bucket=bucket_name, ServerSideEncryptionConfiguration={ - "Rules": [ - {"ApplyServerSideEncryptionByDefault": {"SSEAlgorithm": "AES256"}} - ] + "Rules": [{"ApplyServerSideEncryptionByDefault": {"SSEAlgorithm": "AES256"}}] }, ) LOGGER.verbose('enabled encryption for bucket "%s"', bucket_name) @@ -127,7 +120,7 @@ def ensure_bucket_exists( def does_s3_object_exist( bucket: str, key: str, - session: Optional[boto3.Session] = None, + session: boto3.Session | None = None, region: str = "us-east-1", ) -> bool: """Determine if object exists on s3.""" @@ -143,18 +136,14 @@ def does_s3_object_exist( return True -def upload( - bucket: str, key: str, filename: str, session: Optional[boto3.Session] = None -) -> None: +def upload(bucket: str, key: str, filename: str, session: boto3.Session | None = None) -> None: """Upload file to S3 bucket.""" s3_client = _get_client(session) LOGGER.info("uploading %s to s3://%s/%s...", filename, bucket, key) s3_client.upload_file(Filename=filename, Bucket=bucket, Key=key) -def download( - bucket: str, key: str, file_path: str, session: Optional[boto3.Session] = None -) -> str: +def download(bucket: str, key: str, file_path: str, session: boto3.Session | None = None) -> str: """Download a file from S3 to the given path.""" s3_client = _get_client(session) @@ -164,7 +153,7 @@ def download( def download_and_extract_to_mkdtemp( - bucket: str, key: str, session: Optional[boto3.Session] = None + bucket: str, key: str, session: boto3.Session | None = None ) -> str: """Download zip archive and extract it to temporary directory.""" filedes, temp_file = tempfile.mkstemp() @@ -174,7 +163,7 @@ def download_and_extract_to_mkdtemp( output_dir = tempfile.mkdtemp() with zipfile.ZipFile(temp_file, "r") as zip_ref: zip_ref.extractall(output_dir) - os.remove(temp_file) + Path(temp_file).unlink() LOGGER.verbose("extracted %s to %s", temp_file, output_dir) return output_dir @@ -183,7 +172,7 @@ def get_matching_s3_objects( bucket: str, prefix: Sequence[str] = "", suffix: str = "", - session: Optional[boto3.Session] = None, + session: boto3.Session | None = None, ) -> Iterator[ObjectTypeDef]: """Generate objects in an S3 bucket. @@ -222,7 +211,7 @@ def get_matching_s3_keys( bucket: str, prefix: str = "", suffix: str = "", - session: Optional[boto3.Session] = None, + session: boto3.Session | None = None, ) -> Iterator[str]: """Generate the keys in an S3 bucket. diff --git a/runway/sources/git.py b/runway/sources/git.py index 4c287d1b4..c39b69a2e 100644 --- a/runway/sources/git.py +++ b/runway/sources/git.py @@ -1,11 +1,13 @@ """'Git type Path Source.""" +from __future__ import annotations + import logging import shutil import subprocess import tempfile from pathlib import Path -from typing import Any, Dict, Optional +from typing import Any from .source import Source @@ -23,7 +25,7 @@ class Git(Source): def __init__( self, *, - arguments: Optional[Dict[str, str]] = None, + arguments: dict[str, str] | None = None, location: str = "", uri: str = "", **kwargs: Any, @@ -38,6 +40,7 @@ def __init__( module resides. Leaving this as an empty string, ``/``, or ``./`` will have runway look in the root folder. uri: The uniform resource identifier that targets the remote git repository + **kwargs: Arbitrary keyword arguments. """ self.args = arguments or {} @@ -48,7 +51,7 @@ def __init__( def fetch(self) -> Path: """Retrieve the git repository from it's remote location.""" - from git.repo import Repo # pylint: disable=import-outside-toplevel + from git.repo import Repo ref = self.__determine_git_ref() dir_name = "_".join([self.sanitize_git_path(self.uri), ref]) @@ -91,9 +94,7 @@ def __determine_git_ls_remote_ref(self) -> str: def __determine_git_ref(self) -> str: """Determine the git reference code.""" - ref_config_keys = sum( - bool(self.args.get(i)) for i in ["commit", "tag", "branch"] - ) + ref_config_keys = sum(bool(self.args.get(i)) for i in ["commit", "tag", "branch"]) if ref_config_keys > 1: raise ValueError( "Fetching remote git sources failed: conflicting revisions " diff --git a/runway/sources/source.py b/runway/sources/source.py index 06daf757a..4e5c520b4 100644 --- a/runway/sources/source.py +++ b/runway/sources/source.py @@ -5,9 +5,11 @@ """ +from __future__ import annotations + import logging from pathlib import Path -from typing import Any, Union +from typing import Any LOGGER = logging.getLogger(__name__) @@ -29,12 +31,13 @@ class Source: cache_dir: Path - def __init__(self, *, cache_dir: Union[Path, str], **_: Any): + def __init__(self, *, cache_dir: Path | str, **_: Any) -> None: """Source. Args: cache_dir: The directory where the given remote resource should be cached. + **kwargs: Arbitrary keyword arguments. """ self.cache_dir = cache_dir if isinstance(cache_dir, Path) else Path(cache_dir) diff --git a/runway/templates/.flake8 b/runway/templates/.flake8 deleted file mode 100644 index ed384d4ba..000000000 --- a/runway/templates/.flake8 +++ /dev/null @@ -1,4 +0,0 @@ -[flake8] -exclude = - node_modules, - .serverless diff --git a/runway/templates/.pylintrc b/runway/templates/.pylintrc deleted file mode 100644 index 0b852af53..000000000 --- a/runway/templates/.pylintrc +++ /dev/null @@ -1,549 +0,0 @@ -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins= - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# When enabled, pylint would attempt to guess common misconfiguration and emit -# user-friendly hints instead of false-positive error messages -suggestion-mode=yes - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -disable=line-too-long, - import-error, - unused-import, - print-statement, - parameter-unpacking, - unpacking-in-except, - old-raise-syntax, - backtick, - long-suffix, - old-ne-operator, - old-octal-literal, - import-star-module-level, - non-ascii-bytes-literal, - invalid-unicode-literal, - raw-checker-failed, - bad-inline-option, - locally-disabled, - locally-enabled, - file-ignored, - suppressed-message, - useless-suppression, - deprecated-pragma, - apply-builtin, - basestring-builtin, - buffer-builtin, - cmp-builtin, - coerce-builtin, - execfile-builtin, - file-builtin, - long-builtin, - raw_input-builtin, - reduce-builtin, - standarderror-builtin, - unicode-builtin, - xrange-builtin, - coerce-method, - delslice-method, - getslice-method, - setslice-method, - no-absolute-import, - old-division, - dict-iter-method, - dict-view-method, - next-method-called, - metaclass-assignment, - indexing-exception, - raising-string, - reload-builtin, - oct-method, - hex-method, - nonzero-method, - cmp-method, - input-builtin, - round-builtin, - intern-builtin, - unichr-builtin, - map-builtin-not-iterating, - zip-builtin-not-iterating, - range-builtin-not-iterating, - filter-builtin-not-iterating, - using-cmp-argument, - eq-without-hash, - div-method, - idiv-method, - rdiv-method, - exception-message-attribute, - invalid-str-codec, - sys-max-int, - bad-python3-import, - deprecated-string-function, - deprecated-str-translate-call, - deprecated-itertools-function, - deprecated-types-field, - next-method-defined, - dict-items-not-iterating, - dict-keys-not-iterating, - dict-values-not-iterating, - deprecated-operator-function, - deprecated-urllib-function, - xreadlines-attribute, - deprecated-sys-function, - exception-escape, - comprehension-escape - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable=c-extension-no-member - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - -# Complete name of functions that never returns. When checking for -# inconsistent-return-statements if a never returning function is called then -# it will be considered as an explicit return statement and no message will be -# printed. -never-returning-functions=optparse.Values,sys.exit - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules= - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[BASIC] - -# Naming style matching correct argument names -argument-naming-style=snake_case - -# Regular expression matching correct argument names. Overrides argument- -# naming-style -#argument-rgx= - -# Naming style matching correct attribute names -attr-naming-style=snake_case - -# Regular expression matching correct attribute names. Overrides attr-naming- -# style -#attr-rgx= - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo, - bar, - baz, - toto, - tutu, - tata - -# Naming style matching correct class attribute names -class-attribute-naming-style=any - -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style -#class-attribute-rgx= - -# Naming style matching correct class names -class-naming-style=PascalCase - -# Regular expression matching correct class names. Overrides class-naming-style -#class-rgx= - -# Naming style matching correct constant names -const-naming-style=UPPER_CASE - -# Regular expression matching correct constant names. Overrides const-naming- -# style -#const-rgx= - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Naming style matching correct function names -function-naming-style=snake_case - -# Regular expression matching correct function names. Overrides function- -# naming-style -#function-rgx= - -# Good variable names which should always be accepted, separated by a comma -good-names=i, - j, - k, - ex, - Run, - _ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Naming style matching correct inline iteration names -inlinevar-naming-style=any - -# Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style -#inlinevar-rgx= - -# Naming style matching correct method names -method-naming-style=snake_case - -# Regular expression matching correct method names. Overrides method-naming- -# style -#method-rgx= - -# Naming style matching correct module names -module-naming-style=snake_case - -# Regular expression matching correct module names. Overrides module-naming- -# style -#module-rgx= - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Naming style matching correct variable names -variable-naming-style=snake_case - -# Regular expression matching correct variable names. Overrides variable- -# naming-style -#variable-rgx= - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=no - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO - - -[SPELLING] - -# Limits count of emitted suggestions for spelling mistakes -max-spelling-suggestions=4 - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_, - _cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,past.builtins,future.builtins,io,builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -expected-line-ending-format= - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma, - dict-separator - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict, - _fields, - _replace, - _source, - _make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -max-attributes=7 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception diff --git a/runway/templates/cdk-csharp/README.md b/runway/templates/cdk-csharp/README.md index b1fdeb70b..10160c5c5 100644 --- a/runway/templates/cdk-csharp/README.md +++ b/runway/templates/cdk-csharp/README.md @@ -1,4 +1,3 @@ - # CDK HelloWorld Welcome to your CDK .NET project! @@ -8,13 +7,13 @@ a stack (`HelloStack`) which also uses a user-defined construct (`HelloConstruct The `cdk.json` file tells the CDK Toolkit how to execute your app. It uses the `dotnet` CLI to do this. -# Useful commands +## Useful commands -* `dotnet build src` compile this app -* `cdk ls` list all stacks in the app -* `cdk synth` emits the synthesized CloudFormation template -* `cdk deploy` deploy this stack to your default AWS account/region -* `cdk diff` compare deployed stack with current state -* `cdk docs` open CDK documentation +- `dotnet build src` compile this app +- `cdk ls` list all stacks in the app +- `cdk synth` emits the synthesized CloudFormation template +- `cdk deploy` deploy this stack to your default AWS account/region +- `cdk diff` compare deployed stack with current state +- `cdk docs` open CDK documentation Enjoy! diff --git a/runway/templates/cdk-csharp/package.json b/runway/templates/cdk-csharp/package.json index a1dbc2e70..39a11b1ae 100644 --- a/runway/templates/cdk-csharp/package.json +++ b/runway/templates/cdk-csharp/package.json @@ -1,12 +1,12 @@ { - "name": "sampleapp", - "version": "1.0.0", - "description": "Sample CDK Project", - "author": "Onica", - "homepage": "https://www.onica.com", - "private": true, - "main": "app.py", - "devDependencies": { - "aws-cdk": "^0.27.0" - } + "author": "Onica", + "description": "Sample CDK Project", + "devDependencies": { + "aws-cdk": "^0.27.0" + }, + "homepage": "https://www.onica.com", + "main": "app.py", + "name": "sampleapp", + "private": true, + "version": "1.0.0" } diff --git a/runway/templates/cdk-csharp/runway.module.yml b/runway/templates/cdk-csharp/runway.module.yml index 568f9bd3f..7fac5323c 100644 --- a/runway/templates/cdk-csharp/runway.module.yml +++ b/runway/templates/cdk-csharp/runway.module.yml @@ -1,4 +1,3 @@ ---- options: build_steps: - dotnet build src diff --git a/runway/templates/cdk-py/__init__.py b/runway/templates/cdk-py/__init__.py new file mode 100644 index 000000000..0349622bd --- /dev/null +++ b/runway/templates/cdk-py/__init__.py @@ -0,0 +1 @@ +"""PLACEHOLDER.""" diff --git a/runway/templates/cdk-py/app.py b/runway/templates/cdk-py/app.py index febe08d8e..e4582376b 100644 --- a/runway/templates/cdk-py/app.py +++ b/runway/templates/cdk-py/app.py @@ -1,5 +1,6 @@ -#!/usr/bin/env python3 """Sample app.""" + +# ruff: noqa from aws_cdk import core from hello.hello_stack import MyStack diff --git a/runway/templates/cdk-py/hello/hello_construct.py b/runway/templates/cdk-py/hello/hello_construct.py index cf2e5ff49..709d59696 100644 --- a/runway/templates/cdk-py/hello/hello_construct.py +++ b/runway/templates/cdk-py/hello/hello_construct.py @@ -1,5 +1,6 @@ """Sample app.""" +# ruff: noqa from aws_cdk import aws_iam as iam from aws_cdk import aws_s3 as s3 from aws_cdk import core @@ -17,7 +18,7 @@ def __init__(self, scope: core.Construct, id: str, num_buckets: int) -> None: """Instantiate class.""" super().__init__(scope, id) self._buckets = [] - for i in range(0, num_buckets): + for i in range(num_buckets): self._buckets.append(s3.Bucket(self, f"Bucket-{i}")) def grant_read(self, principal: iam.IPrincipal): diff --git a/runway/templates/cdk-py/hello/hello_stack.py b/runway/templates/cdk-py/hello/hello_stack.py index e90281fba..d970a8000 100644 --- a/runway/templates/cdk-py/hello/hello_stack.py +++ b/runway/templates/cdk-py/hello/hello_stack.py @@ -1,5 +1,6 @@ """Hello stack.""" +# ruff: noqa from aws_cdk import aws_iam as iam from aws_cdk import aws_sns as sns from aws_cdk import aws_sns_subscriptions as subs @@ -16,9 +17,7 @@ def __init__(self, scope: core.Construct, id: str, **kwargs) -> None: """Instantiate class.""" super().__init__(scope, id, **kwargs) - queue = sqs.Queue( - self, "MyFirstQueue", visibility_timeout=core.Duration.seconds(300) - ) + queue = sqs.Queue(self, "MyFirstQueue", visibility_timeout=core.Duration.seconds(300)) topic = sns.Topic(self, "MyFirstTopic", display_name="My First Topic") diff --git a/runway/templates/cdk-py/package.json b/runway/templates/cdk-py/package.json index 25b829b2f..09eff9f88 100644 --- a/runway/templates/cdk-py/package.json +++ b/runway/templates/cdk-py/package.json @@ -1,12 +1,12 @@ { - "name": "sampleapp", - "version": "1.0.0", - "description": "Sample CDK Project", "author": "Onica", - "homepage": "https://www.onica.com", - "private": true, - "main": "app.py", + "description": "Sample CDK Project", "devDependencies": { "aws-cdk": "^1.13.0" - } + }, + "homepage": "https://www.onica.com", + "main": "app.py", + "name": "sampleapp", + "private": true, + "version": "1.0.0" } diff --git a/runway/templates/cdk-py/pyproject.toml b/runway/templates/cdk-py/pyproject.toml index f92603924..fdced52e0 100644 --- a/runway/templates/cdk-py/pyproject.toml +++ b/runway/templates/cdk-py/pyproject.toml @@ -1,21 +1,21 @@ [tool.poetry] name = "runway-sample-cdk-py" version = "0.0.0" -description = "Runway Sample" authors = ["Onica Group LLC "] +description = "Runway Sample" license = "Apache-2.0" [tool.poetry.dependencies] python = "^3.9" [tool.poetry.dev-dependencies] -"aws-cdk.core" = "^1.13" "aws-cdk.aws_iam" = "^1.13" -"aws-cdk.aws_sqs" = "^1.13" +"aws-cdk.aws_s3" = "^1.13" "aws-cdk.aws_sns" = "^1.13" "aws-cdk.aws_sns_subscriptions" = "^1.13" -"aws-cdk.aws_s3" = "^1.13" +"aws-cdk.aws_sqs" = "^1.13" +"aws-cdk.core" = "^1.13" [build-system] -requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" +requires = ["poetry-core>=1.0.0"] diff --git a/runway/templates/cdk-py/runway.module.yml b/runway/templates/cdk-py/runway.module.yml index 16dedbc2b..11784bb82 100644 --- a/runway/templates/cdk-py/runway.module.yml +++ b/runway/templates/cdk-py/runway.module.yml @@ -1,4 +1,3 @@ ---- options: build_steps: - poetry install diff --git a/runway/templates/cdk-tsc/README.md b/runway/templates/cdk-tsc/README.md index da3d2c543..cceca9130 100644 --- a/runway/templates/cdk-tsc/README.md +++ b/runway/templates/cdk-tsc/README.md @@ -1,7 +1,7 @@ # Useful commands -* `npm run build` compile typescript to js -* `npm run watch` watch for changes and compile -* `npx cdk deploy` deploy this stack to your default AWS account/region -* `npx cdk diff` compare deployed stack with current state -* `npx cdk synth` emits the synthesized CloudFormation template +- `npm run build` compile typescript to js +- `npm run watch` watch for changes and compile +- `npx cdk deploy` deploy this stack to your default AWS account/region +- `npx cdk diff` compare deployed stack with current state +- `npx cdk synth` emits the synthesized CloudFormation template diff --git a/runway/templates/cdk-tsc/package.json b/runway/templates/cdk-tsc/package.json index 2d58e675f..164400f13 100644 --- a/runway/templates/cdk-tsc/package.json +++ b/runway/templates/cdk-tsc/package.json @@ -1,23 +1,23 @@ { - "name": "sampleapp", - "version": "0.1.0", "bin": { "newbase": "bin/sample.js" }, - "scripts": { - "build": "tsc", - "watch": "tsc -w", - "cdk": "cdk" + "dependencies": { + "@aws-cdk/core": "^1.1.0", + "source-map-support": "^0.5.9" }, "devDependencies": { "@types/node": "^10.17.5", "@types/source-map-support": "^0.5.0", - "typescript": "^3.3.3333", + "aws-cdk": "^1.1.0", "ts-node": "^8.1.0", - "aws-cdk": "^1.1.0" + "typescript": "^3.3.3333" }, - "dependencies": { - "@aws-cdk/core": "^1.1.0", - "source-map-support": "^0.5.9" - } + "name": "sampleapp", + "scripts": { + "build": "tsc", + "cdk": "cdk", + "watch": "tsc -w" + }, + "version": "0.1.0" } diff --git a/runway/templates/cdk-tsc/runway.module.yml b/runway/templates/cdk-tsc/runway.module.yml index 01f3f5109..661ba5426 100644 --- a/runway/templates/cdk-tsc/runway.module.yml +++ b/runway/templates/cdk-tsc/runway.module.yml @@ -1,4 +1,3 @@ ---- options: build_steps: - npm run build diff --git a/runway/templates/k8s-cfn-repo/README.md b/runway/templates/k8s-cfn-repo/README.md index 6252ebb4d..020f0e6ca 100644 --- a/runway/templates/k8s-cfn-repo/README.md +++ b/runway/templates/k8s-cfn-repo/README.md @@ -22,7 +22,7 @@ This repo represents a sample infrastructure deployment of EKS, featuring: ### Deployment 1. Update the VPC-id & subnet ids in [runway.yml](./runway.yml) to reflect your VPC & private subnets. -2. Deploy to the **dev** environment (`runway deploy -e dev`). This will take some time to complete. +1. Deploy to the **dev** environment (`runway deploy -e dev`). This will take some time to complete. ### Post-Deployment diff --git a/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/auth_map.py b/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/auth_map.py index a90a85184..24880132c 100644 --- a/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/auth_map.py +++ b/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/auth_map.py @@ -5,7 +5,7 @@ import logging import os from pathlib import Path -from typing import TYPE_CHECKING, Any, List +from typing import TYPE_CHECKING, Any from runway.cfngin.lookups.handlers.output import OutputLookup @@ -37,8 +37,8 @@ def get_principal_arn(context: CfnginContext) -> str: def generate( - context: CfnginContext, *, filename: str, path: List[str], stack: str, **_: Any -): + context: CfnginContext, *, filename: str, path: list[str], stack: str, **_: Any +) -> bool: """Generate an EKS auth_map for worker connection. Args: @@ -53,25 +53,23 @@ def generate( """ overlay_path = Path(*path) file_path = overlay_path / filename - if os.path.exists(filename): + if os.path.exists(filename): # noqa: PTH110 LOGGER.info("%s file present; skipping initial creation", file_path) return True LOGGER.info("Creating auth_map at %s", file_path) overlay_path.mkdir(parents=True, exist_ok=True) principal_arn = get_principal_arn(context) - node_instancerole_arn = OutputLookup.handle( - f"{stack}::NodeInstanceRoleArn", context=context - ) + node_instancerole_arn = OutputLookup.handle(f"{stack}::NodeInstanceRoleArn", context=context) aws_authmap_template = (Path(__file__).parent / "aws-auth-cm.yaml").read_text() file_path.write_text( - aws_authmap_template.replace( - "INSTANCEROLEARNHERE", node_instancerole_arn - ).replace("ORIGINALPRINCIPALARNHERE", principal_arn) + aws_authmap_template.replace("INSTANCEROLEARNHERE", node_instancerole_arn).replace( + "ORIGINALPRINCIPALARNHERE", principal_arn + ) ) return True -def remove(*, path: List[str], filename: str, **_: Any) -> bool: +def remove(*, path: list[str], filename: str, **_: Any) -> bool: """Remove an EKS auth_map for worker connection. For use after destroying a cluster. diff --git a/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/aws-auth-cm.yaml b/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/aws-auth-cm.yaml index 3d9ecdaa8..d7a47b2bb 100644 --- a/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/aws-auth-cm.yaml +++ b/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/aws-auth-cm.yaml @@ -1,4 +1,3 @@ ---- apiVersion: v1 kind: ConfigMap metadata: diff --git a/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/awscli.py b/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/awscli.py index ae5da1c9d..b01b74ec6 100644 --- a/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/awscli.py +++ b/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/awscli.py @@ -22,6 +22,7 @@ def aws_eks_update_kubeconfig(context: CfnginContext, **kwargs: Any) -> bool: Args: context: Context object. + **kwargs: Arbitrary keyword arguments. Returns: boolean for whether or not the hook succeeded @@ -34,9 +35,7 @@ def aws_eks_update_kubeconfig(context: CfnginContext, **kwargs: Any) -> bool: f"{kwargs['stack']}::EksClusterName", context=context ) LOGGER.info("writing kubeconfig...") - subprocess.check_output( - ["aws", "eks", "update-kubeconfig", "--name", eks_cluster_name] - ) + subprocess.check_output(["aws", "eks", "update-kubeconfig", "--name", eks_cluster_name]) LOGGER.info("kubeconfig written successfully...") # The newly-generated kubeconfig will have introduced a dependency on the @@ -45,7 +44,7 @@ def aws_eks_update_kubeconfig(context: CfnginContext, **kwargs: Any) -> bool: if not os.environ.get("PIPENV_ACTIVE") and ( not os.environ.get("VIRTUAL_ENV") and not which("aws") ): - print("", file=sys.stderr) # noqa: T201 + print(file=sys.stderr) # noqa: T201 print( # noqa: T201 "Warning: the generated kubeconfig uses the aws-cli for " "authentication, but it is not found in your environment. ", diff --git a/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/bootstrap.py b/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/bootstrap.py index 2b5dc58fa..90b5ddbe3 100644 --- a/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/bootstrap.py +++ b/runway/templates/k8s-cfn-repo/k8s-master.cfn/k8s_hooks/bootstrap.py @@ -3,7 +3,6 @@ from __future__ import annotations import logging -import os import shutil from pathlib import Path from typing import TYPE_CHECKING, Any @@ -16,13 +15,13 @@ LOGGER = logging.getLogger(__name__) -def copy_template_to_env(path: Path, env: str, region: str): +def copy_template_to_env(path: Path, env: str, region: str) -> None: """Copy k8s module template into new environment directory.""" overlays_dir = path / "overlays" template_dir = overlays_dir / "template" env_dir = overlays_dir / env if template_dir.is_dir(): - if env_dir.is_dir() or (os.path.isdir(f"{env_dir}-{region}")): + if env_dir.is_dir() or (Path(f"{env_dir}-{region}").is_dir()): LOGGER.info( 'Bootstrap of k8s module at "%s" skipped; module ' "already has a config for this environment", @@ -30,7 +29,7 @@ def copy_template_to_env(path: Path, env: str, region: str): ) else: LOGGER.info( - 'Copying overlay template at "%s" to new ' 'environment directory "%s"', + 'Copying overlay template at "%s" to new environment directory "%s"', template_dir, env_dir, ) @@ -44,10 +43,8 @@ def copy_template_to_env(path: Path, env: str, region: str): templated_file_path = env_dir / i if templated_file_path.is_file(): filedata = templated_file_path.read_text() - if "REPLACEMEENV" in filedata: - templated_file_path.write_text( - filedata.replace("REPLACEMEENV", env) - ) + if "REPLACE_ME_ENV" in filedata: + templated_file_path.write_text(filedata.replace("REPLACE_ME_ENV", env)) else: LOGGER.info( 'Skipping bootstrap of k8s module at "%s"; no template directory present', @@ -55,7 +52,7 @@ def copy_template_to_env(path: Path, env: str, region: str): ) -def create_runway_environments(*, context: CfnginContext, namespace: str, **_: Any): +def create_runway_environments(*, context: CfnginContext, namespace: str, **_: Any) -> bool: """Copy k8s module templates into new environment directories. Args: @@ -65,9 +62,7 @@ def create_runway_environments(*, context: CfnginContext, namespace: str, **_: A Returns: boolean for whether or not the hook succeeded. """ - LOGGER.info( - "Bootstrapping runway k8s modules, looking for unconfigured environments..." - ) + LOGGER.info("Bootstrapping runway k8s modules, looking for unconfigured environments...") environment = namespace diff --git a/runway/templates/k8s-cfn-repo/k8s-workers.cfn/local_lookups/bootstrap_value.py b/runway/templates/k8s-cfn-repo/k8s-workers.cfn/local_lookups/bootstrap_value.py index 3157eda85..9b690c72e 100644 --- a/runway/templates/k8s-cfn-repo/k8s-workers.cfn/local_lookups/bootstrap_value.py +++ b/runway/templates/k8s-cfn-repo/k8s-workers.cfn/local_lookups/bootstrap_value.py @@ -40,7 +40,6 @@ class BootstrapValue(LookupHandler): """ - # pylint: disable=arguments-differ @classmethod def handle( # type: ignore cls, @@ -58,16 +57,12 @@ def handle( # type: ignore if not stack: raise ValueError(f"stack {query} not defined in CFNgin config") try: - stack_des = provider.cloudformation.describe_stacks(StackName=stack.fqn)[ - "Stacks" - ][0] + stack_des = provider.cloudformation.describe_stacks(StackName=stack.fqn)["Stacks"][0] except ClientError as exc: if "does not exist" not in str(exc): raise return args.bootstrap - if provider.is_stack_completed(stack_des) or ( - provider.is_stack_in_progress(stack_des) - ): + if provider.is_stack_completed(stack_des) or (provider.is_stack_in_progress(stack_des)): return args.post_bootstrap return args.bootstrap diff --git a/runway/templates/k8s-cfn-repo/runway.yml b/runway/templates/k8s-cfn-repo/runway.yml index 7a54edd11..37e3dc16e 100644 --- a/runway/templates/k8s-cfn-repo/runway.yml +++ b/runway/templates/k8s-cfn-repo/runway.yml @@ -1,4 +1,3 @@ ---- deployments: - modules: - name: EKS Cluster diff --git a/runway/templates/k8s-cfn-repo/service-hello-world.k8s/base/deployment.yaml b/runway/templates/k8s-cfn-repo/service-hello-world.k8s/base/deployment.yaml index 7b989ea0f..9b7068ef1 100644 --- a/runway/templates/k8s-cfn-repo/service-hello-world.k8s/base/deployment.yaml +++ b/runway/templates/k8s-cfn-repo/service-hello-world.k8s/base/deployment.yaml @@ -12,9 +12,7 @@ spec: containers: - name: the-container image: monopole/hello:1 - command: ["/hello", - "--port=8080", - "--enableRiskyFeature=$(ENABLE_RISKY)"] + command: ["/hello", "--port=8080", "--enableRiskyFeature=$(ENABLE_RISKY)"] ports: - containerPort: 8080 env: diff --git a/runway/templates/k8s-flux-repo/README.md b/runway/templates/k8s-flux-repo/README.md index e5527360c..6e4b60187 100644 --- a/runway/templates/k8s-flux-repo/README.md +++ b/runway/templates/k8s-flux-repo/README.md @@ -17,82 +17,82 @@ This repo represents a sample Terraform infrastructure deployment of EKS & Flux. 1. Update the `kubectl-access-role-arn` parameter in [runway.yml](./runway.yml) to specify the IAM role to which cluster admin access should be granted. E.g., if you assume an IAM role for operating in your account `aws sts get-caller-identity --query 'Arn' --output text` will show you the assumed role principal like: - ```text - arn:aws:sts::123456789012:assumed-role/myIamRole/guy.incognito - ``` + ```text + arn:aws:sts::123456789012:assumed-role/myIamRole/guy.incognito + ``` - You can use that arn to determine the IAM role arn for runway.yml: + You can use that arn to determine the IAM role arn for runway.yml: - ```yaml - deployments: - ... - - modules: - ... - parameters: - ... - kubectl-access-role-arn: arn:aws:iam::123456789012:role/myIamRole - ``` + ```yaml + deployments: + ... + - modules: + ... + parameters: + ... + kubectl-access-role-arn: arn:aws:iam::123456789012:role/myIamRole + ``` - (to use IAM users instead, see `mapUsers` in `eks-base.tf/main.tf`) + (to use IAM users instead, see `mapUsers` in `eks-base.tf/main.tf`) -2. After updating the role ARN, deploy to the dev environment (`runway deploy -e dev`). +1. After updating the role ARN, deploy to the dev environment (`runway deploy -e dev`). This will take some time to complete. - (Terraform will prompt for confirmation; pass the `--ci` flag to prevent any prompting) + (Terraform will prompt for confirmation; pass the `--ci` flag to prevent any prompting) #### Part 2: Pushing to the Flux repo 1. Setup and push an initial commit to the AWS CodeCommit git repository called `flux-dev`. - macOS/Linux: - - ```sh - CC_REPO_URL=https://git-codecommit.us-west-2.amazonaws.com/v1/repos/flux-dev - cd flux-dev - git init - git config credential."$CC_REPO_URL".helper '!aws codecommit credential-helper $@' - git config credential."$CC_REPO_URL".UseHttpPath true - git remote add origin $CC_REPO_URL - git add * - git commit -m "initial commit" - git push --set-upstream origin master - ``` - - Windows: - - ```powershell - cd $home - $CC_REPO_URL = "https://git-codecommit.us-west-2.amazonaws.com/v1/repos/flux-dev" - cd flux-dev - git init - git config credential."$CC_REPO_URL".helper '!aws codecommit credential-helper $@' - git config credential."$CC_REPO_URL".UseHttpPath true - git remote add origin $CC_REPO_URL - git add * - git commit -m "initial commit" - git push --set-upstream origin master - ``` - -2. [Wait 5 minutes](https://fluxcd.io/legacy/flux/faq/#how-often-does-flux-check-for-new-images)... - -3. The CodeCommit git repo will have a `flux` tag indicated the applied state of the repo and a namespace titled `demo` will appear in the cluster. - - macOS/Linux: - - ```sh - git ls-remote - cd .. - eval $(runway envvars -e dev) - runway kbenv run -- get namespace - ``` - - Windows: - - ```powershell - git ls-remote - cd .. - runway envvars -e dev | iex - runway kbenv run -- get namespace - ``` + macOS/Linux: + + ```sh + CC_REPO_URL=https://git-codecommit.us-west-2.amazonaws.com/v1/repos/flux-dev + cd flux-dev + git init + git config credential."$CC_REPO_URL".helper '!aws codecommit credential-helper $@' + git config credential."$CC_REPO_URL".UseHttpPath true + git remote add origin $CC_REPO_URL + git add * + git commit -m "initial commit" + git push --set-upstream origin master + ``` + + Windows: + + ```powershell + cd $home + $CC_REPO_URL = "https://git-codecommit.us-west-2.amazonaws.com/v1/repos/flux-dev" + cd flux-dev + git init + git config credential."$CC_REPO_URL".helper '!aws codecommit credential-helper $@' + git config credential."$CC_REPO_URL".UseHttpPath true + git remote add origin $CC_REPO_URL + git add * + git commit -m "initial commit" + git push --set-upstream origin master + ``` + +1. [Wait 5 minutes](https://fluxcd.io/legacy/flux/faq/#how-often-does-flux-check-for-new-images)... + +1. The CodeCommit git repo will have a `flux` tag indicated the applied state of the repo and a namespace titled `demo` will appear in the cluster. + + macOS/Linux: + + ```sh + git ls-remote + cd .. + eval $(runway envvars -e dev) + runway kbenv run -- get namespace + ``` + + Windows: + + ```powershell + git ls-remote + cd .. + runway envvars -e dev | iex + runway kbenv run -- get namespace + ``` ### Post-Deployment diff --git a/runway/templates/k8s-flux-repo/flux.tf/__init__.py b/runway/templates/k8s-flux-repo/flux.tf/__init__.py new file mode 100644 index 000000000..fe2653a60 --- /dev/null +++ b/runway/templates/k8s-flux-repo/flux.tf/__init__.py @@ -0,0 +1 @@ +"""Empty init file for python import traversal.""" diff --git a/runway/templates/k8s-flux-repo/runway.yml b/runway/templates/k8s-flux-repo/runway.yml index e59010f16..889db4afc 100644 --- a/runway/templates/k8s-flux-repo/runway.yml +++ b/runway/templates/k8s-flux-repo/runway.yml @@ -1,4 +1,3 @@ ---- deployments: - modules: - path: tfstate.cfn diff --git a/runway/templates/k8s-tf-repo/README.md b/runway/templates/k8s-tf-repo/README.md index 1613538de..c397f53c6 100644 --- a/runway/templates/k8s-tf-repo/README.md +++ b/runway/templates/k8s-tf-repo/README.md @@ -25,27 +25,27 @@ This repo represents a sample Terraform infrastructure deployment of EKS, featur 1. Update the `kubectl-access-role-arn` parameter in [runway.yml](./runway.yml) to specify the IAM role to which cluster admin access should be granted. E.g., if you assume an IAM role for operating in your account `aws sts get-caller-identity --query 'Arn' --output text` will show you the assumed role principal like: - ```text - arn:aws:sts::123456789012:assumed-role/myIamRole/guy.incognito - ``` + ```text + arn:aws:sts::123456789012:assumed-role/myIamRole/guy.incognito + ``` - You can use that arn to determine the IAM role arn for runway.yml: + You can use that arn to determine the IAM role arn for runway.yml: - ```yaml - deployments: - ... - - modules: - ... - parameters: - ... - kubectl-access-role-arn: arn:aws:iam::123456789012:role/myIamRole - ``` + ```yaml + deployments: + ... + - modules: + ... + parameters: + ... + kubectl-access-role-arn: arn:aws:iam::123456789012:role/myIamRole + ``` - (to use IAM users instead, see `mapUsers` in `eks-base.tf/main.tf`) + (to use IAM users instead, see `mapUsers` in `eks-base.tf/main.tf`) -2. After updating the role ARN, deploy to the dev environment (`runway deploy -e dev`). +1. After updating the role ARN, deploy to the dev environment (`runway deploy -e dev`). This will take some time to complete. - (Terraform will prompt twice for confirmation; pass the `--ci` flag to prevent any prompting) + (Terraform will prompt twice for confirmation; pass the `--ci` flag to prevent any prompting) ### Post-Deployment diff --git a/runway/templates/k8s-tf-repo/eks-base.tf/__init__.py b/runway/templates/k8s-tf-repo/eks-base.tf/__init__.py new file mode 100644 index 000000000..fe2653a60 --- /dev/null +++ b/runway/templates/k8s-tf-repo/eks-base.tf/__init__.py @@ -0,0 +1 @@ +"""Empty init file for python import traversal.""" diff --git a/runway/templates/k8s-tf-repo/job-s3-echo.tf/__init__.py b/runway/templates/k8s-tf-repo/job-s3-echo.tf/__init__.py new file mode 100644 index 000000000..fe2653a60 --- /dev/null +++ b/runway/templates/k8s-tf-repo/job-s3-echo.tf/__init__.py @@ -0,0 +1 @@ +"""Empty init file for python import traversal.""" diff --git a/runway/templates/k8s-tf-repo/runway.yml b/runway/templates/k8s-tf-repo/runway.yml index 907e58c8a..0f8a490cb 100644 --- a/runway/templates/k8s-tf-repo/runway.yml +++ b/runway/templates/k8s-tf-repo/runway.yml @@ -1,4 +1,3 @@ ---- deployments: - modules: - path: tfstate.cfn diff --git a/runway/templates/k8s-tf-repo/service-hello-world.k8s/base/deployment.yaml b/runway/templates/k8s-tf-repo/service-hello-world.k8s/base/deployment.yaml index 7b989ea0f..9b7068ef1 100644 --- a/runway/templates/k8s-tf-repo/service-hello-world.k8s/base/deployment.yaml +++ b/runway/templates/k8s-tf-repo/service-hello-world.k8s/base/deployment.yaml @@ -12,9 +12,7 @@ spec: containers: - name: the-container image: monopole/hello:1 - command: ["/hello", - "--port=8080", - "--enableRiskyFeature=$(ENABLE_RISKY)"] + command: ["/hello", "--port=8080", "--enableRiskyFeature=$(ENABLE_RISKY)"] ports: - containerPort: 8080 env: diff --git a/runway/templates/sls-py/__init__.py b/runway/templates/sls-py/__init__.py index a70847153..5d3447e99 100644 --- a/runway/templates/sls-py/__init__.py +++ b/runway/templates/sls-py/__init__.py @@ -1 +1 @@ -"""Empty file for python import traversal.""" # pylint: disable=all +"""Empty file for python import traversal.""" diff --git a/runway/templates/sls-py/config-dev-us-east-1.json b/runway/templates/sls-py/config-dev-us-east-1.json index 0db3279e4..0967ef424 100644 --- a/runway/templates/sls-py/config-dev-us-east-1.json +++ b/runway/templates/sls-py/config-dev-us-east-1.json @@ -1,3 +1 @@ -{ - -} +{} diff --git a/runway/templates/sls-py/hello_world/__init__.py b/runway/templates/sls-py/hello_world/__init__.py index bfa0de3db..9359fcc30 100644 --- a/runway/templates/sls-py/hello_world/__init__.py +++ b/runway/templates/sls-py/hello_world/__init__.py @@ -3,20 +3,16 @@ from __future__ import annotations import json -from typing import Any, Dict, Union +from typing import Any -# pylint: disable=unused-argument -def handler(event: Any, context: Any) -> Dict[str, Union[int, str]]: +def handler(event: Any, context: Any) -> dict[str, int | str]: # noqa: ARG001 """Return Serverless Hello World.""" body = { "message": "Go Serverless v1.0! Your function executed successfully!", "input": event, } - - response = {"statusCode": 200, "body": json.dumps(body)} - - return response + return {"statusCode": 200, "body": json.dumps(body)} # Use this code if you don't use the http event with the LAMBDA-PROXY # integration diff --git a/runway/templates/sls-py/package.json b/runway/templates/sls-py/package.json index 23ff2a5dc..48de1b12c 100644 --- a/runway/templates/sls-py/package.json +++ b/runway/templates/sls-py/package.json @@ -1,12 +1,12 @@ { - "name": "sampleapp", - "version": "1.0.0", + "author": "unused", "description": "Serverless Python app", "devDependencies": { "serverless": "^1.57.0", "serverless-iam-roles-per-function": "^2.0.2", "serverless-python-requirements": "^5.0.1" }, - "author": "unused", - "license": "unused" + "license": "unused", + "name": "sampleapp", + "version": "1.0.0" } diff --git a/runway/templates/sls-py/pyproject.toml b/runway/templates/sls-py/pyproject.toml index 5ebc3f6b2..c7702b999 100644 --- a/runway/templates/sls-py/pyproject.toml +++ b/runway/templates/sls-py/pyproject.toml @@ -1,18 +1,16 @@ [tool.poetry] name = "runway-sample-sls-py" version = "0.0.0" -description = "Runway Sample" authors = ["Onica Group LLC "] +description = "Runway Sample" license = "Apache-2.0" [tool.poetry.dependencies] python = "^3.9" - pyyaml = "^5.1" [tool.poetry.dev-dependencies] - [build-system] -requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" +requires = ["poetry-core>=1.0.0"] diff --git a/runway/templates/sls-tsc/package.json b/runway/templates/sls-tsc/package.json index a86b845c7..7103b454b 100644 --- a/runway/templates/sls-tsc/package.json +++ b/runway/templates/sls-tsc/package.json @@ -1,20 +1,9 @@ { - "name": "replaceme-myslsservice", - "version": "1.0.0", - "description": "Replace Me - My Serverless Service", - "main": "index.js", - "scripts": { - "docs": "typedoc", - "lint": "eslint src --ext .js,.jsx,.ts,.tsx", - "lintfix": "npm run lint -- --fix", - "test": "jest", - "coverage": "npm test -- --coverage" - }, "author": "", - "license": "ISC", "dependencies": { "source-map-support": "^0.5.19" }, + "description": "Replace Me - My Serverless Service", "devDependencies": { "@types/aws-lambda": "^8.10.66", "@types/jest": "^26.0.19", @@ -35,7 +24,18 @@ "typescript": "^4.1.3", "webpack": "^5.10.3" }, + "license": "ISC", + "main": "index.js", + "name": "replaceme-myslsservice", "prettier": { "trailingComma": "all" - } + }, + "scripts": { + "coverage": "npm test -- --coverage", + "docs": "typedoc", + "lint": "eslint src --ext .js,.jsx,.ts,.tsx", + "lintfix": "npm run lint -- --fix", + "test": "jest" + }, + "version": "1.0.0" } diff --git a/runway/templates/static-angular/runway.yml b/runway/templates/static-angular/runway.yml index 976d7d265..09d336f55 100644 --- a/runway/templates/static-angular/runway.yml +++ b/runway/templates/static-angular/runway.yml @@ -1,15 +1,15 @@ deployments: - modules: - - path: sampleapp.web - type: static - parameters: - namespace: sampleapp-${env DEPLOY_ENVIRONMENT} - staticsite_cf_disable: ${var cf_disable.${env DEPLOY_ENVIRONMENT}::default=false, transform=bool} - options: - build_output: dist/sample-app - build_steps: - - npm install - - npx ng build + - path: sampleapp.web + type: static + parameters: + namespace: sampleapp-${env DEPLOY_ENVIRONMENT} + staticsite_cf_disable: ${var cf_disable.${env DEPLOY_ENVIRONMENT}::default=false, transform=bool} + options: + build_output: dist/sample-app + build_steps: + - npm install + - npx ng build regions: - us-east-1 diff --git a/runway/templates/static-angular/sampleapp.web/angular.json b/runway/templates/static-angular/sampleapp.web/angular.json index 4efb6346e..df32f45c6 100644 --- a/runway/templates/static-angular/sampleapp.web/angular.json +++ b/runway/templates/static-angular/sampleapp.web/angular.json @@ -1,74 +1,70 @@ { "$schema": "./node_modules/@angular/cli/lib/config/schema.json", - "version": 1, + "defaultProject": "sample-app", "newProjectRoot": "projects", "projects": { "sample-app": { - "projectType": "application", - "schematics": {}, - "root": "", - "sourceRoot": "src", - "prefix": "app", "architect": { "build": { "builder": "@angular-devkit/build-angular:browser", - "options": { - "outputPath": "dist/sample-app", - "index": "src/index.html", - "main": "src/main.ts", - "polyfills": "src/polyfills.ts", - "tsConfig": "tsconfig.app.json", - "aot": false, - "assets": [ - "src/favicon.ico", - "src/assets" - ], - "styles": [ - "src/styles.css" - ], - "scripts": [] - }, "configurations": { "production": { + "aot": true, + "budgets": [ + { + "maximumError": "5mb", + "maximumWarning": "2mb", + "type": "initial" + }, + { + "maximumError": "10kb", + "maximumWarning": "6kb", + "type": "anyComponentStyle" + } + ], + "buildOptimizer": true, + "extractCss": true, + "extractLicenses": true, "fileReplacements": [ { "replace": "src/environments/environment.ts", "with": "src/environments/environment.prod.ts" } ], + "namedChunks": false, "optimization": true, "outputHashing": "all", "sourceMap": false, - "extractCss": true, - "namedChunks": false, - "aot": true, - "extractLicenses": true, - "vendorChunk": false, - "buildOptimizer": true, - "budgets": [ - { - "type": "initial", - "maximumWarning": "2mb", - "maximumError": "5mb" - }, - { - "type": "anyComponentStyle", - "maximumWarning": "6kb", - "maximumError": "10kb" - } - ] + "vendorChunk": false } + }, + "options": { + "aot": false, + "assets": [ + "src/favicon.ico", + "src/assets" + ], + "index": "src/index.html", + "main": "src/main.ts", + "outputPath": "dist/sample-app", + "polyfills": "src/polyfills.ts", + "scripts": [], + "styles": [ + "src/styles.css" + ], + "tsConfig": "tsconfig.app.json" } }, - "serve": { - "builder": "@angular-devkit/build-angular:dev-server", - "options": { - "browserTarget": "sample-app:build" - }, + "e2e": { + "builder": "@angular-devkit/build-angular:protractor", "configurations": { "production": { - "browserTarget": "sample-app:build:production" + "devServerTarget": "sample-app:serve:production" } + }, + "options": { + "devServerTarget": "sample-app:serve", + "protractorConfig": "e2e/protractor.conf.js" } }, "extract-i18n": { @@ -77,49 +73,54 @@ "browserTarget": "sample-app:build" } }, - "test": { - "builder": "@angular-devkit/build-angular:karma", - "options": { - "main": "src/test.ts", - "polyfills": "src/polyfills.ts", - "tsConfig": "tsconfig.spec.json", - "karmaConfig": "karma.conf.js", - "assets": [ - "src/favicon.ico", - "src/assets" - ], - "styles": [ - "src/styles.css" - ], - "scripts": [] - } - }, "lint": { "builder": "@angular-devkit/build-angular:tslint", "options": { + "exclude": [ + "**/node_modules/**" + ], "tsConfig": [ "tsconfig.app.json", "tsconfig.spec.json", "e2e/tsconfig.json" - ], - "exclude": [ - "**/node_modules/**" ] } }, - "e2e": { - "builder": "@angular-devkit/build-angular:protractor", - "options": { - "protractorConfig": "e2e/protractor.conf.js", - "devServerTarget": "sample-app:serve" - }, + "serve": { + "builder": "@angular-devkit/build-angular:dev-server", "configurations": { "production": { - "devServerTarget": "sample-app:serve:production" + "browserTarget": "sample-app:build:production" } + }, + "options": { + "browserTarget": "sample-app:build" + } + }, + "test": { + "builder": "@angular-devkit/build-angular:karma", + "options": { + "assets": [ + "src/favicon.ico", + "src/assets" + ], + "karmaConfig": "karma.conf.js", + "main": "src/test.ts", + "polyfills": "src/polyfills.ts", + "scripts": [], + "styles": [ + "src/styles.css" + ], + "tsConfig": "tsconfig.spec.json" } } - } - }}, - "defaultProject": "sample-app" + }, + "prefix": "app", + "projectType": "application", + "root": "", + "schematics": {}, + "sourceRoot": "src" + } + }, + "version": 1 } diff --git a/runway/templates/static-angular/sampleapp.web/package.json b/runway/templates/static-angular/sampleapp.web/package.json index 98b874fb4..0e1f54867 100644 --- a/runway/templates/static-angular/sampleapp.web/package.json +++ b/runway/templates/static-angular/sampleapp.web/package.json @@ -1,15 +1,4 @@ { - "name": "sample-app", - "version": "0.0.0", - "scripts": { - "ng": "ng", - "start": "ng serve", - "build": "ng build", - "test": "ng test", - "lint": "ng lint", - "e2e": "ng e2e" - }, - "private": true, "dependencies": { "@angular/animations": "~8.2.11", "@angular/common": "~8.2.11", @@ -28,9 +17,9 @@ "@angular/cli": "~15.2.4", "@angular/compiler-cli": "~18.0.2", "@angular/language-service": "~8.2.11", - "@types/node": "~8.9.4", "@types/jasmine": "~3.3.8", "@types/jasminewd2": "~2.0.3", + "@types/node": "~8.9.4", "codelyzer": "^5.0.0", "jasmine-core": "~3.4.0", "jasmine-spec-reporter": "~4.2.1", @@ -43,5 +32,16 @@ "ts-node": "~7.0.0", "tslint": "~5.15.0", "typescript": "~3.5.3" - } + }, + "name": "sample-app", + "private": true, + "scripts": { + "build": "ng build", + "e2e": "ng e2e", + "lint": "ng lint", + "ng": "ng", + "start": "ng serve", + "test": "ng test" + }, + "version": "0.0.0" } diff --git a/runway/templates/static-angular/sampleapp.web/tsconfig.app.json b/runway/templates/static-angular/sampleapp.web/tsconfig.app.json index 565a11a21..69edc4a83 100644 --- a/runway/templates/static-angular/sampleapp.web/tsconfig.app.json +++ b/runway/templates/static-angular/sampleapp.web/tsconfig.app.json @@ -1,18 +1,18 @@ { - "extends": "./tsconfig.json", - "compilerOptions": { - "outDir": "./out-tsc/app", - "types": [] - }, - "files": [ - "src/main.ts", - "src/polyfills.ts" - ], - "include": [ - "src/**/*.ts" - ], - "exclude": [ - "src/test.ts", - "src/**/*.spec.ts" - ] + "compilerOptions": { + "outDir": "./out-tsc/app", + "types": [] + }, + "exclude": [ + "src/test.ts", + "src/**/*.spec.ts" + ], + "extends": "./tsconfig.json", + "files": [ + "src/main.ts", + "src/polyfills.ts" + ], + "include": [ + "src/**/*.ts" + ] } diff --git a/runway/templates/static-angular/sampleapp.web/tsconfig.spec.json b/runway/templates/static-angular/sampleapp.web/tsconfig.spec.json index 6400fde7d..95793f6ec 100644 --- a/runway/templates/static-angular/sampleapp.web/tsconfig.spec.json +++ b/runway/templates/static-angular/sampleapp.web/tsconfig.spec.json @@ -1,5 +1,4 @@ { - "extends": "./tsconfig.json", "compilerOptions": { "outDir": "./out-tsc/spec", "types": [ @@ -7,6 +6,7 @@ "node" ] }, + "extends": "./tsconfig.json", "files": [ "src/test.ts", "src/polyfills.ts" diff --git a/runway/templates/static-react/runway.yml b/runway/templates/static-react/runway.yml index 439b2a0fa..de51c4e98 100644 --- a/runway/templates/static-react/runway.yml +++ b/runway/templates/static-react/runway.yml @@ -1,15 +1,15 @@ deployments: - modules: - - path: sampleapp.web - type: static - parameters: - namespace: sampleapp-${env DEPLOY_ENVIRONMENT} - staticsite_cf_disable: ${var cf_disable.${env DEPLOY_ENVIRONMENT}::default=false, transform=bool} - options: - build_output: build - build_steps: - - npm install - - npm run build + - path: sampleapp.web + type: static + parameters: + namespace: sampleapp-${env DEPLOY_ENVIRONMENT} + staticsite_cf_disable: ${var cf_disable.${env DEPLOY_ENVIRONMENT}::default=false, transform=bool} + options: + build_output: build + build_steps: + - npm install + - npm run build regions: - us-east-1 diff --git a/runway/templates/static-react/sampleapp.web/package.json b/runway/templates/static-react/sampleapp.web/package.json index 10b8ff226..b514bed7f 100644 --- a/runway/templates/static-react/sampleapp.web/package.json +++ b/runway/templates/static-react/sampleapp.web/package.json @@ -1,7 +1,16 @@ { - "name": "sample-app", - "version": "0.1.0", - "private": true, + "browserslist": { + "development": [ + "last 1 chrome version", + "last 1 firefox version", + "last 1 safari version" + ], + "production": [ + ">0.2%", + "not dead", + "not op_mini all" + ] + }, "dependencies": { "@testing-library/jest-dom": "^4.2.4", "@testing-library/react": "^9.5.0", @@ -10,25 +19,16 @@ "react-dom": "^16.13.1", "react-scripts": "3.4.1" }, - "scripts": { - "start": "react-scripts start", - "build": "react-scripts build", - "test": "react-scripts test", - "eject": "react-scripts eject" - }, "eslintConfig": { "extends": "react-app" }, - "browserslist": { - "production": [ - ">0.2%", - "not dead", - "not op_mini all" - ], - "development": [ - "last 1 chrome version", - "last 1 firefox version", - "last 1 safari version" - ] - } + "name": "sample-app", + "private": true, + "scripts": { + "build": "react-scripts build", + "eject": "react-scripts eject", + "start": "react-scripts start", + "test": "react-scripts test" + }, + "version": "0.1.0" } diff --git a/runway/templates/static-react/sampleapp.web/public/manifest.json b/runway/templates/static-react/sampleapp.web/public/manifest.json index 080d6c77a..40bd3d842 100644 --- a/runway/templates/static-react/sampleapp.web/public/manifest.json +++ b/runway/templates/static-react/sampleapp.web/public/manifest.json @@ -1,25 +1,25 @@ { - "short_name": "React App", - "name": "Create React App Sample", - "icons": [ - { - "src": "favicon.ico", - "sizes": "64x64 32x32 24x24 16x16", - "type": "image/x-icon" - }, - { - "src": "logo192.png", - "type": "image/png", - "sizes": "192x192" - }, - { - "src": "logo512.png", - "type": "image/png", - "sizes": "512x512" - } - ], - "start_url": ".", - "display": "standalone", - "theme_color": "#000000", - "background_color": "#ffffff" + "background_color": "#ffffff", + "display": "standalone", + "icons": [ + { + "sizes": "64x64 32x32 24x24 16x16", + "src": "favicon.ico", + "type": "image/x-icon" + }, + { + "sizes": "192x192", + "src": "logo192.png", + "type": "image/png" + }, + { + "sizes": "512x512", + "src": "logo512.png", + "type": "image/png" + } + ], + "name": "Create React App Sample", + "short_name": "React App", + "start_url": ".", + "theme_color": "#000000" } diff --git a/runway/tests/handlers/base.py b/runway/tests/handlers/base.py index 965facfbf..014785955 100644 --- a/runway/tests/handlers/base.py +++ b/runway/tests/handlers/base.py @@ -3,7 +3,7 @@ from __future__ import annotations import os -from typing import TYPE_CHECKING, Any, Dict, List, Union +from typing import TYPE_CHECKING, Any if TYPE_CHECKING: from ...config.components.runway.base import ConfigProperty @@ -13,12 +13,12 @@ class TestHandler: """Base class for test handlers.""" @classmethod - def handle(cls, name: str, args: Union[ConfigProperty, Dict[str, Any]]) -> None: + def handle(cls, name: str, args: ConfigProperty | dict[str, Any]) -> None: """Redefine in subclass.""" - raise NotImplementedError() + raise NotImplementedError @staticmethod - def get_dirs(provided_path: str) -> List[str]: + def get_dirs(provided_path: str) -> list[str]: """Return list of directories.""" repo_dirs = next(os.walk(provided_path))[1] if ".git" in repo_dirs: diff --git a/runway/tests/handlers/cfn_lint.py b/runway/tests/handlers/cfn_lint.py index 57b3e7f00..5a53dbd4a 100644 --- a/runway/tests/handlers/cfn_lint.py +++ b/runway/tests/handlers/cfn_lint.py @@ -7,7 +7,7 @@ import runpy import sys from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, Union +from typing import TYPE_CHECKING, Any import yaml @@ -26,7 +26,7 @@ class CfnLintHandler(TestHandler): """Lints CFN.""" @classmethod - def handle(cls, name: str, args: Union[ConfigProperty, Dict[str, Any]]) -> None: + def handle(cls, name: str, args: ConfigProperty | dict[str, Any]) -> None: """Perform the actual test. Relies on .cfnlintrc file to be located beside the Runway config file. @@ -42,7 +42,7 @@ def handle(cls, name: str, args: Union[ConfigProperty, Dict[str, Any]]) -> None: # prevent duplicate log messages by not passing to the root logger logging.getLogger("cfnlint").propagate = False try: - with argv(*["cfn-lint"] + args.get("cli_args", [])): + with argv(*["cfn-lint", *args.get("cli_args", [])]): runpy.run_module("cfnlint", run_name="__main__") except SystemExit as err: # this call will always result in SystemExit if err.code != 0: # ignore zero exit codes but re-raise for non-zero diff --git a/runway/tests/handlers/script.py b/runway/tests/handlers/script.py index fcbc22b31..445a03613 100644 --- a/runway/tests/handlers/script.py +++ b/runway/tests/handlers/script.py @@ -6,7 +6,7 @@ import subprocess import sys from subprocess import CalledProcessError -from typing import TYPE_CHECKING, Any, Dict, Union +from typing import TYPE_CHECKING, Any from ..._logging import PrefixAdaptor from ...tests.handlers.base import TestHandler @@ -22,7 +22,7 @@ class ScriptHandler(TestHandler): """Handle script tests. Args: - commands (List[str]): A list of commands to be executed in order. + commands: A list of commands to be executed in order. Each command is run in its own subprocess. The working directory will be the same as where the 'runway test' command was executed. @@ -40,7 +40,7 @@ class ScriptHandler(TestHandler): """ @classmethod - def handle(cls, name: str, args: Union[ConfigProperty, Dict[str, Any]]) -> None: + def handle(cls, name: str, args: ConfigProperty | dict[str, Any]) -> None: """Perform the actual test.""" logger = PrefixAdaptor(name, LOGGER) for cmd in args["commands"]: diff --git a/runway/tests/handlers/yaml_lint.py b/runway/tests/handlers/yaml_lint.py index 0f632891d..0bd4c4403 100644 --- a/runway/tests/handlers/yaml_lint.py +++ b/runway/tests/handlers/yaml_lint.py @@ -7,7 +7,7 @@ import logging import os import runpy -from typing import TYPE_CHECKING, Any, Dict, List, Union +from typing import TYPE_CHECKING, Any from ...tests.handlers.base import TestHandler from ...utils import argv @@ -23,32 +23,34 @@ class YamllintHandler(TestHandler): """Lints yaml.""" @staticmethod - def get_yaml_files_at_path(provided_path: str) -> List[str]: + def get_yaml_files_at_path(provided_path: str) -> list[str]: """Return list of yaml files.""" - yaml_files = glob.glob(os.path.join(provided_path, "*.yaml")) - yml_files = glob.glob(os.path.join(provided_path, "*.yml")) + yaml_files = glob.glob(os.path.join(provided_path, "*.yaml")) # noqa: PTH207, PTH118 + yml_files = glob.glob(os.path.join(provided_path, "*.yml")) # noqa: PTH118, PTH207 return yaml_files + yml_files @classmethod - def get_yamllint_options(cls, path: str) -> List[str]: + def get_yamllint_options(cls, path: str) -> list[str]: """Return yamllint option list.""" - yamllint_options: List[str] = [] + yamllint_options: list[str] = [] return yamllint_options + cls.get_dirs(path) + cls.get_yaml_files_at_path(path) @classmethod - def handle(cls, name: str, args: Union[ConfigProperty, Dict[str, Any]]) -> None: + def handle(cls, name: str, args: ConfigProperty | dict[str, Any]) -> None: # noqa: ARG003 """Perform the actual test.""" - base_dir = os.getcwd() + base_dir = os.getcwd() # noqa: PTH109 - if os.path.isfile(os.path.join(base_dir, ".yamllint")): - yamllint_config = os.path.join(base_dir, ".yamllint") - elif os.path.isfile(os.path.join(base_dir, ".yamllint.yml")): - yamllint_config = os.path.join(base_dir, ".yamllint.yml") + if os.path.isfile(os.path.join(base_dir, ".yamllint")): # noqa: PTH118, PTH113 + yamllint_config = os.path.join(base_dir, ".yamllint") # noqa: PTH118 + elif os.path.isfile(os.path.join(base_dir, ".yamllint.yml")): # noqa: PTH113, PTH118 + yamllint_config = os.path.join(base_dir, ".yamllint.yml") # noqa: PTH118 else: - yamllint_config = os.path.join( - os.path.dirname( - os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + yamllint_config = os.path.join( # noqa: PTH118 + os.path.dirname( # noqa: PTH120 + os.path.dirname( # noqa: PTH120 + os.path.dirname(os.path.abspath(__file__)) # noqa: PTH120, PTH100 + ) ), "templates", ".yamllint.yml", @@ -59,5 +61,5 @@ def handle(cls, name: str, args: Union[ConfigProperty, Dict[str, Any]]) -> None: *cls.get_yamllint_options(base_dir), ] - with argv(*["yamllint"] + yamllint_options): + with argv(*["yamllint", *yamllint_options]): runpy.run_module("yamllint", run_name="__main__") diff --git a/runway/tests/registry.py b/runway/tests/registry.py index a33f5556e..66796e7a7 100644 --- a/runway/tests/registry.py +++ b/runway/tests/registry.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Dict, Type +from typing import TYPE_CHECKING from .handlers import cfn_lint, script from .handlers import yaml_lint as yamllint @@ -10,10 +10,10 @@ if TYPE_CHECKING: from .handlers.base import TestHandler -TEST_HANDLERS: Dict[str, Type[TestHandler]] = {} +TEST_HANDLERS: dict[str, type[TestHandler]] = {} -def register_test_handler(test_type: str, handler: Type[TestHandler]) -> None: +def register_test_handler(test_type: str, handler: type[TestHandler]) -> None: """Register a test handler. Args: diff --git a/runway/utils/__init__.py b/runway/utils/__init__.py index e62a2f4e1..a70560561 100644 --- a/runway/utils/__init__.py +++ b/runway/utils/__init__.py @@ -12,39 +12,16 @@ import re import stat import sys -from contextlib import contextmanager +from collections.abc import Iterable, Iterator, MutableMapping +from contextlib import AbstractContextManager, contextmanager from decimal import Decimal +from functools import cached_property # noqa: F401 # TODO (kyle): remove in next major release from pathlib import Path from subprocess import check_call -from types import TracebackType -from typing import ( - ContextManager, # deprecated in 3.9 for contextlib.AbstractContextManager -) -from typing import ( - MutableMapping, # deprecated in 3.9 for collections.abc.MutableMapping -) -from typing import ( - TYPE_CHECKING, - Any, - Callable, - Dict, - Iterable, - Iterator, - List, - Optional, - Set, - Type, - Union, - cast, - overload, -) +from typing import TYPE_CHECKING, Any, Callable, cast, overload import yaml from pydantic import BaseModel as _BaseModel -from typing_extensions import Literal - -# make this importable for util as it was before -from ..compat import cached_property # noqa: F401 # make this importable without defining __all__ yet. # more things need to be moved of this file before starting an explicit __all__. @@ -52,11 +29,16 @@ from ._version import Version # noqa: F401 if TYPE_CHECKING: + from types import TracebackType + from mypy_boto3_cloudformation.type_defs import OutputTypeDef + from typing_extensions import Literal + + from ..compat import Self AWS_ENV_VARS = ("AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN") DOC_SITE = "https://docs.onica.com/projects/runway" -EMBEDDED_LIB_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), "embedded") +EMBEDDED_LIB_PATH = str(Path(__file__).resolve().parent / "embedded") LOGGER = logging.getLogger(__name__) @@ -167,13 +149,13 @@ def __init__(self, **kwargs: Any) -> None: self._found_queries = MutableMap() @property - def data(self) -> Dict[str, Any]: + def data(self) -> dict[str, Any]: """Sanitized output of __dict__. Removes anything that starts with ``_``. """ - result: Dict[str, Any] = {} + result: dict[str, Any] = {} for key, val in self.__dict__.items(): if key.startswith("_"): continue @@ -182,7 +164,7 @@ def data(self) -> Dict[str, Any]: def clear_found_cache(self) -> None: """Clear _found_cache.""" - for _, val in self.__dict__.items(): + for val in self.__dict__.values(): if isinstance(val, MutableMap): val.clear_found_cache() if hasattr(self, "_found_queries"): @@ -350,20 +332,19 @@ def __str__(self) -> str: return json.dumps(self.data, default=json_serial) -class SafeHaven(ContextManager["SafeHaven"]): +class SafeHaven(AbstractContextManager["SafeHaven"]): """Context manager that caches and resets important values on exit. Caches and resets os.environ, sys.argv, sys.modules, and sys.path. """ - # pylint: disable=redefined-outer-name def __init__( self, - argv: Optional[Iterable[str]] = None, - environ: Optional[Dict[str, str]] = None, - sys_modules_exclude: Optional[Iterable[str]] = None, - sys_path: Optional[Iterable[str]] = None, + argv: Iterable[str] | None = None, + environ: dict[str, str] | None = None, + sys_modules_exclude: Iterable[str] | None = None, + sys_path: Iterable[str] | None = None, ) -> None: """Instantiate class. @@ -385,7 +366,7 @@ def __init__( self.__sys_path = list(sys.path) # more informative origin for log statements self.logger = logging.getLogger("runway." + self.__class__.__name__) - self.sys_modules_exclude: Set[str] = ( + self.sys_modules_exclude: set[str] = ( set(sys_modules_exclude) if sys_modules_exclude else set() ) self.sys_modules_exclude.add("runway") @@ -434,7 +415,7 @@ def reset_sys_path(self) -> None: self.logger.debug("resetting sys.path: %s", json.dumps(self.__sys_path)) sys.path = self.__sys_path - def __enter__(self) -> SafeHaven: + def __enter__(self) -> Self: """Enter the context manager. Returns: @@ -446,16 +427,16 @@ def __enter__(self) -> SafeHaven: def __exit__( self, - exc_type: Optional[Type[BaseException]], - exc_value: Optional[BaseException], - traceback: Optional[TracebackType], + exc_type: type[BaseException] | None, + exc_value: BaseException | None, + traceback: TracebackType | None, ) -> None: """Exit the context manager.""" self.logger.debug("leaving the safe haven...") self.reset_all() -# TODO remove after https://github.com/yaml/pyyaml/issues/234 is resolved +# TODO (kyle): remove after https://github.com/yaml/pyyaml/issues/234 is resolved class YamlDumper(yaml.Dumper): """Custom YAML Dumper. @@ -472,7 +453,7 @@ class YamlDumper(yaml.Dumper): """ - def increase_indent(self, flow: bool = False, indentless: bool = False) -> None: + def increase_indent(self, flow: bool = False, indentless: bool = False) -> None: # noqa: ARG002 """Override parent method.""" return super().increase_indent(flow, False) # type: ignore @@ -490,7 +471,7 @@ def argv(*args: str) -> Iterator[None]: @contextmanager -def change_dir(newdir: Union[Path, str]) -> Iterator[None]: +def change_dir(newdir: Path | str) -> Iterator[None]: """Change directory. Adapted from http://stackoverflow.com/a/24176022 @@ -519,9 +500,7 @@ def ensure_file_is_executable(path: str) -> None: SystemExit: file is not executable. """ - if platform.system() != "Windows" and ( - not stat.S_IXUSR & os.stat(path)[stat.ST_MODE] - ): + if platform.system() != "Windows" and (not stat.S_IXUSR & Path(path).stat()[stat.ST_MODE]): print(f"Error: File {path} is not executable") # noqa: T201 sys.exit(1) @@ -536,13 +515,14 @@ def ensure_string(value: Any) -> str: @contextmanager -def environ(env: Optional[Dict[str, str]] = None, **kwargs: str) -> Iterator[None]: +def environ(env: dict[str, str] | None = None, **kwargs: str) -> Iterator[None]: """Context manager for temporarily changing os.environ. The original value of os.environ is restored upon exit. Args: env: Dictionary to use when updating os.environ. + **kwargs: Arbitrary keyword arguments. """ env = env or {} @@ -566,9 +546,7 @@ def json_serial(obj: Any) -> Any: raise TypeError(f"Type {type(obj)} not serializable") -def load_object_from_string( - fqcn: str, try_reload: bool = False -) -> Union[type, Callable[..., Any]]: +def load_object_from_string(fqcn: str, try_reload: bool = False) -> type | Callable[..., Any]: """Convert "." delimited strings to a python object. Args: @@ -595,8 +573,7 @@ def load_object_from_string( if ( try_reload and sys.modules.get(module_path) - and module_path.split(".")[0] - not in sys.builtin_module_names # skip builtins + and module_path.split(".")[0] not in sys.builtin_module_names # skip builtins ): importlib.reload(sys.modules[module_path]) else: @@ -606,21 +583,19 @@ def load_object_from_string( @overload def merge_dicts( - dict1: Dict[Any, Any], dict2: Dict[Any, Any], deep_merge: bool = ... -) -> Dict[str, Any]: ... + dict1: dict[Any, Any], dict2: dict[Any, Any], deep_merge: bool = ... +) -> dict[str, Any]: ... @overload -def merge_dicts( - dict1: List[Any], dict2: List[Any], deep_merge: bool = ... -) -> List[Any]: ... +def merge_dicts(dict1: list[Any], dict2: list[Any], deep_merge: bool = ...) -> list[Any]: ... def merge_dicts( - dict1: Union[Dict[Any, Any], List[Any]], - dict2: Union[Dict[Any, Any], List[Any]], + dict1: dict[Any, Any] | list[Any], + dict2: dict[Any, Any] | list[Any], deep_merge: bool = True, -) -> Union[Dict[Any, Any], List[Any]]: +) -> dict[Any, Any] | list[Any]: """Merge dict2 into dict1.""" if deep_merge: if isinstance(dict1, list) and isinstance(dict2, list): @@ -630,19 +605,13 @@ def merge_dicts( return dict2 for key in dict2: - dict1[key] = ( - merge_dicts(dict1[key], dict2[key], True) - if key in dict1 - else dict2[key] - ) + dict1[key] = merge_dicts(dict1[key], dict2[key], True) if key in dict1 else dict2[key] return dict1 if isinstance(dict1, dict) and isinstance(dict2, dict): dict3 = dict1.copy() dict3.update(dict2) return dict3 - raise ValueError( - f"values of type {type(dict1)} and {type(dict2)} must be type dict" - ) + raise ValueError(f"values of type {type(dict1)} and {type(dict2)} must be type dict") def snake_case_to_kebab_case(value: str) -> str: @@ -655,7 +624,7 @@ def snake_case_to_kebab_case(value: str) -> str: return value.replace("_", "-") -def extract_boto_args_from_env(env_vars: Dict[str, str]) -> Dict[str, str]: +def extract_boto_args_from_env(env_vars: dict[str, str]) -> dict[str, str]: """Return boto3 client args dict with environment creds.""" return { i: env_vars[i.upper()] @@ -664,27 +633,25 @@ def extract_boto_args_from_env(env_vars: Dict[str, str]) -> Dict[str, str]: } -def flatten_path_lists( - env_dict: Dict[str, Any], env_root: Optional[str] = None -) -> Dict[str, Any]: +def flatten_path_lists(env_dict: dict[str, Any], env_root: str | None = None) -> dict[str, Any]: """Join paths in environment dict down to strings.""" for key, val in env_dict.items(): # Lists are presumed to be path components and will be turned back # to strings if isinstance(val, list): env_dict[key] = ( - os.path.join(env_root, os.path.join(*cast(List[str], val))) - if (env_root and not os.path.isabs(os.path.join(*cast(List[str], val)))) - else os.path.join(*cast(List[str], val)) + Path(env_root).joinpath(*cast("list[str]", val)) + if (env_root and not Path(*cast("list[str]", val)).is_absolute()) + else Path(*cast("list[str]", val)) ) return env_dict def merge_nested_environment_dicts( - env_dicts: Dict[str, Any], - env_name: Optional[str] = None, - env_root: Optional[str] = None, -) -> Dict[str, Any]: + env_dicts: dict[str, Any], + env_name: str | None = None, + env_root: str | None = None, +) -> dict[str, Any]: """Return single-level dictionary from dictionary of dictionaries.""" # If the provided dictionary is just a single "level" (no nested # environments), it applies to all environments @@ -700,13 +667,13 @@ def merge_nested_environment_dicts( return {} combined_dicts = merge_dicts( - cast(Dict[Any, Any], env_dicts.get("*", {})), - cast(Dict[Any, Any], env_dicts.get(env_name, {})), + cast("dict[Any, Any]", env_dicts.get("*", {})), + cast("dict[Any, Any]", env_dicts.get(env_name, {})), ) return flatten_path_lists(combined_dicts, env_root) -def find_cfn_output(key: str, outputs: List[OutputTypeDef]) -> Optional[str]: +def find_cfn_output(key: str, outputs: list[OutputTypeDef]) -> str | None: """Return CFN output value. Args: @@ -722,13 +689,13 @@ def find_cfn_output(key: str, outputs: List[OutputTypeDef]) -> Optional[str]: def get_embedded_lib_path() -> str: """Return path of embedded libraries.""" - return os.path.join(os.path.dirname(os.path.abspath(__file__)), "embedded") + return str(Path(__file__).resolve().parent / "embedded") def get_hash_for_filename(filename: str, hashfile_path: str) -> str: """Return hash for filename in the hashfile.""" filehash = "" - with open(hashfile_path, "r", encoding="utf-8") as stream: + with open(hashfile_path, encoding="utf-8") as stream: # noqa: PTH123 for _cnt, line in enumerate(stream): if line.rstrip().endswith(filename): match = re.match(r"^[A-Za-z0-9]*", line) @@ -750,7 +717,7 @@ def ignore_exit_code_0() -> Iterator[None]: raise -def fix_windows_command_list(commands: List[str]) -> List[str]: +def fix_windows_command_list(commands: list[str]) -> list[str]: """Return command list with working Windows commands. npm on windows is npm.cmd, which will blow up @@ -762,16 +729,17 @@ def fix_windows_command_list(commands: List[str]) -> List[str]: """ fully_qualified_cmd_path = which(commands[0]) if fully_qualified_cmd_path: - commands[0] = os.path.basename(fully_qualified_cmd_path) + commands[0] = Path(fully_qualified_cmd_path).name return commands def run_commands( - commands: List[Union[str, List[str], Dict[str, Union[str, List[str]]]]], - directory: Union[Path, str], - env: Optional[Dict[str, str]] = None, + commands: list[dict[str, list[str] | str] | list[str] | str], + directory: Path | str, + env: dict[str, str] | None = None, ) -> None: """Run list of commands.""" + directory = Path(directory) if env is None: env = os.environ.copy() for step in commands: @@ -780,16 +748,12 @@ def run_commands( raw_command = step elif step.get("command"): # dictionary execution_dir = ( - os.path.join(directory, cast(str, step.get("cwd", ""))) - if step.get("cwd") - else directory + directory / str(step["cwd"]) if step.get("cwd") and step["cwd"] else directory ) raw_command = step["command"] else: raise AttributeError(f"Invalid command step: {step}") - command_list = ( - raw_command.split(" ") if isinstance(raw_command, str) else raw_command - ) + command_list = raw_command.split(" ") if isinstance(raw_command, str) else raw_command if platform.system().lower() == "windows": command_list = fix_windows_command_list(command_list) @@ -835,7 +799,7 @@ def get_file_hash( __name__, ) file_hash = getattr(hashlib, algorithm)() - with open(filename, "rb") as stream: + with open(filename, "rb") as stream: # noqa: PTH123 while True: data = stream.read(65536) # 64kb chunks if not data: @@ -870,7 +834,7 @@ def sha256sum(filename: str) -> str: __name__, ) sha256 = hashlib.sha256() - with open(filename, "rb", buffering=0) as stream: + with open(filename, "rb", buffering=0) as stream: # noqa: PTH123 mem_view = memoryview(bytearray(128 * 1024)) for i in iter(lambda: stream.readinto(mem_view), 0): sha256.update(mem_view[:i]) @@ -878,7 +842,7 @@ def sha256sum(filename: str) -> str: @contextmanager -def use_embedded_pkgs(embedded_lib_path: Optional[str] = None) -> Iterator[None]: +def use_embedded_pkgs(embedded_lib_path: str | None = None) -> Iterator[None]: """Temporarily prepend embedded packages to sys.path.""" if embedded_lib_path is None: embedded_lib_path = get_embedded_lib_path() @@ -891,14 +855,14 @@ def use_embedded_pkgs(embedded_lib_path: Optional[str] = None) -> Iterator[None] sys.path = old_sys_path -def which(program: str) -> Optional[str]: +def which(program: str) -> str | None: """Mimic 'which' command behavior.""" def is_exe(fpath: str) -> bool: """Determine if program exists and is executable.""" - return os.path.isfile(fpath) and os.access(fpath, os.X_OK) + return Path(fpath).is_file() and os.access(fpath, os.X_OK) - def get_extensions() -> List[str]: + def get_extensions() -> list[str]: """Get PATHEXT if the exist, otherwise use default.""" exts = ".COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC" @@ -907,7 +871,7 @@ def get_extensions() -> List[str]: return exts.split(";") - fname, file_ext = os.path.splitext(program) + fname, file_ext = os.path.splitext(program) # noqa: PTH122 fpath, fname = os.path.split(program) if not file_ext and platform.system().lower() == "windows": @@ -917,16 +881,16 @@ def get_extensions() -> List[str]: for i in fnames: if fpath: - exe_file = os.path.join(fpath, i) + exe_file = os.path.join(fpath, i) # noqa: PTH118 if is_exe(exe_file): return exe_file else: for path in ( os.environ.get("PATH", "").split(os.pathsep) if "PATH" in os.environ - else [os.getcwd()] + else [os.getcwd()] # noqa: PTH109 ): - exe_file = os.path.join(path, i) + exe_file = os.path.join(path, i) # noqa: PTH118 if is_exe(exe_file): return exe_file diff --git a/runway/utils/_file_hash.py b/runway/utils/_file_hash.py index d9f4b7c90..33448211a 100644 --- a/runway/utils/_file_hash.py +++ b/runway/utils/_file_hash.py @@ -3,10 +3,11 @@ from __future__ import annotations from pathlib import Path -from typing import TYPE_CHECKING, ClassVar, Iterable, Optional +from typing import TYPE_CHECKING, ClassVar, Optional if TYPE_CHECKING: import hashlib + from collections.abc import Iterable from _typeshed import StrPath @@ -26,9 +27,7 @@ class FileHash: 1024 * 10_000_000 # 10mb - number of bytes in each read operation ) - def __init__( - self, hash_alg: "hashlib._Hash", *, chunk_size: int = DEFAULT_CHUNK_SIZE - ) -> None: + def __init__(self, hash_alg: hashlib._Hash, *, chunk_size: int = DEFAULT_CHUNK_SIZE) -> None: """Instantiate class. Args: @@ -75,10 +74,8 @@ def add_file(self, file_path: StrPath) -> None: file_path: Path of the file to add. """ - with open(file_path, "rb") as stream: - # python 3.7 compatible version of `while chunk := buf.read(read_size):` - chunk = stream.read(self.chunk_size) # seed chunk with initial value - while chunk: + with Path.open(Path(file_path), "rb") as stream: + while chunk := stream.read(self.chunk_size): self._hash.update(chunk) chunk = stream.read(self.chunk_size) # read in new chunk @@ -103,11 +100,7 @@ def add_file_name( """ self._hash.update( ( - str( - Path(file_path).relative_to(relative_to) - if relative_to - else Path(file_path) - ) + str(Path(file_path).relative_to(relative_to) if relative_to else Path(file_path)) + end_character ).encode() ) @@ -132,4 +125,4 @@ def add_files( self.add_file_name(fp, relative_to=relative_to) self.add_file(fp) # end of file contents; only necessary with multiple files - self._hash.update("\0".encode()) + self._hash.update(b"\0") diff --git a/runway/utils/_version.py b/runway/utils/_version.py index 2e4c6decc..54c601245 100644 --- a/runway/utils/_version.py +++ b/runway/utils/_version.py @@ -22,8 +22,7 @@ def __repr__(self) -> str: """Return repr.""" # this usage of super is required to reproduce the intended result in # any subclasses of this class - # pylint: disable=super-with-arguments - return f"" + return f"" def __str__(self) -> str: """Return the original version string.""" diff --git a/runway/variables.py b/runway/variables.py index 75f84b27d..23fb4d000 100644 --- a/runway/variables.py +++ b/runway/variables.py @@ -4,24 +4,8 @@ import logging import re -from typing import ( - TYPE_CHECKING, - Any, - Dict, - Generic, - Iterable, - Iterator, - List, - MutableMapping, - MutableSequence, - Optional, - Set, - Type, - TypeVar, - Union, - cast, - overload, -) +from collections.abc import Iterable, Iterator, MutableMapping, MutableSequence +from typing import TYPE_CHECKING, Any, Generic, TypeVar, cast, overload from pydantic import BaseModel from typing_extensions import Literal @@ -35,13 +19,13 @@ UnresolvedVariable, UnresolvedVariableValue, ) -from .lookups.handlers.base import LookupHandler from .lookups.registry import RUNWAY_LOOKUP_HANDLERS if TYPE_CHECKING: from .cfngin.providers.aws.default import Provider from .config.components.runway import RunwayVariablesDefinition from .context import CfnginContext, RunwayContext + from .lookups.handlers.base import LookupHandler LOGGER = logging.getLogger(__name__) @@ -53,6 +37,7 @@ class Variable: """Represents a variable provided to a Runway directive.""" + _value: VariableValue name: str def __init__( @@ -75,11 +60,11 @@ def __init__( self.variable_type = variable_type @property - def dependencies(self) -> Set[str]: + def dependencies(self) -> set[str]: """Stack names that this variable depends on. Returns: - Set[str]: Stack names that this variable depends on. + set[str]: Stack names that this variable depends on. """ return self._value.dependencies @@ -108,9 +93,9 @@ def value(self) -> Any: def resolve( self, - context: Union[CfnginContext, RunwayContext], - provider: Optional[Provider] = None, - variables: Optional[RunwayVariablesDefinition] = None, + context: CfnginContext | RunwayContext, + provider: Provider | None = None, + variables: RunwayVariablesDefinition | None = None, **kwargs: Any, ) -> None: """Resolve the variable value. @@ -119,15 +104,14 @@ def resolve( context: The current context object. provider: Subclass of the base provider. variables: Object containing variables passed to Runway. + **kwargs: Arbitrary keyword arguments. Raises: FailedVariableLookup """ try: - self._value.resolve( - context, provider=provider, variables=variables, **kwargs - ) + self._value.resolve(context, provider=provider, variables=variables, **kwargs) except FailedLookup as err: raise FailedVariableLookup(self, err) from err.cause @@ -147,9 +131,9 @@ def __repr__(self) -> str: def resolve_variables( - variables: List[Variable], - context: Union[CfnginContext, RunwayContext], - provider: Optional[Provider] = None, + variables: list[Variable], + context: CfnginContext | RunwayContext, + provider: Provider | None = None, ) -> None: """Given a list of variables, resolve all of them. @@ -174,7 +158,7 @@ class VariableValue: variable_type: VariableTypeLiteralTypeDef @property - def dependencies(self) -> Set[Any]: + def dependencies(self) -> set[Any]: """Stack names that this variable depends on.""" return set() @@ -212,9 +196,9 @@ def value(self) -> Any: def resolve( self, - context: Union[CfnginContext, RunwayContext], - provider: Optional[Provider] = None, - variables: Optional[RunwayVariablesDefinition] = None, + context: CfnginContext | RunwayContext, + provider: Provider | None = None, + variables: RunwayVariablesDefinition | None = None, **kwargs: Any, ) -> None: """Resolve the variable value. @@ -223,6 +207,7 @@ def resolve( context: The current context object. provider: Subclass of the base provider. variables: Object containing variables passed to Runway. + **kwargs: Arbitrary keyword arguments. """ @@ -245,13 +230,13 @@ def parse_obj( @overload @classmethod def parse_obj( - cls, obj: Dict[str, Any], variable_type: VariableTypeLiteralTypeDef = ... + cls, obj: dict[str, Any], variable_type: VariableTypeLiteralTypeDef = ... ) -> VariableValue: ... @overload @classmethod def parse_obj( - cls, obj: List[Any], variable_type: VariableTypeLiteralTypeDef = ... + cls, obj: list[Any], variable_type: VariableTypeLiteralTypeDef = ... ) -> VariableValueList: ... @overload @@ -264,12 +249,10 @@ def parse_obj( @classmethod def parse_obj( cls, obj: str, variable_type: VariableTypeLiteralTypeDef = ... - ) -> VariableValueConcatenation[ - Union[VariableValueLiteral[str], VariableValueLookup] - ]: ... + ) -> VariableValueConcatenation[VariableValueLiteral[str] | VariableValueLookup]: ... @classmethod - def parse_obj( + def parse_obj( # noqa: C901 cls, obj: Any, variable_type: VariableTypeLiteralTypeDef = "cfngin" ) -> VariableValue: """Parse complex variable structures using type appropriate subclasses. @@ -288,14 +271,14 @@ def parse_obj( if not isinstance(obj, str): return VariableValueLiteral(obj, variable_type=variable_type) # type: ignore - tokens: VariableValueConcatenation[ - Union[VariableValueLiteral[str], VariableValueLookup] - ] = VariableValueConcatenation( - # pyright 1.1.138 is having issues properly inferring the type from comprehension - [ # type: ignore - VariableValueLiteral(cast(str, t), variable_type=variable_type) - for t in re.split(r"(\$\{|\}|\s+)", obj) # ${ or space or } - ] + tokens: VariableValueConcatenation[VariableValueLiteral[str] | VariableValueLookup] = ( + VariableValueConcatenation( + # pyright 1.1.138 is having issues properly inferring the type from comprehension + [ # type: ignore + VariableValueLiteral(cast(str, t), variable_type=variable_type) + for t in re.split(r"(\$\{|\}|\s+)", obj) # ${ or space or } + ] + ) ) opener = "${" @@ -352,7 +335,7 @@ class VariableValueDict(VariableValue, MutableMapping[str, VariableValue]): """A dict variable value.""" def __init__( - self, data: Dict[str, Any], variable_type: VariableTypeLiteralTypeDef = "cfngin" + self, data: dict[str, Any], variable_type: VariableTypeLiteralTypeDef = "cfngin" ) -> None: """Instantiate class. @@ -361,15 +344,13 @@ def __init__( variable_type: Type of variable (cfngin|runway). """ - self._data = { - k: self.parse_obj(v, variable_type=variable_type) for k, v in data.items() - } + self._data = {k: self.parse_obj(v, variable_type=variable_type) for k, v in data.items()} self.variable_type: VariableTypeLiteralTypeDef = variable_type @property - def dependencies(self) -> Set[str]: + def dependencies(self) -> set[str]: """Stack names that this variable depends on.""" - deps: Set[str] = set() + deps: set[str] = set() for item in self.values(): deps.update(item.dependencies) return deps @@ -383,7 +364,7 @@ def resolved(self) -> bool: return accumulator @property - def simplified(self) -> Dict[str, Any]: + def simplified(self) -> dict[str, Any]: """Return a simplified version of the value. This can be used to concatenate two literals into one literal or @@ -393,15 +374,15 @@ def simplified(self) -> Dict[str, Any]: return {k: v.simplified for k, v in self.items()} @property - def value(self) -> Dict[str, Any]: + def value(self) -> dict[str, Any]: """Value of the variable. Can be resolved or unresolved.""" return {k: v.value for k, v in self.items()} def resolve( self, - context: Union[CfnginContext, RunwayContext], - provider: Optional[Provider] = None, - variables: Optional[RunwayVariablesDefinition] = None, + context: CfnginContext | RunwayContext, + provider: Provider | None = None, + variables: RunwayVariablesDefinition | None = None, **kwargs: Any, ) -> None: """Resolve the variable value. @@ -410,6 +391,7 @@ def resolve( context: The current context object. provider: Subclass of the base provider. variables: Object containing variables passed to Runway. + **kwargs: Arbitrary keyword arguments. """ for item in self.values(): @@ -433,7 +415,7 @@ def __len__(self) -> int: def __repr__(self) -> str: """Return object representation.""" - return f"Dict[{', '.join(f'{k}={v}' for k, v in self.items())}]" + return f"dict[{', '.join(f'{k}={v}' for k, v in self.items())}]" def __setitem__(self, __key: str, __value: VariableValue) -> None: """Set item by index.""" @@ -455,15 +437,15 @@ def __init__( variable_type: Type of variable (cfngin|runway). """ - self._data: List[VariableValue] = [ + self._data: list[VariableValue] = [ self.parse_obj(i, variable_type=variable_type) for i in iterable ] self.variable_type: VariableTypeLiteralTypeDef = variable_type @property - def dependencies(self) -> Set[str]: + def dependencies(self) -> set[str]: """Stack names that this variable depends on.""" - deps: Set[str] = set() + deps: set[str] = set() for item in self: deps.update(item.dependencies) return deps @@ -477,7 +459,7 @@ def resolved(self) -> bool: return accumulator @property - def simplified(self) -> List[VariableValue]: + def simplified(self) -> list[VariableValue]: """Return a simplified version of the value. This can be used to concatenate two literals into one literal or @@ -487,7 +469,7 @@ def simplified(self) -> List[VariableValue]: return [item.simplified for item in self] @property - def value(self) -> List[Any]: + def value(self) -> list[Any]: """Value of the variable. Can be resolved or unresolved.""" return [item.value for item in self] @@ -497,9 +479,9 @@ def insert(self, index: int, value: VariableValue) -> None: def resolve( self, - context: Union[CfnginContext, RunwayContext], - provider: Optional[Provider] = None, - variables: Optional[RunwayVariablesDefinition] = None, + context: CfnginContext | RunwayContext, + provider: Provider | None = None, + variables: RunwayVariablesDefinition | None = None, **kwargs: Any, ) -> None: """Resolve the variable value. @@ -508,37 +490,44 @@ def resolve( context: The current context object. provider: Subclass of the base provider. variables: Object containing variables passed to Runway. + **kwargs: Arbitrary keyword arguments. """ for item in self: item.resolve(context, provider=provider, variables=variables, **kwargs) - def __delitem__(self, __index: int) -> None: + @overload + def __delitem__(self, index: int) -> None: ... + + @overload + def __delitem__(self, index: slice) -> None: ... + + def __delitem__(self, index: int | slice) -> None: """Delete item by index.""" - del self._data[__index] + del self._data[index] @overload def __getitem__(self, __index: int) -> VariableValue: ... @overload - def __getitem__(self, __index: slice) -> List[VariableValue]: ... + def __getitem__(self, __index: slice) -> list[VariableValue]: ... - def __getitem__( # type: ignore - self, __index: Union[int, slice] - ) -> Union[MutableSequence[VariableValue], VariableValue]: + def __getitem__( # pyright: ignore[reportIncompatibleMethodOverride] + self, __index: int | slice + ) -> MutableSequence[VariableValue] | VariableValue: """Get item by index.""" - return self._data[__index] # type: ignore + return self._data[__index] # pyright: ignore[reportCallIssue] @overload def __setitem__(self, __index: int, __value: VariableValue) -> None: ... @overload - def __setitem__(self, __index: slice, __value: List[VariableValue]) -> None: ... + def __setitem__(self, __index: slice, __value: list[VariableValue]) -> None: ... - def __setitem__( + def __setitem__( # pyright: ignore[reportIncompatibleMethodOverride] self, - __index: Union[int, slice], - __value: Union[List[VariableValue], VariableValue], + __index: int | slice, + __value: list[VariableValue] | VariableValue, ) -> None: """Set item by index.""" self._data[__index] = __value # type: ignore @@ -553,7 +542,7 @@ def __len__(self) -> int: def __repr__(self) -> str: """Object string representation.""" - return f"List[{', '.join(repr(i) for i in self._data)}]" + return f"list[{', '.join(repr(i) for i in self._data)}]" class VariableValueLiteral(Generic[_LiteralValue], VariableValue): @@ -615,9 +604,9 @@ def __init__( self.variable_type: VariableTypeLiteralTypeDef = variable_type @property - def dependencies(self) -> Set[str]: + def dependencies(self) -> set[str]: """Stack names that this variable depends on.""" - deps: Set[str] = set() + deps: set[str] = set() for item in self: deps.update(item.dependencies) return deps @@ -638,7 +627,7 @@ def simplified(self) -> VariableValue: nested concatenations. """ - concat: List[VariableValue] = [] + concat: list[VariableValue] = [] for item in self: if isinstance(item, VariableValueLiteral) and item.value == "": pass @@ -672,21 +661,19 @@ def value(self) -> Any: if len(self) == 1: return self[0].value - values: List[str] = [] + values: list[str] = [] for value in self: resolved_value = value.value - if isinstance(resolved_value, bool) or not isinstance( - resolved_value, (int, str) - ): + if isinstance(resolved_value, bool) or not isinstance(resolved_value, (int, str)): raise InvalidLookupConcatenation(value, self) values.append(str(resolved_value)) return "".join(values) def resolve( self, - context: Union[CfnginContext, RunwayContext], - provider: Optional[Provider] = None, - variables: Optional[RunwayVariablesDefinition] = None, + context: CfnginContext | RunwayContext, + provider: Provider | None = None, + variables: RunwayVariablesDefinition | None = None, **kwargs: Any, ) -> None: """Resolve the variable value. @@ -695,6 +682,7 @@ def resolve( context: The current context object. provider: Subclass of the base provider. variables: Object containing variables passed to Runway. + **kwargs: Arbitrary keyword arguments. """ for value in self: @@ -708,11 +696,9 @@ def __delitem__(self, __index: int) -> None: def __getitem__(self, __index: int) -> _VariableValue: ... @overload - def __getitem__(self, __index: slice) -> List[_VariableValue]: ... + def __getitem__(self, __index: slice) -> list[_VariableValue]: ... - def __getitem__( - self, __index: Union[int, slice] - ) -> Union[List[_VariableValue], _VariableValue]: + def __getitem__(self, __index: int | slice) -> list[_VariableValue] | _VariableValue: """Get item by index.""" return self._data[__index] @@ -720,12 +706,12 @@ def __getitem__( def __setitem__(self, __index: int, __value: _VariableValue) -> None: ... @overload - def __setitem__(self, __index: slice, __value: List[_VariableValue]) -> None: ... + def __setitem__(self, __index: slice, __value: list[_VariableValue]) -> None: ... def __setitem__( self, - __index: Union[int, slice], - __value: Union[List[_VariableValue], _VariableValue], + __index: int | slice, + __value: list[_VariableValue] | _VariableValue, ) -> None: """Set item by index.""" self._data[__index] = __value @@ -746,7 +732,7 @@ def __repr__(self) -> str: class VariableValueLookup(VariableValue): """A lookup variable value.""" - handler: Type[LookupHandler] + handler: type[LookupHandler] lookup_name: VariableValueLiteral[str] lookup_query: VariableValue @@ -755,8 +741,8 @@ class VariableValueLookup(VariableValue): def __init__( self, lookup_name: VariableValueLiteral[str], - lookup_query: Union[str, VariableValue], - handler: Optional[Type[LookupHandler]] = None, + lookup_query: str | VariableValue, + handler: type[LookupHandler] | None = None, variable_type: VariableTypeLiteralTypeDef = "cfngin", ) -> None: """Initialize class. @@ -790,15 +776,13 @@ def __init__( elif variable_type == "runway": handler = RUNWAY_LOOKUP_HANDLERS[lookup_name_resolved] else: - raise ValueError( - 'Variable type must be one of "cfngin" or "runway"' - ) + raise ValueError('Variable type must be one of "cfngin" or "runway"') except KeyError: raise UnknownLookupType(self) from None self.handler = handler @property - def dependencies(self) -> Set[str]: + def dependencies(self) -> set[str]: """Stack names that this variable depends on.""" if hasattr(self.handler, "dependencies"): return self.handler.dependencies(self.lookup_query) @@ -833,9 +817,9 @@ def value(self) -> Any: def resolve( self, - context: Union[CfnginContext, RunwayContext], - provider: Optional[Provider] = None, - variables: Optional[RunwayVariablesDefinition] = None, + context: CfnginContext | RunwayContext, + provider: Provider | None = None, + variables: RunwayVariablesDefinition | None = None, **kwargs: Any, ) -> None: """Resolve the variable value. @@ -844,14 +828,13 @@ def resolve( context: The current context object. provider: Subclass of the base provider. variables: Object containing variables passed to Runway. + **kwargs: Arbitrary keyword arguments. Raises: FailedLookup: A lookup failed for any reason. """ - self.lookup_query.resolve( - context=context, provider=provider, variables=variables, **kwargs - ) + self.lookup_query.resolve(context=context, provider=provider, variables=variables, **kwargs) try: result = self.handler.handle( self.lookup_query.value, @@ -871,10 +854,8 @@ def __iter__(self) -> Iterator[VariableValueLookup]: def __repr__(self) -> str: """Return object representation.""" if self._resolved: - return ( - f"Lookup[{self._data} ({self.lookup_name} {repr(self.lookup_query)})]" - ) - return f"Lookup[{self.lookup_name} {repr(self.lookup_query)}]" + return f"Lookup[{self._data} ({self.lookup_name} {self.lookup_query!r})]" + return f"Lookup[{self.lookup_name} {self.lookup_query!r}]" def __str__(self) -> str: """Object displayed as a string.""" @@ -896,16 +877,16 @@ def __init__( variable_type: Type of variable (cfngin|runway). """ - self._data: Dict[str, VariableValue] = { + self._data: dict[str, VariableValue] = { k: self.parse_obj(v, variable_type=variable_type) for k, v in data } self._model_class = type(data) self.variable_type: VariableTypeLiteralTypeDef = variable_type @property - def dependencies(self) -> Set[str]: + def dependencies(self) -> set[str]: """Stack names that this variable depends on.""" - deps: Set[str] = set() + deps: set[str] = set() for value in self._data.values(): deps.update(value.dependencies) return deps @@ -919,7 +900,7 @@ def resolved(self) -> bool: return accumulator @property - def simplified(self) -> Dict[str, Any]: + def simplified(self) -> dict[str, Any]: """Return a simplified version of the value. This can be used to concatenate two literals into one literal or @@ -942,9 +923,9 @@ def value(self) -> _PydanticModelTypeVar: def resolve( self, - context: Union[CfnginContext, RunwayContext], - provider: Optional[Provider] = None, - variables: Optional[RunwayVariablesDefinition] = None, + context: CfnginContext | RunwayContext, + provider: Provider | None = None, + variables: RunwayVariablesDefinition | None = None, **kwargs: Any, ) -> None: """Resolve the variable value. @@ -953,6 +934,7 @@ def resolve( context: The current context object. provider: Subclass of the base provider. variables: Object containing variables passed to Runway. + **kwargs: Arbitrary keyword arguments. """ for item in self._data.values(): @@ -977,8 +959,7 @@ def __len__(self) -> int: def __repr__(self) -> str: """Return object representation.""" return ( - self._model_class.__name__ - + f"[{', '.join(f'{k}={v}' for k, v in self._data.items())}]" + self._model_class.__name__ + f"[{', '.join(f'{k}={v}' for k, v in self._data.items())}]" ) def __setitem__(self, __key: str, __value: VariableValue) -> None: diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 941988601..000000000 --- a/setup.cfg +++ /dev/null @@ -1,59 +0,0 @@ -[flake8] -classmethod-decorators = - classmethod, - root_validator, - validator -docstring-convention = all -exclude = - *.egg-info, - *.pyc, - *.pyi, - .demo, - .eggs, - .git, - .github, - .mypy_cache, - .runway, - .serverless, - .terraform, - .venv, - __pycache__, - artifacts, - build, - dist, - docs/.venv, - docs/build, - docs/source/apidocs, - node_modules, - npm, - typings, - quickstarts -extend-ignore = - # BaseException.message` has been deprecated false positive for custom exceptions - B306, - # No blank lines allowed after function docstring - D203, - # Multi-line docstring summary should start at the second line - D213, - # Section underline is over-indented - D215, - # First word of the first line should be properly capitalized - D403, - # Section name should end with a newline - D406, - # Missing dashed underline after section - D407, - # Section underline should be in the line following the section’s name - D408, - # Section underline should match the length of its name - D409, - # First line should end with a period, question mark, or exclamation point - D415, - # whitespace before ':' - black compatible - E203, - # line break before operator - W503 -ignore-decorators = abstractmethod|overload -max-line-length = 98 -show-source = true -statistics = true diff --git a/tests/README.md b/tests/README.md index fb66e04ee..ab5220376 100644 --- a/tests/README.md +++ b/tests/README.md @@ -34,13 +34,12 @@ The the operation of each function/method individually. - Low level tests that import individual functions and classes to invoke them directly. - Mocks should be used to isolate each function/method. - ## Running Tests Tests can be run using `make` commands from the root of the repo. -| Command | Description | -|-------------------------|--------------------------| +| Command | Description | +| ----------------------- | ------------------------ | | `make test` | integration & unit tests | | `make test-functional` | functional tests | | `make test-integration` | integration tests | diff --git a/tests/conftest.py b/tests/conftest.py index 82c2556b7..b73ec1d13 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,22 +1,22 @@ """Pytest configuration, fixtures, and plugins.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import os from pathlib import Path -from typing import TYPE_CHECKING, Generator, Iterator +from typing import TYPE_CHECKING import pytest from .factories import cli_runner_factory if TYPE_CHECKING: + from collections.abc import Generator, Iterator + from _pytest.config import Config from _pytest.config.argparsing import Parser from _pytest.fixtures import SubRequest from click.testing import CliRunner - from pytest import TempPathFactory def pytest_configure(config: Config) -> None: @@ -50,20 +50,20 @@ def pytest_addoption(parser: Parser) -> None: ) -@pytest.fixture(scope="function") +@pytest.fixture() def cli_runner(request: SubRequest) -> CliRunner: """Initialize instance of `click.testing.CliRunner`.""" return cli_runner_factory(request) -@pytest.fixture(scope="function") +@pytest.fixture() def cli_runner_isolated(cli_runner: CliRunner) -> Generator[CliRunner, None, None]: """Initialize instance of `click.testing.CliRunner` with `isolate_filesystem()` called.""" with cli_runner.isolated_filesystem(): yield cli_runner -@pytest.fixture(scope="function") +@pytest.fixture() def cd_tmp_path(tmp_path: Path) -> Iterator[Path]: """Change directory to a temporary path. @@ -79,7 +79,7 @@ def cd_tmp_path(tmp_path: Path) -> Iterator[Path]: os.chdir(prev_dir) -@pytest.fixture(scope="function") +@pytest.fixture() def root_dir() -> Path: """Return a path object to the root directory.""" return Path(__file__).parent.parent @@ -101,6 +101,6 @@ def sanitize_environment() -> None: @pytest.fixture(scope="session") -def tfenv_dir(tmp_path_factory: TempPathFactory) -> Path: +def tfenv_dir(tmp_path_factory: pytest.TempPathFactory) -> Path: """Directory for storing tfenv between tests.""" return tmp_path_factory.mktemp(".tfenv", numbered=True) diff --git a/tests/factories.py b/tests/factories.py index a46eb9c64..a9cafd510 100644 --- a/tests/factories.py +++ b/tests/factories.py @@ -4,7 +4,7 @@ from __future__ import annotations import os # imports os -from typing import TYPE_CHECKING, Any, Dict, cast +from typing import TYPE_CHECKING, Any, cast from click.testing import CliRunner @@ -14,7 +14,7 @@ def cli_runner_factory(request: SubRequest) -> CliRunner: """Initialize instance of `click.testing.CliRunner`.""" - kwargs: Dict[str, Any] = { + kwargs: dict[str, Any] = { "env": { "CFNGIN_STACK_POLL_TIME": "1", "DEPLOY_ENVIRONMENT": "test", @@ -24,5 +24,5 @@ def cli_runner_factory(request: SubRequest) -> CliRunner: } mark = request.node.get_closest_marker("cli_runner") if mark: - kwargs.update(cast(Dict[str, Any], mark.kwargs)) + kwargs.update(cast(dict[str, Any], mark.kwargs)) return CliRunner(**kwargs) diff --git a/tests/functional/cdk/test_multistack/package.json b/tests/functional/cdk/test_multistack/package.json index 03bff770e..b2cc94c28 100644 --- a/tests/functional/cdk/test_multistack/package.json +++ b/tests/functional/cdk/test_multistack/package.json @@ -1,18 +1,7 @@ { - "name": "test_multistack", - "version": "0.0.0", "bin": { "example": "bin/example.js" }, - "scripts": { - "build": "tsc", - "deploy": "cdk deploy", - "diff": "cdk diff", - "lint": "eslint 'bin/*.ts' 'lib/*.ts'", - "lintfix": "npm run lint -- --fix", - "synth": "cdk synth", - "watch": "tsc -w" - }, "dependencies": { "@aws-cdk/core": "^1.181.0" }, @@ -33,5 +22,16 @@ "tslint-config-prettier": "^1.18.0", "tslint-plugin-prettier": "^2.3.0", "typescript": "^4.9.4" - } + }, + "name": "test_multistack", + "scripts": { + "build": "tsc", + "deploy": "cdk deploy", + "diff": "cdk diff", + "lint": "eslint 'bin/*.ts' 'lib/*.ts'", + "lintfix": "npm run lint -- --fix", + "synth": "cdk synth", + "watch": "tsc -w" + }, + "version": "0.0.0" } diff --git a/tests/functional/cdk/test_multistack/test_runner.py b/tests/functional/cdk/test_multistack/test_runner.py index a0f7e6c59..6a9199e01 100644 --- a/tests/functional/cdk/test_multistack/test_runner.py +++ b/tests/functional/cdk/test_multistack/test_runner.py @@ -10,27 +10,28 @@ """ -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent @pytest.fixture(scope="module") -def deploy_result(cli_runner: CliRunner) -> Generator[Result, None, None]: +def deploy_result(cli_runner: CliRunner) -> Result: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" - yield cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) + return cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) @pytest.fixture(scope="module") diff --git a/tests/functional/cfngin/fixtures/blueprints/_bastion.py b/tests/functional/cfngin/fixtures/blueprints/_bastion.py index 0a0eaacfe..3e3312678 100644 --- a/tests/functional/cfngin/fixtures/blueprints/_bastion.py +++ b/tests/functional/cfngin/fixtures/blueprints/_bastion.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict +from typing import TYPE_CHECKING, ClassVar from runway.cfngin.blueprints.base import Blueprint from runway.cfngin.blueprints.variables.types import ( @@ -22,7 +22,7 @@ class FakeBastion(Blueprint): """Fake Bastion.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "VpcId": {"type": EC2VPCId, "description": "Vpc Id"}, "DefaultSG": { "type": EC2SecurityGroupId, @@ -30,15 +30,15 @@ class FakeBastion(Blueprint): }, "PublicSubnets": { "type": EC2SubnetIdList, - "description": "Subnets to deploy public " "instances in.", + "description": "Subnets to deploy public instances in.", }, "PrivateSubnets": { "type": EC2SubnetIdList, - "description": "Subnets to deploy private " "instances in.", + "description": "Subnets to deploy private instances in.", }, "AvailabilityZones": { "type": CFNCommaDelimitedList, - "description": "Availability Zones to deploy " "instances in.", + "description": "Availability Zones to deploy instances in.", }, "InstanceType": { "type": CFNString, diff --git a/tests/functional/cfngin/fixtures/blueprints/_broken.py b/tests/functional/cfngin/fixtures/blueprints/_broken.py index f7fd569f3..99610b61f 100644 --- a/tests/functional/cfngin/fixtures/blueprints/_broken.py +++ b/tests/functional/cfngin/fixtures/blueprints/_broken.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict +from typing import TYPE_CHECKING, ClassVar from troposphere import Ref from troposphere.cloudformation import WaitCondition, WaitConditionHandle @@ -20,7 +20,7 @@ class Broken(Blueprint): """ - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "StringVariable": {"type": str, "default": ""} } diff --git a/tests/functional/cfngin/fixtures/blueprints/_dummy.py b/tests/functional/cfngin/fixtures/blueprints/_dummy.py index 2b316f895..92d97f608 100644 --- a/tests/functional/cfngin/fixtures/blueprints/_dummy.py +++ b/tests/functional/cfngin/fixtures/blueprints/_dummy.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict +from typing import TYPE_CHECKING, ClassVar from troposphere import Ref from troposphere.cloudformation import WaitCondition, WaitConditionHandle @@ -16,7 +16,7 @@ class Dummy(Blueprint): """Dummy blueprint.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "StringVariable": {"type": str, "default": ""} } @@ -35,7 +35,7 @@ class LongRunningDummy(Blueprint): """ - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "Count": { "type": int, "description": "The # of WaitConditionHandles to create.", diff --git a/tests/functional/cfngin/fixtures/blueprints/_lambda_function.py b/tests/functional/cfngin/fixtures/blueprints/_lambda_function.py index 91dd0351a..927a33774 100644 --- a/tests/functional/cfngin/fixtures/blueprints/_lambda_function.py +++ b/tests/functional/cfngin/fixtures/blueprints/_lambda_function.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any, ClassVar, Dict, Optional +from typing import TYPE_CHECKING, Any, ClassVar, Optional import awacs.awslambda import awacs.dynamodb @@ -22,7 +22,7 @@ class LambdaFunction(Blueprint): """Blueprint for creating a Lambda Function.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "AppName": {"type": str, "description": "Name of app."}, "Code": { "type": awslambda.Code, @@ -122,7 +122,7 @@ def runtime(self) -> Ref: @cached_property def lambda_function(self) -> awslambda.Function: """AWS Lambda Function.""" - optional_kwargs: Dict[str, Any] = { + optional_kwargs: dict[str, Any] = { "Environment": ( awslambda.Environment(Variables=self.variables["EnvironmentVariables"]) if self.variables["EnvironmentVariables"] @@ -146,9 +146,7 @@ def lambda_function(self) -> awslambda.Function: self.add_output(f"{func.title}Arn", func.get_att("Arn")) self.add_output("Runtime", self.runtime) for attr in awslambda.Code.props: - self.add_output( - f"Code{attr}", getattr(self.variables["Code"], attr, "null") - ) + self.add_output(f"Code{attr}", getattr(self.variables["Code"], attr, "null")) return func @cached_property @@ -179,5 +177,5 @@ def create_template(self) -> None: """Create template.""" self.template.set_version("2010-09-09") self.template.set_description("Test Lambda") - self.iam_role # pylint: disable=pointless-statement - self.lambda_function # pylint: disable=pointless-statement + self.iam_role # noqa: B018 + self.lambda_function # noqa: B018 diff --git a/tests/functional/cfngin/fixtures/blueprints/_vpc.py b/tests/functional/cfngin/fixtures/blueprints/_vpc.py index 6161745e2..7ad18f69f 100644 --- a/tests/functional/cfngin/fixtures/blueprints/_vpc.py +++ b/tests/functional/cfngin/fixtures/blueprints/_vpc.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict +from typing import TYPE_CHECKING, ClassVar from troposphere.cloudformation import WaitConditionHandle @@ -16,7 +16,7 @@ class FakeVPC(Blueprint): """Fake VPC.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "AZCount": {"type": int, "default": 2}, "PrivateSubnets": { "type": CFNCommaDelimitedList, diff --git a/tests/functional/cfngin/fixtures/hooks/cleanup.py b/tests/functional/cfngin/fixtures/hooks/cleanup.py index 161bf8ce9..8da35b0f3 100644 --- a/tests/functional/cfngin/fixtures/hooks/cleanup.py +++ b/tests/functional/cfngin/fixtures/hooks/cleanup.py @@ -18,7 +18,7 @@ def local_delete( - context: CfnginContext, # pylint: disable=unused-argument + context: CfnginContext, # noqa: ARG001 *, path: StrPath, **_: Any, diff --git a/tests/functional/cfngin/fixtures/stack_policies/default.json b/tests/functional/cfngin/fixtures/stack_policies/default.json index 6a3513825..04ba8c8c1 100644 --- a/tests/functional/cfngin/fixtures/stack_policies/default.json +++ b/tests/functional/cfngin/fixtures/stack_policies/default.json @@ -1,10 +1,10 @@ { - "Statement" : [ - { - "Effect" : "Allow", - "Action" : "Update:*", - "Principal": "*", - "Resource" : "*" - } - ] + "Statement": [ + { + "Action": "Update:*", + "Effect": "Allow", + "Principal": "*", + "Resource": "*" + } + ] } diff --git a/tests/functional/cfngin/fixtures/stack_policies/none.json b/tests/functional/cfngin/fixtures/stack_policies/none.json index daf7f8424..f66cbde7d 100644 --- a/tests/functional/cfngin/fixtures/stack_policies/none.json +++ b/tests/functional/cfngin/fixtures/stack_policies/none.json @@ -1,10 +1,10 @@ { - "Statement" : [ - { - "Effect" : "Deny", - "Action" : "Update:*", - "Principal": "*", - "Resource" : "*" - } - ] + "Statement": [ + { + "Action": "Update:*", + "Effect": "Deny", + "Principal": "*", + "Resource": "*" + } + ] } diff --git a/tests/functional/cfngin/hooks/test_awslambda/sample_app/cfngin.yml b/tests/functional/cfngin/hooks/test_awslambda/sample_app/cfngin.yml index de663aa2a..828d89aa1 100644 --- a/tests/functional/cfngin/hooks/test_awslambda/sample_app/cfngin.yml +++ b/tests/functional/cfngin/hooks/test_awslambda/sample_app/cfngin.yml @@ -70,7 +70,7 @@ pre_deploy: - path: runway.cfngin.hooks.awslambda.PythonLayer data_key: awslambda.layer.xmlsec args: - << : *xmlsec_args + <<: *xmlsec_args compatible_runtimes: - python3.10 extend_gitignore: diff --git a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker/index.py b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker/index.py index a3a77b16e..20ce6cc87 100644 --- a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker/index.py +++ b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker/index.py @@ -1,11 +1,10 @@ """Lambda Function.""" -# pylint: disable=broad-except,import-outside-toplevel,unused-argument from __future__ import annotations import inspect from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any if TYPE_CHECKING: from ..type_defs import LambdaResponse @@ -13,7 +12,7 @@ PACKAGE_DIR = Path(__file__).parent -def handler(event: Dict[str, Any], context: object) -> LambdaResponse: +def handler(event: dict[str, Any], context: object) -> LambdaResponse: # noqa: ARG001 """Lambda Function entrypoint.""" try: import requests @@ -30,7 +29,7 @@ def handler(event: Dict[str, Any], context: object) -> LambdaResponse: "message": None, "status": "success", } - except Exception as exc: + except Exception as exc: # noqa: BLE001 return { "code": 500, "data": { diff --git a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_mysql/Pipfile b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_mysql/Pipfile index e4da7ac5a..6e2f9c074 100644 --- a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_mysql/Pipfile +++ b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_mysql/Pipfile @@ -1,9 +1,9 @@ -[[source]] -url = "https://pypi.org/simple" -verify_ssl = true -name = "pypi" +[dev-packages] [packages] mysqlclient = "==2.1.1" -[dev-packages] +[[source]] +name = "pypi" +url = "https://pypi.org/simple" +verify_ssl = true diff --git a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_mysql/index.py b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_mysql/index.py index c3695e606..a3009272d 100644 --- a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_mysql/index.py +++ b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_mysql/index.py @@ -1,11 +1,10 @@ """Lambda Function.""" -# pylint: disable=broad-except,import-error,import-outside-toplevel,unused-argument from __future__ import annotations import inspect from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any if TYPE_CHECKING: from ..type_defs import LambdaResponse @@ -13,7 +12,7 @@ PACKAGE_DIR = Path(__file__).parent -def handler(event: Dict[str, Any], context: object) -> LambdaResponse: +def handler(event: dict[str, Any], context: object) -> LambdaResponse: # noqa: ARG001 """Lambda Function entrypoint.""" try: import MySQLdb # type: ignore @@ -30,7 +29,7 @@ def handler(event: Dict[str, Any], context: object) -> LambdaResponse: "message": None, "status": "success", } - except Exception as exc: + except Exception as exc: # noqa: BLE001 return { "code": 500, "data": { diff --git a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_xmlsec/index.py b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_xmlsec/index.py index 83ecfd1b7..1eaa4d45a 100644 --- a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_xmlsec/index.py +++ b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_xmlsec/index.py @@ -1,11 +1,10 @@ """Lambda Function.""" -# pylint: disable=broad-except,import-error,import-outside-toplevel,unused-argument from __future__ import annotations import inspect from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any if TYPE_CHECKING: from ..type_defs import LambdaResponse @@ -13,7 +12,7 @@ PACKAGE_DIR = Path(__file__).parent -def handler(event: Dict[str, Any], context: object) -> LambdaResponse: +def handler(event: dict[str, Any], context: object) -> LambdaResponse: # noqa: ARG001 """Lambda Function entrypoint.""" try: import lxml # type: ignore @@ -32,7 +31,7 @@ def handler(event: Dict[str, Any], context: object) -> LambdaResponse: "message": None, "status": "success", } - except Exception as exc: + except Exception as exc: # noqa: BLE001 return { "code": 500, "data": { diff --git a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_xmlsec/pyproject.toml b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_xmlsec/pyproject.toml index 14c5bee02..e971e267f 100644 --- a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_xmlsec/pyproject.toml +++ b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/docker_xmlsec/pyproject.toml @@ -1,17 +1,16 @@ [tool.poetry] name = "test-awslambda-xmlsec" version = "0.0.0" -description = "Test for awslambda hook." -license = "Apache-2.0" authors = [ "Onica Group LLC ", ] +description = "Test for awslambda hook." +license = "Apache-2.0" [tool.poetry.dependencies] python = ">=3.7, <4" - xmlsec = "*" [build-system] -requires = ["poetry_core>=1.0.3"] build-backend = "poetry.core.masonry.api" +requires = ["poetry_core>=1.0.3"] diff --git a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/local/index.py b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/local/index.py index cc4b8371f..58885c3b1 100644 --- a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/local/index.py +++ b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/local/index.py @@ -1,10 +1,9 @@ """Lambda Function.""" -# pylint: disable=broad-except,unused-argument from __future__ import annotations from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any if TYPE_CHECKING: from ..type_defs import LambdaResponse @@ -12,7 +11,7 @@ PACKAGE_DIR = Path(__file__).parent -def handler(event: Dict[str, Any], context: object) -> LambdaResponse: +def handler(event: dict[str, Any], context: object) -> LambdaResponse: # noqa: ARG001 """Lambda Function entrypoint.""" try: return { @@ -26,7 +25,7 @@ def handler(event: Dict[str, Any], context: object) -> LambdaResponse: "message": None, "status": "success", } - except Exception as exc: + except Exception as exc: # noqa: BLE001 return { "code": 500, "data": {}, diff --git a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/local_xmlsec_layer/index.py b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/local_xmlsec_layer/index.py index 02ca8e3b6..d52093dc7 100644 --- a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/local_xmlsec_layer/index.py +++ b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/local_xmlsec_layer/index.py @@ -1,11 +1,10 @@ """Lambda Function using a Lambda Layer for xmlsec.""" -# pylint: disable=broad-except,import-error,import-outside-toplevel,unused-argument from __future__ import annotations import inspect from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any if TYPE_CHECKING: from ..type_defs import LambdaResponse @@ -14,7 +13,7 @@ OPT_DIR = Path("/opt") -def handler(event: Dict[str, Any], context: object) -> LambdaResponse: +def handler(event: dict[str, Any], context: object) -> LambdaResponse: # noqa: ARG001 """Lambda Function entrypoint.""" try: import lxml # type: ignore @@ -36,7 +35,7 @@ def handler(event: Dict[str, Any], context: object) -> LambdaResponse: "message": None, "status": "success", } - except Exception as exc: + except Exception as exc: # noqa: BLE001 return { "code": 500, "data": { diff --git a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/type_defs.py b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/type_defs.py index 47019fe16..53e20f81e 100644 --- a/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/type_defs.py +++ b/tests/functional/cfngin/hooks/test_awslambda/sample_app/src/type_defs.py @@ -2,13 +2,7 @@ from __future__ import annotations -import sys -from typing import Any, Dict, Optional - -if sys.version_info < (3, 8): - from typing_extensions import Literal, TypedDict # type: ignore -else: - from typing import Literal, TypedDict # type: ignore +from typing import Any, Literal, Optional, TypedDict # type: ignore class _LambdaResponseOptional(TypedDict, total=False): @@ -21,7 +15,7 @@ class _LambdaResponseRequired(TypedDict): """Required fields for a Lambda Response.""" code: int - data: Dict[str, Any] + data: dict[str, Any] message: Optional[str] status: Literal["error", "success"] diff --git a/tests/functional/cfngin/hooks/test_awslambda/test_runner.py b/tests/functional/cfngin/hooks/test_awslambda/test_runner.py index 32f654c1d..70d08a60a 100644 --- a/tests/functional/cfngin/hooks/test_awslambda/test_runner.py +++ b/tests/functional/cfngin/hooks/test_awslambda/test_runner.py @@ -1,15 +1,12 @@ """Test AWS Lambda hook.""" -# pylint: disable=no-self-argument -# pylint: disable=redefined-outer-name,unexpected-keyword-arg,unused-argument from __future__ import annotations import json import shutil from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, Generator, Optional +from typing import TYPE_CHECKING, Any, Optional -import boto3 import pytest from pydantic import root_validator @@ -18,6 +15,9 @@ from runway.utils import BaseModel if TYPE_CHECKING: + from collections.abc import Generator + + import boto3 from click.testing import CliRunner, Result from mypy_boto3_cloudformation.client import CloudFormationClient from mypy_boto3_cloudformation.type_defs import StackTypeDef @@ -69,7 +69,7 @@ class AwslambdaStackOutputs(BaseModel): Runtime: str @root_validator(allow_reuse=True, pre=True) - def _convert_null_to_none(cls, values: Dict[str, Any]) -> Dict[str, Any]: + def _convert_null_to_none(self, values: dict[str, Any]) -> dict[str, Any]: """Convert ``null`` to ``NoneType``.""" def _handle_null(v: Any) -> Any: @@ -166,15 +166,11 @@ def test_deploy_exit_code(deploy_result: Result) -> None: def test_deploy_log_messages(deploy_result: Result) -> None: """Test deploy log messages.""" - build_skipped = [ - line for line in deploy_result.stdout.split("\n") if "build skipped" in line - ] + build_skipped = [line for line in deploy_result.stdout.split("\n") if "build skipped" in line] assert not build_skipped, "\n".join(build_skipped) -def test_docker( - deploy_result: Result, namespace: str, runway_context: RunwayContext -) -> None: +def test_docker(deploy_result: Result, namespace: str, runway_context: RunwayContext) -> None: """Test function built with Docker.""" tester = AwslambdaTester( runway_context.get_session(region=AWS_REGION), @@ -193,9 +189,7 @@ def test_docker( assert "certifi/__init__.py" in response["data"]["dir_contents"] -def test_local( - deploy_result: Result, namespace: str, runway_context: RunwayContext -) -> None: +def test_local(deploy_result: Result, namespace: str, runway_context: RunwayContext) -> None: """Test function built with local python.""" tester = AwslambdaTester( runway_context.get_session(region=AWS_REGION), @@ -208,9 +202,7 @@ def test_local( assert response["data"]["dir_contents"] == ["index.py"] -def test_mysql( - deploy_result: Result, namespace: str, runway_context: RunwayContext -) -> None: +def test_mysql(deploy_result: Result, namespace: str, runway_context: RunwayContext) -> None: """Test function built from Dockerfile for mysql.""" tester = AwslambdaTester( runway_context.get_session(region=AWS_REGION), @@ -225,9 +217,7 @@ def test_mysql( assert "Pipfile" not in response["data"]["dir_contents"] -def test_xmlsec( - deploy_result: Result, namespace: str, runway_context: RunwayContext -) -> None: +def test_xmlsec(deploy_result: Result, namespace: str, runway_context: RunwayContext) -> None: """Test function built from Dockerfile for xmlsec.""" tester = AwslambdaTester( runway_context.get_session(region=AWS_REGION), @@ -244,9 +234,7 @@ def test_xmlsec( assert "poetry.lock" not in response["data"]["dir_contents"] -def test_xmlsec_layer( - deploy_result: Result, namespace: str, runway_context: RunwayContext -) -> None: +def test_xmlsec_layer(deploy_result: Result, namespace: str, runway_context: RunwayContext) -> None: """Test layer built from Dockerfile for xmlsec.""" tester = AwslambdaTester( runway_context.get_session(region=AWS_REGION), @@ -262,7 +250,7 @@ def test_xmlsec_layer( assert response["data"]["dir_contents"] == ["index.py"] -def test_plan(cli_runner: CliRunner, deploy_result: Result) -> None: +def test_plan(cli_runner: CliRunner, deploy_result: Result) -> None: # noqa: ARG001 """Test ``runway plan`` - this was not possible with old hook. deploy_result required so cleanup does not start before this runs. @@ -273,9 +261,7 @@ def test_plan(cli_runner: CliRunner, deploy_result: Result) -> None: (DOCKER_XMLSEC_DIR / "poetry.lock").unlink(missing_ok=True) plan_results = cli_runner.invoke(cli, ["plan"], env=ENV_VARS) assert plan_results.exit_code == 0, plan_results.output - matches = [ - line for line in plan_results.stdout.split("\n") if line.endswith(":no changes") - ] + matches = [line for line in plan_results.stdout.split("\n") if line.endswith(":no changes")] a_list = [4, 5] # count needs to be updated if number of test stacks change assert len(matches) in a_list, "\n".join(matches) diff --git a/tests/functional/cfngin/test_assume_role/test_runner.py b/tests/functional/cfngin/test_assume_role/test_runner.py index 1d366cbff..4199bc403 100644 --- a/tests/functional/cfngin/test_assume_role/test_runner.py +++ b/tests/functional/cfngin/test_assume_role/test_runner.py @@ -1,11 +1,10 @@ """Test Runway assume role.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, Generator +from typing import TYPE_CHECKING, Any import boto3 import pytest @@ -15,6 +14,8 @@ from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result AWS_REGION = "us-east-1" @@ -27,9 +28,7 @@ def assert_session_belongs_to_account(session: boto3.Session, account_id: str) - @pytest.fixture(scope="module") -def assumed_session( - main_session: boto3.Session, variables: Dict[str, Any] -) -> boto3.Session: +def assumed_session(main_session: boto3.Session, variables: dict[str, Any]) -> boto3.Session: """boto3 session for assumed account.""" role_arn = variables["runner_role"]["test-alt"] sts_client = main_session.client("sts") @@ -52,15 +51,15 @@ def main_session() -> boto3.Session: @pytest.fixture(scope="module") -def variables() -> Dict[str, Any]: +def variables() -> dict[str, Any]: """Contents of runway.variables.yml.""" return yaml.safe_load((CURRENT_DIR / "runway.variables.yml").read_bytes()) @pytest.fixture(scope="module") -def deploy_result(cli_runner: CliRunner) -> Generator[Result, None, None]: +def deploy_result(cli_runner: CliRunner) -> Result: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" - yield cli_runner.invoke(cli, ["deploy", "--debug"], env={"CI": "1"}) + return cli_runner.invoke(cli, ["deploy", "--debug"], env={"CI": "1"}) @pytest.fixture(scope="module") @@ -77,7 +76,7 @@ def test_deploy_exit_code(deploy_result: Result) -> None: def test_does_not_exist_in_main_account( - main_session: boto3.Session, namespace: str, variables: Dict[str, Any] + main_session: boto3.Session, namespace: str, variables: dict[str, Any] ) -> None: """Test that the deployed stack does not exist in the main test account.""" assert_session_belongs_to_account(main_session, variables["account_id"]["test"]) @@ -89,12 +88,10 @@ def test_does_not_exist_in_main_account( def test_exists_in_assumed_account( - assumed_session: boto3.Session, namespace: str, variables: Dict[str, Any] + assumed_session: boto3.Session, namespace: str, variables: dict[str, Any] ) -> None: """Test that the deployed stack exists in the assumed account.""" - assert_session_belongs_to_account( - assumed_session, variables["account_id"]["test-alt"] - ) + assert_session_belongs_to_account(assumed_session, variables["account_id"]["test-alt"]) assert assumed_session.client("cloudformation").describe_stacks( StackName=f"{namespace}-test-assume-role" )["Stacks"] diff --git a/tests/functional/cfngin/test_aws_lambda_hook/cfngin.yml b/tests/functional/cfngin/test_aws_lambda_hook/cfngin.yml index ef62f7c0f..6b4b31bc3 100644 --- a/tests/functional/cfngin/test_aws_lambda_hook/cfngin.yml +++ b/tests/functional/cfngin/test_aws_lambda_hook/cfngin.yml @@ -21,12 +21,12 @@ pre_deploy: exclude: - '*.pyc' nondockerize: - path: ./lambda_src/nondockerize_src - runtime: python3.8 - include: - - '*.py' - exclude: - - '*.pyc' + path: ./lambda_src/nondockerize_src + runtime: python3.8 + include: + - '*.py' + exclude: + - '*.pyc' stacks: - name: test-dockerize @@ -46,17 +46,17 @@ stacks: post_deploy: - path: hooks.awslambda_test.invoke - required: True + required: true args: function_name: ${cfn ${namespace}-test-dockerize.LambdaFunction} - path: hooks.awslambda_test.invoke - required: True + required: true args: function_name: ${cfn ${namespace}-test-nondockerize.LambdaFunction} post_destroy: - path: hooks.cleanup.s3_delete_prefix - required: True + required: true args: bucket_name: ${cfngin_bucket} prefix: lambda_functions/${namespace}/ diff --git a/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/dockerize_src/Pipfile b/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/dockerize_src/Pipfile index cd5c3de34..bef4f4bba 100644 --- a/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/dockerize_src/Pipfile +++ b/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/dockerize_src/Pipfile @@ -1,9 +1,9 @@ -[[source]] -url = "https://pypi.org/simple" -verify_ssl = true -name = "pypi" +[dev-packages] [packages] numpy = "*" -[dev-packages] +[[source]] +name = "pypi" +url = "https://pypi.org/simple" +verify_ssl = true diff --git a/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/dockerize_src/dockerize.py b/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/dockerize_src/dockerize.py index b3b02c1db..3216d890c 100644 --- a/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/dockerize_src/dockerize.py +++ b/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/dockerize_src/dockerize.py @@ -1,15 +1,17 @@ -"""Test handler.""" +"""Test handler.""" # noqa: INP001 -# flake8: noqa -# pylint: disable=unused-argument -import lib +from __future__ import annotations +from typing import Any -def handler(event, context): +import lib # type: ignore + + +def handler(event: Any, context: Any) -> dict[str, int | str]: # noqa: ARG001 """Handle lambda.""" try: if lib.RESPONSE_OBJ.shape == (3, 5): - return {"statusCode": 200, "body": str(lib.RESPONSE_OBJ.shape)} + return {"statusCode": 200, "body": str(lib.RESPONSE_OBJ.shape)} # type: ignore raise ValueError - except: # pylint: disable=bare-except + except: # noqa: E722 return {"statusCode": 500, "body": "fail"} diff --git a/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/nondockerize_src/Pipfile b/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/nondockerize_src/Pipfile index cd5c3de34..bef4f4bba 100644 --- a/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/nondockerize_src/Pipfile +++ b/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/nondockerize_src/Pipfile @@ -1,9 +1,9 @@ -[[source]] -url = "https://pypi.org/simple" -verify_ssl = true -name = "pypi" +[dev-packages] [packages] numpy = "*" -[dev-packages] +[[source]] +name = "pypi" +url = "https://pypi.org/simple" +verify_ssl = true diff --git a/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/nondockerize_src/nondockerize.py b/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/nondockerize_src/nondockerize.py index b3b02c1db..3216d890c 100644 --- a/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/nondockerize_src/nondockerize.py +++ b/tests/functional/cfngin/test_aws_lambda_hook/lambda_src/nondockerize_src/nondockerize.py @@ -1,15 +1,17 @@ -"""Test handler.""" +"""Test handler.""" # noqa: INP001 -# flake8: noqa -# pylint: disable=unused-argument -import lib +from __future__ import annotations +from typing import Any -def handler(event, context): +import lib # type: ignore + + +def handler(event: Any, context: Any) -> dict[str, int | str]: # noqa: ARG001 """Handle lambda.""" try: if lib.RESPONSE_OBJ.shape == (3, 5): - return {"statusCode": 200, "body": str(lib.RESPONSE_OBJ.shape)} + return {"statusCode": 200, "body": str(lib.RESPONSE_OBJ.shape)} # type: ignore raise ValueError - except: # pylint: disable=bare-except + except: # noqa: E722 return {"statusCode": 500, "body": "fail"} diff --git a/tests/functional/cfngin/test_aws_lambda_hook/test_runner.py b/tests/functional/cfngin/test_aws_lambda_hook/test_runner.py index 2c988061b..5547b8a78 100644 --- a/tests/functional/cfngin/test_aws_lambda_hook/test_runner.py +++ b/tests/functional/cfngin/test_aws_lambda_hook/test_runner.py @@ -1,17 +1,18 @@ """Test AWS Lambda hook.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent @@ -61,8 +62,7 @@ def test_deploy_log_messages_pipenv(deploy_result: Result) -> None: def test_deploy_log_messages_upload(deploy_result: Result, namespace: str) -> None: """Test deploy log messages.""" assert ( - f"uploading object: lambda_functions/{namespace}/lambda-dockerize-" - in deploy_result.stdout + f"uploading object: lambda_functions/{namespace}/lambda-dockerize-" in deploy_result.stdout ) assert ( f"uploading object: lambda_functions/{namespace}/lambda-nondockerize-" diff --git a/tests/functional/cfngin/test_destroy_removed/00-bootstrap.yaml b/tests/functional/cfngin/test_destroy_removed/00-bootstrap.yaml index 6c3e17ed5..efed99c10 100644 --- a/tests/functional/cfngin/test_destroy_removed/00-bootstrap.yaml +++ b/tests/functional/cfngin/test_destroy_removed/00-bootstrap.yaml @@ -16,22 +16,22 @@ stacks: post_destroy: - path: hooks.cleanup.s3_delete_prefix - required: True + required: true args: bucket_name: ${cfngin_bucket} prefix: persistent_graphs/${namespace}/ - path: hooks.cleanup.s3_delete_prefix - required: True + required: true args: bucket_name: ${cfngin_bucket} prefix: stack_templates/${namespace}-bastion/ - path: hooks.cleanup.s3_delete_prefix - required: True + required: true args: bucket_name: ${cfngin_bucket} prefix: stack_templates/${namespace}-other/ - path: hooks.cleanup.s3_delete_prefix - required: True + required: true args: bucket_name: ${cfngin_bucket} prefix: stack_templates/${namespace}-vpc/ diff --git a/tests/functional/cfngin/test_destroy_removed/test_runner.py b/tests/functional/cfngin/test_destroy_removed/test_runner.py index 2bc183a53..24414f841 100644 --- a/tests/functional/cfngin/test_destroy_removed/test_runner.py +++ b/tests/functional/cfngin/test_destroy_removed/test_runner.py @@ -1,17 +1,18 @@ """Test destroy stack removed from persistent graph.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent @@ -50,8 +51,7 @@ def test_deploy_log_messages(deploy_result: Result, namespace: str) -> None: ) assert ( '00-bootstrap:locked persistent graph "runway-testing-lab-cfngin-bucket-us-east-1' - f'/persistent_graphs/{namespace}/test.json" with lock ID "' - in deploy_result.stdout + f'/persistent_graphs/{namespace}/test.json" with lock ID "' in deploy_result.stdout ) assert ( '00-bootstrap:unlocked persistent graph "runway-testing-lab-cfngin-bucket-us-east-1' @@ -59,8 +59,7 @@ def test_deploy_log_messages(deploy_result: Result, namespace: str) -> None: ) assert ( '01-removed:locked persistent graph "runway-testing-lab-cfngin-bucket-us-east-1' - f'/persistent_graphs/{namespace}/test.json" with lock ID "' - in deploy_result.stdout + f'/persistent_graphs/{namespace}/test.json" with lock ID "' in deploy_result.stdout ) assert ( f"{namespace}-other:removed from the CFNgin config file; it is being destroyed" @@ -85,7 +84,4 @@ def test_destroy_exit_code(destroy_result: Result) -> None: @pytest.mark.order(after="test_destroy_exit_code") def test_destroy_log_messages(destroy_result: Result) -> None: """Test destroy log messages.""" - assert ( - "persistent graph deleted; does not need to be unlocked" - in destroy_result.stdout - ) + assert "persistent graph deleted; does not need to be unlocked" in destroy_result.stdout diff --git a/tests/functional/cfngin/test_duplicate_stack/test_runner.py b/tests/functional/cfngin/test_duplicate_stack/test_runner.py index a870c6c51..ee4b4b173 100644 --- a/tests/functional/cfngin/test_duplicate_stack/test_runner.py +++ b/tests/functional/cfngin/test_duplicate_stack/test_runner.py @@ -1,17 +1,18 @@ """Test duplicate stack names.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent diff --git a/tests/functional/cfngin/test_locked_stack/test_runner.py b/tests/functional/cfngin/test_locked_stack/test_runner.py index 7ea182023..6e57045de 100644 --- a/tests/functional/cfngin/test_locked_stack/test_runner.py +++ b/tests/functional/cfngin/test_locked_stack/test_runner.py @@ -1,17 +1,18 @@ """Test locked stack.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent diff --git a/tests/functional/cfngin/test_parallel/test_runner.py b/tests/functional/cfngin/test_parallel/test_runner.py index 43d4d3bb0..6ec32268a 100644 --- a/tests/functional/cfngin/test_parallel/test_runner.py +++ b/tests/functional/cfngin/test_parallel/test_runner.py @@ -1,27 +1,28 @@ """Test parallel deployment.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import platform import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent @pytest.fixture(scope="module") -def deploy_result(cli_runner: CliRunner) -> Generator[Result, None, None]: +def deploy_result(cli_runner: CliRunner) -> Result: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" - yield cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) + return cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) @pytest.fixture(scope="module") @@ -34,18 +35,14 @@ def destroy_result(cli_runner: CliRunner) -> Generator[Result, None, None]: @pytest.mark.order("first") -@pytest.mark.skipif( - platform.system() != "Linux", reason="only runs consistently on Linux" -) +@pytest.mark.skipif(platform.system() != "Linux", reason="only runs consistently on Linux") def test_deploy_exit_code(deploy_result: Result) -> None: """Test deploy exit code.""" assert deploy_result.exit_code == 0 @pytest.mark.order(after="test_deploy_exit_code") -@pytest.mark.skipif( - platform.system() != "Linux", reason="only runs consistently on Linux" -) +@pytest.mark.skipif(platform.system() != "Linux", reason="only runs consistently on Linux") def test_deploy_log_messages(deploy_result: Result) -> None: """Test deploy log messages.""" assert ( @@ -55,9 +52,7 @@ def test_deploy_log_messages(deploy_result: Result) -> None: @pytest.mark.order("last") -@pytest.mark.skipif( - platform.system() != "Linux", reason="only runs consistently on Linux" -) +@pytest.mark.skipif(platform.system() != "Linux", reason="only runs consistently on Linux") def test_destroy_exit_code(destroy_result: Result) -> None: """Test destroy exit code.""" assert destroy_result.exit_code == 0 diff --git a/tests/functional/cfngin/test_raw_cfn/templates/dummy.yml b/tests/functional/cfngin/test_raw_cfn/templates/dummy.yml index cbebd07c2..e92b8d44f 100644 --- a/tests/functional/cfngin/test_raw_cfn/templates/dummy.yml +++ b/tests/functional/cfngin/test_raw_cfn/templates/dummy.yml @@ -16,10 +16,8 @@ Parameters: Conditions: - DeployOne: - !Or [ !Equals [ !Ref WaitConditionCount, 1 ], !Equals [ !Ref WaitConditionCount, 2 ] ] - DeployTwo: - !Equals [ !Ref WaitConditionCount, 2 ] + DeployOne: !Or [!Equals [!Ref WaitConditionCount, 1], !Equals [!Ref WaitConditionCount, 2]] + DeployTwo: !Equals [!Ref WaitConditionCount, 2] Resources: diff --git a/tests/functional/cfngin/test_raw_cfn/test_runner.py b/tests/functional/cfngin/test_raw_cfn/test_runner.py index c559ddfaf..51ac53696 100644 --- a/tests/functional/cfngin/test_raw_cfn/test_runner.py +++ b/tests/functional/cfngin/test_raw_cfn/test_runner.py @@ -1,17 +1,18 @@ """Test using raw CloudFormation template.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent diff --git a/tests/functional/cfngin/test_recreate_failed/test_runner.py b/tests/functional/cfngin/test_recreate_failed/test_runner.py index 3d304f98e..4f0e72753 100644 --- a/tests/functional/cfngin/test_recreate_failed/test_runner.py +++ b/tests/functional/cfngin/test_recreate_failed/test_runner.py @@ -1,17 +1,18 @@ """Test recreation of a failed deployment.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent @@ -21,10 +22,7 @@ def deploy_bad_result(cli_runner: CliRunner) -> Generator[Result, None, None]: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" yield cli_runner.invoke(cli, ["deploy", "--tag", "bad"], env={"CI": "1"}) - assert ( - cli_runner.invoke(cli, ["destroy", "--tag", "good"], env={"CI": "1"}).exit_code - == 0 - ) + assert cli_runner.invoke(cli, ["destroy", "--tag", "good"], env={"CI": "1"}).exit_code == 0 shutil.rmtree(CURRENT_DIR / ".runway", ignore_errors=True) @@ -60,8 +58,7 @@ def test_deploy_bad_log_messages(deploy_bad_result: Result, namespace: str) -> N # output may or may not have a "rolled back" or "failed (creating new stack)" msg # depends on API throttling assert ( - "[runway] The following steps failed: recreate-failed" - in deploy_bad_result.stdout + "[runway] The following steps failed: recreate-failed" in deploy_bad_result.stdout ), f"stdout does not match expected\n\nSTDOUT:\n{deploy_bad_result.stdout}" diff --git a/tests/functional/cfngin/test_rollback_dependant/test_runner.py b/tests/functional/cfngin/test_rollback_dependant/test_runner.py index cce4da118..0a397a5bd 100644 --- a/tests/functional/cfngin/test_rollback_dependant/test_runner.py +++ b/tests/functional/cfngin/test_rollback_dependant/test_runner.py @@ -1,17 +1,18 @@ """Test failed stack with dependency.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent diff --git a/tests/functional/cfngin/test_simple_build/test_runner.py b/tests/functional/cfngin/test_simple_build/test_runner.py index f7b6fdfdc..5aaae4b56 100644 --- a/tests/functional/cfngin/test_simple_build/test_runner.py +++ b/tests/functional/cfngin/test_simple_build/test_runner.py @@ -1,11 +1,10 @@ """Run a simple test of CFNgin deploy and destroy.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest @@ -13,6 +12,8 @@ from runway.config import CfnginConfig if TYPE_CHECKING: + from collections.abc import Generator + from _pytest.fixtures import SubRequest from click.testing import CliRunner, Result @@ -27,9 +28,7 @@ def cfngin_config( request: SubRequest, runway_config: RunwayConfig, runway_context: RunwayContext ) -> CfnginConfig: """Find and return the CFNgin config.""" - runway_config.deployments[0].resolve( - runway_context, variables=runway_config.variables - ) + runway_config.deployments[0].resolve(runway_context, variables=runway_config.variables) return CfnginConfig.parse_file( path=request.path.parent / "simple-build.cfn" / "cfngin.yml", parameters=runway_config.deployments[0].parameters, @@ -163,9 +162,7 @@ def test_stacks_not_exists(cfngin_context: CfnginContext) -> None: client = cfngin_context.get_session(region="us-east-1").client("cloudformation") assert cfngin_context.stacks, "no stacks found in context/config" for stack in cfngin_context.stacks: - try: + with pytest.raises(client.exceptions.ClientError, match="does not exist"): assert not client.describe_stacks(StackName=stack.fqn)[ "Stacks" ], f"stack exists: {stack.fqn}" - except client.exceptions.ClientError as exc: - assert "does not exist" in str(exc) diff --git a/tests/functional/cfngin/test_simple_diff/blueprints.py b/tests/functional/cfngin/test_simple_diff/blueprints.py index 99150ca6a..a7479a7a0 100644 --- a/tests/functional/cfngin/test_simple_diff/blueprints.py +++ b/tests/functional/cfngin/test_simple_diff/blueprints.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict +from typing import TYPE_CHECKING, ClassVar from troposphere.cloudformation import WaitConditionHandle @@ -16,7 +16,7 @@ class DiffTester(Blueprint): """Diff tester.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "InstanceType": { "type": CFNString, "description": "NAT EC2 instance type.", @@ -24,8 +24,7 @@ class DiffTester(Blueprint): }, "WaitConditionCount": { "type": int, - "description": "Number of WaitConditionHandle resources " - "to add to the template", + "description": "Number of WaitConditionHandle resources to add to the template", }, } diff --git a/tests/functional/cfngin/test_simple_diff/test_runner.py b/tests/functional/cfngin/test_simple_diff/test_runner.py index 3b828e8ec..1aac871bd 100644 --- a/tests/functional/cfngin/test_simple_diff/test_runner.py +++ b/tests/functional/cfngin/test_simple_diff/test_runner.py @@ -1,15 +1,16 @@ """Run a simple test of `runway plan` for CFNgin.""" -# pylint: disable=redefined-outer-name,unused-argument from __future__ import annotations -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result from runway.config import RunwayConfig @@ -24,11 +25,9 @@ def initial_deploy(cli_runner: CliRunner) -> Generator[None, None, None]: @pytest.fixture(scope="module") -def plan_result(cli_runner: CliRunner, initial_deploy: None) -> Result: +def plan_result(cli_runner: CliRunner, initial_deploy: None) -> Result: # noqa: ARG001 """Execute `runway plan`.""" - return cli_runner.invoke( - cli, ["plan"], env={"CI": "1", "DEPLOY_ENVIRONMENT": "test2"} - ) + return cli_runner.invoke(cli, ["plan"], env={"CI": "1", "DEPLOY_ENVIRONMENT": "test2"}) @pytest.mark.order("first") diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py index 68ddf6e6d..5abacb0ea 100644 --- a/tests/functional/conftest.py +++ b/tests/functional/conftest.py @@ -1,15 +1,13 @@ """Pytest configuration, fixtures, and plugins.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import os from pathlib import Path -from typing import TYPE_CHECKING, Any, Generator +from typing import TYPE_CHECKING, Any +from unittest.mock import patch import pytest -from click.testing import CliRunner -from mock import patch from runway.config import CfnginConfig, RunwayConfig from runway.context import CfnginContext, RunwayContext @@ -19,12 +17,14 @@ from ..factories import cli_runner_factory if TYPE_CHECKING: + from collections.abc import Generator + from _pytest.config import Config from _pytest.fixtures import SubRequest + from click.testing import CliRunner -# pylint: disable=unused-argument -def pytest_ignore_collect(path: Any, config: Config) -> bool: +def pytest_ignore_collect(path: Any, config: Config) -> bool: # noqa: ARG001 """Determine if this directory should have its tests collected.""" return not config.option.functional @@ -58,9 +58,7 @@ def cfngin_config( request: SubRequest, runway_config: RunwayConfig, runway_context: RunwayContext ) -> CfnginConfig: """Find and return the CFNgin config.""" - runway_config.deployments[0].resolve( - runway_context, variables=runway_config.variables - ) + runway_config.deployments[0].resolve(runway_context, variables=runway_config.variables) return CfnginConfig.parse_file( path=request.path.parent / "cfngin.yml", parameters=runway_config.deployments[0].parameters, @@ -84,7 +82,7 @@ def cfngin_context( @pytest.fixture(scope="module") -def cli_runner(cd_test_dir: Path, request: SubRequest) -> CliRunner: +def cli_runner(cd_test_dir: Path, request: SubRequest) -> CliRunner: # noqa: ARG001 """Initialize instance of `click.testing.CliRunner`.""" return cli_runner_factory(request) diff --git a/tests/functional/serverless/test_promotezip/package.json b/tests/functional/serverless/test_promotezip/package.json index 5a74a853d..413f27c15 100644 --- a/tests/functional/serverless/test_promotezip/package.json +++ b/tests/functional/serverless/test_promotezip/package.json @@ -1,19 +1,19 @@ { - "name": "test_promotezip", - "version": "1.0.0", - "description": "", - "main": "index.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "keywords": [], "author": "", - "license": "ISC", + "description": "", "devDependencies": { "@typescript-eslint/eslint-plugin": "^5.48.1", "@typescript-eslint/parser": "^5.48.1", "eslint": "^8.31.0", "serverless": "~3.30.1", "typescript": "^4.9.4" - } + }, + "keywords": [], + "license": "ISC", + "main": "index.js", + "name": "test_promotezip", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "version": "1.0.0" } diff --git a/tests/functional/serverless/test_promotezip/test_runner.py b/tests/functional/serverless/test_promotezip/test_runner.py index 58f680dd1..2b16ebdc3 100644 --- a/tests/functional/serverless/test_promotezip/test_runner.py +++ b/tests/functional/serverless/test_promotezip/test_runner.py @@ -1,26 +1,27 @@ """Test promote zip between environments.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent @pytest.fixture(scope="module") -def deploy_promotezip_result(cli_runner: CliRunner) -> Generator[Result, None, None]: +def deploy_promotezip_result(cli_runner: CliRunner) -> Result: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" - yield cli_runner.invoke( + return cli_runner.invoke( cli, ["deploy", "--tag", "sls"], env={"DEPLOY_ENVIRONMENT": "promotezip", "CI": "1"}, @@ -28,15 +29,15 @@ def deploy_promotezip_result(cli_runner: CliRunner) -> Generator[Result, None, N @pytest.fixture(scope="module") -def deploy_result(cli_runner: CliRunner) -> Generator[Result, None, None]: +def deploy_result(cli_runner: CliRunner) -> Result: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" - yield cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) + return cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) @pytest.fixture(scope="module") -def destroy_promotezip_result(cli_runner: CliRunner) -> Generator[Result, None, None]: +def destroy_promotezip_result(cli_runner: CliRunner) -> Result: """Execute `runway destroy`.""" - yield cli_runner.invoke( + return cli_runner.invoke( cli, ["destroy", "--tag", "sls"], env={"DEPLOY_ENVIRONMENT": "promotezip", "CI": "1"}, @@ -70,15 +71,13 @@ def test_deploy_promotezip_exit_code(deploy_promotezip_result: Result) -> None: def test_deploy_promotezip_log_messages(deploy_promotezip_result: Result) -> None: """Test deploy log messages.""" assert ( - "test_promotezip:found existing package for helloWorld0" - in deploy_promotezip_result.stdout + "test_promotezip:found existing package for helloWorld0" in deploy_promotezip_result.stdout ), f"expected not in stdout:\n{deploy_promotezip_result.stdout}" assert ( "downloading s3://" in deploy_promotezip_result.stdout ), f"expected not in stdout:\n{deploy_promotezip_result.stdout}" assert ( - "est_promotezip:found existing package for helloWorld1" - in deploy_promotezip_result.stdout + "est_promotezip:found existing package for helloWorld1" in deploy_promotezip_result.stdout ), f"expected not in stdout:\n{deploy_promotezip_result.stdout}" diff --git a/tests/functional/sources/git/test_runner.py b/tests/functional/sources/git/test_runner.py index 46d8c6a64..a68e9d8ab 100644 --- a/tests/functional/sources/git/test_runner.py +++ b/tests/functional/sources/git/test_runner.py @@ -1,26 +1,27 @@ """Test Runway module from git repo.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent @pytest.fixture(scope="module") -def deploy_result(cli_runner: CliRunner) -> Generator[Result, None, None]: +def deploy_result(cli_runner: CliRunner) -> Result: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" - yield cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) + return cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) @pytest.fixture(scope="module") diff --git a/tests/functional/staticsite/test_simple_build/runway.yml b/tests/functional/staticsite/test_simple_build/runway.yml index 7edf53770..bc80d1521 100644 --- a/tests/functional/staticsite/test_simple_build/runway.yml +++ b/tests/functional/staticsite/test_simple_build/runway.yml @@ -1,12 +1,12 @@ deployments: - modules: - - name: test-simple-build - path: ./ - type: static - parameters: - namespace: ${env RUNWAY_TEST_NAMESPACE::default=${env USER::default=user}-local} - staticsite_cf_disable: true - options: - build_output: site + - name: test-simple-build + path: ./ + type: static + parameters: + namespace: ${env RUNWAY_TEST_NAMESPACE::default=${env USER::default=user}-local} + staticsite_cf_disable: true + options: + build_output: site regions: - us-east-1 diff --git a/tests/functional/staticsite/test_simple_build/test_runner.py b/tests/functional/staticsite/test_simple_build/test_runner.py index 59c26bb64..2a1bd97de 100644 --- a/tests/functional/staticsite/test_simple_build/test_runner.py +++ b/tests/functional/staticsite/test_simple_build/test_runner.py @@ -1,26 +1,27 @@ """Test staticsite.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest from runway._cli import cli if TYPE_CHECKING: + from collections.abc import Generator + from click.testing import CliRunner, Result CURRENT_DIR = Path(__file__).parent @pytest.fixture(scope="module") -def deploy_result(cli_runner: CliRunner) -> Generator[Result, None, None]: +def deploy_result(cli_runner: CliRunner) -> Result: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" - yield cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) + return cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) @pytest.fixture(scope="module") diff --git a/tests/functional/terraform/conftest.py b/tests/functional/terraform/conftest.py index 1117f5a55..32355317a 100644 --- a/tests/functional/terraform/conftest.py +++ b/tests/functional/terraform/conftest.py @@ -1,15 +1,16 @@ """Pytest configuration, fixtures, and plugins.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator +from typing import TYPE_CHECKING import pytest if TYPE_CHECKING: + from collections.abc import Generator + from _pytest.fixtures import SubRequest @@ -19,10 +20,8 @@ def fixture_dir() -> Path: return Path(__file__).parent / "fixtures" -@pytest.fixture(scope="function") -def local_backend( - fixture_dir: Path, request: SubRequest -) -> Generator[Path, None, None]: +@pytest.fixture() +def local_backend(fixture_dir: Path, request: SubRequest) -> Generator[Path, None, None]: """Copy local_backend.tf into the test directory.""" file_name = "local_backend.tf" og_file = fixture_dir / file_name @@ -32,7 +31,7 @@ def local_backend( new_file.unlink() -@pytest.fixture(scope="function") +@pytest.fixture() def no_backend(fixture_dir: Path, request: SubRequest) -> Generator[Path, None, None]: """Copy no_backend.tf into the test directory.""" file_name = "no_backend.tf" @@ -43,7 +42,7 @@ def no_backend(fixture_dir: Path, request: SubRequest) -> Generator[Path, None, new_file.unlink() -@pytest.fixture(scope="function") +@pytest.fixture() def s3_backend(fixture_dir: Path, request: SubRequest) -> Generator[Path, None, None]: """Copy s3_backend.tf into the test directory.""" file_name = "s3_backend.tf" diff --git a/tests/functional/terraform/test_backend_local_2_s3/test_runner.py b/tests/functional/terraform/test_backend_local_2_s3/test_runner.py index ff3fdbd95..29084e52f 100644 --- a/tests/functional/terraform/test_backend_local_2_s3/test_runner.py +++ b/tests/functional/terraform/test_backend_local_2_s3/test_runner.py @@ -1,12 +1,11 @@ """Test migrating local backend to s3.""" -# pylint: disable=redefined-outer-name,unused-argument from __future__ import annotations import locale import shutil from pathlib import Path -from typing import TYPE_CHECKING, Iterator, cast +from typing import TYPE_CHECKING, cast import pytest @@ -14,6 +13,8 @@ from runway.env_mgr.tfenv import TF_VERSION_FILENAME if TYPE_CHECKING: + from collections.abc import Iterator + from _pytest.fixtures import SubRequest from click.testing import CliRunner, Result @@ -25,9 +26,7 @@ def tf_state_bucket(cli_runner: CliRunner) -> Iterator[None]: """Create Terraform state bucket and table.""" cli_runner.invoke(cli, ["deploy", "--tag", "bootstrap"], env={"CI": "1"}) yield - destroy_result = cli_runner.invoke( - cli, ["destroy", "--tag", "cleanup"], env={"CI": "1"} - ) + destroy_result = cli_runner.invoke(cli, ["destroy", "--tag", "cleanup"], env={"CI": "1"}) assert destroy_result.exit_code == 0 @@ -44,20 +43,20 @@ def tf_version(request: SubRequest) -> Iterator[str]: encoding=locale.getpreferredencoding(do_setlocale=False), ) yield cast(str, request.param) - file_path.unlink(missing_ok=True) # pylint: disable=unexpected-keyword-arg + file_path.unlink(missing_ok=True) -@pytest.fixture(scope="function") +@pytest.fixture() def deploy_local_backend_result( - cli_runner: CliRunner, local_backend: Path -) -> Iterator[Result]: + cli_runner: CliRunner, local_backend: Path # noqa: ARG001 +) -> Result: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" - yield cli_runner.invoke(cli, ["deploy", "--tag", "local"], env={"CI": "1"}) + return cli_runner.invoke(cli, ["deploy", "--tag", "local"], env={"CI": "1"}) -@pytest.fixture(scope="function") +@pytest.fixture() def deploy_s3_backend_result( - cli_runner: CliRunner, s3_backend: Path + cli_runner: CliRunner, s3_backend: Path # noqa: ARG001 ) -> Iterator[Result]: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" yield cli_runner.invoke(cli, ["deploy", "--tag", "test"], env={"CI": "1"}) @@ -65,10 +64,7 @@ def deploy_s3_backend_result( shutil.rmtree(CURRENT_DIR / ".runway", ignore_errors=True) shutil.rmtree(CURRENT_DIR / ".terraform", ignore_errors=True) shutil.rmtree(CURRENT_DIR / "terraform.tfstate.d", ignore_errors=True) - (CURRENT_DIR / "local_backend").unlink( # pylint: disable=unexpected-keyword-arg - missing_ok=True - ) - # pylint: disable=unexpected-keyword-arg + (CURRENT_DIR / "local_backend").unlink(missing_ok=True) (CURRENT_DIR / ".terraform.lock.hcl").unlink(missing_ok=True) diff --git a/tests/functional/terraform/test_backend_no_2_local/test_runner.py b/tests/functional/terraform/test_backend_no_2_local/test_runner.py index 0f9c0afbe..e2c7f0c0d 100644 --- a/tests/functional/terraform/test_backend_no_2_local/test_runner.py +++ b/tests/functional/terraform/test_backend_no_2_local/test_runner.py @@ -1,12 +1,11 @@ """Test migration from no backend to local backend.""" -# pylint: disable=redefined-outer-name,unused-argument from __future__ import annotations import locale import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator, cast +from typing import TYPE_CHECKING, cast import pytest @@ -14,6 +13,8 @@ from runway.env_mgr.tfenv import TF_VERSION_FILENAME if TYPE_CHECKING: + from collections.abc import Generator + from _pytest.fixtures import SubRequest from click.testing import CliRunner, Result @@ -33,14 +34,14 @@ def tf_version(request: SubRequest) -> Generator[str, None, None]: encoding=locale.getpreferredencoding(do_setlocale=False), ) yield cast(str, request.param) - file_path.unlink(missing_ok=True) # pylint: disable=unexpected-keyword-arg + file_path.unlink(missing_ok=True) -@pytest.fixture(scope="function") +@pytest.fixture() def deploy_local_backend_result( cli_runner: CliRunner, - local_backend: Path, - tf_version: str, + local_backend: Path, # noqa: ARG001 + tf_version: str, # noqa: ARG001 ) -> Generator[Result, None, None]: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" assert (CURRENT_DIR / "terraform.tfstate.d").exists() @@ -49,18 +50,17 @@ def deploy_local_backend_result( shutil.rmtree(CURRENT_DIR / ".runway", ignore_errors=True) shutil.rmtree(CURRENT_DIR / ".terraform", ignore_errors=True) shutil.rmtree(CURRENT_DIR / "terraform.tfstate.d", ignore_errors=True) - # pylint: disable=unexpected-keyword-arg (CURRENT_DIR / ".terraform.lock.hcl").unlink(missing_ok=True) -@pytest.fixture(scope="function") +@pytest.fixture() def deploy_no_backend_result( cli_runner: CliRunner, - no_backend: Path, - tf_version: str, -) -> Generator[Result, None, None]: + no_backend: Path, # noqa: ARG001 + tf_version: str, # noqa: ARG001 +) -> Result: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" - yield cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) + return cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) def test_deploy_no_backend_result(deploy_no_backend_result: Result) -> None: diff --git a/tests/functional/terraform/test_base/test_runner.py b/tests/functional/terraform/test_base/test_runner.py index 73618bf60..9e9354970 100644 --- a/tests/functional/terraform/test_base/test_runner.py +++ b/tests/functional/terraform/test_base/test_runner.py @@ -5,13 +5,12 @@ """ -# pylint: disable=redefined-outer-name from __future__ import annotations import locale import shutil from pathlib import Path -from typing import TYPE_CHECKING, Generator, cast +from typing import TYPE_CHECKING, cast import pytest @@ -19,6 +18,8 @@ from runway.env_mgr.tfenv import TF_VERSION_FILENAME if TYPE_CHECKING: + from collections.abc import Generator + from _pytest.fixtures import SubRequest from click.testing import CliRunner, Result @@ -38,12 +39,12 @@ def tf_version(request: SubRequest) -> Generator[str, None, None]: encoding=locale.getpreferredencoding(do_setlocale=False), ) yield cast(str, request.param) - file_path.unlink(missing_ok=True) # pylint: disable=unexpected-keyword-arg + file_path.unlink(missing_ok=True) -@pytest.fixture(scope="function") +@pytest.fixture() def deploy_result( - cli_runner: CliRunner, no_backend: Path # pylint: disable=unused-argument + cli_runner: CliRunner, no_backend: Path # noqa: ARG001 ) -> Generator[Result, None, None]: """Execute `runway deploy` with `runway destroy` as a cleanup step.""" yield cli_runner.invoke(cli, ["deploy"], env={"CI": "1"}) @@ -52,7 +53,6 @@ def deploy_result( shutil.rmtree(CURRENT_DIR / ".runway", ignore_errors=True) shutil.rmtree(CURRENT_DIR / ".terraform", ignore_errors=True) shutil.rmtree(CURRENT_DIR / "terraform.tfstate.d", ignore_errors=True) - # pylint: disable=unexpected-keyword-arg (CURRENT_DIR / ".terraform.lock.hcl").unlink(missing_ok=True) assert destroy_result.exit_code == 0 diff --git a/tests/integration/cli/commands/kbenv/conftest.py b/tests/integration/cli/commands/kbenv/conftest.py new file mode 100644 index 000000000..4eb0abf43 --- /dev/null +++ b/tests/integration/cli/commands/kbenv/conftest.py @@ -0,0 +1,24 @@ +"""Pytest fixtures and plugins.""" + +from __future__ import annotations + +from typing import TYPE_CHECKING + +import pytest + +if TYPE_CHECKING: + from pathlib import Path + + from pytest_mock import MockFixture + + +@pytest.fixture(autouse=True) +def versions_dir(cd_tmp_path: Path, mocker: MockFixture) -> Path: + """Patches TFEnvManager.versions_dir.""" + path = cd_tmp_path / "versions" + path.mkdir(exist_ok=True) + mocker.patch("runway._cli.commands._kbenv._install.KBEnvManager.versions_dir", path) + mocker.patch("runway._cli.commands._kbenv._list.KBEnvManager.versions_dir", path) + mocker.patch("runway._cli.commands._kbenv._run.KBEnvManager.versions_dir", path) + mocker.patch("runway._cli.commands._kbenv._uninstall.KBEnvManager.versions_dir", path) + return path diff --git a/tests/integration/cli/commands/kbenv/test_install.py b/tests/integration/cli/commands/kbenv/test_install.py index c39be8277..d5d37464b 100644 --- a/tests/integration/cli/commands/kbenv/test_install.py +++ b/tests/integration/cli/commands/kbenv/test_install.py @@ -1,30 +1,21 @@ """Test ``runway kbenv install`` command.""" -# pylint: disable=unused-argument from __future__ import annotations import logging from pathlib import Path from typing import TYPE_CHECKING -import pytest from click.testing import CliRunner from runway._cli import cli -from runway.env_mgr.kbenv import KB_VERSION_FILENAME, KBEnvManager +from runway.env_mgr.kbenv import KB_VERSION_FILENAME if TYPE_CHECKING: - from pytest import LogCaptureFixture - from pytest_mock import MockerFixture + import pytest -@pytest.fixture(autouse=True, scope="function") -def patch_versions_dir(mocker: MockerFixture, tmp_path: Path) -> None: - """Patch TFEnvManager.versions_dir.""" - mocker.patch.object(KBEnvManager, "versions_dir", tmp_path) - - -def test_kbenv_install(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_kbenv_install(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway kbenv install`` reading version from a file. For best results, remove any existing installs. @@ -41,12 +32,11 @@ def test_kbenv_install(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: def test_kbenv_install_no_version_file( - cd_tmp_path: Path, caplog: LogCaptureFixture + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner ) -> None: """Test ``runway kbenv install`` no version file.""" caplog.set_level(logging.WARNING, logger="runway") - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "install"]) + result = cli_runner.invoke(cli, ["kbenv", "install"]) assert result.exit_code == 1 assert ( @@ -55,7 +45,7 @@ def test_kbenv_install_no_version_file( ) -def test_kbenv_install_version(caplog: LogCaptureFixture) -> None: +def test_kbenv_install_version(caplog: pytest.LogCaptureFixture) -> None: """Test ``runway kbenv install ``. For best results, remove any existing installs. diff --git a/tests/integration/cli/commands/kbenv/test_list.py b/tests/integration/cli/commands/kbenv/test_list.py index 122c225b8..39ea3d155 100644 --- a/tests/integration/cli/commands/kbenv/test_list.py +++ b/tests/integration/cli/commands/kbenv/test_list.py @@ -5,44 +5,40 @@ import logging from typing import TYPE_CHECKING -from click.testing import CliRunner - from runway._cli import cli -from runway.env_mgr.kbenv import KBEnvManager if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture - from pytest_mock import MockerFixture + import pytest + from click.testing import CliRunner def test_kbenv_list( - caplog: LogCaptureFixture, mocker: MockerFixture, tmp_path: Path + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner, versions_dir: Path ) -> None: """Test ``runway kbenv list``.""" - caplog.set_level(logging.INFO, logger="runway.cli.commands.kbenv") - mocker.patch.object(KBEnvManager, "versions_dir", tmp_path) - version_dirs = [tmp_path / "v1.14.0", tmp_path / "v1.21.0"] + caplog.set_level(logging.INFO, logger="runway._cli.commands._kbenv") + version_dirs = [versions_dir / "v1.14.0", versions_dir / "v1.21.0"] for v_dir in version_dirs: v_dir.mkdir() - (tmp_path / "something.txt").touch() - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "list"]) + (versions_dir / "something.txt").touch() + result = cli_runner.invoke(cli, ["kbenv", "list"]) assert result.exit_code == 0 assert caplog.messages == ["kubectl versions installed:"] - assert result.stdout == "\n".join( - ["[runway] kubectl versions installed:", "v1.14.0", "v1.21.0", ""] - ) + assert {i.strip() for i in result.output.split("\n")} == { + "[runway] kubectl versions installed:", + "v1.14.0", + "v1.21.0", + "", + } def test_kbenv_list_none( - caplog: LogCaptureFixture, mocker: MockerFixture, tmp_path: Path + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner, versions_dir: Path ) -> None: """Test ``runway kbenv list`` no versions installed.""" - caplog.set_level(logging.WARNING, logger="runway.cli.commands.kbenv") - mocker.patch.object(KBEnvManager, "versions_dir", tmp_path) - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "list"]) + caplog.set_level(logging.WARNING, logger="runway._cli.commands._kbenv") + result = cli_runner.invoke(cli, ["kbenv", "list"]) assert result.exit_code == 0 - assert caplog.messages == [f"no versions of kubectl installed at path {tmp_path}"] + assert caplog.messages == [f"no versions of kubectl installed at path {versions_dir}"] diff --git a/tests/integration/cli/commands/kbenv/test_run.py b/tests/integration/cli/commands/kbenv/test_run.py index 2baaa39e8..d5624375a 100644 --- a/tests/integration/cli/commands/kbenv/test_run.py +++ b/tests/integration/cli/commands/kbenv/test_run.py @@ -1,29 +1,27 @@ """Test ``runway kbenv run`` command.""" -# pylint: disable=unused-argument from __future__ import annotations import logging from typing import TYPE_CHECKING -from click.testing import CliRunner - from runway._cli import cli from runway.env_mgr.kbenv import KB_VERSION_FILENAME if TYPE_CHECKING: from pathlib import Path - from pytest import CaptureFixture, LogCaptureFixture + import pytest + from click.testing import CliRunner def test_kbenv_run_no_version_file( - cd_tmp_path: Path, caplog: LogCaptureFixture + caplog: pytest.LogCaptureFixture, + cli_runner: CliRunner, ) -> None: """Test ``runway kbenv run -- --help`` no version file.""" caplog.set_level(logging.WARNING, logger="runway") - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "run", "--", "--help"]) + result = cli_runner.invoke(cli, ["kbenv", "run", "--", "--help"]) assert result.exit_code == 1 assert ( @@ -32,7 +30,9 @@ def test_kbenv_run_no_version_file( ) -def test_kbenv_run_separator(cd_tmp_path: Path, capfd: CaptureFixture[str]) -> None: +def test_kbenv_run_separator( + capfd: pytest.CaptureFixture[str], cli_runner: CliRunner, tmp_path: Path +) -> None: """Test ``runway kbenv run -- --help``. Parsing of command using ``--`` as a separator between options and args. @@ -41,24 +41,24 @@ def test_kbenv_run_separator(cd_tmp_path: Path, capfd: CaptureFixture[str]) -> N pass options shared with Runway such as ``--help``. """ - (cd_tmp_path / KB_VERSION_FILENAME).write_text("v1.14.0") - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "run", "--", "--help"]) + (tmp_path / KB_VERSION_FILENAME).write_text("v1.14.0") + result = cli_runner.invoke(cli, ["kbenv", "run", "--", "--help"]) captured = capfd.readouterr() # capfd required for subprocess assert result.exit_code == 0 assert "runway" not in captured.out assert "kubectl --help" in captured.out -def test_kbenv_run_version(cd_tmp_path: Path, capfd: CaptureFixture[str]) -> None: +def test_kbenv_run_version( + capfd: pytest.CaptureFixture[str], cli_runner: CliRunner, tmp_path: Path +) -> None: """Test ``runway kbenv run version``. Parsing of bare command. """ - (cd_tmp_path / KB_VERSION_FILENAME).write_text("v1.14.0") - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "run", "version", "--client"]) + (tmp_path / KB_VERSION_FILENAME).write_text("v1.14.0") + result = cli_runner.invoke(cli, ["kbenv", "run", "version", "--client"]) captured = capfd.readouterr() # capfd required for subprocess assert result.exit_code == 0 assert "v1.14.0" in captured.out diff --git a/tests/integration/cli/commands/kbenv/test_uninstall.py b/tests/integration/cli/commands/kbenv/test_uninstall.py index a85feeb14..089e652ed 100644 --- a/tests/integration/cli/commands/kbenv/test_uninstall.py +++ b/tests/integration/cli/commands/kbenv/test_uninstall.py @@ -1,50 +1,41 @@ """Test ``runway kbenv uninstall`` command.""" -# pylint: disable=unused-argument from __future__ import annotations import logging -from pathlib import Path from typing import TYPE_CHECKING -import pytest -from click.testing import CliRunner - from runway._cli import cli -from runway.env_mgr.kbenv import KB_VERSION_FILENAME, KBEnvManager +from runway.env_mgr.kbenv import KB_VERSION_FILENAME if TYPE_CHECKING: - from pytest import LogCaptureFixture - from pytest_mock import MockerFixture - -LOGGER = "runway.cli.commands.kbenv" + from pathlib import Path + import pytest + from click.testing import CliRunner -@pytest.fixture(autouse=True, scope="function") -def patch_versions_dir(mocker: MockerFixture, tmp_path: Path) -> None: - """Patch KBEnvManager.versions_dir.""" - mocker.patch.object(KBEnvManager, "versions_dir", tmp_path) +LOGGER = "runway.cli.commands.kbenv" -def test_kbenv_uninstall(cd_tmp_path: Path) -> None: +def test_kbenv_uninstall(cli_runner: CliRunner, versions_dir: Path) -> None: """Test ``runway kbenv uninstall``.""" version = "v1.21.0" - version_dir = cd_tmp_path / version + version_dir = versions_dir / version version_dir.mkdir() - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "uninstall", version]) + result = cli_runner.invoke(cli, ["kbenv", "uninstall", version]) assert result.exit_code == 0 assert not version_dir.exists() -def test_kbenv_uninstall_all(caplog: LogCaptureFixture, cd_tmp_path: Path) -> None: +def test_kbenv_uninstall_all( + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner, versions_dir: Path +) -> None: """Test ``runway kbenv uninstall --all``.""" caplog.set_level(logging.INFO, logger=LOGGER) - version_dirs = [cd_tmp_path / "v1.14.0", cd_tmp_path / "v1.21.0"] + version_dirs = [versions_dir / "v1.14.0", versions_dir / "v1.21.0"] for v in version_dirs: v.mkdir() - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "uninstall", "--all"]) + result = cli_runner.invoke(cli, ["kbenv", "uninstall", "--all"]) assert result.exit_code == 0 assert "uninstalling all versions of kubectl..." in caplog.messages assert "all versions of kubectl have been uninstalled" in caplog.messages @@ -52,15 +43,14 @@ def test_kbenv_uninstall_all(caplog: LogCaptureFixture, cd_tmp_path: Path) -> No def test_kbenv_uninstall_all_takes_precedence( - caplog: LogCaptureFixture, cd_tmp_path: Path + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner, versions_dir: Path ) -> None: """Test ``runway kbenv uninstall --all`` takes precedence over arg.""" caplog.set_level(logging.INFO, logger=LOGGER) - version_dirs = [cd_tmp_path / "v1.14.0", cd_tmp_path / "v1.21.0"] + version_dirs = [versions_dir / "v1.14.0", versions_dir / "v1.21.0"] for v in version_dirs: v.mkdir() - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "uninstall", "0.13.0", "--all"]) + result = cli_runner.invoke(cli, ["kbenv", "uninstall", "0.13.0", "--all"]) assert result.exit_code == 0 assert "uninstalling all versions of kubectl..." in caplog.messages assert "all versions of kubectl have been uninstalled" in caplog.messages @@ -68,54 +58,52 @@ def test_kbenv_uninstall_all_takes_precedence( def test_kbenv_uninstall_all_none_installed( - caplog: LogCaptureFixture, cd_tmp_path: Path + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner ) -> None: """Test ``runway kbenv uninstall --all`` none installed.""" caplog.set_level(logging.INFO, logger=LOGGER) - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "uninstall", "--all"]) + result = cli_runner.invoke(cli, ["kbenv", "uninstall", "--all"]) assert result.exit_code == 0 assert "uninstalling all versions of kubectl..." in caplog.messages assert "all versions of kubectl have been uninstalled" in caplog.messages -def test_kbenv_uninstall_arg_takes_precedence(cd_tmp_path: Path) -> None: +def test_kbenv_uninstall_arg_takes_precedence( + cd_tmp_path: Path, cli_runner: CliRunner, versions_dir: Path +) -> None: """Test ``runway kbenv uninstall`` arg takes precedence over file.""" version = "v1.21.0" - version_dir = cd_tmp_path / version + version_dir = versions_dir / version version_dir.mkdir() (cd_tmp_path / KB_VERSION_FILENAME).write_text("v1.14.0") - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "uninstall", version]) + result = cli_runner.invoke(cli, ["kbenv", "uninstall", version]) assert result.exit_code == 0 assert not version_dir.exists() def test_kbenv_uninstall_no_version( - caplog: LogCaptureFixture, cd_tmp_path: Path + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner ) -> None: """Test ``runway kbenv uninstall`` no version.""" caplog.set_level(logging.ERROR, logger=LOGGER) - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "uninstall"]) + result = cli_runner.invoke(cli, ["kbenv", "uninstall"]) assert result.exit_code != 0 assert "version not specified" in caplog.messages -def test_kbenv_uninstall_not_installed(cd_tmp_path: Path) -> None: +def test_kbenv_uninstall_not_installed(cli_runner: CliRunner) -> None: """Test ``runway kbenv uninstall`` not installed.""" - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "uninstall", "1.21.0"]) - assert result.exit_code != 0 + assert cli_runner.invoke(cli, ["kbenv", "uninstall", "1.21.0"]).exit_code != 0 -def test_kbenv_uninstall_version_file(cd_tmp_path: Path) -> None: +def test_kbenv_uninstall_version_file( + cd_tmp_path: Path, cli_runner: CliRunner, versions_dir: Path +) -> None: """Test ``runway kbenv uninstall`` version file.""" version = "v1.21.0" - version_dir = cd_tmp_path / version + version_dir = versions_dir / version version_dir.mkdir() (cd_tmp_path / KB_VERSION_FILENAME).write_text(version) - runner = CliRunner() - result = runner.invoke(cli, ["kbenv", "uninstall"]) + result = cli_runner.invoke(cli, ["kbenv", "uninstall"]) assert result.exit_code == 0 assert not version_dir.exists() diff --git a/tests/integration/cli/commands/test_deploy.py b/tests/integration/cli/commands/test_deploy.py index 98944adf7..54757a367 100644 --- a/tests/integration/cli/commands/test_deploy.py +++ b/tests/integration/cli/commands/test_deploy.py @@ -9,9 +9,9 @@ import logging from typing import TYPE_CHECKING +from unittest.mock import Mock from click.testing import CliRunner -from mock import Mock from runway._cli import cli from runway.config import RunwayConfig @@ -21,7 +21,7 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture + import pytest from pytest_mock import MockerFixture from ...conftest import CpConfigTypeDef @@ -32,7 +32,7 @@ def test_deploy( cd_tmp_path: Path, cp_config: CpConfigTypeDef, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, ) -> None: """Test deploy.""" @@ -86,7 +86,7 @@ def test_deploy_options_deploy_environment( def test_deploy_options_tag( - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cd_tmp_path: Path, cp_config: CpConfigTypeDef, mocker: MockerFixture, @@ -96,9 +96,7 @@ def test_deploy_options_tag( mock_runway = mocker.patch(f"{MODULE}.Runway", Mock(spec=Runway, spec_set=True)) cp_config("tagged_modules", cd_tmp_path) runner = CliRunner() - result0 = runner.invoke( - cli, ["deploy", "--tag", "app:test-app", "--tag", "tier:iac"] - ) + result0 = runner.invoke(cli, ["deploy", "--tag", "app:test-app", "--tag", "tier:iac"]) assert result0.exit_code == 0 deployment = mock_runway.return_value.deploy.call_args.args[0][0] assert len(deployment.modules) == 1 diff --git a/tests/integration/cli/commands/test_destroy.py b/tests/integration/cli/commands/test_destroy.py index 5fe113772..ff60a199f 100644 --- a/tests/integration/cli/commands/test_destroy.py +++ b/tests/integration/cli/commands/test_destroy.py @@ -9,9 +9,9 @@ import logging from typing import TYPE_CHECKING +from unittest.mock import Mock from click.testing import CliRunner -from mock import Mock from runway._cli import cli from runway.config import RunwayConfig @@ -21,7 +21,7 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture, MonkeyPatch + import pytest from pytest_mock import MockerFixture from ...conftest import CpConfigTypeDef @@ -29,9 +29,7 @@ MODULE = "runway._cli.commands._destroy" -def test_destroy( - cd_tmp_path: Path, cp_config: CpConfigTypeDef, mocker: MockerFixture -) -> None: +def test_destroy(cd_tmp_path: Path, cp_config: CpConfigTypeDef, mocker: MockerFixture) -> None: """Test destroy.""" mock_runway = mocker.patch(f"{MODULE}.Runway", Mock(spec=Runway)) cp_config("min_required", cd_tmp_path) @@ -83,9 +81,7 @@ def test_destroy_options_deploy_environment( mock_runway = mocker.patch(f"{MODULE}.Runway", Mock(spec=Runway)) cp_config("min_required", cd_tmp_path) runner = CliRunner() - assert ( - runner.invoke(cli, ["destroy", "-e", "e-option"], input="y\ny\n").exit_code == 0 - ) + assert runner.invoke(cli, ["destroy", "-e", "e-option"], input="y\ny\n").exit_code == 0 assert mock_runway.call_args.args[1].env.name == "e-option" assert ( @@ -100,10 +96,10 @@ def test_destroy_options_deploy_environment( def test_destroy_options_tag( - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cd_tmp_path: Path, cp_config: CpConfigTypeDef, - monkeypatch: MonkeyPatch, + monkeypatch: pytest.MonkeyPatch, ) -> None: """Test destroy option --tag.""" caplog.set_level(logging.ERROR, logger="runway.cli.commands.destroy") @@ -121,10 +117,7 @@ def test_destroy_options_tag( assert len(deployment.modules) == 1 assert deployment.modules[0].name == "sampleapp-01.cfn" - assert ( - runner.invoke(cli, ["destroy", "--tag", "app:test-app"], input="y\n").exit_code - == 0 - ) + assert runner.invoke(cli, ["destroy", "--tag", "app:test-app"], input="y\n").exit_code == 0 deployment = mock_destroy.call_args.args[0][0] assert len(deployment.modules) == 3 assert deployment.modules[0].name == "parallel_parent" @@ -133,14 +126,12 @@ def test_destroy_options_tag( assert deployment.modules[1].name == "sampleapp-02.cfn" assert deployment.modules[2].name == "sampleapp-01.cfn" - assert ( - runner.invoke(cli, ["destroy", "--tag", "no-match"], input="y\n").exit_code == 1 - ) + assert runner.invoke(cli, ["destroy", "--tag", "no-match"], input="y\n").exit_code == 1 assert "No modules found with the provided tag(s): no-match" in caplog.messages def test_destroy_select_deployment( - cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: MonkeyPatch + cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: pytest.MonkeyPatch ) -> None: """Test destroy select from two deployments.""" cp_config("min_required_multi", cd_tmp_path) @@ -158,7 +149,7 @@ def test_destroy_select_deployment( def test_destroy_select_deployment_all( - cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: MonkeyPatch + cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: pytest.MonkeyPatch ) -> None: """Test destroy select all deployments.""" cp_config("min_required_multi", cd_tmp_path) @@ -176,7 +167,7 @@ def test_destroy_select_deployment_all( def test_destroy_select_module( - cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: MonkeyPatch + cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: pytest.MonkeyPatch ) -> None: """Test destroy select from two modules.""" cp_config("min_required_multi", cd_tmp_path) @@ -192,7 +183,7 @@ def test_destroy_select_module( def test_destroy_select_module_all( - cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: MonkeyPatch + cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: pytest.MonkeyPatch ) -> None: """Test destroy select all modules.""" cp_config("min_required_multi", cd_tmp_path) @@ -209,7 +200,7 @@ def test_destroy_select_module_all( def test_destroy_select_module_child_modules( - cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: MonkeyPatch + cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: pytest.MonkeyPatch ) -> None: """Test destroy select child module.""" cp_config("simple_child_modules.1", cd_tmp_path) @@ -225,7 +216,7 @@ def test_destroy_select_module_child_modules( def test_destroy_select_module_child_modules_all( - cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: MonkeyPatch + cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: pytest.MonkeyPatch ) -> None: """Test destroy select all child module.""" cp_config("simple_child_modules.1", cd_tmp_path) diff --git a/tests/integration/cli/commands/test_dismantle.py b/tests/integration/cli/commands/test_dismantle.py index 43572b54e..3ce8eab54 100644 --- a/tests/integration/cli/commands/test_dismantle.py +++ b/tests/integration/cli/commands/test_dismantle.py @@ -4,9 +4,9 @@ import logging from typing import TYPE_CHECKING +from unittest.mock import Mock from click.testing import CliRunner -from mock import Mock from runway._cli import cli from runway._cli.commands import destroy @@ -14,16 +14,16 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture, MonkeyPatch + import pytest from ...conftest import CpConfigTypeDef def test_dismantle( - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cd_tmp_path: Path, cp_config: CpConfigTypeDef, - monkeypatch: MonkeyPatch, + monkeypatch: pytest.MonkeyPatch, ) -> None: """Test dismantle.""" cp_config("min_required", cd_tmp_path) diff --git a/tests/integration/cli/commands/test_docs.py b/tests/integration/cli/commands/test_docs.py index fae9717a4..9e5f6bc6c 100644 --- a/tests/integration/cli/commands/test_docs.py +++ b/tests/integration/cli/commands/test_docs.py @@ -3,14 +3,14 @@ from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import patch from click.testing import CliRunner -from mock import patch from runway._cli import cli if TYPE_CHECKING: - from mock import MagicMock + from unittest.mock import MagicMock DOCS_URL = "https://docs.onica.com/projects/runway/" @@ -22,10 +22,5 @@ def test_docs(mock_launch: MagicMock) -> None: assert runner.invoke(cli, ["docs"], env={}).exit_code == 0 mock_launch.assert_called_once_with(DOCS_URL) - assert ( - runner.invoke( - cli, ["docs"], env={"LD_LIBRARY_PATH_ORIG": "something"} - ).exit_code - == 0 - ) + assert runner.invoke(cli, ["docs"], env={"LD_LIBRARY_PATH_ORIG": "something"}).exit_code == 0 assert mock_launch.call_count == 2 diff --git a/tests/integration/cli/commands/test_envvars.py b/tests/integration/cli/commands/test_envvars.py index 41c50694e..a64c69bdf 100644 --- a/tests/integration/cli/commands/test_envvars.py +++ b/tests/integration/cli/commands/test_envvars.py @@ -4,16 +4,16 @@ import logging from typing import TYPE_CHECKING +from unittest.mock import Mock from click.testing import CliRunner -from mock import Mock from runway._cli import cli if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture, MonkeyPatch + import pytest from ...conftest import CpConfigTypeDef @@ -30,7 +30,7 @@ def test_envvars( - cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: MonkeyPatch + cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: pytest.MonkeyPatch ) -> None: """Test envvars.""" monkeypatch.setattr("platform.system", Mock(return_value="Darwin")) @@ -42,7 +42,7 @@ def test_envvars( def test_envvar_windows( - cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: MonkeyPatch + cd_tmp_path: Path, cp_config: CpConfigTypeDef, monkeypatch: pytest.MonkeyPatch ) -> None: """Test envvars for Windows.""" monkeypatch.setattr("platform.system", Mock(return_value="Windows")) @@ -58,7 +58,7 @@ def test_envvar_windows( assert result1.output == POSIX_OUTPUT -def test_envvars_no_config(caplog: LogCaptureFixture, cd_tmp_path: Path) -> None: +def test_envvars_no_config(caplog: pytest.LogCaptureFixture, cd_tmp_path: Path) -> None: """Test envvars with no config in the directory or parent.""" caplog.set_level(logging.ERROR, logger="runway") runner = CliRunner() @@ -72,7 +72,7 @@ def test_envvars_no_config(caplog: LogCaptureFixture, cd_tmp_path: Path) -> None def test_envvars_no_env_vars( - caplog: LogCaptureFixture, cd_tmp_path: Path, cp_config: CpConfigTypeDef + caplog: pytest.LogCaptureFixture, cd_tmp_path: Path, cp_config: CpConfigTypeDef ) -> None: """Test envvars with no env_vars in the config.""" caplog.set_level(logging.ERROR, logger="runway") diff --git a/tests/integration/cli/commands/test_gen_sample.py b/tests/integration/cli/commands/test_gen_sample.py index 734f89b70..8596dda4d 100644 --- a/tests/integration/cli/commands/test_gen_sample.py +++ b/tests/integration/cli/commands/test_gen_sample.py @@ -13,10 +13,8 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture - -def test_cdk_csharp(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_cdk_csharp(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample cdk-csharp`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -49,7 +47,7 @@ def test_cdk_csharp(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ] -def test_cdk_py(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_cdk_py(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample cdk-py`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -81,7 +79,7 @@ def test_cdk_py(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ] -def test_cdk_tsc(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_cdk_tsc(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample cdk-tsc`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -113,7 +111,7 @@ def test_cdk_tsc(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ] -def test_cfn(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_cfn(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample cfn`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -131,7 +129,7 @@ def test_cfn(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: assert caplog.messages == [f"Sample CloudFormation module created at {module}"] -def test_cfngin(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_cfngin(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample cfngin`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -154,7 +152,7 @@ def test_cfngin(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: assert caplog.messages == [f"Sample CFNgin module created at {module}"] -def test_k8s_cfn_repo(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_k8s_cfn_repo(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample k8s-cfn-repo`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -205,7 +203,7 @@ def test_k8s_cfn_repo(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ] -def test_k8s_tf_repo(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_k8s_tf_repo(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample k8s-tf-repo`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -251,7 +249,7 @@ def test_k8s_tf_repo(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ] -def test_sls_py(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_sls_py(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample sls-py`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -282,7 +280,7 @@ def test_sls_py(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ] -def test_sls_tsc(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_sls_tsc(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample sls-tsc`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -315,7 +313,7 @@ def test_sls_tsc(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ] -def test_static_angular(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_static_angular(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample static-angular`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -369,7 +367,7 @@ def test_static_angular(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ] -def test_static_react(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_static_react(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample static-react`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -409,7 +407,7 @@ def test_static_react(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ] -def test_tf(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_tf(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway gen-sample tf`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -450,7 +448,7 @@ def test_tf(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ], ) def test_dir_exists( - command: str, dir_name: str, caplog: LogCaptureFixture, cd_tmp_path: Path + command: str, dir_name: str, caplog: pytest.LogCaptureFixture, cd_tmp_path: Path ) -> None: """Test ``runway gen-sample`` commands when directory exists.""" caplog.set_level(logging.ERROR, logger="runway.cli.gen_sample") diff --git a/tests/integration/cli/commands/test_init.py b/tests/integration/cli/commands/test_init.py index ed5e889a6..b188d06b4 100644 --- a/tests/integration/cli/commands/test_init.py +++ b/tests/integration/cli/commands/test_init.py @@ -9,9 +9,9 @@ import logging from typing import TYPE_CHECKING +from unittest.mock import Mock from click.testing import CliRunner -from mock import Mock from pydantic import ValidationError from runway._cli import cli @@ -23,7 +23,7 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture + import pytest from pytest_mock import MockerFixture from ...conftest import CpConfigTypeDef @@ -34,7 +34,7 @@ def test_init( cd_tmp_path: Path, cp_config: CpConfigTypeDef, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, ) -> None: """Test init.""" @@ -117,16 +117,14 @@ def test_init_options_deploy_environment( assert mock_runway.call_args.args[1].env.name == "e-option" assert ( - runner.invoke( - cli, ["init", "--deploy-environment", "deploy-environment-option"] - ).exit_code + runner.invoke(cli, ["init", "--deploy-environment", "deploy-environment-option"]).exit_code == 0 ) assert mock_runway.call_args.args[1].env.name == "deploy-environment-option" def test_init_options_tag( - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cd_tmp_path: Path, cp_config: CpConfigTypeDef, mocker: MockerFixture, diff --git a/tests/integration/cli/commands/test_new.py b/tests/integration/cli/commands/test_new.py index e25f7f12e..da77ab412 100644 --- a/tests/integration/cli/commands/test_new.py +++ b/tests/integration/cli/commands/test_new.py @@ -13,10 +13,10 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture + import pytest -def test_new(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_new(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway new`` command.""" caplog.set_level(logging.INFO, logger="runway.cli") runner = CliRunner() @@ -36,13 +36,11 @@ def test_new(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: ] -def test_new_file_exists(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_new_file_exists(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway new`` command with existing file.""" caplog.set_level(logging.ERROR, logger="runway.cli") (cd_tmp_path / "runway.yml").touch() runner = CliRunner() result = runner.invoke(cli, ["new"]) assert result.exit_code == 1 - assert caplog.messages == [ - "There is already a runway.yml file in the current directory" - ] + assert caplog.messages == ["There is already a runway.yml file in the current directory"] diff --git a/tests/integration/cli/commands/test_plan.py b/tests/integration/cli/commands/test_plan.py index f9344211b..3dca1d8da 100644 --- a/tests/integration/cli/commands/test_plan.py +++ b/tests/integration/cli/commands/test_plan.py @@ -9,9 +9,9 @@ import logging from typing import TYPE_CHECKING +from unittest.mock import Mock from click.testing import CliRunner -from mock import Mock from runway._cli import cli from runway.config import RunwayConfig @@ -21,7 +21,7 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture + import pytest from pytest_mock import MockerFixture from ...conftest import CpConfigTypeDef @@ -29,9 +29,7 @@ MODULE = "runway._cli.commands._plan" -def test_plan( - cd_tmp_path: Path, cp_config: CpConfigTypeDef, mocker: MockerFixture -) -> None: +def test_plan(cd_tmp_path: Path, cp_config: CpConfigTypeDef, mocker: MockerFixture) -> None: """Test plan.""" mock_runway = mocker.patch(f"{MODULE}.Runway", Mock(spec=Runway, spec_set=True)) cp_config("min_required", cd_tmp_path) @@ -73,16 +71,14 @@ def test_plan_options_deploy_environment( assert mock_runway.call_args.args[1].env.name == "e-option" assert ( - runner.invoke( - cli, ["plan", "--deploy-environment", "deploy-environment-option"] - ).exit_code + runner.invoke(cli, ["plan", "--deploy-environment", "deploy-environment-option"]).exit_code == 0 ) assert mock_runway.call_args.args[1].env.name == "deploy-environment-option" def test_plan_options_tag( - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cd_tmp_path: Path, cp_config: CpConfigTypeDef, mocker: MockerFixture, @@ -92,12 +88,7 @@ def test_plan_options_tag( mock_runway = mocker.patch(f"{MODULE}.Runway", Mock(spec=Runway, spec_set=True)) cp_config("tagged_modules", cd_tmp_path) runner = CliRunner() - assert ( - runner.invoke( - cli, ["plan", "--tag", "app:test-app", "--tag", "tier:iac"] - ).exit_code - == 0 - ) + assert runner.invoke(cli, ["plan", "--tag", "app:test-app", "--tag", "tier:iac"]).exit_code == 0 deployment = mock_runway.return_value.plan.call_args.args[0][0] assert len(deployment.modules) == 1 assert deployment.modules[0].name == "sampleapp-01.cfn" diff --git a/tests/integration/cli/commands/test_preflight.py b/tests/integration/cli/commands/test_preflight.py index bb307bbd3..ebe95952f 100644 --- a/tests/integration/cli/commands/test_preflight.py +++ b/tests/integration/cli/commands/test_preflight.py @@ -4,9 +4,9 @@ import logging from typing import TYPE_CHECKING +from unittest.mock import Mock from click.testing import CliRunner -from mock import Mock from runway._cli import cli from runway._cli.commands import test @@ -14,16 +14,16 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture, MonkeyPatch + import pytest from ...conftest import CpConfigTypeDef def test_preflight( - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cd_tmp_path: Path, cp_config: CpConfigTypeDef, - monkeypatch: MonkeyPatch, + monkeypatch: pytest.MonkeyPatch, ) -> None: """Test ``runway preflight``.""" cp_config("min_required", cd_tmp_path) diff --git a/tests/integration/cli/commands/test_run_python.py b/tests/integration/cli/commands/test_run_python.py index 3fa7aee53..beb5a57fa 100644 --- a/tests/integration/cli/commands/test_run_python.py +++ b/tests/integration/cli/commands/test_run_python.py @@ -14,9 +14,7 @@ def test_run_python(cd_tmp_path: Path) -> None: """Test ``runway run-python hello_world.py``.""" - (cd_tmp_path / "hello_world.py").write_text( - "if __name__ == '__main__': print('hello world')" - ) + (cd_tmp_path / "hello_world.py").write_text("if __name__ == '__main__': print('hello world')") runner = CliRunner() result = runner.invoke(cli, ["run-python", "hello_world.py"]) assert result.exit_code == 0 diff --git a/tests/integration/cli/commands/test_schema_cfngin.py b/tests/integration/cli/commands/test_schema_cfngin.py index dfb90df2c..7dbcfe1ac 100644 --- a/tests/integration/cli/commands/test_schema_cfngin.py +++ b/tests/integration/cli/commands/test_schema_cfngin.py @@ -34,7 +34,4 @@ def test_schema_cfngin_output(cd_tmp_path: Path) -> None: assert result.exit_code == 0 assert str(file_path) in result.output assert file_path.is_file() - assert ( - file_path.read_text() - == CfnginConfigDefinitionModel.schema_json(indent=4) + "\n" - ) + assert file_path.read_text() == CfnginConfigDefinitionModel.schema_json(indent=4) + "\n" diff --git a/tests/integration/cli/commands/test_schema_runway.py b/tests/integration/cli/commands/test_schema_runway.py index 10695a62b..e64a99bd1 100644 --- a/tests/integration/cli/commands/test_schema_runway.py +++ b/tests/integration/cli/commands/test_schema_runway.py @@ -34,7 +34,4 @@ def test_schema_runway_output(cd_tmp_path: Path) -> None: assert result.exit_code == 0 assert str(file_path) in result.output assert file_path.is_file() - assert ( - file_path.read_text() - == RunwayConfigDefinitionModel.schema_json(indent=4) + "\n" - ) + assert file_path.read_text() == RunwayConfigDefinitionModel.schema_json(indent=4) + "\n" diff --git a/tests/integration/cli/commands/test_takeoff.py b/tests/integration/cli/commands/test_takeoff.py index f78ee1b89..a53761a54 100644 --- a/tests/integration/cli/commands/test_takeoff.py +++ b/tests/integration/cli/commands/test_takeoff.py @@ -4,9 +4,9 @@ import logging from typing import TYPE_CHECKING +from unittest.mock import Mock from click.testing import CliRunner -from mock import Mock from runway._cli import cli from runway._cli.commands import deploy @@ -14,16 +14,16 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture, MonkeyPatch + import pytest from ...conftest import CpConfigTypeDef def test_takeoff( - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cd_tmp_path: Path, cp_config: CpConfigTypeDef, - monkeypatch: MonkeyPatch, + monkeypatch: pytest.MonkeyPatch, ) -> None: """Test takeoff.""" cp_config("min_required", cd_tmp_path) diff --git a/tests/integration/cli/commands/test_taxi.py b/tests/integration/cli/commands/test_taxi.py index 782596f93..035d7f9e3 100644 --- a/tests/integration/cli/commands/test_taxi.py +++ b/tests/integration/cli/commands/test_taxi.py @@ -4,9 +4,9 @@ import logging from typing import TYPE_CHECKING +from unittest.mock import Mock from click.testing import CliRunner -from mock import Mock from runway._cli import cli from runway._cli.commands import plan @@ -14,16 +14,16 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture, MonkeyPatch + import pytest from ...conftest import CpConfigTypeDef def test_taxi( - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cd_tmp_path: Path, cp_config: CpConfigTypeDef, - monkeypatch: MonkeyPatch, + monkeypatch: pytest.MonkeyPatch, ) -> None: """Test taxi.""" cp_config("min_required", cd_tmp_path) diff --git a/tests/integration/cli/commands/test_test.py b/tests/integration/cli/commands/test_test.py index 3dd451b0f..ae2156b25 100644 --- a/tests/integration/cli/commands/test_test.py +++ b/tests/integration/cli/commands/test_test.py @@ -37,40 +37,28 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import CaptureFixture, LogCaptureFixture + import pytest # def test_test_invalid_type(cd_tmp_path, capfd, caplog): def test_test_invalid_type( cd_tmp_path: Path, -) -> None: # TODO update after catching error +) -> None: # TODO (kyle): update after catching error """Test ``runway test`` with two tests; one invalid.""" # caplog.set_level(logging.INFO, logger="runway.core") runway_yml = cd_tmp_path / "runway.yml" runway_yml.write_text( - yaml.safe_dump( - {"deployments": [], "tests": [INVALID_TYPE.copy(), SUCCESS.copy()]} - ) + yaml.safe_dump({"deployments": [], "tests": [INVALID_TYPE.copy(), SUCCESS.copy()]}) ) runner = CliRunner() result = runner.invoke(cli, ["test"]) assert result.exit_code == 1 - assert result.exception.errors()[0]["loc"] == ("tests", 0, "type") + assert result.exception.errors()[0]["loc"] == ("tests", 0, "type") # type: ignore - # captured = capfd.readouterr() - # logs = "\n".join(caplog.messages) - # print(captured) - # assert "found 2 test(s)" in logs - # assert "invalid-type:running test (in progress)" in logs - # assert 'invalid-type:unable to find handler of type "invalid"' in logs - # assert "success:running test (in progress)" in logs - # assert "Hello world" in captured.out - # assert "success:running test (pass)" in logs - -def test_test_not_defined(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_test_not_defined(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway test`` with no tests defined.""" caplog.set_level(logging.ERROR) runway_yml = cd_tmp_path / "runway.yml" @@ -83,14 +71,12 @@ def test_test_not_defined(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: def test_test_single_successful( - cd_tmp_path: Path, capfd: CaptureFixture[str], caplog: LogCaptureFixture + cd_tmp_path: Path, capfd: pytest.CaptureFixture[str], caplog: pytest.LogCaptureFixture ) -> None: """Test ``runway test`` with a single, successful test.""" caplog.set_level(logging.INFO, logger="runway.core") runway_yml = cd_tmp_path / "runway.yml" - runway_yml.write_text( - yaml.safe_dump({"deployments": [], "tests": [SUCCESS.copy()]}) - ) + runway_yml.write_text(yaml.safe_dump({"deployments": [], "tests": [SUCCESS.copy()]})) runner = CliRunner() result = runner.invoke(cli, ["test"]) @@ -105,7 +91,7 @@ def test_test_single_successful( def test_test_two_test( - cd_tmp_path: Path, capfd: CaptureFixture[str], caplog: LogCaptureFixture + cd_tmp_path: Path, capfd: pytest.CaptureFixture[str], caplog: pytest.LogCaptureFixture ) -> None: """Test ``runway test`` with two tests; one failing.""" caplog.set_level(logging.INFO, logger="runway.core") @@ -130,15 +116,13 @@ def test_test_two_test( def test_test_two_test_required( - cd_tmp_path: Path, capfd: CaptureFixture[str], caplog: LogCaptureFixture + cd_tmp_path: Path, capfd: pytest.CaptureFixture[str], caplog: pytest.LogCaptureFixture ) -> None: """Test ``runway test`` with two tests; one failing required.""" caplog.set_level(logging.INFO) runway_yml = cd_tmp_path / "runway.yml" runway_yml.write_text( - yaml.safe_dump( - {"deployments": [], "tests": [FAIL_REQUIRED.copy(), SUCCESS.copy()]} - ) + yaml.safe_dump({"deployments": [], "tests": [FAIL_REQUIRED.copy(), SUCCESS.copy()]}) ) runner = CliRunner() diff --git a/tests/integration/cli/commands/test_whichenv.py b/tests/integration/cli/commands/test_whichenv.py index d90aa47b9..71a29a83f 100644 --- a/tests/integration/cli/commands/test_whichenv.py +++ b/tests/integration/cli/commands/test_whichenv.py @@ -13,29 +13,25 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture + import pytest -def test_whichenv(caplog: LogCaptureFixture, cd_tmp_path: Path) -> None: +def test_whichenv(caplog: pytest.LogCaptureFixture, cd_tmp_path: Path) -> None: """Test ``runway whichenv``.""" caplog.set_level(logging.DEBUG, logger="runway") runway_yml = cd_tmp_path / "runway.yml" - runway_yml.write_text( - yaml.safe_dump({"deployments": [], "ignore_git_branch": True}) - ) + runway_yml.write_text(yaml.safe_dump({"deployments": [], "ignore_git_branch": True})) runner = CliRunner() result = runner.invoke(cli, ["whichenv"], env={}) assert result.exit_code == 0 assert result.output == cd_tmp_path.name + "\n" -def test_whichenv_debug(caplog: LogCaptureFixture, cd_tmp_path: Path) -> None: +def test_whichenv_debug(caplog: pytest.LogCaptureFixture, cd_tmp_path: Path) -> None: """Test ``runway whichenv`` debug.""" caplog.set_level(logging.DEBUG, logger="runway") runway_yml = cd_tmp_path / "runway.yml" - runway_yml.write_text( - yaml.safe_dump({"deployments": [], "ignore_git_branch": True}) - ) + runway_yml.write_text(yaml.safe_dump({"deployments": [], "ignore_git_branch": True})) runner = CliRunner() result = runner.invoke(cli, ["whichenv", "--debug"]) assert result.exit_code == 0 @@ -43,13 +39,11 @@ def test_whichenv_debug(caplog: LogCaptureFixture, cd_tmp_path: Path) -> None: assert "set dependency log level to debug" not in caplog.messages -def test_whichenv_debug_debug(caplog: LogCaptureFixture, cd_tmp_path: Path) -> None: +def test_whichenv_debug_debug(caplog: pytest.LogCaptureFixture, cd_tmp_path: Path) -> None: """Test ``runway whichenv`` debug.""" caplog.set_level(logging.DEBUG, logger="runway") runway_yml = cd_tmp_path / "runway.yml" - runway_yml.write_text( - yaml.safe_dump({"deployments": [], "ignore_git_branch": True}) - ) + runway_yml.write_text(yaml.safe_dump({"deployments": [], "ignore_git_branch": True})) runner = CliRunner() result = runner.invoke(cli, ["whichenv"], env={"DEBUG": "2"}) assert result.exit_code == 0 @@ -60,12 +54,8 @@ def test_whichenv_debug_debug(caplog: LogCaptureFixture, cd_tmp_path: Path) -> N def test_whichenv_invalid_debug_environ(cd_tmp_path: Path) -> None: """Test ``runway whichenv`` with invalid debug environ.""" runway_yml = cd_tmp_path / "runway.yml" - runway_yml.write_text( - yaml.safe_dump({"deployments": [], "ignore_git_branch": True}) - ) + runway_yml.write_text(yaml.safe_dump({"deployments": [], "ignore_git_branch": True})) runner = CliRunner() result = runner.invoke(cli, ["whichenv"], env={"DEBUG": "invalid"}) assert result.exit_code == 2 - assert ( - "Invalid value for '--debug': 'invalid' is not a valid integer" in result.output - ) + assert "Invalid value for '--debug': 'invalid' is not a valid integer" in result.output diff --git a/tests/integration/cli/commands/tfenv/conftest.py b/tests/integration/cli/commands/tfenv/conftest.py new file mode 100644 index 000000000..086a598d0 --- /dev/null +++ b/tests/integration/cli/commands/tfenv/conftest.py @@ -0,0 +1,24 @@ +"""Pytest fixtures and plugins.""" + +from __future__ import annotations + +from typing import TYPE_CHECKING + +import pytest + +if TYPE_CHECKING: + from pathlib import Path + + from pytest_mock import MockFixture + + +@pytest.fixture(autouse=True) +def versions_dir(cd_tmp_path: Path, mocker: MockFixture) -> Path: + """Patches TFEnvManager.versions_dir.""" + path = cd_tmp_path / "versions" + path.mkdir(exist_ok=True) + mocker.patch("runway._cli.commands._tfenv._install.TFEnvManager.versions_dir", path) + mocker.patch("runway._cli.commands._tfenv._list.TFEnvManager.versions_dir", path) + mocker.patch("runway._cli.commands._tfenv._run.TFEnvManager.versions_dir", path) + mocker.patch("runway._cli.commands._tfenv._uninstall.TFEnvManager.versions_dir", path) + return path diff --git a/tests/integration/cli/commands/tfenv/test_install.py b/tests/integration/cli/commands/tfenv/test_install.py index f803a316b..44712b058 100644 --- a/tests/integration/cli/commands/tfenv/test_install.py +++ b/tests/integration/cli/commands/tfenv/test_install.py @@ -1,30 +1,20 @@ """Test ``runway tfenv install`` command.""" -# pylint: disable=unused-argument from __future__ import annotations import logging from pathlib import Path from typing import TYPE_CHECKING -import pytest from click.testing import CliRunner from runway._cli import cli -from runway.env_mgr.tfenv import TFEnvManager if TYPE_CHECKING: - from pytest import LogCaptureFixture - from pytest_mock import MockerFixture + import pytest -@pytest.fixture(autouse=True, scope="function") -def patch_versions_dir(mocker: MockerFixture, tmp_path: Path) -> None: - """Patch TFEnvManager.versions_dir.""" - mocker.patch.object(TFEnvManager, "versions_dir", tmp_path) - - -def test_tfenv_install(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: +def test_tfenv_install(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway tfenv install`` reading version from a file. For best results, remove any existing installs. @@ -41,18 +31,16 @@ def test_tfenv_install(cd_tmp_path: Path, caplog: LogCaptureFixture) -> None: def test_tfenv_install_no_version_file( - cd_tmp_path: Path, caplog: LogCaptureFixture + cli_runner: CliRunner, caplog: pytest.LogCaptureFixture ) -> None: """Test ``runway tfenv install`` no version file.""" caplog.set_level(logging.ERROR, logger="runway") - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "install"]) - assert result.exit_code == 1 + assert cli_runner.invoke(cli, ["tfenv", "install"]).exit_code == 1 assert "unable to find a .terraform-version file" in "\n".join(caplog.messages) -def test_tfenv_install_version(caplog: LogCaptureFixture) -> None: +def test_tfenv_install_version(caplog: pytest.LogCaptureFixture) -> None: """Test ``runway tfenv install ``. For best results, remove any existing installs. @@ -63,5 +51,5 @@ def test_tfenv_install_version(caplog: LogCaptureFixture) -> None: result = runner.invoke(cli, ["tfenv", "install", "0.12.1"]) assert result.exit_code == 0 - kb_bin = Path(caplog.messages[-1].replace("terraform path: ", "")) - assert kb_bin.exists() + tf_bin = Path(caplog.messages[-1].replace("terraform path: ", "")) + assert tf_bin.exists() diff --git a/tests/integration/cli/commands/tfenv/test_list.py b/tests/integration/cli/commands/tfenv/test_list.py index 161d99820..e6aaf6a06 100644 --- a/tests/integration/cli/commands/tfenv/test_list.py +++ b/tests/integration/cli/commands/tfenv/test_list.py @@ -13,12 +13,12 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture + import pytest from pytest_mock import MockerFixture def test_tfenv_list( - caplog: LogCaptureFixture, mocker: MockerFixture, tmp_path: Path + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, tmp_path: Path ) -> None: """Test ``runway tfenv list``.""" caplog.set_level(logging.INFO, logger="runway.cli.commands.tfenv") @@ -31,13 +31,11 @@ def test_tfenv_list( result = runner.invoke(cli, ["tfenv", "list"]) assert result.exit_code == 0 assert caplog.messages == ["Terraform versions installed:"] - assert result.stdout == "\n".join( - ["[runway] Terraform versions installed:", "0.13.0", "1.0.0", ""] - ) + assert result.stdout == "[runway] Terraform versions installed:\n0.13.0\n1.0.0\n" def test_tfenv_list_none( - caplog: LogCaptureFixture, mocker: MockerFixture, tmp_path: Path + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, tmp_path: Path ) -> None: """Test ``runway tfenv list`` no versions installed.""" caplog.set_level(logging.WARNING, logger="runway.cli.commands.tfenv") diff --git a/tests/integration/cli/commands/tfenv/test_run.py b/tests/integration/cli/commands/tfenv/test_run.py index 9de265278..e8ab9b1b4 100644 --- a/tests/integration/cli/commands/tfenv/test_run.py +++ b/tests/integration/cli/commands/tfenv/test_run.py @@ -1,33 +1,29 @@ """Test ``runway tfenv run`` command.""" -# pylint: disable=unused-argument from __future__ import annotations import logging from typing import TYPE_CHECKING -from click.testing import CliRunner - from runway._cli import cli if TYPE_CHECKING: from pathlib import Path - from pytest import CaptureFixture, LogCaptureFixture + import pytest + from click.testing import CliRunner -def test_tfenv_run_no_version_file( - cd_tmp_path: Path, caplog: LogCaptureFixture -) -> None: +def test_tfenv_run_no_version_file(cli_runner: CliRunner, caplog: pytest.LogCaptureFixture) -> None: """Test ``runway tfenv run -- --help`` no version file.""" caplog.set_level(logging.ERROR, logger="runway") - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "run", "--", "--help"]) - assert result.exit_code == 1 + assert cli_runner.invoke(cli, ["tfenv", "run", "--", "--help"]).exit_code == 1 assert "unable to find a .terraform-version file" in "\n".join(caplog.messages) -def test_tfenv_run_separator(cd_tmp_path: Path, capfd: CaptureFixture[str]) -> None: +def test_tfenv_run_separator( + cli_runner: CliRunner, capfd: pytest.CaptureFixture[str], tmp_path: Path +) -> None: """Test ``runway tfenv run -- --help``. Parsing of command using ``--`` as a separator between options and args. @@ -36,25 +32,25 @@ def test_tfenv_run_separator(cd_tmp_path: Path, capfd: CaptureFixture[str]) -> N pass options shared with Runway such as ``--help``. """ - (cd_tmp_path / ".terraform-version").write_text("0.12.0") - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "run", "--", "--help"]) + (tmp_path / ".terraform-version").write_text("0.12.0") + result = cli_runner.invoke(cli, ["tfenv", "run", "--", "--help"]) captured = capfd.readouterr() # capfd required for subprocess assert result.exit_code == 0 assert "runway" not in captured.out assert "terraform [-version] [-help] [args]" in captured.out -def test_tfenv_run_version(cd_tmp_path: Path, capfd: CaptureFixture[str]) -> None: +def test_tfenv_run_version( + cli_runner: CliRunner, capfd: pytest.CaptureFixture[str], tmp_path: Path +) -> None: """Test ``runway tfenv run --version``. Parsing of bare command. """ version = "0.12.0" - (cd_tmp_path / ".terraform-version").write_text(version) - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "run", "--version"]) + (tmp_path / ".terraform-version").write_text(version) + result = cli_runner.invoke(cli, ["tfenv", "run", "--version"]) captured = capfd.readouterr() # capfd required for subprocess assert result.exit_code == 0 assert f"Terraform v{version}" in captured.out diff --git a/tests/integration/cli/commands/tfenv/test_uninstall.py b/tests/integration/cli/commands/tfenv/test_uninstall.py index ddfdf06f9..f658a0af9 100644 --- a/tests/integration/cli/commands/tfenv/test_uninstall.py +++ b/tests/integration/cli/commands/tfenv/test_uninstall.py @@ -1,50 +1,41 @@ """Test ``runway tfenv uninstall`` command.""" -# pylint: disable=unused-argument from __future__ import annotations import logging -from pathlib import Path from typing import TYPE_CHECKING -import pytest -from click.testing import CliRunner - from runway._cli import cli -from runway.env_mgr.tfenv import TF_VERSION_FILENAME, TFEnvManager +from runway.env_mgr.tfenv import TF_VERSION_FILENAME if TYPE_CHECKING: - from pytest import LogCaptureFixture - from pytest_mock import MockerFixture - -LOGGER = "runway.cli.commands.tfenv" + from pathlib import Path + import pytest + from click.testing import CliRunner -@pytest.fixture(autouse=True, scope="function") -def patch_versions_dir(mocker: MockerFixture, tmp_path: Path) -> None: - """Patch TFEnvManager.versions_dir.""" - mocker.patch.object(TFEnvManager, "versions_dir", tmp_path) +LOGGER = "runway.cli.commands.tfenv" -def test_tfenv_uninstall(cd_tmp_path: Path) -> None: +def test_tfenv_uninstall(cli_runner: CliRunner, versions_dir: Path) -> None: """Test ``runway tfenv uninstall``.""" version = "1.0.0" - version_dir = cd_tmp_path / version + version_dir = versions_dir / version version_dir.mkdir() - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "uninstall", "1.0.0"]) + result = cli_runner.invoke(cli, ["tfenv", "uninstall", "1.0.0"]) assert result.exit_code == 0 assert not version_dir.exists() -def test_tfenv_uninstall_all(caplog: LogCaptureFixture, cd_tmp_path: Path) -> None: +def test_tfenv_uninstall_all( + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner, versions_dir: Path +) -> None: """Test ``runway tfenv uninstall --all``.""" caplog.set_level(logging.INFO, logger=LOGGER) - version_dirs = [cd_tmp_path / "0.12.0", cd_tmp_path / "1.0.0"] + version_dirs = [versions_dir / "0.12.0", versions_dir / "1.0.0"] for v in version_dirs: v.mkdir() - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "uninstall", "--all"]) + result = cli_runner.invoke(cli, ["tfenv", "uninstall", "--all"]) assert result.exit_code == 0 assert "uninstalling all versions of Terraform..." in caplog.messages assert "all versions of Terraform have been uninstalled" in caplog.messages @@ -52,15 +43,14 @@ def test_tfenv_uninstall_all(caplog: LogCaptureFixture, cd_tmp_path: Path) -> No def test_tfenv_uninstall_all_takes_precedence( - caplog: LogCaptureFixture, cd_tmp_path: Path + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner, versions_dir: Path ) -> None: """Test ``runway tfenv uninstall --all`` takes precedence over arg.""" caplog.set_level(logging.INFO, logger=LOGGER) - version_dirs = [cd_tmp_path / "0.12.0", cd_tmp_path / "1.0.0"] + version_dirs = [versions_dir / "0.12.0", versions_dir / "1.0.0"] for v in version_dirs: v.mkdir() - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "uninstall", "0.13.0", "--all"]) + result = cli_runner.invoke(cli, ["tfenv", "uninstall", "0.13.0", "--all"]) assert result.exit_code == 0 assert "uninstalling all versions of Terraform..." in caplog.messages assert "all versions of Terraform have been uninstalled" in caplog.messages @@ -68,54 +58,52 @@ def test_tfenv_uninstall_all_takes_precedence( def test_tfenv_uninstall_all_none_installed( - caplog: LogCaptureFixture, cd_tmp_path: Path + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner ) -> None: """Test ``runway tfenv uninstall --all`` none installed.""" caplog.set_level(logging.INFO, logger=LOGGER) - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "uninstall", "--all"]) + result = cli_runner.invoke(cli, ["tfenv", "uninstall", "--all"]) assert result.exit_code == 0 assert "uninstalling all versions of Terraform..." in caplog.messages assert "all versions of Terraform have been uninstalled" in caplog.messages -def test_tfenv_uninstall_arg_takes_precedence(cd_tmp_path: Path) -> None: +def test_tfenv_uninstall_arg_takes_precedence( + cd_tmp_path: Path, cli_runner: CliRunner, versions_dir: Path +) -> None: """Test ``runway tfenv uninstall`` arg takes precedence over file.""" version = "1.0.0" - version_dir = cd_tmp_path / version + version_dir = versions_dir / version version_dir.mkdir() (cd_tmp_path / TF_VERSION_FILENAME).write_text("0.12.0") - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "uninstall", "1.0.0"]) + result = cli_runner.invoke(cli, ["tfenv", "uninstall", "1.0.0"]) assert result.exit_code == 0 assert not version_dir.exists() def test_tfenv_uninstall_no_version( - caplog: LogCaptureFixture, cd_tmp_path: Path + caplog: pytest.LogCaptureFixture, cli_runner: CliRunner ) -> None: """Test ``runway tfenv uninstall`` no version.""" caplog.set_level(logging.ERROR, logger=LOGGER) - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "uninstall"]) + result = cli_runner.invoke(cli, ["tfenv", "uninstall"]) assert result.exit_code != 0 assert "version not specified" in caplog.messages -def test_tfenv_uninstall_not_installed(cd_tmp_path: Path) -> None: +def test_tfenv_uninstall_not_installed(cli_runner: CliRunner) -> None: """Test ``runway tfenv uninstall`` not installed.""" - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "uninstall", "1.0.0"]) - assert result.exit_code != 0 + assert cli_runner.invoke(cli, ["tfenv", "uninstall", "1.0.0"]).exit_code != 0 -def test_tfenv_uninstall_version_file(cd_tmp_path: Path) -> None: +def test_tfenv_uninstall_version_file( + cd_tmp_path: Path, cli_runner: CliRunner, versions_dir: Path +) -> None: """Test ``runway tfenv uninstall`` version file.""" version = "1.0.0" - version_dir = cd_tmp_path / version + version_dir = versions_dir / version version_dir.mkdir() (cd_tmp_path / TF_VERSION_FILENAME).write_text(version) - runner = CliRunner() - result = runner.invoke(cli, ["tfenv", "uninstall"]) + result = cli_runner.invoke(cli, ["tfenv", "uninstall"]) assert result.exit_code == 0 assert not version_dir.exists() diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py index 9f793eef2..7d642d531 100644 --- a/tests/integration/conftest.py +++ b/tests/integration/conftest.py @@ -1,6 +1,5 @@ """Pytest configuration, fixtures, and plugins.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import shutil @@ -17,8 +16,7 @@ CpConfigTypeDef = Callable[[str, Path], Path] -# pylint: disable=unused-argument -def pytest_ignore_collect(path: Any, config: Config) -> bool: +def pytest_ignore_collect(path: Any, config: Config) -> bool: # noqa: ARG001 """Determine if this directory should have its tests collected.""" if config.option.functional: return True @@ -27,13 +25,13 @@ def pytest_ignore_collect(path: Any, config: Config) -> bool: return not (config.option.integration or config.option.integration_only) -@pytest.fixture +@pytest.fixture() def configs() -> Path: """Path to Runway config fixtures.""" return TEST_ROOT.parent / "fixtures" / "configs" -@pytest.fixture +@pytest.fixture() def cp_config(configs: Path) -> Callable[[str, Path], Path]: """Copy a config file.""" diff --git a/tests/unit/cfngin/actions/conftest.py b/tests/unit/cfngin/actions/conftest.py index ac890d883..829d9d9d6 100644 --- a/tests/unit/cfngin/actions/conftest.py +++ b/tests/unit/cfngin/actions/conftest.py @@ -7,16 +7,17 @@ from typing import TYPE_CHECKING import pytest -from mock import MagicMock from runway.cfngin.providers.aws.default import Provider if TYPE_CHECKING: + from unittest.mock import MagicMock + from mypy_boto3_cloudformation.type_defs import StackTypeDef from pytest_mock import MockerFixture -@pytest.fixture(scope="function") +@pytest.fixture() def provider_get_stack(mocker: MockerFixture) -> MagicMock: """Patches ``runway.cfngin.providers.aws.default.Provider.get_stack``.""" return_value: StackTypeDef = { diff --git a/tests/unit/cfngin/actions/test_base.py b/tests/unit/cfngin/actions/test_base.py index 0c80e09fd..e11b7d39d 100644 --- a/tests/unit/cfngin/actions/test_base.py +++ b/tests/unit/cfngin/actions/test_base.py @@ -1,11 +1,11 @@ """Tests for runway.cfngin.actions.base.""" -# pylint: disable=protected-access # pyright: basic import unittest +from unittest.mock import MagicMock, PropertyMock, patch import botocore.exceptions -from mock import MagicMock, PropertyMock, patch +import pytest from runway.cfngin.actions.base import BaseAction from runway.cfngin.blueprints.base import Blueprint @@ -64,9 +64,7 @@ def test_ensure_cfn_bucket_exists(self, mock_ensure_s3_bucket: MagicMock) -> Non """Test ensure cfn bucket exists.""" action = BaseAction( context=mock_context("mynamespace"), - provider_builder=MockProviderBuilder( - provider=Provider(get_session("us-east-1")) - ), + provider_builder=MockProviderBuilder(provider=Provider(get_session("us-east-1"))), ) assert not action.ensure_cfn_bucket() mock_ensure_s3_bucket.assert_called_once_with( @@ -83,22 +81,16 @@ def test_ensure_cfn_bucket_exists_raise_cfngin_bucket_not_found( ) action = BaseAction( context=mock_context("mynamespace"), - provider_builder=MockProviderBuilder( - provider=Provider(get_session("us-east-1")) - ), + provider_builder=MockProviderBuilder(provider=Provider(get_session("us-east-1"))), ) - with self.assertRaises(CfnginBucketNotFound): + with pytest.raises(CfnginBucketNotFound): assert action.ensure_cfn_bucket() mock_ensure_s3_bucket.assert_called_once_with( action.s3_conn, action.bucket_name, None, create=False ) - @patch( - "runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock - ) - @patch( - "runway.cfngin.actions.base.BaseAction._stack_action", new_callable=PropertyMock - ) + @patch("runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock) + @patch("runway.cfngin.actions.base.BaseAction._stack_action", new_callable=PropertyMock) def test_generate_plan_no_persist_exclude( self, mock_stack_action: PropertyMock, mock_tags: PropertyMock ) -> None: @@ -112,29 +104,23 @@ def test_generate_plan_no_persist_exclude( ) action = BaseAction( context=context, - provider_builder=MockProviderBuilder( - provider=self.provider, region=self.region - ), + provider_builder=MockProviderBuilder(provider=self.provider, region=self.region), ) plan = action._generate_plan(include_persistent_graph=False) mock_tags.assert_not_called() - self.assertIsInstance(plan, Plan) + assert isinstance(plan, Plan) # order is different between python2/3 so can't compare dicts result_graph_dict = plan.graph.to_dict() - self.assertEqual(2, len(result_graph_dict)) - self.assertEqual(set(), result_graph_dict["stack1"]) - self.assertEqual({"stack1"}, result_graph_dict["stack2"]) - self.assertEqual(BaseAction.DESCRIPTION, plan.description) - self.assertTrue(plan.require_unlocked) - - @patch( - "runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock - ) - @patch( - "runway.cfngin.actions.base.BaseAction._stack_action", new_callable=PropertyMock - ) + assert len(result_graph_dict) == 2 + assert set() == result_graph_dict["stack1"] + assert {"stack1"} == result_graph_dict["stack2"] + assert plan.description == BaseAction.DESCRIPTION + assert plan.require_unlocked + + @patch("runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock) + @patch("runway.cfngin.actions.base.BaseAction._stack_action", new_callable=PropertyMock) def test_generate_plan_no_persist_include( self, mock_stack_action: PropertyMock, mock_tags: PropertyMock ) -> None: @@ -148,29 +134,23 @@ def test_generate_plan_no_persist_include( ) action = BaseAction( context=context, - provider_builder=MockProviderBuilder( - provider=self.provider, region=self.region - ), + provider_builder=MockProviderBuilder(provider=self.provider, region=self.region), ) plan = action._generate_plan(include_persistent_graph=True) mock_tags.assert_not_called() - self.assertIsInstance(plan, Plan) + assert isinstance(plan, Plan) # order is different between python2/3 so can't compare dicts result_graph_dict = plan.graph.to_dict() - self.assertEqual(2, len(result_graph_dict)) - self.assertEqual(set(), result_graph_dict["stack1"]) - self.assertEqual({"stack1"}, result_graph_dict["stack2"]) - self.assertEqual(BaseAction.DESCRIPTION, plan.description) - self.assertTrue(plan.require_unlocked) - - @patch( - "runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock - ) - @patch( - "runway.cfngin.actions.base.BaseAction._stack_action", new_callable=PropertyMock - ) + assert len(result_graph_dict) == 2 + assert set() == result_graph_dict["stack1"] + assert {"stack1"} == result_graph_dict["stack2"] + assert plan.description == BaseAction.DESCRIPTION + assert plan.require_unlocked + + @patch("runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock) + @patch("runway.cfngin.actions.base.BaseAction._stack_action", new_callable=PropertyMock) def test_generate_plan_with_persist_exclude( self, mock_stack_action: PropertyMock, mock_tags: PropertyMock ) -> None: @@ -184,28 +164,22 @@ def test_generate_plan_with_persist_exclude( context._persistent_graph = Graph.from_steps([persist_step]) action = BaseAction( context=context, - provider_builder=MockProviderBuilder( - provider=self.provider, region=self.region - ), + provider_builder=MockProviderBuilder(provider=self.provider, region=self.region), ) plan = action._generate_plan(include_persistent_graph=False) - self.assertIsInstance(plan, Plan) + assert isinstance(plan, Plan) # order is different between python2/3 so can't compare dicts result_graph_dict = plan.graph.to_dict() - self.assertEqual(2, len(result_graph_dict)) - self.assertEqual(set(), result_graph_dict["stack1"]) - self.assertEqual({"stack1"}, result_graph_dict["stack2"]) - self.assertEqual(BaseAction.DESCRIPTION, plan.description) - self.assertTrue(plan.require_unlocked) - - @patch( - "runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock - ) - @patch( - "runway.cfngin.actions.base.BaseAction._stack_action", new_callable=PropertyMock - ) + assert len(result_graph_dict) == 2 + assert set() == result_graph_dict["stack1"] + assert {"stack1"} == result_graph_dict["stack2"] + assert plan.description == BaseAction.DESCRIPTION + assert plan.require_unlocked + + @patch("runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock) + @patch("runway.cfngin.actions.base.BaseAction._stack_action", new_callable=PropertyMock) def test_generate_plan_with_persist_include( self, mock_stack_action: PropertyMock, mock_tags: PropertyMock ) -> None: @@ -219,30 +193,24 @@ def test_generate_plan_with_persist_include( context._persistent_graph = Graph.from_steps([persist_step]) action = BaseAction( context=context, - provider_builder=MockProviderBuilder( - provider=self.provider, region=self.region - ), + provider_builder=MockProviderBuilder(provider=self.provider, region=self.region), ) plan = action._generate_plan(include_persistent_graph=True) - self.assertIsInstance(plan, Plan) + assert isinstance(plan, Plan) mock_tags.assert_called_once() # order is different between python2/3 so can't compare dicts result_graph_dict = plan.graph.to_dict() - self.assertEqual(3, len(result_graph_dict)) - self.assertEqual(set(), result_graph_dict["stack1"]) - self.assertEqual({"stack1"}, result_graph_dict["stack2"]) - self.assertEqual(set(), result_graph_dict["removed"]) - self.assertEqual(BaseAction.DESCRIPTION, plan.description) - self.assertTrue(plan.require_unlocked) - - @patch( - "runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock - ) - @patch( - "runway.cfngin.actions.base.BaseAction._stack_action", new_callable=PropertyMock - ) + assert len(result_graph_dict) == 3 + assert set() == result_graph_dict["stack1"] + assert {"stack1"} == result_graph_dict["stack2"] + assert set() == result_graph_dict["removed"] + assert plan.description == BaseAction.DESCRIPTION + assert plan.require_unlocked + + @patch("runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock) + @patch("runway.cfngin.actions.base.BaseAction._stack_action", new_callable=PropertyMock) def test_generate_plan_with_persist_no_lock_req( self, mock_stack_action: PropertyMock, mock_tags: PropertyMock ) -> None: @@ -256,30 +224,26 @@ def test_generate_plan_with_persist_no_lock_req( context._persistent_graph = Graph.from_steps([persist_step]) action = BaseAction( context=context, - provider_builder=MockProviderBuilder( - provider=self.provider, region=self.region - ), + provider_builder=MockProviderBuilder(provider=self.provider, region=self.region), ) - plan = action._generate_plan( - include_persistent_graph=True, require_unlocked=False - ) + plan = action._generate_plan(include_persistent_graph=True, require_unlocked=False) - self.assertIsInstance(plan, Plan) + assert isinstance(plan, Plan) mock_tags.assert_called_once() # order is different between python2/3 so can't compare dicts result_graph_dict = plan.graph.to_dict() - self.assertEqual(3, len(result_graph_dict)) - self.assertEqual(set(), result_graph_dict["stack1"]) - self.assertEqual({"stack1"}, result_graph_dict["stack2"]) - self.assertEqual(set(), result_graph_dict["removed"]) - self.assertEqual(BaseAction.DESCRIPTION, plan.description) - self.assertFalse(plan.require_unlocked) + assert len(result_graph_dict) == 3 + assert set() == result_graph_dict["stack1"] + assert {"stack1"} == result_graph_dict["stack2"] + assert set() == result_graph_dict["removed"] + assert plan.description == BaseAction.DESCRIPTION + assert not plan.require_unlocked def test_stack_template_url(self) -> None: """Test stack template url.""" context = mock_context("mynamespace") - blueprint = MockBlueprint(name="myblueprint", context=context) + blueprint = MockBlueprint(name="test-blueprint", context=context) region = "us-east-1" endpoint = "https://example.com" @@ -295,8 +259,8 @@ def test_stack_template_url(self) -> None: autospec=True, return_value=endpoint, ): - self.assertEqual( - action.stack_template_url(blueprint), - f"{endpoint}/cfngin-{context.namespace}-{region}/stack_templates/" - f"{context.namespace}-{blueprint.name}/{blueprint.name}-{MOCK_VERSION}.json", + assert ( + action.stack_template_url(blueprint) + == f"{endpoint}/cfngin-{context.namespace}-{region}/stack_templates/" + f"{context.namespace}-{blueprint.name}/{blueprint.name}-{MOCK_VERSION}.json" ) diff --git a/tests/unit/cfngin/actions/test_deploy.py b/tests/unit/cfngin/actions/test_deploy.py index 801d96529..101fbbd00 100644 --- a/tests/unit/cfngin/actions/test_deploy.py +++ b/tests/unit/cfngin/actions/test_deploy.py @@ -1,15 +1,14 @@ """Tests for runway.cfngin.actions.deploy.""" -# pylint: disable=unused-argument, protected-access -# pyright: basic from __future__ import annotations import unittest from collections import namedtuple -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast +from datetime import datetime +from typing import TYPE_CHECKING, Any, Optional, cast +from unittest.mock import MagicMock, PropertyMock, patch import pytest -from mock import MagicMock, PropertyMock, patch from runway.cfngin import exceptions from runway.cfngin.actions import deploy @@ -50,39 +49,35 @@ from runway.cfngin.status import Status -def mock_stack_parameters(parameters: Dict[str, Any]) -> StackTypeDef: +def mock_stack_parameters(parameters: dict[str, Any]) -> StackTypeDef: """Mock stack parameters.""" return { # type: ignore - "Parameters": [ - {"ParameterKey": k, "ParameterValue": v} for k, v in parameters.items() - ] + "Parameters": [{"ParameterKey": k, "ParameterValue": v} for k, v in parameters.items()] } class MockProvider(BaseProvider): """Mock provider.""" - _outputs: Dict[str, Dict[str, str]] + _outputs: dict[str, dict[str, str]] - def __init__( - self, *, outputs: Optional[Dict[str, Dict[str, str]]] = None, **_: Any - ) -> None: + def __init__(self, *, outputs: dict[str, dict[str, str]] | None = None, **_: Any) -> None: """Instantiate class.""" self._outputs = outputs or {} - def set_outputs(self, outputs: Dict[str, Dict[str, str]]) -> None: + def set_outputs(self, outputs: dict[str, dict[str, str]]) -> None: """Set outputs.""" self._outputs = outputs def get_stack( self, stack_name: str, *_args: Any, **_kwargs: Any - ) -> Dict[str, Union[Dict[str, str], str]]: + ) -> dict[str, dict[str, str] | str]: """Get stack.""" if stack_name not in self._outputs: raise exceptions.StackDoesNotExist(stack_name) return {"name": stack_name, "outputs": self._outputs[stack_name]} - def get_outputs(self, stack_name: str, *args: Any, **kwargs: Any) -> Dict[str, Any]: + def get_outputs(self, stack_name: str, *_args: Any, **_kwargs: Any) -> dict[str, Any]: """Get outputs.""" stack = self.get_stack(stack_name) return stack["outputs"] # type: ignore @@ -94,9 +89,9 @@ class MockStack: def __init__( self, name: str, - in_progress_behavior: Optional[str] = None, - tags: Any = None, - **_: Any, + in_progress_behavior: str | None = None, + *_args: Any, + **_kwargs: Any, ) -> None: """Instantiate class.""" self.name = name @@ -156,16 +151,12 @@ def test_upload_disabled_setter_raise_cfngin_bucket_required( Action(cfngin_context).upload_disabled = False -class TestBuildAction( - unittest.TestCase -): # TODO: refactor tests into the TestAction class +class TestBuildAction(unittest.TestCase): # TODO (kyle): refactor tests into the TestAction class """Tests for runway.cfngin.actions.deploy.BuildAction.""" def setUp(self) -> None: """Run before tests.""" - self.context = CfnginContext( - config=CfnginConfig.parse_obj({"namespace": "namespace"}) - ) + self.context = CfnginContext(config=CfnginConfig.parse_obj({"namespace": "namespace"})) self.provider = MockProvider() self.deploy_action = deploy.Action( self.context, @@ -173,10 +164,10 @@ def setUp(self) -> None: ) def _get_context( - self, extra_config_args: Optional[Dict[str, Any]] = None, **kwargs: Any + self, extra_config_args: Optional[dict[str, Any]] = None, **kwargs: Any ) -> CfnginContext: """Get context.""" - config: Dict[str, Any] = { + config: dict[str, Any] = { "namespace": "namespace", "stacks": [ {"name": "vpc", "template_path": "."}, @@ -217,56 +208,40 @@ def test_destroy_stack_delete_failed(self) -> None: status = self.deploy_action._destroy_stack( MockStack("vpc", in_progress_behavior="wait"), status=PENDING # type: ignore ) - provider.is_stack_being_destroyed.assert_called_once_with( - provider.get_stack.return_value - ) - provider.is_stack_destroyed.assert_called_once_with( - provider.get_stack.return_value - ) - provider.is_stack_in_progress.assert_called_once_with( - provider.get_stack.return_value - ) - provider.is_stack_destroy_possible.assert_called_once_with( - provider.get_stack.return_value - ) + provider.is_stack_being_destroyed.assert_called_once_with(provider.get_stack.return_value) + provider.is_stack_destroyed.assert_called_once_with(provider.get_stack.return_value) + provider.is_stack_in_progress.assert_called_once_with(provider.get_stack.return_value) + provider.is_stack_destroy_possible.assert_called_once_with(provider.get_stack.return_value) provider.get_delete_failed_status_reason.assert_called_once_with("vpc") - provider.get_stack_status_reason.assert_called_once_with( - provider.get_stack.return_value - ) + provider.get_stack_status_reason.assert_called_once_with(provider.get_stack.return_value) assert isinstance(status, FailedStatus) assert status.reason == "reason" - @patch( - "runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock - ) + @patch("runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock) def test_generate_plan_persist_destroy(self, mock_graph_tags: PropertyMock) -> None: """Test generate plan persist destroy.""" mock_graph_tags.return_value = {} - context = self._get_context( - extra_config_args={"persistent_graph_key": "test.json"} - ) - context._persistent_graph = Graph.from_steps( - [Step.from_stack_name("removed", context)] - ) + context = self._get_context(extra_config_args={"persistent_graph_key": "test.json"}) + context._persistent_graph = Graph.from_steps([Step.from_stack_name("removed", context)]) deploy_action = deploy.Action(context=context) plan = cast(Plan, deploy_action._Action__generate_plan()) # type: ignore - self.assertIsInstance(plan, Plan) - self.assertEqual(deploy.Action.DESCRIPTION, plan.description) + assert isinstance(plan, Plan) + assert plan.description == deploy.Action.DESCRIPTION mock_graph_tags.assert_called_once() # order is different between python2/3 so can't compare dicts result_graph_dict = plan.graph.to_dict() - self.assertEqual(5, len(result_graph_dict)) - self.assertEqual(set(), result_graph_dict["other"]) - self.assertEqual(set(), result_graph_dict["removed"]) - self.assertEqual(set(), result_graph_dict["vpc"]) - self.assertEqual({"vpc"}, result_graph_dict["bastion"]) - self.assertEqual({"bastion", "vpc"}, result_graph_dict["db"]) - self.assertEqual(deploy_action._destroy_stack, plan.graph.steps["removed"].fn) - self.assertEqual(deploy_action._launch_stack, plan.graph.steps["vpc"].fn) - self.assertEqual(deploy_action._launch_stack, plan.graph.steps["bastion"].fn) - self.assertEqual(deploy_action._launch_stack, plan.graph.steps["db"].fn) - self.assertEqual(deploy_action._launch_stack, plan.graph.steps["other"].fn) + assert len(result_graph_dict) == 5 + assert set() == result_graph_dict["other"] + assert set() == result_graph_dict["removed"] + assert set() == result_graph_dict["vpc"] + assert {"vpc"} == result_graph_dict["bastion"] + assert {"bastion", "vpc"} == result_graph_dict["db"] + assert deploy_action._destroy_stack == plan.graph.steps["removed"].fn + assert deploy_action._launch_stack == plan.graph.steps["vpc"].fn + assert deploy_action._launch_stack == plan.graph.steps["bastion"].fn + assert deploy_action._launch_stack == plan.graph.steps["db"].fn + assert deploy_action._launch_stack == plan.graph.steps["other"].fn def test_handle_missing_params(self) -> None: """Test handle missing params.""" @@ -282,17 +257,17 @@ def test_handle_missing_params(self) -> None: result = _handle_missing_parameters( parameter_values, all_params, required, existing_stack_params ) - self.assertEqual(sorted(result), sorted(expected_params.items())) + assert sorted(result) == sorted(expected_params.items()) def test_missing_params_no_existing_stack(self) -> None: """Test missing params no existing stack.""" all_params = ["Address", "StackName"] required = ["Address"] - parameter_values: Dict[str, Any] = {} - with self.assertRaises(exceptions.MissingParameterException) as result: + parameter_values: dict[str, Any] = {} + with pytest.raises(exceptions.MissingParameterException) as result: _handle_missing_parameters(parameter_values, all_params, required) - self.assertEqual(result.exception.parameters, required) + assert result.value.parameters == required def test_existing_stack_params_does_not_override_given_params(self) -> None: """Test existing stack params does not override given params.""" @@ -304,22 +279,19 @@ def test_existing_stack_params_does_not_override_given_params(self) -> None: result = _handle_missing_parameters( parameter_values, all_params, required, existing_stack_params ) - self.assertEqual(sorted(result), sorted(parameter_values.items())) + assert sorted(result) == sorted(parameter_values.items()) def test_generate_plan(self) -> None: """Test generate plan.""" context = self._get_context() deploy_action = deploy.Action(context, cancel=MockThreadingEvent()) # type: ignore plan = cast(Plan, deploy_action._Action__generate_plan()) # type: ignore - self.assertEqual( - { - "db": {"bastion", "vpc"}, - "bastion": {"vpc"}, - "other": set(), - "vpc": set(), - }, - plan.graph.to_dict(), - ) + assert plan.graph.to_dict() == { + "db": {"bastion", "vpc"}, + "bastion": {"vpc"}, + "other": set(), + "vpc": set(), + } def test_does_not_execute_plan_when_outline_specified(self) -> None: """Test does not execute plan when outline specified.""" @@ -327,7 +299,7 @@ def test_does_not_execute_plan_when_outline_specified(self) -> None: deploy_action = deploy.Action(context, cancel=MockThreadingEvent()) # type: ignore with patch.object(deploy_action, "_generate_plan") as mock_generate_plan: deploy_action.run(outline=True) - self.assertEqual(mock_generate_plan().execute.call_count, 0) + assert mock_generate_plan().execute.call_count == 0 def test_execute_plan_when_outline_not_specified(self) -> None: """Test execute plan when outline not specified.""" @@ -335,15 +307,11 @@ def test_execute_plan_when_outline_not_specified(self) -> None: deploy_action = deploy.Action(context, cancel=MockThreadingEvent()) # type: ignore with patch.object(deploy_action, "_generate_plan") as mock_generate_plan: deploy_action.run(outline=False) - self.assertEqual(mock_generate_plan().execute.call_count, 1) + assert mock_generate_plan().execute.call_count == 1 - @patch( - "runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock - ) + @patch("runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock) @patch("runway.context.CfnginContext.lock_persistent_graph", new_callable=MagicMock) - @patch( - "runway.context.CfnginContext.unlock_persistent_graph", new_callable=MagicMock - ) + @patch("runway.context.CfnginContext.unlock_persistent_graph", new_callable=MagicMock) @patch("runway.cfngin.plan.Plan.execute", new_callable=MagicMock) def test_run_persist( self, @@ -354,12 +322,8 @@ def test_run_persist( ) -> None: """Test run persist.""" mock_graph_tags.return_value = {} - context = self._get_context( - extra_config_args={"persistent_graph_key": "test.json"} - ) - context._persistent_graph = Graph.from_steps( - [Step.from_stack_name("removed", context)] - ) + context = self._get_context(extra_config_args={"persistent_graph_key": "test.json"}) + context._persistent_graph = Graph.from_steps([Step.from_stack_name("removed", context)]) deploy_action = deploy.Action(context=context) deploy_action.run() @@ -382,7 +346,7 @@ def test_should_update(self) -> None: for test in test_scenarios: mock_stack.locked = test.locked mock_stack.force = test.force - self.assertEqual(deploy.should_update(mock_stack), test.result) # type: ignore + assert deploy.should_update(mock_stack) == test.result # type: ignore def test_should_ensure_cfn_bucket(self) -> None: """Test should ensure cfn bucket.""" @@ -399,9 +363,7 @@ def test_should_ensure_cfn_bucket(self) -> None: dump = scenario["dump"] result = scenario["result"] try: - self.assertEqual( - deploy.should_ensure_cfn_bucket(outline, dump), result # type: ignore - ) + assert deploy.should_ensure_cfn_bucket(outline, dump) == result # type: ignore except AssertionError as err: err.args += ("scenario", str(scenario)) raise @@ -418,10 +380,10 @@ def test_should_submit(self) -> None: mock_stack.name = "test-stack" for test in test_scenarios: mock_stack.enabled = test.enabled - self.assertEqual(deploy.should_submit(mock_stack), test.result) # type: ignore + assert deploy.should_submit(mock_stack) == test.result # type: ignore -class TestLaunchStack(TestBuildAction): # TODO: refactor tests to be pytest tests +class TestLaunchStack(TestBuildAction): # TODO (kyle): refactor tests to be pytest tests """Tests for runway.cfngin.actions.deploy.BuildAction launch stack.""" def setUp(self) -> None: @@ -453,7 +415,7 @@ def patch_object(*args: Any, **kwargs: Any) -> None: self.addCleanup(mock_object.stop) mock_object.start() - def get_stack(name: str, *_args: Any, **_kwargs: Any) -> Dict[str, Any]: + def get_stack(name: str, *_args: Any, **_kwargs: Any) -> dict[str, Any]: if name != self.stack.name or not self.stack_status: raise StackDoesNotExist(name) @@ -464,11 +426,12 @@ def get_stack(name: str, *_args: Any, **_kwargs: Any) -> Dict[str, Any]: "Tags": [], } - def get_events(name: str, *_args: Any, **_kwargs: Any) -> List[Dict[str, str]]: + def get_events(*_args: Any, **_kwargs: Any) -> list[dict[str, Any]]: return [ { "ResourceStatus": "ROLLBACK_IN_PROGRESS", "ResourceStatusReason": "CFN fail", + "Timestamp": datetime(2015, 1, 1), } ] @@ -489,12 +452,12 @@ def _advance( """Advance.""" self.stack_status = new_provider_status status = self.step._run_once() - self.assertEqual(status, expected_status) - self.assertEqual(status.reason, expected_reason) + assert status == expected_status + assert status.reason == expected_reason def test_launch_stack_disabled(self) -> None: """Test launch stack disabled.""" - self.assertEqual(self.step.status, PENDING) + assert self.step.status == PENDING self.stack.enabled = False self._advance(None, NotSubmittedStatus(), "disabled") @@ -502,7 +465,7 @@ def test_launch_stack_disabled(self) -> None: def test_launch_stack_create(self) -> None: """Test launch stack create.""" # initial status should be PENDING - self.assertEqual(self.step.status, PENDING) + assert self.step.status == PENDING # initial run should return SUBMITTED since we've passed off to CF self._advance(None, SUBMITTED, "creating new stack") @@ -516,7 +479,7 @@ def test_launch_stack_create(self) -> None: def test_launch_stack_create_rollback(self) -> None: """Test launch stack create rollback.""" # initial status should be PENDING - self.assertEqual(self.step.status, PENDING) + assert self.step.status == PENDING # initial run should return SUBMITTED since we've passed off to CF self._advance(None, SUBMITTED, "creating new stack") @@ -535,21 +498,16 @@ def test_launch_stack_create_rollback(self) -> None: def test_launch_stack_recreate(self) -> None: """Test launch stack recreate.""" - # pylint: disable=attribute-defined-outside-init self.provider.recreate_failed = True # initial status should be PENDING - self.assertEqual(self.step.status, PENDING) + assert self.step.status == PENDING # first action with an existing failed stack should be deleting it - self._advance( - "ROLLBACK_COMPLETE", SUBMITTED, "destroying stack for re-creation" - ) + self._advance("ROLLBACK_COMPLETE", SUBMITTED, "destroying stack for re-creation") # status should stay as submitted during deletion - self._advance( - "DELETE_IN_PROGRESS", SUBMITTED, "destroying stack for re-creation" - ) + self._advance("DELETE_IN_PROGRESS", SUBMITTED, "destroying stack for re-creation") # deletion being complete must trigger re-creation self._advance("DELETE_COMPLETE", SUBMITTED, "re-creating stack") @@ -563,7 +521,7 @@ def test_launch_stack_recreate(self) -> None: def test_launch_stack_update_skipped(self) -> None: """Test launch stack update skipped.""" # initial status should be PENDING - self.assertEqual(self.step.status, PENDING) + assert self.step.status == PENDING # start the upgrade, that will be skipped self.provider.update_stack.side_effect = StackDidNotChange # type: ignore @@ -572,7 +530,7 @@ def test_launch_stack_update_skipped(self) -> None: def test_launch_stack_update_rollback(self) -> None: """Test launch stack update rollback.""" # initial status should be PENDING - self.assertEqual(self.step.status, PENDING) + assert self.step.status == PENDING # initial run should return SUBMITTED since we've passed off to CF self._advance("CREATE_COMPLETE", SUBMITTED, "updating existing stack") @@ -589,7 +547,7 @@ def test_launch_stack_update_rollback(self) -> None: def test_launch_stack_update_success(self) -> None: """Test launch stack update success.""" # initial status should be PENDING - self.assertEqual(self.step.status, PENDING) + assert self.step.status == PENDING # initial run should return SUBMITTED since we've passed off to CF self._advance("CREATE_COMPLETE", SUBMITTED, "updating existing stack") @@ -601,7 +559,7 @@ def test_launch_stack_update_success(self) -> None: self._advance("UPDATE_COMPLETE", COMPLETE, "updating existing stack") -class TestFunctions(unittest.TestCase): # TODO: refactor tests to be pytest tests +class TestFunctions(unittest.TestCase): # TODO (kyle): refactor tests to be pytest tests """Tests for runway.cfngin.actions.deploy module level functions.""" def setUp(self) -> None: @@ -618,8 +576,8 @@ def test_resolve_parameters_unused_parameter(self) -> None: } params = {"a": "Apple", "c": "Carrot"} resolved_params = _resolve_parameters(params, self.blueprint) - self.assertNotIn("c", resolved_params) - self.assertIn("a", resolved_params) + assert "c" not in resolved_params + assert "a" in resolved_params def test_resolve_parameters_none_conversion(self) -> None: """Test resolve parameters none conversion.""" @@ -629,7 +587,7 @@ def test_resolve_parameters_none_conversion(self) -> None: } params = {"a": None, "c": "Carrot"} resolved_params = _resolve_parameters(params, self.blueprint) - self.assertNotIn("a", resolved_params) + assert "a" not in resolved_params def test_resolve_parameters_booleans(self) -> None: """Test resolve parameters booleans.""" @@ -639,5 +597,5 @@ def test_resolve_parameters_booleans(self) -> None: } params = {"a": True, "b": False} resolved_params = _resolve_parameters(params, self.blueprint) - self.assertEqual("true", resolved_params["a"]) - self.assertEqual("false", resolved_params["b"]) + assert resolved_params["a"] == "true" + assert resolved_params["b"] == "false" diff --git a/tests/unit/cfngin/actions/test_destroy.py b/tests/unit/cfngin/actions/test_destroy.py index 9b743b2d1..c118b6ccd 100644 --- a/tests/unit/cfngin/actions/test_destroy.py +++ b/tests/unit/cfngin/actions/test_destroy.py @@ -1,13 +1,11 @@ """Tests for runway.cfngin.actions.destroy.""" -# pylint: disable=protected-access,unused-argument # pyright: basic from __future__ import annotations import unittest -from typing import Any, Dict, Optional - -from mock import MagicMock, PropertyMock, patch +from typing import Any, Optional +from unittest.mock import MagicMock, PropertyMock, patch from runway.cfngin.actions import destroy from runway.cfngin.exceptions import StackDoesNotExist @@ -22,7 +20,7 @@ class MockStack: """Mock our local CFNgin stack and an AWS provider stack.""" - def __init__(self, name: str, tags: Any = None, **_: Any) -> None: + def __init__(self, name: str, *_args: Any, **_kwargs: Any) -> None: """Instantiate class.""" self.name = name self.fqn = name @@ -34,13 +32,13 @@ def __init__(self, name: str, tags: Any = None, **_: Any) -> None: class TestDestroyAction(unittest.TestCase): """Tests for runway.cfngin.actions.destroy.DestroyAction.""" - def setUp(self): + def setUp(self) -> None: """Run before tests.""" self.context = self._get_context() self.action = destroy.Action(self.context, cancel=MockThreadingEvent()) # type: ignore def _get_context( - self, extra_config_args: Optional[Dict[str, Any]] = None, **kwargs: Any + self, extra_config_args: Optional[dict[str, Any]] = None, **kwargs: Any ) -> CfnginContext: """Get context.""" config = { @@ -68,28 +66,25 @@ def _get_context( def test_generate_plan(self) -> None: """Test generate plan.""" plan = self.action._generate_plan(reverse=True) - self.assertEqual( - { - "vpc": {"db", "instance", "bastion"}, - "other": set(), - "bastion": {"instance", "db"}, - "instance": {"db"}, - "db": {"other"}, - }, - plan.graph.to_dict(), - ) + assert plan.graph.to_dict() == { + "vpc": {"db", "instance", "bastion"}, + "other": set(), + "bastion": {"instance", "db"}, + "instance": {"db"}, + "db": {"other"}, + } def test_only_execute_plan_when_forced(self) -> None: """Test only execute plan when forced.""" with patch.object(self.action, "_generate_plan") as mock_generate_plan: self.action.run(force=False) - self.assertEqual(mock_generate_plan().execute.call_count, 0) + assert mock_generate_plan().execute.call_count == 0 def test_execute_plan_when_forced(self) -> None: """Test execute plan when forced.""" with patch.object(self.action, "_generate_plan") as mock_generate_plan: self.action.run(force=True) - self.assertEqual(mock_generate_plan().execute.call_count, 1) + assert mock_generate_plan().execute.call_count == 1 def test_destroy_stack_complete_if_state_submitted(self) -> None: """Test destroy stack complete if state submitted.""" @@ -101,11 +96,11 @@ def test_destroy_stack_complete_if_state_submitted(self) -> None: status = self.action._destroy_stack(MockStack("vpc"), status=PENDING) # type: ignore # if we haven't processed the step (ie. has never been SUBMITTED, # should be skipped) - self.assertEqual(status, SKIPPED) + assert status == SKIPPED status = self.action._destroy_stack(MockStack("vpc"), status=SUBMITTED) # type: ignore # if we have processed the step and then can't find the stack, it means # we successfully deleted it - self.assertEqual(status, COMPLETE) + assert status == COMPLETE def test_destroy_stack_delete_failed(self) -> None: """Test _destroy_stack DELETE_FAILED.""" @@ -121,19 +116,11 @@ def test_destroy_stack_delete_failed(self) -> None: provider.get_stack_status_reason.return_value = "reason" self.action.provider_builder = MockProviderBuilder(provider=provider) status = self.action._destroy_stack(MockStack("vpc"), status=PENDING) # type: ignore - provider.is_stack_destroyed.assert_called_once_with( - provider.get_stack.return_value - ) - provider.is_stack_in_progress.assert_called_once_with( - provider.get_stack.return_value - ) - provider.is_stack_destroy_possible.assert_called_once_with( - provider.get_stack.return_value - ) + provider.is_stack_destroyed.assert_called_once_with(provider.get_stack.return_value) + provider.is_stack_in_progress.assert_called_once_with(provider.get_stack.return_value) + provider.is_stack_destroy_possible.assert_called_once_with(provider.get_stack.return_value) provider.get_delete_failed_status_reason.assert_called_once_with("vpc") - provider.get_stack_status_reason.assert_called_once_with( - provider.get_stack.return_value - ) + provider.get_stack_status_reason.assert_called_once_with(provider.get_stack.return_value) assert isinstance(status, FailedStatus) assert status.reason == "reason" @@ -156,7 +143,7 @@ def get_stack(stack_name: Any) -> Any: mock_provider.get_stack.side_effect = StackDoesNotExist("mock") step.run() - self.assertEqual(step.status, SKIPPED) + assert step.status == SKIPPED # simulate stack getting successfully deleted mock_provider.get_stack.side_effect = get_stack @@ -164,25 +151,21 @@ def get_stack(stack_name: Any) -> Any: mock_provider.is_stack_in_progress.return_value = False step._run_once() - self.assertEqual(step.status, SUBMITTED) + assert step.status == SUBMITTED mock_provider.is_stack_destroyed.return_value = False mock_provider.is_stack_in_progress.return_value = True step._run_once() - self.assertEqual(step.status, SUBMITTED) + assert step.status == SUBMITTED mock_provider.is_stack_destroyed.return_value = True mock_provider.is_stack_in_progress.return_value = False step._run_once() - self.assertEqual(step.status, COMPLETE) + assert step.status == COMPLETE - @patch( - "runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock - ) + @patch("runway.context.CfnginContext.persistent_graph_tags", new_callable=PropertyMock) @patch("runway.context.CfnginContext.lock_persistent_graph", new_callable=MagicMock) - @patch( - "runway.context.CfnginContext.unlock_persistent_graph", new_callable=MagicMock - ) + @patch("runway.context.CfnginContext.unlock_persistent_graph", new_callable=MagicMock) @patch("runway.cfngin.plan.Plan.execute", new_callable=MagicMock) def test_run_persist( self, @@ -193,12 +176,8 @@ def test_run_persist( ) -> None: """Test run persist.""" mock_graph_tags.return_value = {} - context = self._get_context( - extra_config_args={"persistent_graph_key": "test.json"} - ) - context._persistent_graph = Graph.from_steps( - [Step.from_stack_name("removed", context)] - ) + context = self._get_context(extra_config_args={"persistent_graph_key": "test.json"}) + context._persistent_graph = Graph.from_steps([Step.from_stack_name("removed", context)]) destroy_action = destroy.Action(context=context) destroy_action.run(force=True) diff --git a/tests/unit/cfngin/actions/test_diff.py b/tests/unit/cfngin/actions/test_diff.py index 84906f175..af271bc3d 100644 --- a/tests/unit/cfngin/actions/test_diff.py +++ b/tests/unit/cfngin/actions/test_diff.py @@ -1,6 +1,5 @@ """Tests for runway.cfngin.actions.diff.""" -# pylint: disable=protected-access # pyright: basic from __future__ import annotations @@ -8,10 +7,10 @@ import unittest from operator import attrgetter from typing import TYPE_CHECKING, Optional +from unittest.mock import MagicMock, Mock, patch import pytest from botocore.exceptions import ClientError -from mock import MagicMock, Mock, patch from runway.cfngin.actions.diff import ( Action, @@ -26,10 +25,9 @@ from ..factories import MockProviderBuilder, MockThreadingEvent if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture - from ...factories import MockCFNginContext + from ...factories import MockCfnginContext MODULE = "runway.cfngin.actions.diff" @@ -50,11 +48,11 @@ class TestAction: def test_pre_run( self, mock_bucket_init: MagicMock, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, bucket_name: Optional[str], forbidden: bool, not_found: bool, - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, ) -> None: """Test pre_run.""" caplog.set_level(logging.DEBUG, logger=MODULE) @@ -71,9 +69,7 @@ def test_pre_run( with pytest.raises(SystemExit) as excinfo: action.pre_run() assert excinfo.value.code == 1 - assert ( - f"access denied for CFNgin bucket: {bucket_name}" - ) in caplog.messages + assert (f"access denied for CFNgin bucket: {bucket_name}") in caplog.messages return action.pre_run() @@ -88,8 +84,8 @@ def test_pre_run( @pytest.mark.parametrize("stack_not_exist", [False, True]) def test__diff_stack_validationerror_template_too_large( self, - caplog: LogCaptureFixture, - cfngin_context: MockCFNginContext, + caplog: pytest.LogCaptureFixture, + cfngin_context: MockCfnginContext, mocker: MockerFixture, provider_get_stack: MagicMock, stack_not_exist: bool, @@ -100,9 +96,7 @@ def test__diff_stack_validationerror_template_too_large( cfngin_context.add_stubber("cloudformation") cfngin_context.config.cfngin_bucket = "" expected = SkippedStatus("cfngin_bucket: existing bucket required") - mock_build_parameters = mocker.patch.object( - Action, "build_parameters", return_value=[] - ) + mock_build_parameters = mocker.patch.object(Action, "build_parameters", return_value=[]) mock_get_stack_changes = mocker.patch.object( Provider, "get_stack_changes", @@ -147,35 +141,28 @@ class TestDictValueFormat(unittest.TestCase): def test_status(self) -> None: """Test status.""" added = DictValue("k0", None, "value_0") - self.assertEqual(added.status(), DictValue.ADDED) + assert added.status() == DictValue.ADDED removed = DictValue("k1", "value_1", None) - self.assertEqual(removed.status(), DictValue.REMOVED) + assert removed.status() == DictValue.REMOVED modified = DictValue("k2", "value_1", "value_2") - self.assertEqual(modified.status(), DictValue.MODIFIED) + assert modified.status() == DictValue.MODIFIED unmodified = DictValue("k3", "value_1", "value_1") - self.assertEqual(unmodified.status(), DictValue.UNMODIFIED) + assert unmodified.status() == DictValue.UNMODIFIED def test_format(self) -> None: """Test format.""" added = DictValue("k0", None, "value_0") - self.assertEqual(added.changes(), [f"+{added.key} = {added.new_value}"]) + assert added.changes() == [f"+{added.key} = {added.new_value}"] removed = DictValue("k1", "value_1", None) - self.assertEqual(removed.changes(), [f"-{removed.key} = {removed.old_value}"]) + assert removed.changes() == [f"-{removed.key} = {removed.old_value}"] modified = DictValue("k2", "value_1", "value_2") - self.assertEqual( - modified.changes(), - [ - f"-{modified.key} = {modified.old_value}", - f"+{modified.key} = {modified.new_value}", - ], - ) + assert modified.changes() == [ + f"-{modified.key} = {modified.old_value}", + f"+{modified.key} = {modified.new_value}", + ] unmodified = DictValue("k3", "value_1", "value_1") - self.assertEqual( - unmodified.changes(), [f" {unmodified.key} = {unmodified.old_value}"] - ) - self.assertEqual( - unmodified.changes(), [f" {unmodified.key} = {unmodified.new_value}"] - ) + assert unmodified.changes() == [f" {unmodified.key} = {unmodified.old_value}"] + assert unmodified.changes() == [f" {unmodified.key} = {unmodified.new_value}"] class TestDiffDictionary(unittest.TestCase): @@ -195,7 +182,7 @@ def test_diff_dictionaries(self) -> None: } count, changes = diff_dictionaries(old_dict, new_dict) - self.assertEqual(count, 3) + assert count == 3 expected_output = [ DictValue("a", "Apple", "Apple"), DictValue("b", "Banana", "Bob"), @@ -207,10 +194,10 @@ def test_diff_dictionaries(self) -> None: # compare all the outputs to the expected change for expected_change in expected_output: change = changes.pop(0) - self.assertEqual(change, expected_change) + assert change == expected_change # No extra output - self.assertEqual(len(changes), 0) + assert len(changes) == 0 class TestDiffParameters(unittest.TestCase): @@ -222,4 +209,4 @@ def test_diff_parameters_no_changes(self) -> None: new_params = {"a": "Apple"} param_diffs = diff_parameters(old_params, new_params) - self.assertEqual(param_diffs, []) + assert param_diffs == [] diff --git a/tests/unit/cfngin/actions/test_init.py b/tests/unit/cfngin/actions/test_init.py index 51411cec7..117663ddc 100644 --- a/tests/unit/cfngin/actions/test_init.py +++ b/tests/unit/cfngin/actions/test_init.py @@ -3,9 +3,9 @@ from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import Mock import pytest -from mock import Mock from runway._logging import LogLevels from runway.cfngin.actions.init import Action @@ -14,7 +14,6 @@ from runway.core.providers.aws.s3 import Bucket if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from runway.context import CfnginContext @@ -25,9 +24,7 @@ class TestAction: """Test Action.""" - def test___init__( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test___init__(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test __init__.""" copied_context = mocker.patch.object(cfngin_context, "copy") obj = Action(cfngin_context) @@ -36,25 +33,18 @@ def test___init__( def test__stack_action(self, cfngin_context: CfnginContext) -> None: """Test _stack_action.""" - # pylint: disable=protected-access assert Action(cfngin_context)._stack_action is None - def test_cfngin_bucket( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_cfngin_bucket(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test cfngin_bucket.""" mocker.patch.object(cfngin_context, "copy", return_value=cfngin_context) mocker.patch.object(cfngin_context, "s3_client") bucket = mocker.patch(f"{MODULE}.Bucket") bucket_name = mocker.patch.object(cfngin_context, "bucket_name", "bucket_name") - bucket_region = mocker.patch.object( - cfngin_context, "bucket_region", "bucket_region" - ) + bucket_region = mocker.patch.object(cfngin_context, "bucket_region", "bucket_region") obj = Action(cfngin_context) assert obj.cfngin_bucket == bucket.return_value - bucket.assert_called_once_with( - cfngin_context, name=bucket_name, region=bucket_region - ) + bucket.assert_called_once_with(cfngin_context, name=bucket_name, region=bucket_region) def test_cfngin_bucket_handle_no_bucket( self, cfngin_context: CfnginContext, mocker: MockerFixture @@ -74,9 +64,7 @@ def test_default_cfngin_bucket_stack( """Test default_cfngin_bucket_stack.""" mocker.patch.object(cfngin_context, "copy", return_value=cfngin_context) bucket_name = mocker.patch.object(cfngin_context, "bucket_name", "bucket_name") - assert Action( - cfngin_context - ).default_cfngin_bucket_stack == CfnginStackDefinitionModel( + assert Action(cfngin_context).default_cfngin_bucket_stack == CfnginStackDefinitionModel( class_path="runway.cfngin.blueprints.cfngin_bucket.CfnginBucket", in_progress_behavior="wait", name="cfngin-bucket", @@ -86,7 +74,7 @@ def test_default_cfngin_bucket_stack( def test_run( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, mocker: MockerFixture, ) -> None: @@ -115,7 +103,7 @@ def test_run( def test_run_cfngin_bucket_region( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, mocker: MockerFixture, ) -> None: @@ -147,7 +135,7 @@ def test_run_cfngin_bucket_region( def test_run_exists( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, mocker: MockerFixture, ) -> None: @@ -162,9 +150,7 @@ def test_run_exists( assert not Action(cfngin_context).run() assert f"cfngin_bucket {cfngin_bucket.name} already exists" in caplog.messages - def test_run_forbidden( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_run_forbidden(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test run.""" cfngin_bucket = mocker.patch.object( Action, @@ -177,7 +163,7 @@ def test_run_forbidden( def test_run_get_stack( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, mocker: MockerFixture, ) -> None: @@ -193,9 +179,7 @@ def test_run_get_stack( ) assert not Action(cfngin_context, provider_builder, cancel).run() get_stack.assert_called_once_with("cfngin-bucket") - assert ( - "found stack for creating cfngin_bucket: cfngin-bucket" in caplog.messages - ) + assert "found stack for creating cfngin_bucket: cfngin-bucket" in caplog.messages assert cfngin_context.stack_names == ["cfngin-bucket"] mock_deploy.Action.assert_called_once_with( context=cfngin_context, provider_builder=provider_builder, cancel=cancel @@ -208,7 +192,7 @@ def test_run_get_stack( def test_run_no_cfngin_bucket( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, mocker: MockerFixture, ) -> None: diff --git a/tests/unit/cfngin/blueprints/test_base.py b/tests/unit/cfngin/blueprints/test_base.py index a80d73602..a6ba79324 100644 --- a/tests/unit/cfngin/blueprints/test_base.py +++ b/tests/unit/cfngin/blueprints/test_base.py @@ -3,10 +3,10 @@ from __future__ import annotations import json -from typing import TYPE_CHECKING, Any, ClassVar, Dict, List, Union +from typing import TYPE_CHECKING, Any, ClassVar, Union +from unittest.mock import Mock import pytest -from mock import Mock from troposphere import Parameter, Ref, s3, sns from runway.cfngin.blueprints.base import ( @@ -46,14 +46,14 @@ class SampleBlueprint(Blueprint): """Sample Blueprint to use for testing.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "Var0": {"type": CFNString, "default": "test"}, "Var1": {"type": str, "default": ""}, } def create_template(self) -> None: """Create template.""" - return None + return def resolve_troposphere_var(tpe: Any, value: Any, **kwargs: Any) -> Any: @@ -83,9 +83,7 @@ def create_template(self) -> None: blueprint = _Blueprint(name="test", context=cfngin_context) blueprint.render_template() - assert ( - blueprint.template.outputs[output_name].properties["Value"] == output_value - ) + assert blueprint.template.outputs[output_name].properties["Value"] == output_value def test_cfn_parameters(self, cfngin_context: CfnginContext) -> None: """Test cfn_parameters.""" @@ -107,20 +105,14 @@ def test_defined_variables(self, cfngin_context: CfnginContext) -> None: def test_description(self, cfngin_context: CfnginContext) -> None: """Test description.""" description = "my blueprint description" - obj = SampleBlueprint( - name="test", context=cfngin_context, description=description - ) + obj = SampleBlueprint(name="test", context=cfngin_context, description=description) assert obj.description == description obj.render_template() assert obj.template.description == description - def test_get_cfn_parameters( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_get_cfn_parameters(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test get_cfn_parameters.""" - mock_cfn_parameters = mocker.patch.object( - Blueprint, "cfn_parameters", "success" - ) + mock_cfn_parameters = mocker.patch.object(Blueprint, "cfn_parameters", "success") assert ( Blueprint(name="test", context=cfngin_context).get_cfn_parameters() == mock_cfn_parameters @@ -130,9 +122,7 @@ def test_get_output_definitions( self, cfngin_context: CfnginContext, mocker: MockerFixture ) -> None: """Test get_output_definitions.""" - mock_output_definitions = mocker.patch.object( - Blueprint, "output_definitions", "success" - ) + mock_output_definitions = mocker.patch.object(Blueprint, "output_definitions", "success") assert ( Blueprint(name="test", context=cfngin_context).get_output_definitions() == mock_output_definitions @@ -154,9 +144,7 @@ def test_get_parameter_values( self, cfngin_context: CfnginContext, mocker: MockerFixture ) -> None: """Test get_parameter_values.""" - mock_parameter_values = mocker.patch.object( - Blueprint, "parameter_values", "success" - ) + mock_parameter_values = mocker.patch.object(Blueprint, "parameter_values", "success") assert ( Blueprint(name="test", context=cfngin_context).get_parameter_values() == mock_parameter_values @@ -170,31 +158,24 @@ def test_get_required_parameter_definitions( Blueprint, "required_parameter_definitions", "success" ) assert ( - Blueprint( - name="test", context=cfngin_context - ).get_required_parameter_definitions() + Blueprint(name="test", context=cfngin_context).get_required_parameter_definitions() == mock_required_parameter_definitions ) - def test_get_variables( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_get_variables(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test get_variables.""" mock_variables = mocker.patch.object(Blueprint, "variables", "success") - assert ( - Blueprint(name="test", context=cfngin_context).get_variables() - == mock_variables - ) + assert Blueprint(name="test", context=cfngin_context).get_variables() == mock_variables def test_init_raise_attribute_error(self, cfngin_context: CfnginContext) -> None: """Test __init__.""" class _Blueprint(Blueprint): - PARAMETERS: ClassVar[Dict[str, BlueprintVariableTypeDef]] = {} + PARAMETERS: ClassVar[dict[str, BlueprintVariableTypeDef]] = {} def create_template(self) -> None: """Create template.""" - return None + return with pytest.raises(AttributeError): _Blueprint("test", cfngin_context) @@ -208,9 +189,9 @@ def test_output_definitions(self, cfngin_context: CfnginContext) -> None: def test_parameter_definitions(self, cfngin_context: CfnginContext) -> None: """Test parameter_definitions.""" - assert SampleBlueprint( - name="test", context=cfngin_context - ).parameter_definitions == {"Var0": {"type": "String", "default": "test"}} + assert SampleBlueprint(name="test", context=cfngin_context).parameter_definitions == { + "Var0": {"type": "String", "default": "test"} + } def test_parameter_values(self, cfngin_context: CfnginContext) -> None: """Test parameter_values.""" @@ -218,16 +199,12 @@ def test_parameter_values(self, cfngin_context: CfnginContext) -> None: obj.resolve_variables([]) assert obj.parameter_values == {"Var0": "test"} - def test_read_user_data( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_read_user_data(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test read_user_data.""" mock_read_value_from_path = mocker.patch( f"{MODULE}.read_value_from_path", return_value="something" ) - mock_parse_user_data = mocker.patch( - f"{MODULE}.parse_user_data", return_value="success" - ) + mock_parse_user_data = mocker.patch(f"{MODULE}.parse_user_data", return_value="success") obj = SampleBlueprint(name="test", context=cfngin_context) obj.resolve_variables([]) assert obj.read_user_data("path") == mock_parse_user_data.return_value @@ -236,9 +213,7 @@ def test_read_user_data( obj.variables, mock_read_value_from_path.return_value, obj.name ) - def test_rendered( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_rendered(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test rendered.""" mock_render_template = mocker.patch.object( SampleBlueprint, "render_template", return_value=("version", "render") @@ -247,32 +222,25 @@ def test_rendered( assert obj.rendered == "render" mock_render_template.assert_called_once_with() - def test_required_parameter_definitions( - self, cfngin_context: CfnginContext - ) -> None: + def test_required_parameter_definitions(self, cfngin_context: CfnginContext) -> None: """Test required_parameter_definitions.""" class _Blueprint(SampleBlueprint): - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "Var0": {"type": CFNString}, "Var1": {"type": str, "default": ""}, } - assert _Blueprint( - name="test", context=cfngin_context - ).required_parameter_definitions == {"Var0": {"type": "String"}} + assert _Blueprint(name="test", context=cfngin_context).required_parameter_definitions == { + "Var0": {"type": "String"} + } - def test_required_parameter_definitions_none( - self, cfngin_context: CfnginContext - ) -> None: + def test_required_parameter_definitions_none(self, cfngin_context: CfnginContext) -> None: """Test required_parameter_definitions.""" - assert SampleBlueprint( - name="test", context=cfngin_context - ).required_parameter_definitions + assert SampleBlueprint(name="test", context=cfngin_context).required_parameter_definitions def test_reset_template(self, cfngin_context: CfnginContext) -> None: """Test reset_template.""" - # pylint: disable=protected-access obj = SampleBlueprint(name="test", context=cfngin_context) obj._rendered = "true" obj._version = "test" @@ -289,9 +257,7 @@ def test_requires_change_set(self, cfngin_context: CfnginContext) -> None: obj.template.transform = "something" # type: ignore assert obj.requires_change_set - def test_setup_parameters( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_setup_parameters(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test setup_parameters.""" template = Mock() mocker.patch(f"{MODULE}.build_parameter", return_value="params") @@ -303,7 +269,7 @@ def test_to_json(self, cfngin_context: CfnginContext) -> None: """Test to_json.""" class _Blueprint(Blueprint): - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "Param1": {"default": "default", "type": CFNString}, "Param2": {"type": CFNNumber}, "Param3": {"type": CFNCommaDelimitedList}, @@ -316,9 +282,7 @@ def create_template(self) -> None: self.template.set_version("2010-09-09") self.template.set_description("TestBlueprint") - result = _Blueprint("test", context=cfngin_context).to_json( - {"Param3": "something"} - ) + result = _Blueprint("test", context=cfngin_context).to_json({"Param3": "something"}) assert isinstance(result, str) assert json.loads(result) == { "AWSTemplateFormatVersion": "2010-09-09", @@ -343,9 +307,7 @@ def test_variables(self, cfngin_context: CfnginContext) -> None: """Test variables.""" class _Blueprint(Blueprint): - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { - "Var0": {"type": str} - } + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = {"Var0": {"type": str}} def create_template(self) -> None: """Create template.""" @@ -358,9 +320,7 @@ def create_template(self) -> None: obj.variables = {"key": "val"} assert obj.variables == {"key": "val"} - def test_version( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_version(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test version.""" mock_render_template = mocker.patch.object( SampleBlueprint, "render_template", return_value=("version", "render") @@ -399,7 +359,7 @@ def test_to_parameter_value(self) -> None: (1, "1"), ], ) - def test_value(self, expected: Union[List[str], str], provided: Any) -> None: + def test_value(self, expected: Union[list[str], str], provided: Any) -> None: """Test value.""" assert CFNParameter("myParameter", provided).value == expected @@ -447,14 +407,10 @@ def test_resolve_variable_allowed_values() -> None: """Test resolve_variable.""" var_name = "testVar" var_def: BlueprintVariableTypeDef = {"type": str, "allowed_values": ["allowed"]} - with pytest.raises(ValueError): - resolve_variable( - var_name, var_def, Variable(var_name, "not_allowed", "cfngin"), "test" - ) + with pytest.raises(ValueError): # noqa: PT011 + resolve_variable(var_name, var_def, Variable(var_name, "not_allowed", "cfngin"), "test") assert ( - resolve_variable( - var_name, var_def, Variable(var_name, "allowed", "cfngin"), "test" - ) + resolve_variable(var_name, var_def, Variable(var_name, "allowed", "cfngin"), "test") == "allowed" ) @@ -484,9 +440,7 @@ def test_resolve_variable_provided_not_resolved(mocker: MockerFixture) -> None: """Test resolve_variable.""" mocker.patch("runway.variables.CFNGIN_LOOKUP_HANDLERS", {"mock": Mock()}) with pytest.raises(UnresolvedBlueprintVariable): - resolve_variable( - "name", {"type": str}, Variable("name", "${mock abc}", "cfngin"), "test" - ) + resolve_variable("name", {"type": str}, Variable("name", "${mock abc}", "cfngin"), "test") def test_resolve_variable_troposphere_fail() -> None: @@ -654,14 +608,9 @@ def test_validate_variable_type_python_raise_type_error() -> None: def test_validate_variable_type_troposphere(mocker: MockerFixture) -> None: """Test validate_variable_type.""" - mock_create = mocker.patch.object( - TroposphereType, "create", side_effect=["success", Exception] - ) + mock_create = mocker.patch.object(TroposphereType, "create", side_effect=["success", Exception]) value = {"Endpoint": "test", "Protocol": "test"} - assert ( - validate_variable_type("test", TroposphereType(sns.Subscription), value) - == "success" - ) + assert validate_variable_type("test", TroposphereType(sns.Subscription), value) == "success" mock_create.assert_called_once_with(value) with pytest.raises(ValidatorError): validate_variable_type("test", TroposphereType(sns.Subscription), value) diff --git a/tests/unit/cfngin/blueprints/test_cfngin_bucket.py b/tests/unit/cfngin/blueprints/test_cfngin_bucket.py index eeeb41f70..da2e2abb3 100644 --- a/tests/unit/cfngin/blueprints/test_cfngin_bucket.py +++ b/tests/unit/cfngin/blueprints/test_cfngin_bucket.py @@ -3,8 +3,8 @@ from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import ANY, Mock -from mock import ANY, Mock from troposphere import s3 from runway import __version__ @@ -32,9 +32,7 @@ def test_bucket(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> N "VersioningStatus": Mock(ref="Ref(VersioningStatus)"), }, ) - mock_bucket = Mock( - get_att=Mock(return_value="get_att"), ref=Mock(return_value="ref") - ) + mock_bucket = Mock(get_att=Mock(return_value="get_att"), ref=Mock(return_value="ref")) mock_bucket.return_value = mock_bucket mocker.patch(f"{MODULE}.s3", Bucket=mock_bucket) bucket_encryption = mocker.patch.object( @@ -80,9 +78,7 @@ def test_bucket_encryption(self, cfngin_context: CfnginContext) -> None: == "AES256" ) - def test_bucket_name( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_bucket_name(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test bucket_name.""" mocker.patch.object( CfnginBucket, @@ -110,9 +106,7 @@ def test_bucket_tags(self, cfngin_context: CfnginContext) -> None: obj = CfnginBucket("test", cfngin_context) assert obj.bucket_tags.to_dict() == [{"Key": "version", "Value": __version__}] - def test_create_template( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_create_template(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test create_template.""" bucket = mocker.patch.object(CfnginBucket, "bucket", "bucket") obj = CfnginBucket("test", cfngin_context) diff --git a/tests/unit/cfngin/blueprints/test_raw.py b/tests/unit/cfngin/blueprints/test_raw.py index 312188204..402870905 100644 --- a/tests/unit/cfngin/blueprints/test_raw.py +++ b/tests/unit/cfngin/blueprints/test_raw.py @@ -1,15 +1,14 @@ """Tests for runway.cfngin.blueprints.raw.""" -# pylint: disable=unused-argument # pyright: basic from __future__ import annotations import json from pathlib import Path from typing import TYPE_CHECKING, cast +from unittest.mock import MagicMock, Mock import pytest -from mock import MagicMock, Mock from runway.cfngin.blueprints.raw import ( RawTemplateBlueprint, @@ -26,7 +25,6 @@ from ..factories import mock_context if TYPE_CHECKING: - from pytest import MonkeyPatch from pytest_mock import MockerFixture from runway.context import CfnginContext @@ -137,13 +135,12 @@ def test_parameter_definitions_yaml(self) -> None: "Param2": {"Default": "default", "Type": "CommaDelimitedList"}, } - def test_parameter_values( - self, cfngin_context: CfnginContext, tmp_path: Path - ) -> None: + def test_parameter_values(self, cfngin_context: CfnginContext, tmp_path: Path) -> None: """Test parameter_values.""" obj = RawTemplateBlueprint("test", cfngin_context, raw_template_path=tmp_path) - assert not obj.parameter_values and isinstance(obj.parameter_values, dict) - obj._resolved_variables = {"var": "val"} # pylint: disable=protected-access + assert not obj.parameter_values + assert isinstance(obj.parameter_values, dict) + obj._resolved_variables = {"var": "val"} del obj.parameter_values assert obj.parameter_values == {"var": "val"} @@ -152,18 +149,14 @@ def test_required_parameter_definitions_json(self) -> None: blueprint = RawTemplateBlueprint( name="test", context=MagicMock(), raw_template_path=RAW_JSON_TEMPLATE_PATH ) - assert blueprint.required_parameter_definitions == { - "Param1": {"Type": "String"} - } + assert blueprint.required_parameter_definitions == {"Param1": {"Type": "String"}} def test_required_parameter_definitions_yaml(self) -> None: """Verify required_parameter_definitions.""" blueprint = RawTemplateBlueprint( name="test", context=MagicMock(), raw_template_path=RAW_YAML_TEMPLATE_PATH ) - assert blueprint.required_parameter_definitions == { - "Param1": {"Type": "String"} - } + assert blueprint.required_parameter_definitions == {"Param1": {"Type": "String"}} def test_requires_change_set( self, cfngin_context: CfnginContext, mocker: MockerFixture, tmp_path: Path @@ -189,13 +182,9 @@ def test_to_dict( mock_parse_cloudformation_template = mocker.patch( f"{MODULE}.parse_cloudformation_template", return_value="success" ) - mock_rendered = mocker.patch.object( - RawTemplateBlueprint, "rendered", "rendered template" - ) + mock_rendered = mocker.patch.object(RawTemplateBlueprint, "rendered", "rendered template") assert ( - RawTemplateBlueprint( - "test", cfngin_context, raw_template_path=tmp_path - ).to_dict() + RawTemplateBlueprint("test", cfngin_context, raw_template_path=tmp_path).to_dict() == mock_parse_cloudformation_template.return_value ) mock_parse_cloudformation_template.assert_called_once_with(mock_rendered) @@ -204,21 +193,15 @@ def test_to_json( self, cfngin_context: CfnginContext, mocker: MockerFixture, tmp_path: Path ) -> None: """Test to_json.""" - mock_to_dict = mocker.patch.object( - RawTemplateBlueprint, "to_dict", return_value="dict" - ) + mock_to_dict = mocker.patch.object(RawTemplateBlueprint, "to_dict", return_value="dict") mock_dumps = Mock(return_value="success") mocker.patch(f"{MODULE}.json", dumps=mock_dumps) assert ( - RawTemplateBlueprint( - "test", cfngin_context, raw_template_path=tmp_path - ).to_json() + RawTemplateBlueprint("test", cfngin_context, raw_template_path=tmp_path).to_json() == mock_dumps.return_value ) mock_to_dict.assert_called_once_with() - mock_dumps.assert_called_once_with( - mock_to_dict.return_value, sort_keys=True, indent=4 - ) + mock_dumps.assert_called_once_with(mock_to_dict.return_value, sort_keys=True, indent=4) def test_to_json_cfn_template(self, cfngin_context: CfnginContext) -> None: """Test to_json.""" @@ -230,9 +213,7 @@ def test_to_json_cfn_template(self, cfngin_context: CfnginContext) -> None: "Param1": {"Type": "String"}, "Param2": {"Default": "default", "Type": "CommaDelimitedList"}, }, - "Resources": { - "Dummy": {"Type": "AWS::CloudFormation::WaitConditionHandle"} - }, + "Resources": {"Dummy": {"Type": "AWS::CloudFormation::WaitConditionHandle"}}, "Outputs": {"DummyId": {"Value": "dummy-1234"}}, }, sort_keys=True, @@ -257,9 +238,7 @@ def test_to_json_j2(self) -> None: "Param1": {"Type": "String"}, "Param2": {"Default": "default", "Type": "CommaDelimitedList"}, }, - "Resources": { - "Dummy": {"Type": "AWS::CloudFormation::WaitConditionHandle"} - }, + "Resources": {"Dummy": {"Type": "AWS::CloudFormation::WaitConditionHandle"}}, "Outputs": {"DummyId": {"Value": "dummy-bar-param1val-foo-1234"}}, }, sort_keys=True, @@ -293,9 +272,7 @@ def test_render_template( self, cfngin_context: CfnginContext, mocker: MockerFixture, tmp_path: Path ) -> None: """Test render_template.""" - mock_rendered = mocker.patch.object( - RawTemplateBlueprint, "rendered", "rendered" - ) + mock_rendered = mocker.patch.object(RawTemplateBlueprint, "rendered", "rendered") mock_version = mocker.patch.object(RawTemplateBlueprint, "version", "version") assert RawTemplateBlueprint( "test", cfngin_context, raw_template_path=tmp_path @@ -307,7 +284,7 @@ def test_variables(self, cfngin_context: CfnginContext, tmp_path: Path) -> None: with pytest.raises(UnresolvedBlueprintVariables): _ = obj.variables # obj.resolve_variables([Variable("Var0", "test")]) - obj._resolved_variables = {"var": "val"} # pylint: disable=protected-access + obj._resolved_variables = {"var": "val"} assert obj.variables == {"var": "val"} obj.variables = {"key": "val"} assert obj.variables == {"key": "val"} @@ -318,9 +295,7 @@ def test_version( """Test version.""" mocker.patch.object(RawTemplateBlueprint, "rendered", "success") assert ( - RawTemplateBlueprint( - "test", cfngin_context, raw_template_path=tmp_path - ).version + RawTemplateBlueprint("test", cfngin_context, raw_template_path=tmp_path).version == "260ca9dd" ) @@ -335,14 +310,12 @@ def test_get_template_path_local_file(tmp_path: Path) -> None: assert template_path.samefile(cast(Path, result)) -def test_get_template_path_invalid_file(cd_tmp_path: Path) -> None: +def test_get_template_path_invalid_file(cd_tmp_path: Path) -> None: # noqa: ARG001 """Verify get_template_path with an invalid filename.""" assert get_template_path(Path("cfn_template.json")) is None -def test_get_template_path_file_in_syspath( - tmp_path: Path, monkeypatch: MonkeyPatch -) -> None: +def test_get_template_path_file_in_syspath(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None: """Verify get_template_path with a file in sys.path. This ensures templates are able to be retrieved from remote packages. @@ -358,10 +331,7 @@ def test_get_template_path_file_in_syspath( def test_resolve_variable() -> None: """Test resolve_variable.""" - assert ( - resolve_variable(Variable("var", "val", variable_type="cfngin"), "test") - == "val" - ) + assert resolve_variable(Variable("var", "val", variable_type="cfngin"), "test") == "val" def test_resolve_variable_raise_unresolved() -> None: diff --git a/tests/unit/cfngin/blueprints/test_testutil.py b/tests/unit/cfngin/blueprints/test_testutil.py index 453bb051a..ee8dd8ee5 100644 --- a/tests/unit/cfngin/blueprints/test_testutil.py +++ b/tests/unit/cfngin/blueprints/test_testutil.py @@ -3,6 +3,7 @@ # pyright: basic import unittest +import pytest from troposphere import ecr from runway.cfngin.blueprints.base import Blueprint @@ -24,9 +25,7 @@ class Repositories(Blueprint): def create_template(self) -> None: """Create template.""" for repo in self.variables["Repositories"]: - self.template.add_resource( - ecr.Repository(f"{repo}Repository", RepositoryName=repo) - ) + self.template.add_resource(ecr.Repository(f"{repo}Repository", RepositoryName=repo)) class TestRepositories(BlueprintTestCase): @@ -38,9 +37,7 @@ def test_create_template_passes(self) -> None: """Test create template passes.""" ctx = CfnginContext() blueprint = Repositories("test_repo", ctx) - blueprint.resolve_variables( - [Variable("Repositories", ["repo1", "repo2"], "cfngin")] - ) + blueprint.resolve_variables([Variable("Repositories", ["repo1", "repo2"], "cfngin")]) blueprint.create_template() self.assertRenderedBlueprint(blueprint) @@ -52,7 +49,7 @@ def test_create_template_fails(self) -> None: [Variable("Repositories", ["repo1", "repo2", "repo3"], "cfngin")] ) blueprint.create_template() - with self.assertRaises(AssertionError): + with pytest.raises(AssertionError): self.assertRenderedBlueprint(blueprint) diff --git a/tests/unit/cfngin/blueprints/variables/test_types.py b/tests/unit/cfngin/blueprints/variables/test_types.py index ecd81c085..09e592493 100644 --- a/tests/unit/cfngin/blueprints/variables/test_types.py +++ b/tests/unit/cfngin/blueprints/variables/test_types.py @@ -3,7 +3,6 @@ from __future__ import annotations import re -from typing import Type import pytest @@ -12,12 +11,8 @@ PATTERN_LIST = r"(AWS|CFN)?(?P.*)List?" PATTERN_SUB_AWS_PARAMETER_TYPE = r"(AWS|::)" -AWS_CLASSES = [ - kls for kls in CFNType.__subclasses__() if not kls.__name__.startswith("CFN") -] -CFN_CLASSES = [ - kls for kls in CFNType.__subclasses__() if kls.__name__.startswith("CFN") -] +AWS_CLASSES = [kls for kls in CFNType.__subclasses__() if not kls.__name__.startswith("CFN")] +CFN_CLASSES = [kls for kls in CFNType.__subclasses__() if kls.__name__.startswith("CFN")] def handle_ssm_parameter_value(value: str) -> str: @@ -28,7 +23,7 @@ def handle_ssm_parameter_value(value: str) -> str: @pytest.mark.parametrize("kls", AWS_CLASSES) -def test_aws_types(kls: Type[CFNType]) -> None: +def test_aws_types(kls: type[CFNType]) -> None: """Test variable types for parameter types beginning with ``AWS::``. This does not test the formatting of the value. @@ -47,7 +42,7 @@ def test_aws_types(kls: Type[CFNType]) -> None: @pytest.mark.parametrize("kls", CFN_CLASSES) -def test_cfn_types(kls: Type[CFNType]) -> None: +def test_cfn_types(kls: type[CFNType]) -> None: """Test variable types beginning with CFN.""" if kls.__name__.endswith("List") and "CommaDelimited" not in kls.__name__: match = re.search(PATTERN_LIST, kls.__name__) diff --git a/tests/unit/cfngin/conftest.py b/tests/unit/cfngin/conftest.py index fd4ccc771..48b5ce9a2 100644 --- a/tests/unit/cfngin/conftest.py +++ b/tests/unit/cfngin/conftest.py @@ -1,7 +1,5 @@ """Pytest fixtures and plugins.""" -# pyright: basic -import os from pathlib import Path import pytest @@ -12,17 +10,16 @@ @pytest.fixture(scope="package") def cfngin_fixtures() -> Path: """CFNgin fixture directory Path object.""" - path = os.path.join(os.path.dirname(os.path.realpath(__file__)), "fixtures") - return Path(path) + return Path(__file__).parent / "fixtures" -@pytest.fixture +@pytest.fixture() def empty_dag() -> DAG: """Create an empty DAG.""" return DAG() -@pytest.fixture +@pytest.fixture() def basic_dag() -> DAG: """Create a basic DAG.""" dag = DAG() diff --git a/tests/unit/cfngin/factories.py b/tests/unit/cfngin/factories.py index a29ecb981..ce1599417 100644 --- a/tests/unit/cfngin/factories.py +++ b/tests/unit/cfngin/factories.py @@ -1,12 +1,10 @@ """Factories for tests.""" -# pylint: disable=unused-argument # pyright: basic from __future__ import annotations -from typing import TYPE_CHECKING, Any, Dict, NamedTuple, Optional - -from mock import MagicMock +from typing import TYPE_CHECKING, Any, NamedTuple, Optional +from unittest.mock import MagicMock from runway.cfngin.providers.aws.default import ProviderBuilder from runway.config import CfnginConfig, CfnginStackDefinitionModel @@ -27,7 +25,7 @@ class Lookup(NamedTuple): class MockThreadingEvent: """Mock thread events.""" - def wait(self, timeout: Optional[int] = None) -> bool: + def wait(self, timeout: Optional[int] = None) -> bool: # noqa: ARG002 """Mock wait method.""" return False @@ -35,15 +33,13 @@ def wait(self, timeout: Optional[int] = None) -> bool: class MockProviderBuilder(ProviderBuilder): """Mock provider builder.""" - def __init__( # pylint: disable=super-init-not-called - self, *, provider: Provider, region: Optional[str] = None, **_: Any - ) -> None: + def __init__(self, *, provider: Provider, region: Optional[str] = None, **_: Any) -> None: """Instantiate class.""" self.provider = provider self.region = region def build( - self, *, profile: Optional[str] = None, region: Optional[str] = None + self, *, profile: Optional[str] = None, region: Optional[str] = None # noqa: ARG002 ) -> Provider: """Mock build method.""" return self.provider @@ -56,7 +52,7 @@ def mock_provider(**kwargs: Any) -> MagicMock: def mock_context( namespace: str = "default", - extra_config_args: Optional[Dict[str, Any]] = None, + extra_config_args: Optional[dict[str, Any]] = None, **kwargs: Any, ) -> CfnginContext: """Mock context.""" @@ -73,7 +69,7 @@ def generate_definition( base_name: str, stack_id: Any = None, **overrides: Any ) -> CfnginStackDefinitionModel: """Generate definitions.""" - definition: Dict[str, Any] = { + definition: dict[str, Any] = { "name": f"{base_name}-{stack_id}" if stack_id else base_name, "class_path": f"tests.unit.cfngin.fixtures.mock_blueprints.{base_name.upper()}", "requires": [], @@ -82,9 +78,7 @@ def generate_definition( return CfnginStackDefinitionModel(**definition) -def mock_lookup( - lookup_input: Any, lookup_type: str, raw: Optional[str] = None -) -> Lookup: +def mock_lookup(lookup_input: Any, lookup_type: str, raw: Optional[str] = None) -> Lookup: """Mock lookup.""" if raw is None: raw = f"{lookup_type} {lookup_input}" @@ -109,11 +103,11 @@ def myfile_test(self, client_stub): """ - def __init__(self, client_stub: Any): + def __init__(self, client_stub: Any) -> None: """Instantiate class.""" self.client_stub = client_stub - def client(self, region: str) -> Any: + def client(self, region: str) -> Any: # noqa: ARG002 """Return the stubbed client object. Args: diff --git a/tests/unit/cfngin/fixtures/cfn_template.json b/tests/unit/cfngin/fixtures/cfn_template.json index 623cbd662..cadc99a90 100644 --- a/tests/unit/cfngin/fixtures/cfn_template.json +++ b/tests/unit/cfngin/fixtures/cfn_template.json @@ -1,6 +1,11 @@ { "AWSTemplateFormatVersion": "2010-09-09", "Description": "TestTemplate", + "Outputs": { + "DummyId": { + "Value": "dummy-1234" + } + }, "Parameters": { "Param1": { "Type": "String" @@ -11,13 +16,8 @@ } }, "Resources": { - "Dummy": { - "Type": "AWS::CloudFormation::WaitConditionHandle" - } - }, - "Outputs": { - "DummyId": { - "Value": "dummy-1234" - } + "Dummy": { + "Type": "AWS::CloudFormation::WaitConditionHandle" + } } } diff --git a/tests/unit/cfngin/fixtures/cfn_template.yaml b/tests/unit/cfngin/fixtures/cfn_template.yaml index 41826a17f..fbe3b38c5 100644 --- a/tests/unit/cfngin/fixtures/cfn_template.yaml +++ b/tests/unit/cfngin/fixtures/cfn_template.yaml @@ -10,10 +10,9 @@ Resources: Bucket: Type: AWS::S3::Bucket Properties: - BucketName: - !Join - - "-" - - - !Ref "AWS::StackName" + BucketName: !Join + - "-" + - - !Ref "AWS::StackName" - !Ref "AWS::Region" Dummy: Type: AWS::CloudFormation::WaitConditionHandle diff --git a/tests/unit/cfngin/fixtures/mock_blueprints.py b/tests/unit/cfngin/fixtures/mock_blueprints.py index 5c8312d32..8daf38b10 100644 --- a/tests/unit/cfngin/fixtures/mock_blueprints.py +++ b/tests/unit/cfngin/fixtures/mock_blueprints.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, ClassVar, Dict +from typing import TYPE_CHECKING, ClassVar import awacs import awacs.cloudformation @@ -31,7 +31,7 @@ class FunctionalTests(Blueprint): """Creates a stack with an IAM user and access key for functional tests.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "Namespace": { "type": CFNString, "description": "The namespace that the tests will use. " @@ -166,9 +166,7 @@ def create_template(self) -> None: template.add_output(Output("User", Value=Ref(user))) template.add_output(Output("AccessKeyId", Value=Ref(key))) template.add_output( - Output( - "SecretAccessKey", Value=GetAtt("FunctionalTestKey", "SecretAccessKey") - ) + Output("SecretAccessKey", Value=GetAtt("FunctionalTestKey", "SecretAccessKey")) ) template.add_output(Output("FunctionalTestRole", Value=GetAtt(role, "Arn"))) @@ -176,7 +174,7 @@ def create_template(self) -> None: class Dummy(Blueprint): """Dummy blueprint.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "StringVariable": {"type": str, "default": ""} } @@ -194,7 +192,7 @@ class Dummy2(Blueprint): """ - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "StringVariable": {"type": str, "default": ""} } @@ -214,7 +212,7 @@ class LongRunningDummy(Blueprint): """ - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "Count": { "type": int, "description": "The # of WaitConditionHandles to create.", @@ -228,7 +226,7 @@ class LongRunningDummy(Blueprint): }, "OutputValue": { "type": str, - "description": "The value to put in an output to allow for " "updates.", + "description": "The value to put in an output to allow for updates.", "default": "DefaultOutput", }, } @@ -271,7 +269,7 @@ class Broken(Blueprint): """ - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "StringVariable": {"type": str, "default": ""} } @@ -294,7 +292,7 @@ def create_template(self) -> None: class VPC(Blueprint): """VPC blueprint.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "AZCount": {"type": int, "default": 2}, "PrivateSubnets": { "type": CFNCommaDelimitedList, @@ -351,7 +349,7 @@ def create_template(self) -> None: class DiffTester(Blueprint): """Diff test blueprint.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "InstanceType": { "type": CFNString, "description": "NAT EC2 instance type.", @@ -359,12 +357,11 @@ class DiffTester(Blueprint): }, "WaitConditionCount": { "type": int, - "description": "Number of WaitConditionHandle resources " - "to add to the template", + "description": "Number of WaitConditionHandle resources to add to the template", }, } - def create_template(self): + def create_template(self) -> None: """Create template.""" for i in range(self.variables["WaitConditionCount"]): self.template.add_resource(WaitConditionHandle(f"VPC{i}")) @@ -373,7 +370,7 @@ def create_template(self): class Bastion(Blueprint): """Bastion blueprint.""" - VARIABLES: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + VARIABLES: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "VpcId": {"type": EC2VPCId, "description": "Vpc Id"}, "DefaultSG": { "type": EC2SecurityGroupId, @@ -381,15 +378,15 @@ class Bastion(Blueprint): }, "PublicSubnets": { "type": EC2SubnetIdList, - "description": "Subnets to deploy public " "instances in.", + "description": "Subnets to deploy public instances in.", }, "PrivateSubnets": { "type": EC2SubnetIdList, - "description": "Subnets to deploy private " "instances in.", + "description": "Subnets to deploy private instances in.", }, "AvailabilityZones": { "type": CFNCommaDelimitedList, - "description": "Availability Zones to deploy " "instances in.", + "description": "Availability Zones to deploy instances in.", }, "InstanceType": { "type": CFNString, @@ -419,7 +416,7 @@ class Bastion(Blueprint): }, } - def create_template(self): + def create_template(self) -> None: """Create template.""" return @@ -427,7 +424,7 @@ def create_template(self): class PreOneOhBastion(Blueprint): """Used to ensure old blueprints won't be usable in 1.0.""" - PARAMETERS: ClassVar[Dict[str, BlueprintVariableTypeDef]] = { + PARAMETERS: ClassVar[dict[str, BlueprintVariableTypeDef]] = { "VpcId": {"type": "AWS::EC2::VPC::Id", "description": "Vpc Id"}, "DefaultSG": { "type": "AWS::EC2::SecurityGroup::Id", @@ -435,15 +432,15 @@ class PreOneOhBastion(Blueprint): }, "PublicSubnets": { "type": "List", - "description": "Subnets to deploy public " "instances in.", + "description": "Subnets to deploy public instances in.", }, "PrivateSubnets": { "type": "List", - "description": "Subnets to deploy private " "instances in.", + "description": "Subnets to deploy private instances in.", }, "AvailabilityZones": { "type": "CommaDelimitedList", - "description": "Availability Zones to deploy " "instances in.", + "description": "Availability Zones to deploy instances in.", }, "InstanceType": { "type": "String", diff --git a/tests/unit/cfngin/fixtures/mock_hooks.py b/tests/unit/cfngin/fixtures/mock_hooks.py index 665d88009..5ee91a062 100644 --- a/tests/unit/cfngin/fixtures/mock_hooks.py +++ b/tests/unit/cfngin/fixtures/mock_hooks.py @@ -1,9 +1,9 @@ """Mock hook.""" -from typing import Any, Dict +from typing import Any -def mock_hook(*, value: Any, **_: Any) -> Dict[str, Any]: +def mock_hook(*, value: Any, **_: Any) -> dict[str, Any]: """Mock hook. Returns: diff --git a/tests/unit/cfngin/fixtures/vpc-bastion-db-web-pre-1.0.yaml b/tests/unit/cfngin/fixtures/vpc-bastion-db-web-pre-1.0.yaml index 33b866d25..290d07dc8 100644 --- a/tests/unit/cfngin/fixtures/vpc-bastion-db-web-pre-1.0.yaml +++ b/tests/unit/cfngin/fixtures/vpc-bastion-db-web-pre-1.0.yaml @@ -10,7 +10,8 @@ mappings: us-east-1: NAT: ami-ad227cc4 ubuntu1404: &ubuntu1404 ami-74e27e1c # Setting an anchor - bastion: *ubuntu1404 # Using the anchor above + bastion: *ubuntu1404 + # Using the anchor above us-west-2: NAT: ami-290f4119 ubuntu1404west2: &ubuntu1404west2 ami-5189a661 @@ -52,7 +53,7 @@ stacks: # parameters the stack actually needs and only submits those to each # stack. For example, most stacks are in the PrivateSubnets, but not # the PublicSubnets, but cfngin deals with it for you. - << : *vpc_parameters + <<: *vpc_parameters InstanceType: m3.medium OfficeNetwork: 203.0.113.0/24 MinSize: 2 diff --git a/tests/unit/cfngin/fixtures/vpc-bastion-db-web.yaml b/tests/unit/cfngin/fixtures/vpc-bastion-db-web.yaml index e73e79224..34417576c 100644 --- a/tests/unit/cfngin/fixtures/vpc-bastion-db-web.yaml +++ b/tests/unit/cfngin/fixtures/vpc-bastion-db-web.yaml @@ -10,7 +10,8 @@ mappings: us-east-1: NAT: ami-ad227cc4 ubuntu1404: &ubuntu1404 ami-74e27e1c # Setting an anchor - bastion: *ubuntu1404 # Using the anchor above + bastion: *ubuntu1404 + # Using the anchor above us-west-2: NAT: ami-290f4119 ubuntu1404west2: &ubuntu1404west2 ami-5189a661 @@ -51,7 +52,7 @@ stacks: # parameters the stack actually needs and only submits those to each # stack. For example, most stacks are in the PrivateSubnets, but not # the PublicSubnets, but cfngin deals with it for you. - << : *vpc_parameters + <<: *vpc_parameters InstanceType: m3.medium OfficeNetwork: 203.0.113.0/24 MinSize: 2 diff --git a/tests/unit/cfngin/hooks/awslambda/factories.py b/tests/unit/cfngin/hooks/awslambda/factories.py index 6dd6a38e0..b6a62510b 100644 --- a/tests/unit/cfngin/hooks/awslambda/factories.py +++ b/tests/unit/cfngin/hooks/awslambda/factories.py @@ -3,8 +3,7 @@ from __future__ import annotations from typing import TYPE_CHECKING - -from mock import Mock +from unittest.mock import Mock from runway.cfngin.hooks.awslambda.base_classes import Project from runway.cfngin.hooks.awslambda.models.args import AwsLambdaHookArgs @@ -21,8 +20,7 @@ class MockProject(Project[AwsLambdaHookArgs]): def build_directory(self) -> Path: """Directory being used to build deployment package.""" result = ( - self.source_code - / f"{self.source_code.root_directory.name}.{self.source_code.md5_hash}" + self.source_code / f"{self.source_code.root_directory.name}.{self.source_code.md5_hash}" ) result.mkdir(exist_ok=True, parents=True) return result diff --git a/tests/unit/cfngin/hooks/awslambda/models/test_args.py b/tests/unit/cfngin/hooks/awslambda/models/test_args.py index 5e11cb21f..8bd2a6e15 100644 --- a/tests/unit/cfngin/hooks/awslambda/models/test_args.py +++ b/tests/unit/cfngin/hooks/awslambda/models/test_args.py @@ -3,7 +3,7 @@ from __future__ import annotations from pathlib import Path -from typing import Any, Dict +from typing import Any import pytest from pydantic import ValidationError @@ -43,7 +43,7 @@ def test__validate_runtime_or_docker(self, tmp_path: Path) -> None: "kwargs", [{"image": "test"}, {"file": ""}, {"file": "", "image": "test"}] ) def test__validate_runtime_or_docker_docker_no_runtime( - self, kwargs: Dict[str, Any], tmp_path: Path + self, kwargs: dict[str, Any], tmp_path: Path ) -> None: """Test _validate_runtime_or_docker no runtime if Docker.""" if "file" in kwargs: @@ -74,9 +74,7 @@ def test__validate_runtime_or_docker_docker_disabled(self, tmp_path: Path) -> No assert errors[0]["loc"] == ("runtime",) assert errors[0]["msg"] == "runtime must be provided if docker.disabled is True" - def test__validate_runtime_or_docker_no_runtime_or_docker( - self, tmp_path: Path - ) -> None: + def test__validate_runtime_or_docker_no_runtime_or_docker(self, tmp_path: Path) -> None: """Test _validate_runtime_or_docker no runtime or docker.""" with pytest.raises(ValidationError) as excinfo: AwsLambdaHookArgs( @@ -95,7 +93,8 @@ def test_field_defaults(self, tmp_path: Path) -> None: runtime="test", source_code=tmp_path, ) - assert not obj.extend_gitignore and isinstance(obj.extend_gitignore, list) + assert not obj.extend_gitignore + assert isinstance(obj.extend_gitignore, list) assert not obj.object_prefix def test_source_code_is_file(self, tmp_path: Path) -> None: @@ -125,10 +124,7 @@ def test_source_code_not_exist(self, tmp_path: Path) -> None: errors = excinfo.value.errors() assert len(errors) == 1 assert errors[0]["loc"] == ("source_code",) - assert ( - errors[0]["msg"] - == f'file or directory at path "{source_path}" does not exist' - ) + assert errors[0]["msg"] == f'file or directory at path "{source_path}" does not exist' class TestPythonHookArgs: diff --git a/tests/unit/cfngin/hooks/awslambda/python_requirements/test__deployment_package.py b/tests/unit/cfngin/hooks/awslambda/python_requirements/test__deployment_package.py index 388243414..eda784429 100644 --- a/tests/unit/cfngin/hooks/awslambda/python_requirements/test__deployment_package.py +++ b/tests/unit/cfngin/hooks/awslambda/python_requirements/test__deployment_package.py @@ -3,9 +3,9 @@ from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import Mock, call import pytest -from mock import Mock, call from runway.cfngin.hooks.awslambda.python_requirements import PythonDeploymentPackage @@ -23,9 +23,7 @@ class TestPythonDeploymentPackage: @pytest.mark.parametrize( "slim, strip", [(False, False), (False, True), (True, False), (True, True)] ) - def test_gitignore_filter( - self, mocker: MockerFixture, slim: bool, strip: bool - ) -> None: + def test_gitignore_filter(self, mocker: MockerFixture, slim: bool, strip: bool) -> None: """Test gitignore_filter.""" mock_ignore_parser = Mock() mock_ignore_parser_class = mocker.patch( @@ -35,9 +33,7 @@ def test_gitignore_filter( project.args.slim = slim project.args.strip = strip if slim: - assert ( - PythonDeploymentPackage(project).gitignore_filter == mock_ignore_parser - ) + assert PythonDeploymentPackage(project).gitignore_filter == mock_ignore_parser mock_ignore_parser_class.assert_called_once_with() calls = [ call("**/*.dist-info*", project.dependency_directory), @@ -57,8 +53,6 @@ def test_insert_layer_dir(self, tmp_path: Path) -> None: == tmp_path / "python" / "foo.txt" ) assert ( - PythonDeploymentPackage.insert_layer_dir( - tmp_path / "bar" / "foo.txt", tmp_path - ) + PythonDeploymentPackage.insert_layer_dir(tmp_path / "bar" / "foo.txt", tmp_path) == tmp_path / "python" / "bar" / "foo.txt" ) diff --git a/tests/unit/cfngin/hooks/awslambda/python_requirements/test__docker.py b/tests/unit/cfngin/hooks/awslambda/python_requirements/test__docker.py index 5f3a1c9de..42c37e662 100644 --- a/tests/unit/cfngin/hooks/awslambda/python_requirements/test__docker.py +++ b/tests/unit/cfngin/hooks/awslambda/python_requirements/test__docker.py @@ -4,10 +4,10 @@ import logging from typing import TYPE_CHECKING, Optional +from unittest.mock import Mock import pytest from docker.types.services import Mount -from mock import Mock from runway.cfngin.hooks.awslambda.python_requirements import ( PythonDockerDependencyInstaller, @@ -36,9 +36,7 @@ def test_bind_mounts(self, tmp_path: Path) -> None: ) obj = PythonDockerDependencyInstaller(project, client=Mock()) assert obj.bind_mounts == [ - Mount( - target="/var/task/lambda", source="dependency_directory", type="bind" - ), + Mount(target="/var/task/lambda", source="dependency_directory", type="bind"), Mount(target="/var/task/project", source="project_root", type="bind"), Mount( target=f"/var/task/{requirements_txt.name}", @@ -92,7 +90,8 @@ def test_install_commands_no_requirements(self) -> None: result = PythonDockerDependencyInstaller( Mock(requirements_txt=None), client=Mock() ).install_commands - assert not result and isinstance(result, list) + assert not result + assert isinstance(result, list) def test_python_version(self, mocker: MockerFixture) -> None: """Test python_version.""" @@ -105,9 +104,7 @@ def test_python_version(self, mocker: MockerFixture) -> None: mock_version_cls = mocker.patch(f"{MODULE}.Version", return_value="success") obj = PythonDockerDependencyInstaller(Mock(), client=Mock()) assert obj.python_version == mock_version_cls.return_value - mock_run_command.assert_called_once_with( - "python --version", level=logging.DEBUG - ) + mock_run_command.assert_called_once_with("python --version", level=logging.DEBUG) mock_version_cls.assert_called_once_with(version) def test_python_version_not_found(self, mocker: MockerFixture) -> None: @@ -120,9 +117,7 @@ def test_python_version_not_found(self, mocker: MockerFixture) -> None: mock_version_cls = mocker.patch(f"{MODULE}.Version") obj = PythonDockerDependencyInstaller(Mock(), client=Mock()) assert not obj.python_version - mock_run_command.assert_called_once_with( - "python --version", level=logging.DEBUG - ) + mock_run_command.assert_called_once_with("python --version", level=logging.DEBUG) mock_version_cls.assert_not_called() @pytest.mark.parametrize( @@ -140,6 +135,4 @@ def test_runtime( ) -> None: """Test runtime.""" mocker.patch.object(PythonDockerDependencyInstaller, "python_version", version) - assert ( - PythonDockerDependencyInstaller(Mock(), client=Mock()).runtime == expected - ) + assert PythonDockerDependencyInstaller(Mock(), client=Mock()).runtime == expected diff --git a/tests/unit/cfngin/hooks/awslambda/python_requirements/test__project.py b/tests/unit/cfngin/hooks/awslambda/python_requirements/test__project.py index 3112ac815..cdfc56fac 100644 --- a/tests/unit/cfngin/hooks/awslambda/python_requirements/test__project.py +++ b/tests/unit/cfngin/hooks/awslambda/python_requirements/test__project.py @@ -3,10 +3,10 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, List, Sequence +from typing import TYPE_CHECKING +from unittest.mock import Mock, call import pytest -from mock import Mock, call from runway.cfngin.hooks.awslambda.exceptions import RuntimeMismatchError from runway.cfngin.hooks.awslambda.python_requirements import PythonProject @@ -20,9 +20,9 @@ ) if TYPE_CHECKING: + from collections.abc import Sequence from pathlib import Path - from pytest import LogCaptureFixture from pytest_mock import MockerFixture @@ -74,10 +74,7 @@ def test_cleanup( tmp_requirements_txt.exists.assert_called_once_with() else: tmp_requirements_txt.exists.assert_not_called() - if ( - max([sum([file_exists, pipenv_value]), sum([file_exists, poetry_value])]) - == 2 - ): + if max([sum([file_exists, pipenv_value]), sum([file_exists, poetry_value])]) == 2: tmp_requirements_txt.unlink.assert_called_once_with() else: tmp_requirements_txt.unlink.assert_not_called() @@ -125,9 +122,7 @@ def test_docker(self, mocker: MockerFixture) -> None: @pytest.mark.parametrize( "pipenv, poetry", [(False, False), (False, True), (True, False), (True, True)] ) - def test_install_dependencies( - self, mocker: MockerFixture, pipenv: bool, poetry: bool - ) -> None: + def test_install_dependencies(self, mocker: MockerFixture, pipenv: bool, poetry: bool) -> None: """Test install_dependencies.""" args = Mock(cache_dir="foo", extend_pip_args=["--foo", "bar"], use_cache=True) mocker.patch.object(PythonProject, "pipenv", pipenv) @@ -153,17 +148,13 @@ def test_install_dependencies_docker(self, mocker: MockerFixture) -> None: """Test install_dependencies using Docker.""" mock_docker = mocker.patch.object(PythonProject, "docker") mock_pip = mocker.patch.object(PythonProject, "pip") - mocker.patch.object( - PythonProject, "dependency_directory", "dependency_directory" - ) + mocker.patch.object(PythonProject, "dependency_directory", "dependency_directory") mocker.patch.object(PythonProject, "requirements_txt", "requirements.txt") assert not PythonProject(Mock(), Mock()).install_dependencies() mock_docker.install.assert_called_once_with() mock_pip.install.assert_not_called() - def test_install_dependencies_does_not_catch_errors( - self, mocker: MockerFixture - ) -> None: + def test_install_dependencies_does_not_catch_errors(self, mocker: MockerFixture) -> None: """Test install_dependencies does not catch errors.""" mocker.patch.object(PythonProject, "pipenv", False) mocker.patch.object(PythonProject, "poetry", False) @@ -190,15 +181,13 @@ def test_install_dependencies_does_not_catch_errors( ) def test_install_dependencies_skip( - self, caplog: LogCaptureFixture, mocker: MockerFixture + self, caplog: pytest.LogCaptureFixture, mocker: MockerFixture ) -> None: """Test install_dependencies skip because no dependencies.""" caplog.set_level(logging.INFO, logger=MODULE.replace("._", ".")) mock_docker = mocker.patch.object(PythonProject, "docker") mock_pip = mocker.patch.object(PythonProject, "pip") - mocker.patch.object( - PythonProject, "dependency_directory", "dependency_directory" - ) + mocker.patch.object(PythonProject, "dependency_directory", "dependency_directory") mocker.patch.object(PythonProject, "requirements_txt", None) assert not PythonProject(Mock(), Mock()).install_dependencies() mock_docker.install.assert_not_called() @@ -252,10 +241,7 @@ def test_pipenv(self, mocker: MockerFixture) -> None: ) mocker.patch.object(PythonProject, "project_type", "pipenv") project_root = mocker.patch.object(PythonProject, "project_root") - assert ( - PythonProject(Mock(use_poetry=True), ctx).pipenv - == pipenv_class.return_value - ) + assert PythonProject(Mock(use_poetry=True), ctx).pipenv == pipenv_class.return_value pipenv_class.found_in_path.assert_called_once_with() pipenv_class.assert_called_once_with(ctx, project_root) @@ -286,10 +272,7 @@ def test_poetry(self, mocker: MockerFixture) -> None: ) mocker.patch.object(PythonProject, "project_type", "poetry") project_root = mocker.patch.object(PythonProject, "project_root") - assert ( - PythonProject(Mock(use_poetry=True), ctx).poetry - == poetry_class.return_value - ) + assert PythonProject(Mock(use_poetry=True), ctx).poetry == poetry_class.return_value poetry_class.found_in_path.assert_called_once_with() poetry_class.assert_called_once_with(ctx, project_root) @@ -332,7 +315,7 @@ def test_poetry_not_poetry_project(self, mocker: MockerFixture) -> None: ) def test_project_type( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, expected: str, mocker: MockerFixture, pipenv_project: bool, @@ -368,9 +351,7 @@ def test_project_type( ) else: mock_pipenv_dir_is_project.assert_called_once_with(tmp_path) - if (pipenv_project and not use_pipenv) and sum( - [poetry_project, use_poetry] - ) != 2: + if (pipenv_project and not use_pipenv) and sum([poetry_project, use_poetry]) != 2: assert ( "pipenv project detected but use of pipenv is explicitly disabled" in caplog.messages @@ -380,9 +361,7 @@ def test_requirements_txt(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test requirements_txt.""" expected = tmp_path / "requirements.txt" expected.touch() - mock_dir_is_project = mocker.patch( - f"{MODULE}.Pip.dir_is_project", return_value=True - ) + mock_dir_is_project = mocker.patch(f"{MODULE}.Pip.dir_is_project", return_value=True) mocker.patch.object(PythonProject, "pipenv", None) mocker.patch.object(PythonProject, "poetry", None) mocker.patch.object(PythonProject, "project_root", tmp_path) @@ -391,16 +370,12 @@ def test_requirements_txt(self, mocker: MockerFixture, tmp_path: Path) -> None: def test_requirements_txt_none(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test requirements_txt is None.""" - mock_dir_is_project = mocker.patch( - f"{MODULE}.Pip.dir_is_project", return_value=False - ) + mock_dir_is_project = mocker.patch(f"{MODULE}.Pip.dir_is_project", return_value=False) mocker.patch.object(PythonProject, "pipenv", None) mocker.patch.object(PythonProject, "poetry", None) mocker.patch.object(PythonProject, "project_root", tmp_path) assert not PythonProject(Mock(), Mock()).requirements_txt - mock_dir_is_project.assert_called_once_with( - tmp_path, file_name="requirements.txt" - ) + mock_dir_is_project.assert_called_once_with(tmp_path, file_name="requirements.txt") def test_requirements_txt_pipenv(self, mocker: MockerFixture) -> None: """Test requirements_txt.""" @@ -438,14 +413,10 @@ def test_runtime(self, mocker: MockerFixture) -> None: def test_runtime_pip(self, mocker: MockerFixture) -> None: """Test runtime from pip.""" mocker.patch.object(PythonProject, "docker", None) - mocker.patch.object( - PythonProject, "pip", Mock(python_version=Mock(major="3", minor="8")) - ) + mocker.patch.object(PythonProject, "pip", Mock(python_version=Mock(major="3", minor="8"))) assert PythonProject(Mock(runtime=None), Mock()).runtime == "python3.8" - def test_runtime_raise_runtime_mismatch_error_docker( - self, mocker: MockerFixture - ) -> None: + def test_runtime_raise_runtime_mismatch_error_docker(self, mocker: MockerFixture) -> None: """Test runtime raise RuntimeMismatchError.""" args = Mock(runtime="bar") docker = mocker.patch.object(PythonProject, "docker", Mock(runtime="foo")) @@ -454,15 +425,11 @@ def test_runtime_raise_runtime_mismatch_error_docker( assert excinfo.value.detected_runtime == docker.runtime assert excinfo.value.expected_runtime == args.runtime - def test_runtime_raise_runtime_mismatch_error_pip( - self, mocker: MockerFixture - ) -> None: + def test_runtime_raise_runtime_mismatch_error_pip(self, mocker: MockerFixture) -> None: """Test runtime raise RuntimeMismatchError.""" args = Mock(runtime="bar") mocker.patch.object(PythonProject, "docker", None) - mocker.patch.object( - PythonProject, "pip", Mock(python_version=Mock(major="3", minor="8")) - ) + mocker.patch.object(PythonProject, "pip", Mock(python_version=Mock(major="3", minor="8"))) with pytest.raises(RuntimeMismatchError) as excinfo: assert not PythonProject(args, Mock()).runtime assert excinfo.value.detected_runtime == "python3.8" @@ -478,7 +445,7 @@ def test_runtime_raise_runtime_mismatch_error_pip( ], ) def test_supported_metadata_files( - self, update_expected: List[str], use_pipenv: bool, use_poetry: bool + self, update_expected: list[str], use_pipenv: bool, use_poetry: bool ) -> None: """Test supported_metadata_files.""" expected = {*Pip.CONFIG_FILES} @@ -493,9 +460,7 @@ def test_supported_metadata_files( def test_tmp_requirements_txt(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test tmp_requirements_txt.""" - source_code = mocker.patch.object( - PythonProject, "source_code", Mock(md5_hash="hash") - ) + source_code = mocker.patch.object(PythonProject, "source_code", Mock(md5_hash="hash")) assert ( PythonProject(Mock(), Mock(work_dir=tmp_path)).tmp_requirements_txt == tmp_path / f"{source_code.md5_hash}.requirements.txt" diff --git a/tests/unit/cfngin/hooks/awslambda/test__python_hooks.py b/tests/unit/cfngin/hooks/awslambda/test__python_hooks.py index e3a9dd47e..7ad5724da 100644 --- a/tests/unit/cfngin/hooks/awslambda/test__python_hooks.py +++ b/tests/unit/cfngin/hooks/awslambda/test__python_hooks.py @@ -1,12 +1,11 @@ """Test runway.cfngin.hooks.awslambda._python_hooks.""" -# pylint: disable=redefined-outer-name from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import Mock import pytest -from mock import Mock from pydantic import ValidationError from runway.cfngin.hooks.awslambda import PythonFunction, PythonLayer @@ -20,7 +19,7 @@ MODULE = "runway.cfngin.hooks.awslambda._python_hooks" -@pytest.fixture(scope="function") +@pytest.fixture() def args(tmp_path: Path) -> PythonHookArgs: """Fixture for creating default function args.""" return PythonHookArgs( @@ -52,9 +51,7 @@ def test_cleanup(self, args: PythonHookArgs, mocker: MockerFixture) -> None: assert not PythonFunction(Mock(), **args.dict()).cleanup() project.cleanup.assert_called_once_with() - def test_cleanup_on_error( - self, args: PythonHookArgs, mocker: MockerFixture - ) -> None: + def test_cleanup_on_error(self, args: PythonHookArgs, mocker: MockerFixture) -> None: """Test cleanup_on_error.""" deployment_package = mocker.patch.object(PythonFunction, "deployment_package") project = mocker.patch.object(PythonFunction, "project") @@ -62,9 +59,7 @@ def test_cleanup_on_error( deployment_package.delete.assert_called_once_with() project.cleanup_on_error.assert_called_once_with() - def test_deployment_package( - self, args: PythonHookArgs, mocker: MockerFixture - ) -> None: + def test_deployment_package(self, args: PythonHookArgs, mocker: MockerFixture) -> None: """Test deployment_package.""" deployment_package_class = mocker.patch(f"{MODULE}.PythonDeploymentPackage") project = mocker.patch.object(PythonFunction, "project", "project") @@ -77,25 +72,18 @@ def test_deployment_package( def test_pre_deploy(self, args: PythonHookArgs, mocker: MockerFixture) -> None: """Test pre_deploy.""" model = Mock(dict=Mock(return_value="success")) - build_response = mocker.patch.object( - PythonFunction, "build_response", return_value=(model) - ) + build_response = mocker.patch.object(PythonFunction, "build_response", return_value=(model)) cleanup = mocker.patch.object(PythonFunction, "cleanup") cleanup_on_error = mocker.patch.object(PythonFunction, "cleanup_on_error") deployment_package = mocker.patch.object(PythonFunction, "deployment_package") - assert ( - PythonFunction(Mock(), **args.dict()).pre_deploy() - == model.dict.return_value - ) + assert PythonFunction(Mock(), **args.dict()).pre_deploy() == model.dict.return_value deployment_package.upload.assert_called_once_with() build_response.assert_called_once_with("deploy") model.dict.assert_called_once_with(by_alias=True) cleanup_on_error.assert_not_called() cleanup.assert_called_once_with() - def test_pre_deploy_always_cleanup( - self, args: PythonHookArgs, mocker: MockerFixture - ) -> None: + def test_pre_deploy_always_cleanup(self, args: PythonHookArgs, mocker: MockerFixture) -> None: """Test pre_deploy always cleanup.""" build_response = mocker.patch.object( PythonFunction, "build_response", return_value="success" @@ -107,7 +95,7 @@ def test_pre_deploy_always_cleanup( "deployment_package", Mock(upload=Mock(side_effect=Exception)), ) - with pytest.raises(Exception, match=""): + with pytest.raises(Exception): # noqa: B017, PT011 assert PythonFunction(Mock(), **args.dict()).pre_deploy() deployment_package.upload.assert_called_once_with() build_response.assert_not_called() @@ -125,9 +113,7 @@ def test_project(self, args: PythonHookArgs, mocker: MockerFixture) -> None: class TestPythonLayer: """Test PythonLayer.""" - def test_deployment_package( - self, args: PythonHookArgs, mocker: MockerFixture - ) -> None: + def test_deployment_package(self, args: PythonHookArgs, mocker: MockerFixture) -> None: """Test deployment_package.""" deployment_package_class = mocker.patch(f"{MODULE}.PythonDeploymentPackage") project = mocker.patch.object(PythonLayer, "project", "project") diff --git a/tests/unit/cfngin/hooks/awslambda/test_base_classes.py b/tests/unit/cfngin/hooks/awslambda/test_base_classes.py index 922d03a37..4ecacde96 100644 --- a/tests/unit/cfngin/hooks/awslambda/test_base_classes.py +++ b/tests/unit/cfngin/hooks/awslambda/test_base_classes.py @@ -1,14 +1,12 @@ """Test runway.cfngin.hooks.awslambda.base_classes.""" -# pylint: disable=unused-argument from __future__ import annotations import logging -from pathlib import Path from typing import TYPE_CHECKING, Any, cast +from unittest.mock import Mock import pytest -from mock import Mock from runway.cfngin.hooks.awslambda.base_classes import AwsLambdaHook, Project from runway.cfngin.hooks.awslambda.deployment_package import DeploymentPackage @@ -17,7 +15,8 @@ from runway.cfngin.hooks.awslambda.models.responses import AwsLambdaHookDeployResponse if TYPE_CHECKING: - from pytest import LogCaptureFixture + from pathlib import Path + from pytest_mock import MockerFixture from runway.context import CfnginContext @@ -33,9 +32,7 @@ def test___init__(self, cfngin_context: CfnginContext) -> None: obj: AwsLambdaHook[Any] = AwsLambdaHook(cfngin_context) assert not obj.BUILD_LAYER # class var assert obj.ctx # only one attribute is currently set by this base class - assert not hasattr( - obj, "attrs" - ), "should be set by subclasses not by the parent" + assert not hasattr(obj, "attrs"), "should be set by subclasses not by the parent" def test_build_response_deploy(self, mocker: MockerFixture) -> None: """Test build_response.""" @@ -58,9 +55,7 @@ def test_build_response_deploy(self, mocker: MockerFixture) -> None: ), ) deployment_package.bucket.name = "test-bucket" - assert AwsLambdaHook(Mock()).build_response( - "deploy" - ) == AwsLambdaHookDeployResponse( + assert AwsLambdaHook(Mock()).build_response("deploy") == AwsLambdaHookDeployResponse( bucket_name=deployment_package.bucket.name, code_sha256=deployment_package.code_sha256, license="license", @@ -94,9 +89,7 @@ def test_build_response_plan(self, mocker: MockerFixture) -> None: ), ) deployment_package.bucket.name = "test-bucket" - assert AwsLambdaHook(Mock()).build_response( - "plan" - ) == AwsLambdaHookDeployResponse( + assert AwsLambdaHook(Mock()).build_response("plan") == AwsLambdaHookDeployResponse( bucket_name=deployment_package.bucket.name, code_sha256=deployment_package.code_sha256, object_key=deployment_package.object_key, @@ -104,9 +97,7 @@ def test_build_response_plan(self, mocker: MockerFixture) -> None: runtime=deployment_package.runtime, ) - def test_build_response_plan_handle_file_not_found_error( - self, mocker: MockerFixture - ) -> None: + def test_build_response_plan_handle_file_not_found_error(self, mocker: MockerFixture) -> None: """Test build_response.""" mocker.patch.object( AwsLambdaHook, @@ -141,41 +132,29 @@ def test_plan(self, mocker: MockerFixture) -> None: build_response.assert_called_once_with("plan") response_obj.dict.assert_called_once_with(by_alias=True) - def test_post_deploy(self, caplog: LogCaptureFixture) -> None: + def test_post_deploy(self, caplog: pytest.LogCaptureFixture) -> None: """Test post_deploy.""" caplog.set_level(logging.WARNING, logger=MODULE) assert AwsLambdaHook(Mock()).post_deploy() - assert ( - f"post_deploy not implimented for {AwsLambdaHook.__name__}" - in caplog.messages - ) + assert f"post_deploy not implimented for {AwsLambdaHook.__name__}" in caplog.messages - def test_post_destroy(self, caplog: LogCaptureFixture) -> None: + def test_post_destroy(self, caplog: pytest.LogCaptureFixture) -> None: """Test post_destroy.""" caplog.set_level(logging.WARNING, logger=MODULE) assert AwsLambdaHook(Mock()).post_destroy() - assert ( - f"post_destroy not implimented for {AwsLambdaHook.__name__}" - in caplog.messages - ) + assert f"post_destroy not implimented for {AwsLambdaHook.__name__}" in caplog.messages - def test_pre_deploy(self, caplog: LogCaptureFixture) -> None: + def test_pre_deploy(self, caplog: pytest.LogCaptureFixture) -> None: """Test pre_deploy.""" caplog.set_level(logging.WARNING, logger=MODULE) assert AwsLambdaHook(Mock()).pre_deploy() - assert ( - f"pre_deploy not implimented for {AwsLambdaHook.__name__}" - in caplog.messages - ) + assert f"pre_deploy not implimented for {AwsLambdaHook.__name__}" in caplog.messages - def test_pre_destroy(self, caplog: LogCaptureFixture) -> None: + def test_pre_destroy(self, caplog: pytest.LogCaptureFixture) -> None: """Test pre_destroy.""" caplog.set_level(logging.WARNING, logger=MODULE) assert AwsLambdaHook(Mock()).pre_destroy() - assert ( - f"pre_destroy not implimented for {AwsLambdaHook.__name__}" - in caplog.messages - ) + assert f"pre_destroy not implimented for {AwsLambdaHook.__name__}" in caplog.messages def test_project(self) -> None: """Test project.""" @@ -196,9 +175,7 @@ def test___init__(self, cfngin_context: CfnginContext) -> None: def test_build_directory(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test build_directory.""" - mocker.patch.object( - Project, "source_code", Mock(md5_hash="hash", root_directory=tmp_path) - ) + mocker.patch.object(Project, "source_code", Mock(md5_hash="hash", root_directory=tmp_path)) expected = tmp_path / f"{tmp_path.name}.hash" obj = Project(Mock(), Mock(work_dir=tmp_path)) @@ -218,7 +195,7 @@ def test_cache_dir(self, tmp_path: Path) -> None: ) assert Project(args, Mock()).cache_dir == cache_dir - def test_cache_dir_default(self, mocker: MockerFixture, tmp_path: Path) -> None: + def test_cache_dir_default(self, tmp_path: Path) -> None: """Test cache_dir default.""" cache_dir = tmp_path / Project.DEFAULT_CACHE_DIR_NAME cache_dir.mkdir() @@ -261,23 +238,18 @@ def test_compatible_runtimes(self, mocker: MockerFixture, tmp_path: Path) -> Non AwsLambdaHookArgs(bucket_name="", runtime="test", source_code=tmp_path), Mock(), ).compatible_runtimes - assert Project( - Mock(compatible_runtimes=["foobar"]), Mock() - ).compatible_runtimes == ["foobar"] + assert Project(Mock(compatible_runtimes=["foobar"]), Mock()).compatible_runtimes == [ + "foobar" + ] - def test_compatible_runtimes_raise_value_error( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test_compatible_runtimes_raise_value_error(self, mocker: MockerFixture) -> None: """Test compatible_runtimes raise ValueError.""" mocker.patch.object(Project, "runtime", "foobar") - with pytest.raises(ValueError) as excinfo: - assert Project( - Mock(compatible_runtimes=["foo", "bar"]), Mock() - ).compatible_runtimes - assert ( - str(excinfo.value) - == "runtime (foobar) not in compatible runtimes (foo, bar)" - ) + with pytest.raises( + ValueError, + match=r"runtime \(foobar\) not in compatible runtimes \(foo, bar\)", + ): + assert Project(Mock(compatible_runtimes=["foo", "bar"]), Mock()).compatible_runtimes def test_dependency_directory(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test dependency_directory.""" @@ -304,28 +276,26 @@ def test_license(self, tmp_path: Path) -> None: def test_metadata_files(self) -> None: """Test metadata_files.""" result = Project(Mock(), Mock()).metadata_files - assert not result and isinstance(result, tuple) + assert not result + assert isinstance(result, tuple) def test_project_root(self, tmp_path: Path) -> None: """Test project_root.""" config_path = tmp_path / "config.yml" config_path.touch() assert ( - Project( - Mock(source_code=tmp_path), Mock(config_path=config_path) - ).project_root + Project(Mock(source_code=tmp_path), Mock(config_path=config_path)).project_root == tmp_path ) def test_project_root_config_path_is_dir(self, tmp_path: Path) -> None: """Test project_root ctx.config_path is a directory.""" assert ( - Project(Mock(source_code=tmp_path), Mock(config_path=tmp_path)).project_root - == tmp_path + Project(Mock(source_code=tmp_path), Mock(config_path=tmp_path)).project_root == tmp_path ) def test_project_root_config_path_not_parent_of_source_code( - self, caplog: LogCaptureFixture, tmp_path: Path + self, caplog: pytest.LogCaptureFixture, tmp_path: Path ) -> None: """Test project_root ctx.config_path is not a parent of args.source_code.""" caplog.set_level(logging.INFO) @@ -335,14 +305,11 @@ def test_project_root_config_path_not_parent_of_source_code( config_path.touch() src_path = tmp_path / "src" / "lambda_function" assert ( - Project( - Mock(source_code=src_path), Mock(config_path=config_path) - ).project_root + Project(Mock(source_code=src_path), Mock(config_path=config_path)).project_root == src_path ) assert ( - "ignoring project directory; " - "source code located outside of project directory" + "ignoring project directory; source code located outside of project directory" ) in caplog.messages @pytest.mark.parametrize("create_metadata_file", [False, True]) @@ -360,9 +327,9 @@ def test_project_root_config_path_parent_of_source_code( src_path.mkdir(parents=True) if create_metadata_file: (src_path / "test.txt").touch() - assert Project( - Mock(source_code=src_path), Mock(config_path=config_path) - ).project_root == (src_path if create_metadata_file else tmp_path) + assert Project(Mock(source_code=src_path), Mock(config_path=config_path)).project_root == ( + src_path if create_metadata_file else tmp_path + ) def test_project_type(self) -> None: """Test project_type.""" @@ -371,17 +338,13 @@ def test_project_type(self) -> None: def test_runtime(self, mocker: MockerFixture) -> None: """Test runtime.""" - docker = mocker.patch.object( - Project, "docker", Mock(runtime="foo"), create=True - ) + docker = mocker.patch.object(Project, "docker", Mock(runtime="foo"), create=True) assert Project(Mock(runtime=None), Mock()).runtime == docker.runtime def test_runtime_raise_runtime_mismatch_error(self, mocker: MockerFixture) -> None: """Test runtime raise RuntimeMismatchError.""" args = Mock(runtime="bar") - docker = mocker.patch.object( - Project, "docker", Mock(runtime="foo"), create=True - ) + docker = mocker.patch.object(Project, "docker", Mock(runtime="foo"), create=True) with pytest.raises(RuntimeMismatchError) as excinfo: assert not Project(args, Mock()).runtime assert excinfo.value.detected_runtime == docker.runtime @@ -390,12 +353,10 @@ def test_runtime_raise_runtime_mismatch_error(self, mocker: MockerFixture) -> No def test_runtime_raise_value_error(self, mocker: MockerFixture) -> None: """Test runtime raise ValueError.""" mocker.patch.object(Project, "docker", None, create=True) - with pytest.raises(ValueError) as excinfo: + with pytest.raises( + ValueError, match="runtime could not be determined from the build system" + ): assert not Project(Mock(runtime=None), Mock()).runtime - assert ( - str(excinfo.value) - == "runtime could not be determined from the build system" - ) def test_source_code(self, mocker: MockerFixture) -> None: """Test source_code.""" diff --git a/tests/unit/cfngin/hooks/awslambda/test_deployment_package.py b/tests/unit/cfngin/hooks/awslambda/test_deployment_package.py index 8c2c12725..4c7d71d70 100644 --- a/tests/unit/cfngin/hooks/awslambda/test_deployment_package.py +++ b/tests/unit/cfngin/hooks/awslambda/test_deployment_package.py @@ -1,19 +1,15 @@ """Test runway.cfngin.hooks.awslambda.deployment_package.""" -# pylint: disable=protected-access,redefined-outer-name,unused-argument -# pylint: disable=too-many-lines from __future__ import annotations import zipfile -from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, cast +from typing import TYPE_CHECKING, Any, Optional, cast +from unittest.mock import MagicMock, Mock, PropertyMock, call from urllib.parse import urlencode import igittigitt import pytest from botocore.exceptions import ClientError -from mock import MagicMock, Mock, PropertyMock, call -from typing_extensions import Literal from runway._logging import LogLevels from runway.cfngin.hooks.awslambda.base_classes import Project @@ -37,10 +33,12 @@ from .factories import MockProject if TYPE_CHECKING: + from pathlib import Path + from botocore.stub import Stubber from mypy_boto3_s3.type_defs import PutObjectOutputTypeDef - from pytest import LogCaptureFixture from pytest_mock import MockerFixture + from typing_extensions import Literal from runway.context import CfnginContext @@ -49,7 +47,7 @@ ProjectTypeAlias = Project[AwsLambdaHookArgs] -@pytest.fixture(scope="function") +@pytest.fixture() def project(cfngin_context: CfnginContext, tmp_path: Path) -> ProjectTypeAlias: """Mock project object.""" args = AwsLambdaHookArgs( @@ -77,12 +75,8 @@ def test__build_fix_file_permissions(self, project: ProjectTypeAlias) -> None: obj = DeploymentPackage(project) obj._build_fix_file_permissions(archive_file) - assert ( - file0.external_attr & DeploymentPackage.ZIPFILE_PERMISSION_MASK - ) >> 16 == 0o755 - assert ( - file0.external_attr & DeploymentPackage.ZIPFILE_PERMISSION_MASK - ) >> 16 == 0o755 + assert (file0.external_attr & DeploymentPackage.ZIPFILE_PERMISSION_MASK) >> 16 == 0o755 + assert (file0.external_attr & DeploymentPackage.ZIPFILE_PERMISSION_MASK) >> 16 == 0o755 @pytest.mark.parametrize("usage_type", ["function", "layer"]) def test__build_zip_dependencies( @@ -176,8 +170,7 @@ def test__build_zip_source_code( if usage_type == "layer": mock_insert_layer_dir.assert_has_calls( [ # type: ignore - call(src_file, project.source_code.root_directory) - for src_file in files + call(src_file, project.source_code.root_directory) for src_file in files ] ) archive_file.write.assert_has_calls( @@ -228,19 +221,15 @@ def test_bucket(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: assert obj.bucket == bucket_class.return_value bucket_class.assert_any_call(project.ctx, project.args.bucket_name) - def test_bucket_forbidden( - self, mocker: MockerFixture, project: ProjectTypeAlias - ) -> None: + def test_bucket_forbidden(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: """Test bucket.""" - mocker.patch( - f"{MODULE}.Bucket", return_value=Mock(forbidden=True, not_found=False) - ) + mocker.patch(f"{MODULE}.Bucket", return_value=Mock(forbidden=True, not_found=False)) with pytest.raises(BucketAccessDeniedError): assert DeploymentPackage(project).bucket def test_build( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, project: ProjectTypeAlias, ) -> None: @@ -264,21 +253,15 @@ def _write_zip(package: DeploymentPackage[Any], archive_file: Mock) -> None: mock_build_fix_file_permissions = mocker.patch.object( DeploymentPackage, "_build_fix_file_permissions" ) - mock_del_cached_property = mocker.patch.object( - DeploymentPackage, "_del_cached_property" - ) + mock_del_cached_property = mocker.patch.object(DeploymentPackage, "_del_cached_property") obj = DeploymentPackage(project) assert obj.build() == obj.archive_file - mock_zipfile_class.assert_called_once_with( - obj.archive_file, "w", zipfile.ZIP_DEFLATED - ) + mock_zipfile_class.assert_called_once_with(obj.archive_file, "w", zipfile.ZIP_DEFLATED) mock_zipfile.__enter__.assert_called_once_with() mock_build_zip_dependencies.assert_called_once_with(mock_zipfile) mock_build_fix_file_permissions.assert_called_once_with(mock_zipfile) - mock_del_cached_property.assert_called_once_with( - "code_sha256", "exists", "md5_checksum" - ) + mock_del_cached_property.assert_called_once_with("code_sha256", "exists", "md5_checksum") assert f"building {obj.archive_file.name} ({obj.runtime})..." in caplog.messages def test_build_file_empty_after_build( @@ -288,7 +271,7 @@ def test_build_file_empty_after_build( archive_file = project.build_directory / "foobar.zip" mocker.patch.object(DeploymentPackage, "archive_file", archive_file) - def _write_zip(package: DeploymentPackage[Any], archive_file: Mock) -> None: + def _write_zip(package: DeploymentPackage[Any], archive_file: Mock) -> None: # noqa: ARG001 package.archive_file.touch() mock_build_zip_dependencies = mocker.patch.object( @@ -306,7 +289,7 @@ def _write_zip(package: DeploymentPackage[Any], archive_file: Mock) -> None: def test_build_file_exists( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, project: ProjectTypeAlias, ) -> None: @@ -320,9 +303,7 @@ def test_build_file_exists( obj.archive_file.write_text("test" * 8) assert obj.build() == obj.archive_file mock_zipfile_class.assert_not_called() - assert ( - f"build skipped; {obj.archive_file.name} already exists" in caplog.messages - ) + assert f"build skipped; {obj.archive_file.name} already exists" in caplog.messages def test_build_raise_runtime_mismatch_error( self, mocker: MockerFixture, project: ProjectTypeAlias @@ -348,7 +329,7 @@ def test_build_raise_runtime_mismatch_error( mock_build_zip_source_code.assert_not_called() mock_build_fix_file_permissions.assert_not_called() - @pytest.mark.parametrize("url_encoded", [False, True, False, True]) + @pytest.mark.parametrize("url_encoded", [False, True]) def test_build_tag_set( self, mocker: MockerFixture, @@ -356,16 +337,10 @@ def test_build_tag_set( url_encoded: bool, ) -> None: """Test build_tag_set.""" - code_sha256 = mocker.patch.object( - DeploymentPackage, "code_sha256", "code_sha256" - ) + code_sha256 = mocker.patch.object(DeploymentPackage, "code_sha256", "code_sha256") mocker.patch.object(project, "compatible_runtimes", ["compatible_runtimes"]) - md5_checksum = mocker.patch.object( - DeploymentPackage, "md5_checksum", "md5_checksum" - ) - source_md5_hash = mocker.patch.object( - project.source_code, "md5_hash", "source_code.hash" - ) + md5_checksum = mocker.patch.object(DeploymentPackage, "md5_checksum", "md5_checksum") + source_md5_hash = mocker.patch.object(project.source_code, "md5_hash", "source_code.hash") expected = { **project.ctx.tags, DeploymentPackage.META_TAGS["code_sha256"]: code_sha256, @@ -380,33 +355,20 @@ def test_build_tag_set( urlencode(expected) if url_encoded else expected ) - def test_bucket_not_found( - self, mocker: MockerFixture, project: ProjectTypeAlias - ) -> None: + def test_bucket_not_found(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: """Test bucket.""" - mocker.patch( - f"{MODULE}.Bucket", return_value=Mock(forbidden=False, not_found=True) - ) + mocker.patch(f"{MODULE}.Bucket", return_value=Mock(forbidden=False, not_found=True)) with pytest.raises(BucketNotFoundError): assert DeploymentPackage(project).bucket - def test_code_sha256( - self, mocker: MockerFixture, project: ProjectTypeAlias - ) -> None: + def test_code_sha256(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: """Test code_sha256.""" - archive_file = mocker.patch.object( - DeploymentPackage, "archive_file", "archive_file" - ) + archive_file = mocker.patch.object(DeploymentPackage, "archive_file", "archive_file") file_hash = Mock(digest="digest") mock_b64encode = mocker.patch("base64.b64encode", return_value=b"success") - mock_file_hash_class = mocker.patch( - f"{MODULE}.FileHash", return_value=file_hash - ) + mock_file_hash_class = mocker.patch(f"{MODULE}.FileHash", return_value=file_hash) mock_sha256 = mocker.patch("hashlib.sha256") - assert ( - DeploymentPackage(project).code_sha256 - == mock_b64encode.return_value.decode() - ) + assert DeploymentPackage(project).code_sha256 == mock_b64encode.return_value.decode() mock_file_hash_class.assert_called_once_with(mock_sha256.return_value) file_hash.add_file.assert_called_once_with(archive_file) mock_b64encode.assert_called_once_with(file_hash.digest) @@ -418,9 +380,7 @@ def test_compatible_architectures( mocker.patch.object(project, "compatible_architectures", ["foobar"]) assert DeploymentPackage(project).compatible_architectures == ["foobar"] - def test_compatible_runtimes( - self, mocker: MockerFixture, project: ProjectTypeAlias - ) -> None: + def test_compatible_runtimes(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: """Test compatible_runtimes.""" mocker.patch.object(project, "compatible_runtimes", ["foobar"]) assert DeploymentPackage(project).compatible_runtimes == ["foobar"] @@ -430,9 +390,7 @@ def test_delete( self, mocker: MockerFixture, project: ProjectTypeAlias, should_exist: bool ) -> None: """Test delete.""" - mock_del_cached_property = mocker.patch.object( - DeploymentPackage, "_del_cached_property" - ) + mock_del_cached_property = mocker.patch.object(DeploymentPackage, "_del_cached_property") obj = DeploymentPackage(project) if should_exist: obj.archive_file.touch() @@ -454,9 +412,7 @@ def test_gitignore_filter(self, project: ProjectTypeAlias) -> None: """Test gitignore_filter.""" assert not DeploymentPackage(project).gitignore_filter - @pytest.mark.parametrize( - "exists_in_s3, usage_type", [(False, "function"), (True, "layer")] - ) + @pytest.mark.parametrize("exists_in_s3, usage_type", [(False, "function"), (True, "layer")]) def test_init( self, exists_in_s3: bool, @@ -466,30 +422,24 @@ def test_init( ) -> None: """Test init where runtime always matches.""" s3_obj = Mock(exists=exists_in_s3, runtime=project.runtime) - s3_obj_class = mocker.patch( - f"{MODULE}.DeploymentPackageS3Object", return_value=s3_obj - ) + s3_obj_class = mocker.patch(f"{MODULE}.DeploymentPackageS3Object", return_value=s3_obj) if exists_in_s3: assert DeploymentPackage.init(project, usage_type) == s3_obj else: - assert isinstance( - DeploymentPackage.init(project, usage_type), DeploymentPackage - ) + assert isinstance(DeploymentPackage.init(project, usage_type), DeploymentPackage) s3_obj_class.assert_called_once_with(project, usage_type) def test_init_runtime_change( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, project: ProjectTypeAlias, ) -> None: """Test init where runtime has changed and object exists in S3.""" caplog.set_level(LogLevels.WARNING, logger=MODULE) s3_obj = Mock(exists=True, runtime="change") - s3_obj_class = mocker.patch( - f"{MODULE}.DeploymentPackageS3Object", return_value=s3_obj - ) + s3_obj_class = mocker.patch(f"{MODULE}.DeploymentPackageS3Object", return_value=s3_obj) assert isinstance(DeploymentPackage.init(project), DeploymentPackage) s3_obj_class.assert_called_once_with(project, "function") s3_obj.delete.assert_called_once_with() @@ -527,23 +477,14 @@ def test_license(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None mocker.patch.object(project, "license", "foobar") assert DeploymentPackage(project).license == "foobar" - def test_md5_checksum( - self, mocker: MockerFixture, project: ProjectTypeAlias - ) -> None: + def test_md5_checksum(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: """Test md5_checksum.""" - archive_file = mocker.patch.object( - DeploymentPackage, "archive_file", "archive_file" - ) + archive_file = mocker.patch.object(DeploymentPackage, "archive_file", "archive_file") file_hash = Mock(digest="digest") mock_b64encode = mocker.patch("base64.b64encode", return_value=b"success") - mock_file_hash_class = mocker.patch( - f"{MODULE}.FileHash", return_value=file_hash - ) + mock_file_hash_class = mocker.patch(f"{MODULE}.FileHash", return_value=file_hash) mock_md5 = mocker.patch("hashlib.md5") - assert ( - DeploymentPackage(project).md5_checksum - == mock_b64encode.return_value.decode() - ) + assert DeploymentPackage(project).md5_checksum == mock_b64encode.return_value.decode() mock_file_hash_class.assert_called_once_with(mock_md5.return_value) file_hash.add_file.assert_called_once_with(archive_file) mock_b64encode.assert_called_once_with(file_hash.digest) @@ -567,9 +508,7 @@ def test_object_key( project.args.object_prefix = object_prefix obj = DeploymentPackage(project, usage_type) if object_prefix: - expected_prefix = ( - f"awslambda/{usage_type}s/{object_prefix.lstrip('/').rstrip('/')}" - ) + expected_prefix = f"awslambda/{usage_type}s/{object_prefix.lstrip('/').rstrip('/')}" else: expected_prefix = f"awslambda/{usage_type}s" assert obj.object_key == ( @@ -577,15 +516,13 @@ def test_object_key( f"{project.source_code.md5_hash}.zip" ) - @pytest.mark.parametrize( - "response, expected", [({}, None), ({"VersionId": "foo"}, "foo")] - ) + @pytest.mark.parametrize("response, expected", [({}, None), ({"VersionId": "foo"}, "foo")]) def test_object_version_id( self, expected: Optional[str], mocker: MockerFixture, project: ProjectTypeAlias, - response: Dict[str, Any], + response: dict[str, Any], ) -> None: """Test object_version_id.""" mocker.patch.object(DeploymentPackage, "_put_object_response", response) @@ -597,9 +534,7 @@ def test_runtime(self, project: ProjectTypeAlias) -> None: assert DeploymentPackage(project).runtime == project.runtime @pytest.mark.parametrize("build", [False, True]) - def test_upload( - self, build: bool, mocker: MockerFixture, project: ProjectTypeAlias - ) -> None: + def test_upload(self, build: bool, mocker: MockerFixture, project: ProjectTypeAlias) -> None: """Test upload.""" mocker.patch.object( DeploymentPackage, @@ -613,15 +548,11 @@ def test_upload( "build_tag_set", return_value="foo=bar", ) - mock_del_cached_property = mocker.patch.object( - DeploymentPackage, "_del_cached_property" - ) + mock_del_cached_property = mocker.patch.object(DeploymentPackage, "_del_cached_property") mock_guess_type = mocker.patch( "mimetypes.guess_type", return_value=("application/zip", None) ) - md5_checksum = mocker.patch.object( - DeploymentPackage, "md5_checksum", "checksum" - ) + md5_checksum = mocker.patch.object(DeploymentPackage, "md5_checksum", "checksum") obj = DeploymentPackage(project) obj.archive_file.write_text("foobar") @@ -675,7 +606,7 @@ class TestDeploymentPackageS3Object: def test_build_exists( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, project: ProjectTypeAlias, ) -> None: @@ -689,13 +620,9 @@ def test_build_exists( mocker.patch.object(DeploymentPackageS3Object, "exists", True) obj = DeploymentPackageS3Object(project) assert obj.build() == obj.archive_file - assert ( - f"build skipped; {obj.archive_file.name} already exists" in caplog.messages - ) + assert f"build skipped; {obj.archive_file.name} already exists" in caplog.messages - def test_build_not_exists( - self, mocker: MockerFixture, project: ProjectTypeAlias - ) -> None: + def test_build_not_exists(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: """Test build object doesn't exist raises S3ObjectDoesNotExistError.""" mocker.patch.object(DeploymentPackageS3Object, "exists", False) bucket = Bucket(project.ctx, project.args.bucket_name) @@ -706,9 +633,7 @@ def test_build_not_exists( assert excinfo.value.bucket == bucket.name assert excinfo.value.key == obj.object_key - def test_code_sha256( - self, mocker: MockerFixture, project: ProjectTypeAlias - ) -> None: + def test_code_sha256(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: """Test code_sha256.""" expected = "foobar" mocker.patch.object( @@ -734,9 +659,7 @@ def test_code_sha256_raise_required_tag_not_found( assert DeploymentPackageS3Object(project).code_sha256 bucket.format_bucket_path_uri.assert_called_once_with(key=object_key) assert excinfo.value.resource == bucket.format_bucket_path_uri.return_value - assert ( - excinfo.value.tag_key == DeploymentPackageS3Object.META_TAGS["code_sha256"] - ) + assert excinfo.value.tag_key == DeploymentPackageS3Object.META_TAGS["code_sha256"] @pytest.mark.parametrize("value", ["foobar", None, "foo,bar"]) def test_compatible_architectures( @@ -764,11 +687,7 @@ def test_compatible_runtimes( mocker.patch.object( DeploymentPackageS3Object, "object_tags", - ( - {DeploymentPackageS3Object.META_TAGS["compatible_runtimes"]: value} - if value - else {} - ), + ({DeploymentPackageS3Object.META_TAGS["compatible_runtimes"]: value} if value else {}), ) assert DeploymentPackageS3Object(project).compatible_runtimes == ( value.split(", ") if value else None @@ -824,7 +743,7 @@ def test_delete( def test_exists( self, expected: bool, - head: Dict[str, Any], + head: dict[str, Any], project: ProjectTypeAlias, mocker: MockerFixture, ) -> None: @@ -854,7 +773,7 @@ def test_head(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: def test_head_403( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, project: ProjectTypeAlias, ) -> None: @@ -869,9 +788,7 @@ def test_head_403( object_key = mocker.patch.object(DeploymentPackageS3Object, "object_key", "key") stubber = cast("Stubber", project.ctx.add_stubber("s3")) # type: ignore - stubber.add_client_error( - "head_object", http_status_code=403, service_message="Forbidden" - ) + stubber.add_client_error("head_object", http_status_code=403, service_message="Forbidden") with stubber, pytest.raises(ClientError): assert DeploymentPackageS3Object(project).head stubber.assert_no_pending_responses() @@ -882,7 +799,7 @@ def test_head_403( def test_head_404( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, project: ProjectTypeAlias, ) -> None: @@ -897,16 +814,11 @@ def test_head_404( object_key = mocker.patch.object(DeploymentPackageS3Object, "object_key", "key") stubber = cast("Stubber", project.ctx.add_stubber("s3")) # type: ignore - stubber.add_client_error( - "head_object", http_status_code=404, service_message="Not Found" - ) + stubber.add_client_error("head_object", http_status_code=404, service_message="Not Found") with stubber: assert not DeploymentPackageS3Object(project).head stubber.assert_no_pending_responses() - assert ( - f"{bucket.format_bucket_path_uri(key=object_key)} not found" - in caplog.messages - ) + assert f"{bucket.format_bucket_path_uri(key=object_key)} not found" in caplog.messages @pytest.mark.parametrize("value", ["foobar", None]) def test_license( @@ -920,9 +832,7 @@ def test_license( ) assert DeploymentPackageS3Object(project).license == (value) - def test_md5_checksum( - self, project: ProjectTypeAlias, mocker: MockerFixture - ) -> None: + def test_md5_checksum(self, project: ProjectTypeAlias, mocker: MockerFixture) -> None: """Test md5_checksum.""" expected = "foobar" mocker.patch.object( @@ -950,9 +860,7 @@ def test_md5_checksum_raise_required_tag_not_found( assert DeploymentPackageS3Object(project).md5_checksum bucket.format_bucket_path_uri.assert_called_once_with(key=object_key) assert excinfo.value.resource == bucket.format_bucket_path_uri.return_value - assert ( - excinfo.value.tag_key == DeploymentPackageS3Object.META_TAGS["md5_checksum"] - ) + assert excinfo.value.tag_key == DeploymentPackageS3Object.META_TAGS["md5_checksum"] @pytest.mark.parametrize( "response, expected", @@ -963,10 +871,10 @@ def test_md5_checksum_raise_required_tag_not_found( ) def test_object_tags( self, - expected: Dict[str, str], + expected: dict[str, str], mocker: MockerFixture, project: ProjectTypeAlias, - response: Dict[str, List[Dict[str, str]]], + response: dict[str, list[dict[str, str]]], ) -> None: """Test object_tags.""" mocker.patch.object( @@ -993,7 +901,7 @@ def test_object_tags( def test_object_version_id( self, expected: Optional[str], - head: Dict[str, str], + head: dict[str, str], mocker: MockerFixture, project: ProjectTypeAlias, ) -> None: @@ -1031,9 +939,7 @@ def test_runtime_raise_required_tag_not_found( assert excinfo.value.resource == bucket.format_bucket_path_uri.return_value assert excinfo.value.tag_key == DeploymentPackageS3Object.META_TAGS["runtime"] - def test_update_tags( - self, mocker: MockerFixture, project: ProjectTypeAlias - ) -> None: + def test_update_tags(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: """Test mock_update_tags.""" bucket = Bucket(project.ctx, project.args.bucket_name) mocker.patch.object(DeploymentPackageS3Object, "bucket", bucket) @@ -1060,7 +966,7 @@ def test_update_tags( def test_update_tags_no_change( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, project: ProjectTypeAlias, ) -> None: @@ -1087,7 +993,7 @@ def test_update_tags_no_change( def test_upload_exists( self, build: bool, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, project: ProjectTypeAlias, ) -> None: @@ -1105,9 +1011,7 @@ def test_upload_exists( ) mock_update_tags.assert_called_once_with() - def test_upload_not_exists( - self, mocker: MockerFixture, project: ProjectTypeAlias - ) -> None: + def test_upload_not_exists(self, mocker: MockerFixture, project: ProjectTypeAlias) -> None: """Test upload object doesn't exist raises S3ObjectDoesNotExistError.""" mocker.patch.object(DeploymentPackageS3Object, "exists", False) bucket = Bucket(project.ctx, project.args.bucket_name) diff --git a/tests/unit/cfngin/hooks/awslambda/test_docker.py b/tests/unit/cfngin/hooks/awslambda/test_docker.py index e3b777839..6f8d5d8e6 100644 --- a/tests/unit/cfngin/hooks/awslambda/test_docker.py +++ b/tests/unit/cfngin/hooks/awslambda/test_docker.py @@ -4,12 +4,12 @@ import logging from typing import TYPE_CHECKING, Optional +from unittest.mock import Mock, call import pytest from docker.errors import DockerException, ImageNotFound from docker.models.images import Image from docker.types.services import Mount -from mock import Mock, call from runway.cfngin.hooks.awslambda.constants import ( AWS_SAM_BUILD_IMAGE_PREFIX, @@ -25,7 +25,6 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from runway.context import CfnginContext @@ -37,13 +36,9 @@ class TestDockerDependencyInstaller: """Test DockerDependencyInstaller.""" - def test___init__( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test___init__(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test __init__.""" - from_env = mocker.patch( - f"{MODULE}.DockerClient.from_env", return_value="success" - ) + from_env = mocker.patch(f"{MODULE}.DockerClient.from_env", return_value="success") options = Mock() project = Mock(args=Mock(docker=options)) obj = DockerDependencyInstaller(project, context=cfngin_context) @@ -56,9 +51,7 @@ def test___init__( def test___init___client(self, mocker: MockerFixture) -> None: """Test __init__ passing client.""" client = Mock() - from_env = mocker.patch( - f"{MODULE}.DockerClient.from_env", return_value="success" - ) + from_env = mocker.patch(f"{MODULE}.DockerClient.from_env", return_value="success") obj = DockerDependencyInstaller(Mock(), client=client) from_env.assert_not_called() assert obj.client == client @@ -72,9 +65,7 @@ def test_bind_mounts(self) -> None: ) obj = DockerDependencyInstaller(project, client=Mock()) assert obj.bind_mounts == [ - Mount( - target="/var/task/lambda", source="dependency_directory", type="bind" - ), + Mount(target="/var/task/lambda", source="dependency_directory", type="bind"), Mount(target="/var/task/project", source="project_root", type="bind"), ] @@ -87,16 +78,12 @@ def test_bind_mounts_cache_dir(self) -> None: ) obj = DockerDependencyInstaller(project, client=Mock()) assert obj.bind_mounts == [ - Mount( - target="/var/task/lambda", source="dependency_directory", type="bind" - ), + Mount(target="/var/task/lambda", source="dependency_directory", type="bind"), Mount(target="/var/task/project", source="project_root", type="bind"), Mount(target="/var/task/cache_dir", source="cache_dir", type="bind"), ] - @pytest.mark.parametrize( - "name, pull, tag", [("foo", False, "bar"), (None, True, None)] - ) + @pytest.mark.parametrize("name, pull, tag", [("foo", False, "bar"), (None, True, None)]) def test_build_image( self, mocker: MockerFixture, @@ -134,9 +121,7 @@ def test_build_image( pull=pull, ) mock_log_docker_msg_dict.assert_called_once_with(logs) - image.tag.assert_called_once_with( - name or DEFAULT_IMAGE_NAME, tag=tag or DEFAULT_IMAGE_TAG - ) + image.tag.assert_called_once_with(name or DEFAULT_IMAGE_NAME, tag=tag or DEFAULT_IMAGE_TAG) image.reload.assert_called_once_with() def test_build_image_raise_docker_exception(self, tmp_path: Path) -> None: @@ -261,9 +246,7 @@ def test_image_pull_image( runtime: Optional[str], ) -> None: """Test image pull image.""" - project = Mock( - args=Mock(docker=Mock(file=None, image=image, pull=pull), runtime=runtime) - ) + project = Mock(args=Mock(docker=Mock(file=None, image=image, pull=pull), runtime=runtime)) pull_image = mocker.patch.object( DockerDependencyInstaller, "pull_image", return_value="success" ) @@ -281,17 +264,14 @@ def test_image_pull_image( def test_image_raise_value_error(self, mocker: MockerFixture) -> None: """Test image raise ValueError.""" - project = Mock( - args=Mock(docker=Mock(file=None, image=None, pull=True), runtime=None) - ) + project = Mock(args=Mock(docker=Mock(file=None, image=None, pull=True), runtime=None)) build_image = mocker.patch.object(DockerDependencyInstaller, "build_image") pull_image = mocker.patch.object(DockerDependencyInstaller, "pull_image") obj = DockerDependencyInstaller(project, client=Mock()) - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="docker.file, docker.image, or runtime is required"): assert not obj.image build_image.assert_not_called() pull_image.assert_not_called() - assert str(excinfo.value) == "docker.file, docker.image, or runtime is required" def test_install(self, mocker: MockerFixture) -> None: """Test install.""" @@ -320,7 +300,8 @@ def test_install(self, mocker: MockerFixture) -> None: def test_install_commands(self) -> None: """Test install_commands.""" obj = DockerDependencyInstaller(Mock(), client=Mock()) - assert not obj.install_commands and isinstance(obj.install_commands, list) + assert not obj.install_commands + assert isinstance(obj.install_commands, list) @pytest.mark.parametrize("level", [logging.INFO, logging.DEBUG]) def test_log_docker_msg_bytes(self, level: int, mocker: MockerFixture) -> None: @@ -328,9 +309,7 @@ def test_log_docker_msg_bytes(self, level: int, mocker: MockerFixture) -> None: msg = "foobar" obj = DockerDependencyInstaller(Mock(), client=Mock()) docker_logger = mocker.patch.object(obj, "_docker_logger") - assert obj.log_docker_msg_bytes(iter([f"{msg}\n".encode()]), level=level) == [ - msg - ] + assert obj.log_docker_msg_bytes(iter([f"{msg}\n".encode()]), level=level) == [msg] docker_logger.log.assert_called_once_with(level, msg) @pytest.mark.parametrize("level", [logging.INFO, logging.DEBUG]) @@ -357,7 +336,7 @@ def test_log_docker_msg_dict(self, level: int, mocker: MockerFixture) -> None: def test_post_install_commands( self, mocker: MockerFixture, - platform_linux: None, # pylint: disable=unused-argument + platform_linux: None, # noqa: ARG002 ) -> None: """Test post_install_commands.""" # these methods don't exist on windows so they need to be mocked @@ -373,15 +352,13 @@ def test_post_install_commands( def test_post_install_commands_cache_dir( self, mocker: MockerFixture, - platform_linux: None, # pylint: disable=unused-argument + platform_linux: None, # noqa: ARG002 ) -> None: """Test post_install_commands with cache_dir.""" # these methods don't exist on windows so they need to be mocked getgid = mocker.patch(f"{MODULE}.os.getgid", create=True, return_value=3) getuid = mocker.patch(f"{MODULE}.os.getuid", create=True, return_value=4) - obj = DockerDependencyInstaller( - Mock(args=Mock(docker=Mock(extra_files=[]))), client=Mock() - ) + obj = DockerDependencyInstaller(Mock(args=Mock(docker=Mock(extra_files=[]))), client=Mock()) assert obj.post_install_commands == [ f"chown -R {getuid.return_value}:{getgid.return_value} /var/task/lambda", f"chown -R {getuid.return_value}:{getgid.return_value} /var/task/cache_dir", @@ -390,7 +367,7 @@ def test_post_install_commands_cache_dir( def test_post_install_commands_extra_files( self, mocker: MockerFixture, - platform_linux: None, # pylint: disable=unused-argument + platform_linux: None, # noqa: ARG002 ) -> None: """Test post_install_commands with extra_files.""" # these methods don't exist on windows so they need to be mocked @@ -406,9 +383,7 @@ def test_post_install_commands_extra_files( f"chown -R {getuid.return_value}:{getgid.return_value} /var/task/lambda", ] - def test_post_install_commands_windows( - self, platform_windows: None # pylint: disable=unused-argument - ) -> None: + def test_post_install_commands_windows(self, platform_windows: None) -> None: # noqa: ARG002 """Test post_install_commands Windows.""" obj = DockerDependencyInstaller( Mock(args=Mock(docker=Mock(extra_files=[])), cache_dir=False), client=Mock() @@ -433,16 +408,15 @@ def test_pre_install_commands_cache_dir(self) -> None: [(False, False), (False, True), (True, True), (True, False)], ) def test_pull_image( - self, caplog: LogCaptureFixture, exists_locally: bool, force: bool + self, caplog: pytest.LogCaptureFixture, exists_locally: bool, force: bool ) -> None: """Test pull_image.""" caplog.set_level(logging.INFO, logger=MODULE) name = "foo:latest" image = Mock(spec=Image, id=FAKE_IMAGE_ID) - if exists_locally: - mock_get = Mock(return_value=image) - else: - mock_get = Mock(side_effect=ImageNotFound("test")) + mock_get = ( + Mock(return_value=image) if exists_locally else Mock(side_effect=ImageNotFound("test")) + ) mock_pull = Mock(return_value=image) assert ( @@ -461,14 +435,10 @@ def test_pull_image( mock_pull.assert_not_called() else: mock_pull.assert_called_once_with(repository=name) - assert caplog.messages == [ - f"image not found; pulling docker image {name}..." - ] + assert caplog.messages == [f"image not found; pulling docker image {name}..."] @pytest.mark.parametrize("command, level", [("foo", logging.DEBUG), ("bar", None)]) - def test_run_command( - self, command: str, level: Optional[int], mocker: MockerFixture - ) -> None: + def test_run_command(self, command: str, level: Optional[int], mocker: MockerFixture) -> None: """Test run_command.""" container = Mock( logs=Mock(return_value="log-stream"), @@ -478,9 +448,7 @@ def test_run_command( mock_log_docker_msg_bytes = mocker.patch.object( DockerDependencyInstaller, "log_docker_msg_bytes", return_value=["logs"] ) - bind_mounts = mocker.patch.object( - DockerDependencyInstaller, "bind_mounts", ["mount"] - ) + bind_mounts = mocker.patch.object(DockerDependencyInstaller, "bind_mounts", ["mount"]) environment_variables = mocker.patch.object( DockerDependencyInstaller, "environment_variables", {"foo": "bar"} ) @@ -510,9 +478,7 @@ def test_run_command( container.wait.assert_called_once_with() container.remove.assert_called_once_with(force=True) - def test_run_command_container_nonzero_exit_code( - self, mocker: MockerFixture - ) -> None: + def test_run_command_container_nonzero_exit_code(self, mocker: MockerFixture) -> None: """Test run_command container non-zero exit code.""" error_msg = "error msg" container = Mock( @@ -524,9 +490,7 @@ def test_run_command_container_nonzero_exit_code( DockerDependencyInstaller, "log_docker_msg_bytes", return_value=["logs"] ) mocker.patch.object(DockerDependencyInstaller, "bind_mounts", ["mount"]) - mocker.patch.object( - DockerDependencyInstaller, "environment_variables", {"foo": "bar"} - ) + mocker.patch.object(DockerDependencyInstaller, "environment_variables", {"foo": "bar"}) mocker.patch.object(DockerDependencyInstaller, "image", "image") with pytest.raises(DockerExecFailedError) as excinfo: DockerDependencyInstaller( @@ -552,9 +516,7 @@ def test_run_command_container_start_error(self, mocker: MockerFixture) -> None: DockerDependencyInstaller, "log_docker_msg_bytes", return_value=["logs"] ) mocker.patch.object(DockerDependencyInstaller, "bind_mounts", ["mount"]) - mocker.patch.object( - DockerDependencyInstaller, "environment_variables", {"foo": "bar"} - ) + mocker.patch.object(DockerDependencyInstaller, "environment_variables", {"foo": "bar"}) mocker.patch.object(DockerDependencyInstaller, "image", "image") with pytest.raises(DockerException): diff --git a/tests/unit/cfngin/hooks/awslambda/test_source_code.py b/tests/unit/cfngin/hooks/awslambda/test_source_code.py index fe3825061..289cdb2bb 100644 --- a/tests/unit/cfngin/hooks/awslambda/test_source_code.py +++ b/tests/unit/cfngin/hooks/awslambda/test_source_code.py @@ -1,13 +1,12 @@ """Test runway.cfngin.hooks.awslambda.source_code.""" -# pylint: disable=protected-access, unnecessary-dunder-call from __future__ import annotations from pathlib import Path from typing import TYPE_CHECKING +from unittest.mock import Mock, call import pytest -from mock import Mock, call from runway.cfngin.hooks.awslambda.source_code import SourceCode @@ -100,9 +99,7 @@ def test___iter__(self, tmp_path: Path) -> None: ) == 1 ) - gitignore_filter.match.assert_has_calls( - [call(file0), call(file1)], any_order=True - ) + gitignore_filter.match.assert_has_calls([call(file0), call(file1)], any_order=True) def test___str__(self, tmp_path: Path) -> None: """Test __str__.""" @@ -117,20 +114,14 @@ def test_add_filter_rule(self, tmp_path: Path) -> None: gitignore_filter = Mock() pattern = "foobar/" src_path = tmp_path / "src" - obj = SourceCode( - src_path, gitignore_filter=gitignore_filter, project_root=tmp_path - ) + obj = SourceCode(src_path, gitignore_filter=gitignore_filter, project_root=tmp_path) assert not obj.add_filter_rule(pattern) - gitignore_filter.add_rule.assert_called_once_with( - pattern=pattern, base_path=src_path - ) + gitignore_filter.add_rule.assert_called_once_with(pattern=pattern, base_path=src_path) def test_md5_hash(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test md5_hash.""" file_hash = Mock(hexdigest="success") - mock_file_hash_class = mocker.patch( - f"{MODULE}.FileHash", return_value=file_hash - ) + mock_file_hash_class = mocker.patch(f"{MODULE}.FileHash", return_value=file_hash) mock_md5 = mocker.patch("hashlib.md5") src_path = tmp_path / "src" src_path.mkdir() diff --git a/tests/unit/cfngin/hooks/docker/image/test_build.py b/tests/unit/cfngin/hooks/docker/image/test_build.py index 95242a65b..e759829e6 100644 --- a/tests/unit/cfngin/hooks/docker/image/test_build.py +++ b/tests/unit/cfngin/hooks/docker/image/test_build.py @@ -1,15 +1,13 @@ """Test runway.cfngin.hooks.docker.image._build.""" -# pylint: disable=protected-access # pyright: basic from __future__ import annotations -from pathlib import Path from typing import TYPE_CHECKING, Optional +from unittest.mock import MagicMock import pytest from docker.models.images import Image -from mock import MagicMock from pydantic import ValidationError from runway.cfngin.hooks.docker.data_models import ( @@ -27,15 +25,17 @@ from .....mock_docker.fake_api import FAKE_IMAGE_ID if TYPE_CHECKING: + from pathlib import Path + from pytest_mock import MockerFixture - from .....factories import MockCFNginContext + from .....factories import MockCfnginContext MODULE = "runway.cfngin.hooks.docker.image._build" -@pytest.fixture(scope="function") +@pytest.fixture() def tmp_dockerfile(cd_tmp_path: Path) -> Path: """Create temporary Dockerfile.""" dockerfile = cd_tmp_path / "Dockerfile" @@ -43,18 +43,12 @@ def tmp_dockerfile(cd_tmp_path: Path) -> Path: return dockerfile -def test_build( - cfngin_context: MockCFNginContext, mocker: MockerFixture, tmp_path: Path -) -> None: +def test_build(cfngin_context: MockCfnginContext, mocker: MockerFixture, tmp_path: Path) -> None: """Test build.""" (tmp_path / "Dockerfile").touch() - mock_image = MagicMock( - spec=Image, id=FAKE_IMAGE_ID, tags=MagicMock(return_value=["latest"]) - ) + mock_image = MagicMock(spec=Image, id=FAKE_IMAGE_ID, tags=MagicMock(return_value=["latest"])) mock_logs = [{"stream": "log message\n"}, {"not-stream": "no log"}] - mock_client = MagicMock( - images=MagicMock(build=MagicMock(return_value=(mock_image, mock_logs))) - ) + mock_client = MagicMock(images=MagicMock(build=MagicMock(return_value=(mock_image, mock_logs)))) args = ImageBuildArgs(path=tmp_path) mocker.patch.object(ImageBuildArgs, "parse_obj", return_value=args) mocker.patch.object(DockerHookData, "client", mock_client) @@ -68,9 +62,7 @@ def test_build( cfngin_context.hook_data["docker"] = docker_hook_data assert build(context=cfngin_context, **args.dict()) == docker_hook_data mock_from_cfngin_context.assert_called_once_with(cfngin_context) - mock_client.images.build.assert_called_once_with( - path=str(args.path), **args.docker.dict() - ) + mock_client.images.build.assert_called_once_with(path=str(args.path), **args.docker.dict()) mock_image.tag.assert_called_once_with(None, tag="latest") mock_image.reload.assert_called_once() assert isinstance(docker_hook_data.image, DockerImage) @@ -84,7 +76,8 @@ class TestDockerImageBuildApiOptions: def test_field_defaults(self) -> None: """Test field defaults.""" obj = DockerImageBuildApiOptions() - assert not obj.buildargs and isinstance(obj.buildargs, dict) + assert not obj.buildargs + assert isinstance(obj.buildargs, dict) assert obj.custom_context is False assert not obj.extra_hosts assert obj.forcerm is False @@ -172,9 +165,7 @@ def test__set_repo_ecr(self, tmp_path: Path) -> None: """Test _set_repo ECR.""" repo = ElasticContainerRegistryRepository( repo_name="test", - registry=ElasticContainerRegistry( - account_id="123456789012", aws_region="us-east-1" - ), + registry=ElasticContainerRegistry(account_id="123456789012", aws_region="us-east-1"), ) assert ImageBuildArgs(path=tmp_path, ecr_repo=repo).repo == repo.fqn @@ -185,6 +176,4 @@ def test__validate_dockerfile_raise_value_error(self, tmp_path: Path) -> None: errors = excinfo.value.errors() assert len(errors) == 1 assert errors[0]["loc"] == ("dockerfile",) - assert errors[0]["msg"].startswith( - "Dockerfile does not exist at path provided: " - ) + assert errors[0]["msg"].startswith("Dockerfile does not exist at path provided: ") diff --git a/tests/unit/cfngin/hooks/docker/image/test_push.py b/tests/unit/cfngin/hooks/docker/image/test_push.py index 00bd26ede..57b128cc6 100644 --- a/tests/unit/cfngin/hooks/docker/image/test_push.py +++ b/tests/unit/cfngin/hooks/docker/image/test_push.py @@ -1,13 +1,12 @@ """Test runway.cfngin.hooks.docker.image._push.""" -# pylint: disable=no-member # pyright: basic, reportFunctionMemberAccess=none from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import call from docker.models.images import Image -from mock import call from runway.cfngin.hooks.docker.data_models import ( DockerImage, @@ -22,13 +21,13 @@ from docker import DockerClient from pytest_mock import MockerFixture - from .....factories import MockCFNginContext + from .....factories import MockCfnginContext MODULE = "runway.cfngin.hooks.docker.image._push" def test_push( - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, mock_docker_client: DockerClient, mocker: MockerFixture, ) -> None: @@ -79,9 +78,7 @@ def test__set_repo_ecr(self) -> None: """Test _set_repo ECR.""" repo = ElasticContainerRegistryRepository( repo_name="test", - registry=ElasticContainerRegistry( - account_id="123456789012", aws_region="us-east-1" - ), + registry=ElasticContainerRegistry(account_id="123456789012", aws_region="us-east-1"), ) assert ImagePushArgs(ecr_repo=repo).repo == repo.fqn diff --git a/tests/unit/cfngin/hooks/docker/image/test_remove.py b/tests/unit/cfngin/hooks/docker/image/test_remove.py index fc4419d33..3110cbc7e 100644 --- a/tests/unit/cfngin/hooks/docker/image/test_remove.py +++ b/tests/unit/cfngin/hooks/docker/image/test_remove.py @@ -4,10 +4,10 @@ from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import call from docker.errors import ImageNotFound from docker.models.images import Image -from mock import call from runway.cfngin.hooks.docker.data_models import ( DockerImage, @@ -22,13 +22,13 @@ from docker import DockerClient from pytest_mock import MockerFixture - from .....factories import MockCFNginContext + from .....factories import MockCfnginContext MODULE = "runway.cfngin.hooks.docker.image._remove" def test_remove( - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, mock_docker_client: DockerClient, mocker: MockerFixture, ) -> None: @@ -54,17 +54,14 @@ def test_remove( ) mock_from_cfngin_context.assert_called_once_with(cfngin_context) docker_hook_data.client.api.remove_image.assert_has_calls( # type: ignore - [ - call(force=True, image=f"{args.repo}:{tag}", noprune=False) - for tag in args.tags - ] + [call(force=True, image=f"{args.repo}:{tag}", noprune=False) for tag in args.tags] ) assert docker_hook_data.image is None mock_update_context.assert_called_once_with(cfngin_context) def test_remove_image_not_found( - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, mock_docker_client: DockerClient, mocker: MockerFixture, ) -> None: @@ -73,9 +70,7 @@ def test_remove_image_not_found( mocker.patch.object(ImageRemoveArgs, "parse_obj", return_value=args) mocker.patch.object(DockerHookData, "client", mock_docker_client) docker_hook_data = DockerHookData() - mocker.patch.object( - DockerHookData, "from_cfngin_context", return_value=docker_hook_data - ) + mocker.patch.object(DockerHookData, "from_cfngin_context", return_value=docker_hook_data) mock_update_context = mocker.patch.object( DockerHookData, "update_context", return_value=docker_hook_data ) @@ -84,12 +79,8 @@ def test_remove_image_not_found( f"{args.repo}:latest" ) assert remove(context=cfngin_context, **args.dict()) == docker_hook_data - # pylint: disable=no-member docker_hook_data.client.api.remove_image.assert_has_calls( # type: ignore - [ - call(force=False, image=f"{args.repo}:{tag}", noprune=False) - for tag in args.tags - ] + [call(force=False, image=f"{args.repo}:{tag}", noprune=False) for tag in args.tags] ) mock_update_context.assert_called_once_with(cfngin_context) @@ -121,9 +112,7 @@ def test__set_repo_ecr(self) -> None: """Test _set_repo ECR.""" repo = ElasticContainerRegistryRepository( repo_name="test", - registry=ElasticContainerRegistry( - account_id="123456789012", aws_region="us-east-1" - ), + registry=ElasticContainerRegistry(account_id="123456789012", aws_region="us-east-1"), ) assert ImageRemoveArgs(ecr_repo=repo).repo == repo.fqn diff --git a/tests/unit/cfngin/hooks/docker/test_data_models.py b/tests/unit/cfngin/hooks/docker/test_data_models.py index 5a2d44c33..3d802dbd8 100644 --- a/tests/unit/cfngin/hooks/docker/test_data_models.py +++ b/tests/unit/cfngin/hooks/docker/test_data_models.py @@ -1,14 +1,13 @@ """Test runway.cfngin.hooks.docker.data_models.""" -# pylint: disable=protected-access,redefined-outer-name # pyright: basic from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import MagicMock import pytest from docker.models.images import Image -from mock import MagicMock from pydantic import ValidationError from runway.cfngin.hooks.docker.data_models import ( @@ -19,7 +18,7 @@ from runway.utils import MutableMap if TYPE_CHECKING: - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext MODULE = "runway.cfngin.hooks.docker.data_models" MOCK_IMAGE_REPO = "dkr.test.com/image" @@ -31,7 +30,7 @@ } -@pytest.fixture(scope="function") +@pytest.fixture() def mock_image() -> MagicMock: """Return a mock docker.models.images.Image.""" return MagicMock(spec=Image, **MOCK_IMAGE_PROPS) @@ -71,9 +70,7 @@ class TestElasticContainerRegistry: def test_fqn_private(self) -> None: """Test fqn private.""" - obj = ElasticContainerRegistry( - account_id="123456789012", aws_region="us-east-1" - ) + obj = ElasticContainerRegistry(account_id="123456789012", aws_region="us-east-1") assert obj.fqn == "123456789012.dkr.ecr.us-east-1.amazonaws.com/" def test_fqn_public(self) -> None: @@ -81,7 +78,7 @@ def test_fqn_public(self) -> None: obj = ElasticContainerRegistry(alias="test") assert obj.fqn == "public.ecr.aws/test/" - def test_init_default(self, cfngin_context: MockCFNginContext) -> None: + def test_init_default(self, cfngin_context: MockCfnginContext) -> None: """Test init default values.""" account_id = "123456789012" sts_stubber = cfngin_context.add_stubber("sts") @@ -133,7 +130,7 @@ def test_init_public(self) -> None: class TestElasticContainerRegistryRepository: """Test runway.cfngin.hooks.docker._data_models.ElasticContainerRegistryRepository.""" - def test_fqn(self, cfngin_context: MockCFNginContext) -> None: + def test_fqn(self, cfngin_context: MockCfnginContext) -> None: """Test init private.""" account_id = "123456789012" region = "us-east-1" diff --git a/tests/unit/cfngin/hooks/docker/test_hook_data.py b/tests/unit/cfngin/hooks/docker/test_hook_data.py index 6ce162b4c..605d5029c 100644 --- a/tests/unit/cfngin/hooks/docker/test_hook_data.py +++ b/tests/unit/cfngin/hooks/docker/test_hook_data.py @@ -10,7 +10,7 @@ if TYPE_CHECKING: from pytest_mock import MockerFixture - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext MODULE = "runway.cfngin.hooks.docker.hook_data" @@ -24,7 +24,7 @@ def test_client(self, mocker: MockerFixture) -> None: obj = DockerHookData() assert obj.client == mock_local_client.from_env.return_value - def test_from_cfngin_context(self, cfngin_context: MockCFNginContext) -> None: + def test_from_cfngin_context(self, cfngin_context: MockCfnginContext) -> None: """Test from_cfngin_context.""" obj = DockerHookData.from_cfngin_context(cfngin_context) assert isinstance(obj, DockerHookData) @@ -37,7 +37,7 @@ def test_from_cfngin_context(self, cfngin_context: MockCFNginContext) -> None: # compare instance id as these should NOT be the same instance assert id(obj) != id(new_obj) - def test_update_context(self, cfngin_context: MockCFNginContext) -> None: + def test_update_context(self, cfngin_context: MockCfnginContext) -> None: """Test update_context.""" obj = DockerHookData() assert obj.update_context(cfngin_context) == obj diff --git a/tests/unit/cfngin/hooks/docker/test_login.py b/tests/unit/cfngin/hooks/docker/test_login.py index debd92446..639d310ba 100644 --- a/tests/unit/cfngin/hooks/docker/test_login.py +++ b/tests/unit/cfngin/hooks/docker/test_login.py @@ -17,13 +17,13 @@ from docker import DockerClient from pytest_mock import MockerFixture - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext MODULE = "runway.cfngin.hooks.docker._login" def test_login( - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, mock_docker_client: DockerClient, mocker: MockerFixture, ) -> None: @@ -56,9 +56,7 @@ def test__set_ecr(self, mocker: MockerFixture) -> None: ElasticContainerRegistry, "parse_obj", return_value=expected ) assert ( - LoginArgs.parse_obj( - {"ecr": expected.dict(), "password": "", "username": ""} - ).ecr + LoginArgs.parse_obj({"ecr": expected.dict(), "password": "", "username": ""}).ecr == expected ) mock_parse_obj.assert_called_once_with({"context": None, **expected.dict()}) @@ -72,9 +70,7 @@ def test__set_ecr(self, mocker: MockerFixture) -> None: ( ElasticContainerRegistry(alias="foobar"), None, - ElasticContainerRegistry.PUBLIC_URI_TEMPLATE.format( - registry_alias="foobar" - ), + ElasticContainerRegistry.PUBLIC_URI_TEMPLATE.format(registry_alias="foobar"), ), ], ) @@ -85,10 +81,7 @@ def test__set_registry( registry: Optional[str], ) -> None: """Test _set_registry.""" - assert ( - LoginArgs(ecr=ecr, password="", registry=registry, username="").registry - == expected - ) + assert LoginArgs(ecr=ecr, password="", registry=registry, username="").registry == expected def test_field_defaults(self) -> None: """Test field defaults.""" diff --git a/tests/unit/cfngin/hooks/ecr/test__purge_repositroy.py b/tests/unit/cfngin/hooks/ecr/test__purge_repositroy.py index e28c94866..28c10d828 100644 --- a/tests/unit/cfngin/hooks/ecr/test__purge_repositroy.py +++ b/tests/unit/cfngin/hooks/ecr/test__purge_repositroy.py @@ -3,7 +3,7 @@ # pyright: basic from __future__ import annotations -from typing import TYPE_CHECKING, List +from typing import TYPE_CHECKING import boto3 import pytest @@ -16,7 +16,7 @@ from mypy_boto3_ecr.type_defs import ImageIdentifierTypeDef from pytest_mock import MockerFixture - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext MODULE = "runway.cfngin.hooks.ecr._purge_repository" @@ -25,7 +25,7 @@ def test_delete_ecr_images() -> None: """Test delete_ecr_images.""" client = boto3.client("ecr") stubber = Stubber(client) - image_ids: List[ImageIdentifierTypeDef] = [{"imageDigest": "image0"}] + image_ids: list[ImageIdentifierTypeDef] = [{"imageDigest": "image0"}] repo_name = "test-repo" stubber.add_response( @@ -35,16 +35,14 @@ def test_delete_ecr_images() -> None: ) with stubber: - assert not delete_ecr_images( - client, image_ids=image_ids, repository_name=repo_name - ) + assert not delete_ecr_images(client, image_ids=image_ids, repository_name=repo_name) def test_delete_ecr_images_failures() -> None: """Test delete_ecr_images with failures.""" client = boto3.client("ecr") stubber = Stubber(client) - image_ids: List[ImageIdentifierTypeDef] = [{"imageDigest": "image0"}] + image_ids: list[ImageIdentifierTypeDef] = [{"imageDigest": "image0"}] repo_name = "test-repo" stubber.add_response( @@ -62,7 +60,7 @@ def test_delete_ecr_images_failures() -> None: {"repositoryName": repo_name, "imageIds": image_ids}, ) - with stubber, pytest.raises(ValueError): + with stubber, pytest.raises(ValueError): # noqa: PT011 delete_ecr_images(client, image_ids=image_ids, repository_name=repo_name) @@ -109,9 +107,7 @@ def test_list_ecr_images_repository_not_found() -> None: assert list_ecr_images(client, repository_name="test-repo") == [] -def test_purge_repository( - cfngin_context: MockCFNginContext, mocker: MockerFixture -) -> None: +def test_purge_repository(cfngin_context: MockCfnginContext, mocker: MockerFixture) -> None: """Test purge_repository.""" mock_list_ecr_images = mocker.patch( MODULE + ".list_ecr_images", return_value=[{"imageDigest": "abc123"}] @@ -121,18 +117,14 @@ def test_purge_repository( client = cfngin_context.get_session().client("ecr") repo_name = "test-repo" - assert purge_repository(cfngin_context, repository_name=repo_name) == { - "status": "success" - } + assert purge_repository(cfngin_context, repository_name=repo_name) == {"status": "success"} mock_list_ecr_images.assert_called_once_with(client, repository_name=repo_name) mock_delete_ecr_images.assert_called_once_with( client, image_ids=mock_list_ecr_images.return_value, repository_name=repo_name ) -def test_purge_repository_skip( - cfngin_context: MockCFNginContext, mocker: MockerFixture -) -> None: +def test_purge_repository_skip(cfngin_context: MockCfnginContext, mocker: MockerFixture) -> None: """Test purge_repository.""" mock_list_ecr_images = mocker.patch(MODULE + ".list_ecr_images", return_value=[]) mock_delete_ecr_images = mocker.patch(MODULE + ".delete_ecr_images") @@ -140,8 +132,6 @@ def test_purge_repository_skip( client = cfngin_context.get_session().client("ecr") repo_name = "test-repo" - assert purge_repository(cfngin_context, repository_name=repo_name) == { - "status": "skipped" - } + assert purge_repository(cfngin_context, repository_name=repo_name) == {"status": "skipped"} mock_list_ecr_images.assert_called_once_with(client, repository_name=repo_name) mock_delete_ecr_images.assert_not_called() diff --git a/tests/unit/cfngin/hooks/ssm/conftest.py b/tests/unit/cfngin/hooks/ssm/conftest.py index 6379955c0..3701e1e3a 100644 --- a/tests/unit/cfngin/hooks/ssm/conftest.py +++ b/tests/unit/cfngin/hooks/ssm/conftest.py @@ -1,9 +1,8 @@ """Pytest fixtures and plugins.""" -# pylint: disable=redefined-outer-name,unused-argument from __future__ import annotations -from typing import TYPE_CHECKING, cast +from typing import TYPE_CHECKING import pytest @@ -11,16 +10,18 @@ from botocore.stub import Stubber from mypy_boto3_ssm.client import SSMClient - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext -@pytest.fixture(scope="function") -def ssm_client(cfngin_context: MockCFNginContext, ssm_stubber: Stubber) -> SSMClient: +@pytest.fixture() +def ssm_client( + cfngin_context: MockCfnginContext, ssm_stubber: Stubber # noqa: ARG001 +) -> SSMClient: """Create SSM client.""" - return cast("SSMClient", cfngin_context.get_session().client("ssm")) + return cfngin_context.get_session().client("ssm") -@pytest.fixture(scope="function") -def ssm_stubber(cfngin_context: MockCFNginContext) -> Stubber: +@pytest.fixture() +def ssm_stubber(cfngin_context: MockCfnginContext) -> Stubber: """Create SSM stubber.""" return cfngin_context.add_stubber("ssm") diff --git a/tests/unit/cfngin/hooks/ssm/test_parameter.py b/tests/unit/cfngin/hooks/ssm/test_parameter.py index e9a4353a7..04a1f3535 100644 --- a/tests/unit/cfngin/hooks/ssm/test_parameter.py +++ b/tests/unit/cfngin/hooks/ssm/test_parameter.py @@ -17,7 +17,6 @@ if TYPE_CHECKING: from botocore.stub import Stubber from mypy_boto3_ssm.client import SSMClient - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from runway.context import CfnginContext @@ -97,16 +96,12 @@ def test_tags_dict(self) -> None: def test_tags_raise_type_error(self) -> None: """Test tags.""" with pytest.raises(ValidationError, match="Tags"): - assert not ArgsDataModel.parse_obj( - {"name": "test", "tags": "", "type": "String"} - ) + assert not ArgsDataModel.parse_obj({"name": "test", "tags": "", "type": "String"}) def test_tier_invalid(self) -> None: """Test tier.""" with pytest.raises(ValidationError, match="Tier\n unexpected value"): - ArgsDataModel.parse_obj( - {"name": "test", "tier": "invalid", "type": "String"} - ) + ArgsDataModel.parse_obj({"name": "test", "tier": "invalid", "type": "String"}) def test_type_invalid(self) -> None: """Test name.""" @@ -122,9 +117,7 @@ def test_type_required(self) -> None: class TestParameter: """Test Parameter.""" - def test___init__( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test___init__(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test __init__.""" args = mocker.patch(f"{MODULE}.ArgsDataModel") args.parse_obj.return_value = args @@ -132,9 +125,7 @@ def test___init__( obj = Parameter(cfngin_context, name="test", type="String", **data) assert obj.args == args assert obj.ctx == cfngin_context - args.parse_obj.assert_called_once_with( - {"name": "test", "type": "String", **data} - ) + args.parse_obj.assert_called_once_with({"name": "test", "type": "String", **data}) def test_client( self, @@ -144,13 +135,11 @@ def test_client( ) -> None: """Test client.""" mocker.patch(f"{MODULE}.ArgsDataModel") - assert ( - Parameter(cfngin_context, name="test", type="String").client == ssm_client - ) + assert Parameter(cfngin_context, name="test", type="String").client == ssm_client def test_delete( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, ssm_stubber: Stubber, ) -> None: @@ -164,7 +153,7 @@ def test_delete( def test_delete_handle_parameter_not_found( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, ssm_stubber: Stubber, ) -> None: @@ -226,14 +215,11 @@ def test_get_force( }, ) with ssm_stubber: - assert ( - Parameter(cfngin_context, force=True, name="test", type="String").get() - == {} - ) + assert Parameter(cfngin_context, force=True, name="test", type="String").get() == {} def test_get_handle_parameter_not_found( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, ssm_stubber: Stubber, ) -> None: @@ -256,9 +242,7 @@ def test_get_raise_client_error( assert not Parameter(cfngin_context, name="test", type="String").get() ssm_stubber.assert_no_pending_responses() - def test_get_current_tags( - self, cfngin_context: CfnginContext, ssm_stubber: Stubber - ) -> None: + def test_get_current_tags(self, cfngin_context: CfnginContext, ssm_stubber: Stubber) -> None: """Test get_current_tags.""" data = [{"Key": "test-key", "Value": "test-val"}] ssm_stubber.add_response( @@ -267,10 +251,7 @@ def test_get_current_tags( {"ResourceId": "test", "ResourceType": "Parameter"}, ) with ssm_stubber: - assert ( - Parameter(cfngin_context, name="test", type="String").get_current_tags() - == data - ) + assert Parameter(cfngin_context, name="test", type="String").get_current_tags() == data ssm_stubber.assert_no_pending_responses() def test_get_current_tags_empty( @@ -279,10 +260,7 @@ def test_get_current_tags_empty( """Test get_current_tags.""" ssm_stubber.add_response("list_tags_for_resource", {}) with ssm_stubber: - assert ( - Parameter(cfngin_context, name="test", type="String").get_current_tags() - == [] - ) + assert Parameter(cfngin_context, name="test", type="String").get_current_tags() == [] ssm_stubber.assert_no_pending_responses() def test_get_current_tags_handle_invalid_resource_id( @@ -291,10 +269,7 @@ def test_get_current_tags_handle_invalid_resource_id( """Test get_current_tags.""" ssm_stubber.add_client_error("list_tags_for_resource", "InvalidResourceId") with ssm_stubber: - assert ( - Parameter(cfngin_context, name="test", type="String").get_current_tags() - == [] - ) + assert Parameter(cfngin_context, name="test", type="String").get_current_tags() == [] ssm_stubber.assert_no_pending_responses() def test_get_current_tags_handle_parameter_not_found( @@ -303,10 +278,7 @@ def test_get_current_tags_handle_parameter_not_found( """Test get_current_tags.""" ssm_stubber.add_client_error("list_tags_for_resource", "ParameterNotFound") with ssm_stubber: - assert ( - Parameter(cfngin_context, name="test", type="String").get_current_tags() - == [] - ) + assert Parameter(cfngin_context, name="test", type="String").get_current_tags() == [] ssm_stubber.assert_no_pending_responses() def test_get_current_tags_raise_client_error( @@ -315,19 +287,13 @@ def test_get_current_tags_raise_client_error( """Test get_current_tags.""" ssm_stubber.add_client_error("list_tags_for_resource") with ssm_stubber, pytest.raises(ClientError): - assert Parameter( - cfngin_context, name="test", type="String" - ).get_current_tags() + assert Parameter(cfngin_context, name="test", type="String").get_current_tags() ssm_stubber.assert_no_pending_responses() - def test_post_deploy( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_post_deploy(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test post_deploy.""" mock_put = mocker.patch.object(Parameter, "put", return_value="success") - mock_update_tags = mocker.patch.object( - Parameter, "update_tags", return_value=None - ) + mock_update_tags = mocker.patch.object(Parameter, "update_tags", return_value=None) assert ( Parameter(cfngin_context, name="test", type="String").post_deploy() == mock_put.return_value @@ -335,9 +301,7 @@ def test_post_deploy( mock_put.assert_called_once_with() mock_update_tags.assert_called_once_with() - def test_post_destroy( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_post_destroy(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test post_destroy.""" mock_delete = mocker.patch.object(Parameter, "delete", return_value="success") assert ( @@ -346,14 +310,10 @@ def test_post_destroy( ) mock_delete.assert_called_once_with() - def test_pre_deploy( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_pre_deploy(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test pre_deploy.""" mock_put = mocker.patch.object(Parameter, "put", return_value="success") - mock_update_tags = mocker.patch.object( - Parameter, "update_tags", return_value=None - ) + mock_update_tags = mocker.patch.object(Parameter, "update_tags", return_value=None) assert ( Parameter(cfngin_context, name="test", type="String").pre_deploy() == mock_put.return_value @@ -361,9 +321,7 @@ def test_pre_deploy( mock_put.assert_called_once_with() mock_update_tags.assert_called_once_with() - def test_pre_destroy( - self, cfngin_context: CfnginContext, mocker: MockerFixture - ) -> None: + def test_pre_destroy(self, cfngin_context: CfnginContext, mocker: MockerFixture) -> None: """Test pre_destroy.""" mock_delete = mocker.patch.object(Parameter, "delete", return_value="success") assert ( @@ -374,7 +332,7 @@ def test_pre_destroy( def test_put( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, mocker: MockerFixture, ssm_stubber: Stubber, @@ -411,7 +369,7 @@ def test_put( def test_put_handle_parameter_already_exists( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, mocker: MockerFixture, ssm_stubber: Stubber, @@ -423,8 +381,7 @@ def test_put_handle_parameter_already_exists( ssm_stubber.add_client_error("put_parameter", "ParameterAlreadyExists") with ssm_stubber: assert ( - Parameter(cfngin_context, name="test", type="String", value="foo").put() - == expected + Parameter(cfngin_context, name="test", type="String", value="foo").put() == expected ) assert ( "parameter test already exists; to overwrite it's value, " @@ -433,18 +390,16 @@ def test_put_handle_parameter_already_exists( def test_put_no_value( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, ) -> None: """Test put.""" caplog.set_level(LogLevels.INFO, MODULE) - assert Parameter( - cfngin_context, name="test", type="String", value=None - ).put() == {"Tier": "Standard", "Version": 0} - assert ( - "skipped putting SSM Parameter; value provided for test is falsy" - in caplog.messages - ) + assert Parameter(cfngin_context, name="test", type="String", value=None).put() == { + "Tier": "Standard", + "Version": 0, + } + assert "skipped putting SSM Parameter; value provided for test is falsy" in caplog.messages def test_put_raise_client_error( self, cfngin_context: CfnginContext, mocker: MockerFixture, ssm_stubber: Stubber @@ -457,9 +412,7 @@ def test_put_raise_client_error( ) ssm_stubber.add_client_error("put_parameter") with ssm_stubber, pytest.raises(ClientError): - assert not Parameter( - cfngin_context, name="test", type="String", value="foo" - ).put() + assert not Parameter(cfngin_context, name="test", type="String", value="foo").put() def test_put_same_value( self, @@ -473,10 +426,7 @@ def test_put_same_value( "get", return_value={"Value": "foo", **expected}, ) - assert ( - Parameter(cfngin_context, name="test", type="String", value="foo").put() - == expected - ) + assert Parameter(cfngin_context, name="test", type="String", value="foo").put() == expected mock_get.assert_called_once_with() def test_update_tags( @@ -570,9 +520,7 @@ def test_update_tags_delete_only( ) ssm_stubber.add_client_error("add_tags_to_resource") with ssm_stubber: - assert not Parameter( - cfngin_context, name="test", type="String" - ).update_tags() + assert not Parameter(cfngin_context, name="test", type="String").update_tags() def test_update_tags_delete_only_raise_client_error( self, cfngin_context: CfnginContext, mocker: MockerFixture, ssm_stubber: Stubber @@ -590,7 +538,7 @@ def test_update_tags_delete_only_raise_client_error( def test_update_tags_handle_invalid_resource_id( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, cfngin_context: CfnginContext, mocker: MockerFixture, ssm_stubber: Stubber, diff --git a/tests/unit/cfngin/hooks/staticsite/auth_at_edge/test_user_pool_id_retriever.py b/tests/unit/cfngin/hooks/staticsite/auth_at_edge/test_user_pool_id_retriever.py index a622ac36e..ea7060e21 100644 --- a/tests/unit/cfngin/hooks/staticsite/auth_at_edge/test_user_pool_id_retriever.py +++ b/tests/unit/cfngin/hooks/staticsite/auth_at_edge/test_user_pool_id_retriever.py @@ -20,9 +20,7 @@ ), ], ) -def test_hook_args_parse_obj( - provided: dict[str, str], expected: dict[str, str] -) -> None: +def test_hook_args_parse_obj(provided: dict[str, str], expected: dict[str, str]) -> None: """Test HookArgs.parse_obj.""" kwargs = provided args = HookArgs.parse_obj(kwargs) diff --git a/tests/unit/cfngin/hooks/staticsite/test_cleanup.py b/tests/unit/cfngin/hooks/staticsite/test_cleanup.py index 98881c4a4..8e9b1aec6 100644 --- a/tests/unit/cfngin/hooks/staticsite/test_cleanup.py +++ b/tests/unit/cfngin/hooks/staticsite/test_cleanup.py @@ -16,10 +16,9 @@ if TYPE_CHECKING: from mypy_boto3_cloudformation.type_defs import OutputTypeDef - from pytest import LogCaptureFixture from pytest_mock import MockerFixture - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext MODULE = "runway.cfngin.hooks.staticsite.cleanup" @@ -29,24 +28,19 @@ [ ([], []), ( - [ - {"OutputKey": i, "OutputValue": f"{i}Val"} - for i in REPLICATED_FUNCTION_OUTPUTS - ] + [{"OutputKey": i, "OutputValue": f"{i}Val"} for i in REPLICATED_FUNCTION_OUTPUTS] + [{"OutputKey": "foo", "OutputValue": "bar"}], [f"{i}Val" for i in REPLICATED_FUNCTION_OUTPUTS], ), ], ) -def test_get_replicated_function_names( - expected: list[str], outputs: list[OutputTypeDef] -) -> None: +def test_get_replicated_function_names(expected: list[str], outputs: list[OutputTypeDef]) -> None: """Test get_replicated_function_names.""" assert get_replicated_function_names(outputs) == expected def test_warn( - caplog: LogCaptureFixture, cfngin_context: MockCFNginContext, mocker: MockerFixture + caplog: pytest.LogCaptureFixture, cfngin_context: MockCfnginContext, mocker: MockerFixture ) -> None: """Test warn.""" caplog.set_level(LogLevels.WARNING, MODULE) @@ -81,7 +75,7 @@ def test_warn( def test_warn_ignore_client_error( - caplog: LogCaptureFixture, cfngin_context: MockCFNginContext + caplog: pytest.LogCaptureFixture, cfngin_context: MockCfnginContext ) -> None: """Test warn ignore ClientError.""" caplog.set_level(LogLevels.WARNING, MODULE) diff --git a/tests/unit/cfngin/hooks/staticsite/test_upload_staticsite.py b/tests/unit/cfngin/hooks/staticsite/test_upload_staticsite.py index 3bbdefc65..1e9a1a9d9 100644 --- a/tests/unit/cfngin/hooks/staticsite/test_upload_staticsite.py +++ b/tests/unit/cfngin/hooks/staticsite/test_upload_staticsite.py @@ -20,7 +20,7 @@ from runway.module.staticsite.options.models import RunwayStaticSiteExtraFileDataModel if TYPE_CHECKING: - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext @pytest.mark.parametrize( @@ -88,9 +88,7 @@ def test_get_content_yaml() -> None: content = {"a": 0} actual = get_content( - RunwayStaticSiteExtraFileDataModel( - content_type="text/yaml", content=content, name="" - ) + RunwayStaticSiteExtraFileDataModel(content_type="text/yaml", content=content, name="") ) expected = yaml.safe_dump(content) @@ -99,7 +97,7 @@ def test_get_content_yaml() -> None: def test_get_content_unknown() -> None: """Get content unknown.""" - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 get_content(RunwayStaticSiteExtraFileDataModel(content={"a": 0}, name="")) @@ -133,7 +131,7 @@ def test_calculate_hash_of_extra_files( assert calculate_hash_of_extra_files([a]) != calculate_hash_of_extra_files([b]) -def test_sync_extra_files_json_content(cfngin_context: MockCFNginContext) -> None: +def test_sync_extra_files_json_content(cfngin_context: MockCfnginContext) -> None: """Test sync_extra_files json content is put in s3.""" s3_stub = cfngin_context.add_stubber("s3") @@ -153,13 +151,11 @@ def test_sync_extra_files_json_content(cfngin_context: MockCFNginContext) -> Non files = [RunwayStaticSiteExtraFileDataModel(name="test.json", content=content)] with s3_stub as stub: - assert sync_extra_files(cfngin_context, "bucket", extra_files=files) == [ - "test.json" - ] + assert sync_extra_files(cfngin_context, "bucket", extra_files=files) == ["test.json"] stub.assert_no_pending_responses() -def test_sync_extra_files_yaml_content(cfngin_context: MockCFNginContext) -> None: +def test_sync_extra_files_yaml_content(cfngin_context: MockCfnginContext) -> None: """Test sync_extra_files yaml content is put in s3.""" s3_stub = cfngin_context.add_stubber("s3") @@ -176,18 +172,14 @@ def test_sync_extra_files_yaml_content(cfngin_context: MockCFNginContext) -> Non }, ) - files = [ - RunwayStaticSiteExtraFileDataModel.construct(name="test.yaml", content=content) - ] + files = [RunwayStaticSiteExtraFileDataModel.construct(name="test.yaml", content=content)] with s3_stub as stub: - assert sync_extra_files(cfngin_context, "bucket", extra_files=files) == [ - "test.yaml" - ] + assert sync_extra_files(cfngin_context, "bucket", extra_files=files) == ["test.yaml"] stub.assert_no_pending_responses() -def test_sync_extra_files_empty_content(cfngin_context: MockCFNginContext) -> None: +def test_sync_extra_files_empty_content(cfngin_context: MockCfnginContext) -> None: """Test sync_extra_files empty content is not uploaded.""" s3_stub = cfngin_context.add_stubber("s3") @@ -196,9 +188,7 @@ def test_sync_extra_files_empty_content(cfngin_context: MockCFNginContext) -> No cfngin_context, "bucket", extra_files=[ - RunwayStaticSiteExtraFileDataModel.construct( - name="test.yaml", content="" - ) + RunwayStaticSiteExtraFileDataModel.construct(name="test.yaml", content="") ], ) assert isinstance(result, list) @@ -206,7 +196,7 @@ def test_sync_extra_files_empty_content(cfngin_context: MockCFNginContext) -> No stub.assert_no_pending_responses() -def test_sync_extra_files_file_reference(cfngin_context: MockCFNginContext) -> None: +def test_sync_extra_files_file_reference(cfngin_context: MockCfnginContext) -> None: """Test sync_extra_files file is uploaded.""" s3_stub = cfngin_context.add_stubber("s3") @@ -224,9 +214,7 @@ def test_sync_extra_files_file_reference(cfngin_context: MockCFNginContext) -> N }, ) - files = [ - RunwayStaticSiteExtraFileDataModel.construct(name="test", file=".gitignore") - ] + files = [RunwayStaticSiteExtraFileDataModel.construct(name="test", file=".gitignore")] with s3_stub as stub: assert sync_extra_files(cfngin_context, "bucket", extra_files=files) == ["test"] @@ -234,7 +222,7 @@ def test_sync_extra_files_file_reference(cfngin_context: MockCFNginContext) -> N def test_sync_extra_files_file_reference_with_content_type( - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, ) -> None: """Test sync_extra_files file is uploaded with the content type.""" s3_stub = cfngin_context.add_stubber("s3") @@ -250,20 +238,14 @@ def test_sync_extra_files_file_reference_with_content_type( }, ) - files = [ - RunwayStaticSiteExtraFileDataModel.construct( - name="test.json", file=".gitignore" - ) - ] + files = [RunwayStaticSiteExtraFileDataModel.construct(name="test.json", file=".gitignore")] with s3_stub as stub: - assert sync_extra_files(cfngin_context, "bucket", extra_files=files) == [ - "test.json" - ] + assert sync_extra_files(cfngin_context, "bucket", extra_files=files) == ["test.json"] stub.assert_no_pending_responses() -def test_sync_extra_files_hash_unchanged(cfngin_context: MockCFNginContext) -> None: +def test_sync_extra_files_hash_unchanged(cfngin_context: MockCfnginContext) -> None: """Test sync_extra_files upload is skipped if the has was unchanged.""" s3_stub = cfngin_context.add_stubber("s3") ssm_stub = cfngin_context.add_stubber("ssm") @@ -290,7 +272,7 @@ def test_sync_extra_files_hash_unchanged(cfngin_context: MockCFNginContext) -> N ssm_stub.assert_no_pending_responses() -def test_sync_extra_files_hash_updated(cfngin_context: MockCFNginContext) -> None: +def test_sync_extra_files_hash_updated(cfngin_context: MockCfnginContext) -> None: """Test sync_extra_files extra files hash is updated.""" s3_stub = cfngin_context.add_stubber("s3") ssm_stub = cfngin_context.add_stubber("ssm") @@ -324,7 +306,7 @@ def test_sync_extra_files_hash_updated(cfngin_context: MockCFNginContext) -> Non { "Bucket": "bucket", "Key": "test", - "Body": "test".encode(), + "Body": b"test", "ContentType": "text/plain", }, ) diff --git a/tests/unit/cfngin/hooks/staticsite/test_utils.py b/tests/unit/cfngin/hooks/staticsite/test_utils.py index 1a97b9eaa..c8829be4a 100644 --- a/tests/unit/cfngin/hooks/staticsite/test_utils.py +++ b/tests/unit/cfngin/hooks/staticsite/test_utils.py @@ -2,11 +2,11 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Dict, List, Optional, Union, cast +from typing import TYPE_CHECKING, Optional, Union, cast +from unittest.mock import Mock, call import igittigitt import pytest -from mock import Mock, call from runway.cfngin.hooks.staticsite.utils import ( calculate_hash_of_files, @@ -29,10 +29,7 @@ def test_calculate_hash_of_files(mocker: MockerFixture, tmp_path: Path) -> None: file0 = tmp_path / "nested" / "file0.txt" file1 = tmp_path / "file1.txt" - assert ( - calculate_hash_of_files([file0, file1], tmp_path) - == mock_file_hash_obj.hexdigest - ) + assert calculate_hash_of_files([file0, file1], tmp_path) == mock_file_hash_obj.hexdigest mock_file_hash_obj.add_files.assert_called_once_with( [str(file1), str(file0)], relative_to=tmp_path ) @@ -42,7 +39,7 @@ def test_calculate_hash_of_files(mocker: MockerFixture, tmp_path: Path) -> None: "directories", [None, [{"path": "./"}], [{"path": "./", "exclusions": ["foobar"]}]] ) def test_get_hash_of_files( - directories: Optional[List[Dict[str, Union[List[str], str]]]], + directories: Optional[list[dict[str, Union[list[str], str]]]], mocker: MockerFixture, tmp_path: Path, ) -> None: @@ -74,10 +71,7 @@ def test_get_hash_of_files( gitignore.add_rule("exclude/", tmp_path) if directories: - assert ( - get_hash_of_files(tmp_path, directories) - == mock_calculate_hash_of_files.return_value - ) + assert get_hash_of_files(tmp_path, directories) == mock_calculate_hash_of_files.return_value else: assert get_hash_of_files(tmp_path) == mock_calculate_hash_of_files.return_value mock_get_ignorer.assert_has_calls( @@ -91,7 +85,7 @@ def test_get_hash_of_files( @pytest.mark.parametrize("additional_exclusions", [None, [], ["foo"], ["foo", "bar"]]) def test_get_ignorer( - additional_exclusions: Optional[List[str]], mocker: MockerFixture, tmp_path: Path + additional_exclusions: Optional[list[str]], mocker: MockerFixture, tmp_path: Path ) -> None: """Test get_ignorer.""" ignore_parser = mocker.patch(f"{MODULE}.igittigitt.IgnoreParser") @@ -103,8 +97,6 @@ def test_get_ignorer( ignore_parser.parse_rule_files.assert_called_once_with(tmp_path) if additional_exclusions: - ignore_parser.add_rule.assert_has_calls( - [call(i, tmp_path) for i in additional_exclusions] - ) + ignore_parser.add_rule.assert_has_calls([call(i, tmp_path) for i in additional_exclusions]) else: ignore_parser.add_rule.assert_not_called() diff --git a/tests/unit/cfngin/hooks/test_acm.py b/tests/unit/cfngin/hooks/test_acm.py index 5dd431a05..9f2d095d5 100644 --- a/tests/unit/cfngin/hooks/test_acm.py +++ b/tests/unit/cfngin/hooks/test_acm.py @@ -1,20 +1,18 @@ """Tests for runway.cfngin.hooks.acm.""" -# pylint: disable=protected-access,unused-argument -# pyright: basic, reportUnknownArgumentType=none, reportUnknownVariableType=none +# pyright: reportUnknownArgumentType=none, reportUnknownVariableType=none # pyright: reportUnknownLambdaType=none from __future__ import annotations from datetime import datetime -from typing import TYPE_CHECKING, Any, Dict, NoReturn, Union, cast +from typing import TYPE_CHECKING, Any, Literal, NoReturn, cast +from unittest.mock import MagicMock import boto3 import pytest from botocore.exceptions import ClientError from botocore.stub import ANY, Stubber -from mock import MagicMock from troposphere.certificatemanager import Certificate as CertificateResource -from typing_extensions import Literal from runway.cfngin.exceptions import ( StackDoesNotExist, @@ -34,21 +32,24 @@ ChangeTypeDef, ResourceRecordSetTypeDef, ) - from pytest import MonkeyPatch - from ...factories import MockCFNginContext + from ...factories import MockCfnginContext STATUS = MutableMap( - **{ - "failed": FAILED, - "new": SubmittedStatus("creating new stack"), - "no": NO_CHANGE, - "recreate": SubmittedStatus("destroying stack for re-creation"), - "update": SubmittedStatus("updating existing stack"), - } + failed=FAILED, + new=SubmittedStatus("creating new stack"), + no=NO_CHANGE, + recreate=SubmittedStatus("destroying stack for re-creation"), + update=SubmittedStatus("updating existing stack"), ) +@pytest.fixture(autouse=True) +def sub_s3(cfngin_context: MockCfnginContext) -> None: + """Sub s3 for MockCfnginContext as this hook uses a ``cached_property`` that creates it.""" + cfngin_context.add_stubber("s3") + + def check_bool_is_true(val: Any) -> bool: """Check if a value is a true bool.""" if val and isinstance(val, bool): @@ -63,7 +64,7 @@ def check_bool_is_false(val: Any) -> bool: raise ValueError(f'Value should be "False"; got {val}') -def gen_certificate(**kwargs: Any) -> Dict[str, Any]: +def gen_certificate(**kwargs: Any) -> dict[str, Any]: """Generate a response to describe_certificate.""" data = { "CertificateArn": kwargs.pop("CertificateArn"), @@ -81,7 +82,7 @@ def gen_change( return {"Action": action, "ResourceRecordSet": record_set} -def gen_change_batch(changes: Any = ANY, comment: Any = ANY) -> Dict[str, Any]: +def gen_change_batch(changes: Any = ANY, comment: Any = ANY) -> dict[str, Any]: """Generate expected change batch.""" return {"Comment": comment, "Changes": changes} @@ -119,9 +120,9 @@ def gen_domain_validation_option(**kwargs: Any) -> DomainValidationTypeDef: def gen_record_set( use_resource_record: bool = False, **kwargs: Any -) -> Union[ResourceRecordSetTypeDef, ResourceRecordTypeDef]: +) -> ResourceRecordSetTypeDef | ResourceRecordTypeDef: """Generate a record set.""" - data: Dict[str, Any] = { + data: dict[str, Any] = { "Name": "placeholder_name", "Type": "CNAME", "Value": "placeholder_value", @@ -152,11 +153,11 @@ def gen_stack_resource(**kwargs: Any) -> StackResourceTypeDef: class TestCertificate: """Tests for runway.cfngin.hooks.acm.Certificate.""" - def test_attributes(self, cfngin_context: MockCFNginContext) -> None: + def test_attributes(self, cfngin_context: MockCfnginContext) -> None: """Test attributes set during __init__.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" result = Certificate( @@ -177,6 +178,7 @@ def test_attributes(self, cfngin_context: MockCFNginContext) -> None: assert result.properties["ValidationMethod"] == "DNS" # blueprint attributes + assert result.blueprint assert result.blueprint.VARIABLES["DomainName"] assert result.blueprint.VARIABLES["ValidateRecordTTL"] @@ -187,9 +189,7 @@ def test_attributes(self, cfngin_context: MockCFNginContext) -> None: assert not template.conditions assert not template.mappings assert template.outputs["DomainName"].Value.to_dict() == {"Ref": "DomainName"} - assert template.outputs["ValidateRecordTTL"].Value.to_dict() == { - "Ref": "ValidateRecordTTL" - } + assert template.outputs["ValidateRecordTTL"].Value.to_dict() == {"Ref": "ValidateRecordTTL"} assert not template.parameters assert isinstance(template.resources["Certificate"], CertificateResource) assert not template.rules @@ -197,14 +197,15 @@ def test_attributes(self, cfngin_context: MockCFNginContext) -> None: assert not template.transform # stack attributes + assert result.stack assert result.stack.fqn == "test-stack-name" - assert result.stack._blueprint == result.blueprint + assert result.stack.blueprint == result.blueprint # type: ignore - def test_domain_changed(self, cfngin_context: MockCFNginContext) -> None: + def test_domain_changed(self, cfngin_context: MockCfnginContext) -> None: """Test for domain_changed.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" provider = MagicMock() @@ -245,12 +246,12 @@ def test_domain_changed(self, cfngin_context: MockCFNginContext) -> None: assert not cert.domain_changed() def test_get_certificate( - self, cfngin_context: MockCFNginContext, patch_time: None + self, cfngin_context: MockCfnginContext, mock_sleep: None # noqa: ARG002 ) -> None: """Test get_certificate.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" provider = MagicMock(cloudformation=boto3.client("cloudformation")) @@ -290,22 +291,20 @@ def test_get_certificate( @pytest.mark.parametrize("status", ["PENDING_VALIDATION", "SUCCESS", "FAILED"]) def test_get_validation_record( self, - cfngin_context: MockCFNginContext, - monkeypatch: MonkeyPatch, - patch_time: None, + cfngin_context: MockCfnginContext, + monkeypatch: pytest.MonkeyPatch, + mock_sleep: None, # noqa: ARG002 status: str, ) -> None: """Test get_validation_record.""" # setup context - acm_stubber = cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + acm_stubber = cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert_arn = "arn:aws:acm:us-east-1:012345678901:certificate/test" expected_request = {"CertificateArn": cert_arn} - validate_option_missing_record = gen_domain_validation_option( - ValidationStatus=status - ) + validate_option_missing_record = gen_domain_validation_option(ValidationStatus=status) del validate_option_missing_record["ResourceRecord"] cert = Certificate( @@ -333,17 +332,15 @@ def test_get_validation_record( "describe_certificate", gen_certificate( CertificateArn=cert_arn, - DomainValidationOptions=[ - gen_domain_validation_option(ValidationStatus=status) - ], + DomainValidationOptions=[gen_domain_validation_option(ValidationStatus=status)], ), expected_request, ) with acm_stubber: - assert cert.get_validation_record( - status=status - ) == gen_domain_validation_option().get("ResourceRecord") + assert cert.get_validation_record(status=status) == gen_domain_validation_option().get( + "ResourceRecord" + ) acm_stubber.assert_no_pending_responses() @pytest.mark.parametrize( @@ -355,12 +352,12 @@ def test_get_validation_record( ], ) def test_get_validation_record_status_mismatch( - self, cfngin_context: MockCFNginContext, check: str, found: str + self, cfngin_context: MockCfnginContext, check: str, found: str ) -> None: """Test get get_validation_record with a mismatched record status.""" # setup context - acm_stubber = cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + acm_stubber = cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert_arn = "arn:aws:acm:us-east-1:012345678901:certificate/test" @@ -377,26 +374,20 @@ def test_get_validation_record_status_mismatch( "describe_certificate", gen_certificate( CertificateArn=cert_arn, - DomainValidationOptions=[ - gen_domain_validation_option(ValidationStatus=found) - ], + DomainValidationOptions=[gen_domain_validation_option(ValidationStatus=found)], ), expected_request, ) - with acm_stubber, pytest.raises(ValueError) as excinfo: + with acm_stubber, pytest.raises(ValueError, match="No validations with status"): cert.get_validation_record(cert_arn=cert_arn, status=check) - - assert "No validations with status" in str(excinfo.value) acm_stubber.assert_no_pending_responses() - def test_get_validation_record_gt_one( - self, cfngin_context: MockCFNginContext - ) -> None: + def test_get_validation_record_gt_one(self, cfngin_context: MockCfnginContext) -> None: """Test get get_validation_record more than one result.""" # setup context - acm_stubber = cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + acm_stubber = cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert_arn = "arn:aws:acm:us-east-1:012345678901:certificate/test" @@ -421,17 +412,18 @@ def test_get_validation_record_gt_one( expected_request, ) - with acm_stubber, pytest.raises(ValueError) as excinfo: + with ( + acm_stubber, + pytest.raises(ValueError, match="only one option is supported"), + ): cert.get_validation_record(cert_arn=cert_arn) - - assert "only one option is supported" in str(excinfo.value) acm_stubber.assert_no_pending_responses() - def test_put_record_set(self, cfngin_context: MockCFNginContext) -> None: + def test_put_record_set(self, cfngin_context: MockCfnginContext) -> None: """Test put_record.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - r53_stubber = cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + r53_stubber = cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert = Certificate( @@ -451,9 +443,7 @@ def test_put_record_set(self, cfngin_context: MockCFNginContext) -> None: gen_change( record_set=cast( "ResourceRecordSetTypeDef", - gen_record_set( - use_resource_record=True, TTL=cert.args.ttl - ), + gen_record_set(use_resource_record=True, TTL=cert.args.ttl), ) ) ] @@ -462,18 +452,16 @@ def test_put_record_set(self, cfngin_context: MockCFNginContext) -> None: ) with r53_stubber: - assert not cert.put_record_set( - cast("ResourceRecordTypeDef", gen_record_set()) - ) + assert not cert.put_record_set(cast("ResourceRecordTypeDef", gen_record_set())) r53_stubber.assert_no_pending_responses() def test_remove_validation_records( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test remove_validation_records.""" # setup context - acm_stubber = cfngin_context.add_stubber("acm", "us-east-1") - r53_stubber = cfngin_context.add_stubber("route53", "us-east-1") + acm_stubber = cfngin_context.add_stubber("acm", region="us-east-1") + r53_stubber = cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert_arn = "arn:aws:acm:us-east-1:012345678901:certificate/test" @@ -499,9 +487,7 @@ def test_remove_validation_records( "describe_certificate", gen_certificate( CertificateArn=cert_arn, - DomainValidationOptions=[ - gen_domain_validation_option(ValidationMethod="EMAIL") - ], + DomainValidationOptions=[gen_domain_validation_option(ValidationMethod="EMAIL")], ), expected_cert_request, ) @@ -520,9 +506,7 @@ def test_remove_validation_records( gen_record_set( use_resource_record=True, TTL=cert.args.ttl, - **gen_domain_validation_option().get( - "ResourceRecord", {} - ), + **gen_domain_validation_option().get("ResourceRecord", {}), ), ), ) @@ -531,19 +515,22 @@ def test_remove_validation_records( }, ) - with acm_stubber, r53_stubber, pytest.raises(ValueError) as excinfo: + with ( # noqa: PT012 + acm_stubber, + r53_stubber, + pytest.raises(ValueError, match="Must provide one of more record sets"), + ): assert not cert.remove_validation_records() cert.remove_validation_records() acm_stubber.assert_no_pending_responses() r53_stubber.assert_no_pending_responses() - assert str(excinfo.value) == "Must provide one of more record sets" - def test_update_record_set(self, cfngin_context: MockCFNginContext) -> None: + def test_update_record_set(self, cfngin_context: MockCfnginContext) -> None: """Test update_record_set.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - r53_stubber = cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + r53_stubber = cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert = Certificate( @@ -564,9 +551,7 @@ def test_update_record_set(self, cfngin_context: MockCFNginContext) -> None: action="UPSERT", record_set=cast( "ResourceRecordSetTypeDef", - gen_record_set( - use_resource_record=True, TTL=cert.args.ttl - ), + gen_record_set(use_resource_record=True, TTL=cert.args.ttl), ), ) ] @@ -575,18 +560,16 @@ def test_update_record_set(self, cfngin_context: MockCFNginContext) -> None: ) with r53_stubber: - assert not cert.update_record_set( - cast("ResourceRecordTypeDef", gen_record_set()) - ) + assert not cert.update_record_set(cast("ResourceRecordTypeDef", gen_record_set())) r53_stubber.assert_no_pending_responses() def test_deploy( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test deploy.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert_arn = "arn:aws:acm:us-east-1:012345678901:certificate/test" @@ -611,17 +594,17 @@ def test_deploy( "put_record_set", lambda x: None if x == "get_validation_record" else ValueError, ) - monkeypatch.setattr(cert, "_wait_for_stack", lambda x, last_status: None) + monkeypatch.setattr(cert, "_wait_for_stack", lambda _, last_status: None) # noqa: ARG005 assert cert.deploy() == expected def test_deploy_update( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test deploy update stack.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert_arn = "arn:aws:acm:us-east-1:012345678901:certificate/test" @@ -640,9 +623,7 @@ def test_deploy_update( cert, "get_validation_record", lambda x, status: ( - "get_validation_record" - if x == cert_arn and status == "SUCCESS" - else ValueError + "get_validation_record" if x == cert_arn and status == "SUCCESS" else ValueError ), ) monkeypatch.setattr( @@ -650,17 +631,17 @@ def test_deploy_update( "update_record_set", lambda x: None if x == "get_validation_record" else ValueError, ) - monkeypatch.setattr(cert, "_wait_for_stack", lambda x, last_status: None) + monkeypatch.setattr(cert, "_wait_for_stack", lambda _, last_status: None) # noqa: ARG005 assert cert.deploy() == expected def test_deploy_no_change( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test deploy no change.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert_arn = "arn:aws:acm:us-east-1:012345678901:certificate/test" @@ -679,12 +660,12 @@ def test_deploy_no_change( assert cert.deploy() == expected def test_deploy_recreate( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch - ): + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch + ) -> None: """Test deploy with stack recreation.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert_arn = "arn:aws:acm:us-east-1:012345678901:certificate/test" @@ -698,9 +679,7 @@ def test_deploy_recreate( ) monkeypatch.setattr(cert, "domain_changed", lambda: False) monkeypatch.setattr(cert, "deploy_stack", lambda: STATUS.recreate) # type: ignore - monkeypatch.setattr( - cert, "get_certificate", MagicMock(side_effect=["old", cert_arn]) - ) + monkeypatch.setattr(cert, "get_certificate", MagicMock(side_effect=["old", cert_arn])) monkeypatch.setattr( cert, "_wait_for_stack", MagicMock(side_effect=[STATUS.new, None]) # type: ignore ) @@ -718,12 +697,12 @@ def test_deploy_recreate( assert cert.deploy() == expected def test_deploy_domain_changed( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test deploy domain changed.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert = Certificate( @@ -737,12 +716,12 @@ def test_deploy_domain_changed( assert not cert.deploy() def test_deploy_error_destroy( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test deploy with errors that result in destroy being called.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert_arn = "arn:aws:acm:us-east-1:012345678901:certificate/test" @@ -774,27 +753,29 @@ def test_deploy_error_destroy( ), ) monkeypatch.setattr( - cert, "destroy", lambda records, skip_r53: check_bool_is_true(skip_r53) - ) - monkeypatch.setattr( - cert, "_wait_for_stack", MagicMock(side_effect=StackFailed("test")) + cert, + "destroy", + lambda records, skip_r53: check_bool_is_true(skip_r53), # noqa: ARG005 ) + monkeypatch.setattr(cert, "_wait_for_stack", MagicMock(side_effect=StackFailed("test"))) assert not cert.deploy() # cert.r53_client.exceptions.InvalidChangeBatch assert not cert.deploy() # cert.r53_client.exceptions.NoSuchHostedZone monkeypatch.setattr( - cert, "destroy", lambda records, skip_r53: check_bool_is_false(skip_r53) + cert, + "destroy", + lambda records, skip_r53: check_bool_is_false(skip_r53), # noqa: ARG005 ) assert not cert.deploy() # StackFailed def test_deploy_error_no_destroy( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test deploy with errors that don't result in destroy being called.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert = Certificate( @@ -813,12 +794,12 @@ def test_deploy_error_no_destroy( assert not cert.deploy() def test_destroy( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test destroy.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert = Certificate( @@ -828,24 +809,20 @@ def test_destroy( hosted_zone_id="test", ) # should only be called once - monkeypatch.setattr( - cert, "remove_validation_records", MagicMock(return_value=None) - ) - monkeypatch.setattr(cert, "destroy_stack", lambda wait: None) + monkeypatch.setattr(cert, "remove_validation_records", MagicMock(return_value=None)) + monkeypatch.setattr(cert, "destroy_stack", lambda wait: None) # noqa: ARG005 assert cert.destroy() assert cert.destroy(skip_r53=True) - assert ( # pylint: disable=no-member - cert.remove_validation_records.call_count == 1 # type: ignore - ) + assert cert.remove_validation_records.call_count == 1 # type: ignore def test_destroy_aws_errors( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test destroy with errors from AWS.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert = Certificate( @@ -866,19 +843,19 @@ def test_destroy_aws_errors( ] ), ) - monkeypatch.setattr(cert, "destroy_stack", lambda wait: None) + monkeypatch.setattr(cert, "destroy_stack", lambda wait: None) # noqa: ARG005 assert cert.destroy() assert cert.destroy() assert cert.destroy() def test_destroy_raise_client_error( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test destroy with ClientError raised.""" # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" def build_client_error(msg: str) -> ClientError: @@ -891,10 +868,11 @@ def build_client_error(msg: str) -> ClientError: domain="example.com", hosted_zone_id="test", ) - monkeypatch.setattr(cert, "destroy_stack", lambda wait: None) + monkeypatch.setattr(cert, "destroy_stack", lambda wait: None) # noqa: ARG005 def raise_stack_not_exist(_records: Any) -> NoReturn: """Raise ClientError mimicking stack not existing.""" + assert cert.stack raise build_client_error(f"Stack with id {cert.stack.fqn} does not exist") def raise_other(_records: Any) -> NoReturn: @@ -920,8 +898,8 @@ def raise_other(_records: Any) -> NoReturn: ) def test_stage_methods( self, - cfngin_context: MockCFNginContext, - monkeypatch: MonkeyPatch, + cfngin_context: MockCfnginContext, + monkeypatch: pytest.MonkeyPatch, stage: str, expected: str, ) -> None: @@ -933,8 +911,8 @@ def test_stage_methods( """ # setup context - cfngin_context.add_stubber("acm", "us-east-1") - cfngin_context.add_stubber("route53", "us-east-1") + cfngin_context.add_stubber("acm", region="us-east-1") + cfngin_context.add_stubber("route53", region="us-east-1") cfngin_context.config.namespace = "test" cert = Certificate( diff --git a/tests/unit/cfngin/hooks/test_aws_lambda.py b/tests/unit/cfngin/hooks/test_aws_lambda.py index 74b53e512..79ae4a2a6 100644 --- a/tests/unit/cfngin/hooks/test_aws_lambda.py +++ b/tests/unit/cfngin/hooks/test_aws_lambda.py @@ -14,13 +14,13 @@ import unittest from io import BytesIO as StringIO from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union, cast +from typing import TYPE_CHECKING, Any, Optional, Union, cast +from unittest.mock import ANY, MagicMock, patch from zipfile import ZipFile import boto3 import pytest from botocore.exceptions import ClientError -from mock import ANY, MagicMock, patch from moto import mock_s3 from testfixtures.comparison import compare from testfixtures.shouldraise import ShouldRaise @@ -48,7 +48,6 @@ if TYPE_CHECKING: from mypy_boto3_s3.client import S3Client - from pytest import LogCaptureFixture, MonkeyPatch REGION = "us-east-1" ALL_FILES = ( @@ -72,7 +71,7 @@ class TestLambdaHooks(unittest.TestCase): @classmethod def temp_directory_with_files( - cls, files: Union[List[str], Tuple[str, ...]] = ALL_FILES + cls, files: Union[list[str], tuple[str, ...]] = ALL_FILES ) -> TempDirectory: """Create a temp directory with files.""" temp_dict = TempDirectory() @@ -81,13 +80,13 @@ def temp_directory_with_files( return temp_dict @property - def s3(self) -> S3Client: # pylint: disable=invalid-name + def s3(self) -> S3Client: """Return S3 client.""" if not self._s3: self._s3 = boto3.client("s3", region_name=REGION) return self._s3 - def assert_s3_zip_file_list(self, bucket: str, key: str, files: List[str]) -> None: + def assert_s3_zip_file_list(self, bucket: str, key: str, files: list[str]) -> None: """Assert s3 zip file list.""" object_info = self.s3.get_object(Bucket=bucket, Key=key) zip_data = StringIO(object_info["Body"].read()) @@ -96,9 +95,7 @@ def assert_s3_zip_file_list(self, bucket: str, key: str, files: List[str]) -> No with ZipFile(zip_data, "r") as zip_file: for zip_info in zip_file.infolist(): perms = (zip_info.external_attr & ZIP_PERMS_MASK) >> 16 - self.assertIn( - perms, (0o755, 0o644), "ZIP member permission must be 755 or 644" - ) + assert perms in (493, 420), "ZIP member permission must be 755 or 644" found_files.add(zip_info.filename) compare(found_files, set(files)) @@ -116,13 +113,11 @@ def assert_s3_bucket(self, bucket: str, present: bool = True) -> None: def setUp(self) -> None: """Run before tests.""" self.context = CfnginContext( - config=CfnginConfig.parse_obj( - {"namespace": "test", "cfngin_bucket": "test"} - ) + config=CfnginConfig.parse_obj({"namespace": "test", "cfngin_bucket": "test"}) ) self.provider = mock_provider(region="us-east-1") - def run_hook(self, **kwargs: Any) -> Dict[Any, Any]: + def run_hook(self, **kwargs: Any) -> dict[Any, Any]: """Run hook.""" real_kwargs = { "context": self.context, @@ -135,14 +130,14 @@ def run_hook(self, **kwargs: Any) -> Dict[Any, Any]: @mock_s3 def test_bucket_default(self) -> None: """Test bucket default.""" - self.assertIsNotNone(self.run_hook(functions={})) + assert self.run_hook(functions={}) is not None self.assert_s3_bucket("test") @mock_s3 def test_bucket_custom(self) -> None: """Test bucket custom.""" - self.assertIsNotNone(self.run_hook(bucket="custom", functions={})) + assert self.run_hook(bucket="custom", functions={}) is not None self.assert_s3_bucket("test", present=False) self.assert_s3_bucket("custom") @@ -156,29 +151,25 @@ def test_prefix(self) -> None: functions={"MyFunction": {"path": temp_dir.path + "/f1"}}, ) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) + assert isinstance(code, Code) self.assert_s3_zip_file_list(code.S3Bucket, code.S3Key, F1_FILES) - self.assertTrue( - code.S3Key.startswith("cloudformation-custom-resources/lambda-MyFunction-") - ) + assert code.S3Key.startswith("cloudformation-custom-resources/lambda-MyFunction-") @mock_s3 def test_prefix_missing(self) -> None: """Test prefix missing.""" with self.temp_directory_with_files() as temp_dir: - results = self.run_hook( - functions={"MyFunction": {"path": temp_dir.path + "/f1"}} - ) + results = self.run_hook(functions={"MyFunction": {"path": temp_dir.path + "/f1"}}) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) + assert isinstance(code, Code) self.assert_s3_zip_file_list(code.S3Bucket, code.S3Key, F1_FILES) - self.assertTrue(code.S3Key.startswith("lambda-MyFunction-")) + assert code.S3Key.startswith("lambda-MyFunction-") @mock_s3 def test_path_missing(self) -> None: @@ -194,26 +185,25 @@ def test_path_relative(self) -> None: results = self.run_hook( functions={"MyFunction": {"path": "test"}}, context=CfnginContext( - config=CfnginConfig.parse_obj( - {"namespace": "test", "cfngin_bucket": "test"} - ), + config=CfnginConfig.parse_obj({"namespace": "test", "cfngin_bucket": "test"}), config_path=Path(str(temp_dir.path)), ), ) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) + assert isinstance(code, Code) self.assert_s3_zip_file_list(code.S3Bucket, code.S3Key, ["test.py"]) @mock_s3 def test_path_home_relative(self) -> None: """Test path home relative.""" orig_expanduser = os.path.expanduser - with self.temp_directory_with_files(["test.py"]) as temp_dir, patch( - "os.path.expanduser" - ) as mock1: + with ( + self.temp_directory_with_files(["test.py"]) as temp_dir, + patch("os.path.expanduser") as mock1, + ): test_path = "~/test" mock1.side_effect = lambda p: ( # type: ignore @@ -222,10 +212,10 @@ def test_path_home_relative(self) -> None: results = self.run_hook(functions={"MyFunction": {"path": test_path}}) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) + assert isinstance(code, Code) self.assert_s3_zip_file_list(code.S3Bucket, code.S3Key, ["test.py"]) @mock_s3 @@ -239,29 +229,24 @@ def test_multiple_functions(self) -> None: } ) - self.assertIsNotNone(results) + assert results is not None f1_code = results.get("MyFunction") - self.assertIsInstance(f1_code, Code) + assert isinstance(f1_code, Code) self.assert_s3_zip_file_list(f1_code.S3Bucket, f1_code.S3Key, F1_FILES) f2_code = results.get("OtherFunction") - self.assertIsInstance(f2_code, Code) + assert isinstance(f2_code, Code) self.assert_s3_zip_file_list(f2_code.S3Bucket, f2_code.S3Key, F2_FILES) @mock_s3 def test_patterns_invalid(self) -> None: """Test patterns invalid.""" - msg = ( - "Invalid file patterns in key 'include': must be a string or " - "list of strings" - ) + msg = "Invalid file patterns in key 'include': must be a string or list of strings" with ShouldRaise(ValueError(msg)): self.run_hook( - functions={ - "MyFunction": {"path": "test", "include": {"invalid": "invalid"}} - } + functions={"MyFunction": {"path": "test", "include": {"invalid": "invalid"}}} ) @mock_s3 @@ -277,10 +262,10 @@ def test_patterns_include(self) -> None: } ) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) + assert isinstance(code, Code) self.assert_s3_zip_file_list( code.S3Bucket, code.S3Key, @@ -306,10 +291,10 @@ def test_patterns_exclude(self) -> None: } ) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) + assert isinstance(code, Code) self.assert_s3_zip_file_list( code.S3Bucket, code.S3Key, ["f1.py", "__init__.py", "test2/test.txt"] ) @@ -328,13 +313,11 @@ def test_patterns_include_exclude(self) -> None: } ) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) - self.assert_s3_zip_file_list( - code.S3Bucket, code.S3Key, ["f1.py", "__init__.py"] - ) + assert isinstance(code, Code) + self.assert_s3_zip_file_list(code.S3Bucket, code.S3Key, ["f1.py", "__init__.py"]) @mock_s3 def test_patterns_exclude_all(self) -> None: @@ -344,16 +327,12 @@ def test_patterns_exclude_all(self) -> None: "include/exclude options for errors." ) - with self.temp_directory_with_files() as temp_dir, ShouldRaise( - RuntimeError(msg) - ): + with self.temp_directory_with_files() as temp_dir, ShouldRaise(RuntimeError(msg)): results = self.run_hook( - functions={ - "MyFunction": {"path": temp_dir.path + "/f1", "exclude": ["**"]} - } + functions={"MyFunction": {"path": temp_dir.path + "/f1", "exclude": ["**"]}} ) - self.assertIsNone(results) + assert results is None @mock_s3 def test_idempotence(self) -> None: @@ -368,10 +347,10 @@ def test_idempotence(self) -> None: previous = None for _ in range(2): results = self.run_hook(bucket=bucket_name, functions=functions) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) + assert isinstance(code, Code) if not previous: previous = code.S3Key @@ -380,7 +359,7 @@ def test_idempotence(self) -> None: compare( previous, code.S3Key, - prefix="zipfile name should not be modified in " "repeated runs.", + prefix="zipfile name should not be modified in repeated runs.", ) def test_calculate_hash(self) -> None: @@ -395,13 +374,13 @@ def test_calculate_hash(self) -> None: with self.temp_directory_with_files() as temp_dir3: root = cast(str, temp_dir3.path) - with open(os.path.join(root, ALL_FILES[0]), "w", encoding="utf-8") as _file: + with (Path(root) / ALL_FILES[0]).open("w") as _file: _file.write("modified file data") hash3 = _calculate_hash(ALL_FILES, root) - self.assertEqual(hash1, hash2) - self.assertNotEqual(hash1, hash3) - self.assertNotEqual(hash2, hash3) + assert hash1 == hash2 + assert hash1 != hash3 + assert hash2 != hash3 def test_calculate_hash_diff_filename_same_contents(self) -> None: """Test calculate hash diff filename same contents.""" @@ -413,7 +392,7 @@ def test_calculate_hash_diff_filename_same_contents(self) -> None: temp_dir.write(file_name, b"data") hash1 = _calculate_hash([file1], root) hash2 = _calculate_hash([file2], root) - self.assertNotEqual(hash1, hash2) + assert hash1 != hash2 def test_calculate_hash_different_ordering(self) -> None: """Test calculate hash different ordering.""" @@ -429,13 +408,11 @@ def test_calculate_hash_different_ordering(self) -> None: temp_dir2.write(file_name, b"") hash1 = _calculate_hash(files1, root1) hash2 = _calculate_hash(files2, root2) - self.assertEqual(hash1, hash2) + assert hash1 == hash2 def test_select_bucket_region(self) -> None: """Test select bucket region.""" - tests: Tuple[ - Tuple[Tuple[Optional[str], Optional[str], Optional[str], str], str], ... - ] = ( + tests: tuple[tuple[tuple[Optional[str], Optional[str], Optional[str], str], str], ...] = ( (("myBucket", "us-east-1", "us-west-1", "eu-west-1"), "us-east-1"), (("myBucket", None, "us-west-1", "eu-west-1"), "eu-west-1"), ((None, "us-east-1", "us-west-1", "eu-west-1"), "us-west-1"), @@ -443,16 +420,14 @@ def test_select_bucket_region(self) -> None: ) for args, result in tests: - self.assertEqual(select_bucket_region(*args), result) # type: ignore + assert select_bucket_region(*args) == result # type: ignore @mock_s3 def test_follow_symlink_nonbool(self) -> None: """Test follow symlink nonbool.""" msg = "follow_symlinks option must be a boolean" with ShouldRaise(ValueError(msg)): - self.run_hook( - follow_symlinks="raiseValueError", functions={"MyFunction": {}} - ) + self.run_hook(follow_symlinks="raiseValueError", functions={"MyFunction": {}}) @mock_s3 def test_follow_symlink_true(self) -> None: @@ -465,10 +440,10 @@ def test_follow_symlink_true(self) -> None: results = self.run_hook( follow_symlinks=True, functions={"MyFunction": {"path": root2}} ) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) + assert isinstance(code, Code) self.assert_s3_zip_file_list( code.S3Bucket, code.S3Key, @@ -502,10 +477,10 @@ def test_follow_symlink_false(self) -> None: results = self.run_hook( follow_symlinks=False, functions={"MyFunction": {"path": root2}} ) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) + assert isinstance(code, Code) self.assert_s3_zip_file_list( code.S3Bucket, code.S3Key, @@ -530,10 +505,10 @@ def test_follow_symlink_omitted(self) -> None: root2 = temp_dir2.path os.symlink(root1 + "/f1", root2 + "/f3") results = self.run_hook(functions={"MyFunction": {"path": root2}}) - self.assertIsNotNone(results) + assert results is not None code = results.get("MyFunction") - self.assertIsInstance(code, Code) + assert isinstance(code, Code) self.assert_s3_zip_file_list( code.S3Bucket, code.S3Key, @@ -587,9 +562,7 @@ def test_frozen(self, mock_sys: MagicMock, mock_proc: MagicMock) -> None: } ) mock_proc.check_call.assert_called_once_with([ANY, "run-python", ANY]) - assert mock_proc.check_call.call_args.args[0][2].endswith( - "__runway_run_pip_install.py" - ) + assert mock_proc.check_call.call_args.args[0][2].endswith("__runway_run_pip_install.py") class TestDockerizePip: @@ -607,9 +580,9 @@ class TestDockerizePip: { "Target": "/var/task", "Source": ( - os.getcwd().replace("\\", "/") + str(Path.cwd()).replace("\\", "/") if platform.system() == "Windows" - else os.getcwd() + else str(Path.cwd()) ), "Type": "bind", "ReadOnly": False, @@ -622,7 +595,7 @@ def test_with_docker_file(self) -> None: client = make_fake_client() with TempDirectory() as tmp_dir: docker_file = tmp_dir.write("Dockerfile", b"") - dockerized_pip(os.getcwd(), client=client, docker_file=docker_file) + dockerized_pip(str(Path.cwd()), client=client, docker_file=docker_file) client.api.build.assert_called_with( path=tmp_dir.path, dockerfile="Dockerfile", forcerm=True @@ -643,7 +616,7 @@ def test_with_docker_image(self) -> None: """Test with docker_image provided.""" client = make_fake_client() image = "alpine" - dockerized_pip(os.getcwd(), client=client, docker_image=image) + dockerized_pip(str(Path.cwd()), client=client, docker_image=image) client.api.create_container.assert_called_with( detach=True, image=image, command=self.command, host_config=self.host_config @@ -658,7 +631,7 @@ def test_with_runtime(self) -> None: """Test with runtime provided.""" client = make_fake_client() runtime = "python3.8" - dockerized_pip(os.getcwd(), client=client, runtime=runtime) + dockerized_pip(str(Path.cwd()), client=client, runtime=runtime) client.api.create_container.assert_called_with( detach=True, @@ -677,7 +650,7 @@ def test_raises_invalid_config(self) -> None: client = make_fake_client() with pytest.raises(InvalidDockerizePipConfiguration): dockerized_pip( - os.getcwd(), + str(Path.cwd()), client=client, docker_file="docker_file", docker_image="docker_image", @@ -685,52 +658,44 @@ def test_raises_invalid_config(self) -> None: ) with pytest.raises(InvalidDockerizePipConfiguration): dockerized_pip( - os.getcwd(), + str(Path.cwd()), client=client, docker_file="docker_file", docker_image="docker_image", ) with pytest.raises(InvalidDockerizePipConfiguration): dockerized_pip( - os.getcwd(), client=client, docker_file="docker_file", runtime="runtime" + str(Path.cwd()), client=client, docker_file="docker_file", runtime="runtime" ) with pytest.raises(InvalidDockerizePipConfiguration): dockerized_pip( - os.getcwd(), + str(Path.cwd()), client=client, docker_image="docker_image", runtime="runtime", ) with pytest.raises(InvalidDockerizePipConfiguration): - dockerized_pip(os.getcwd(), client=client) + dockerized_pip(str(Path.cwd()), client=client) def test_raises_value_error_missing_dockerfile(self) -> None: """ValueError raised when provided Dockerfile is not found.""" client = make_fake_client() - with pytest.raises(ValueError) as excinfo: - dockerized_pip(os.getcwd(), client=client, docker_file="not-a-Dockerfile") - assert "docker_file" in str(excinfo.value) + with pytest.raises(ValueError, match=".*docker_file.*"): + dockerized_pip(str(Path.cwd()), client=client, docker_file="not-a-Dockerfile") def test_raises_value_error_runtime(self) -> None: """ValueError raised if runtime provided is not supported.""" client = make_fake_client() - with pytest.raises(ValueError) as excinfo: - dockerized_pip(os.getcwd(), client=client, runtime="node") - assert "node" in str(excinfo.value) + with pytest.raises(ValueError, match=".*node.*"): + dockerized_pip(str(Path.cwd()), client=client, runtime="node") class TestHandleRequirements: """Test handle_requirements.""" - PIPFILE = "\n".join( - [ - "[[source]]", - 'url = "https://pypi.org/simple"', - "verify_ssl = true", - 'name = "pypi"', - "[packages]", - "[dev-packages]", - ] + PIPFILE = ( + '[[source]]\nurl = "https://pypi.org/simple"\nverify_ssl = true\nname = "pypi"\n' + "[packages]\n[dev-packages]" ) REQUIREMENTS = "-i https://pypi.org/simple\n\n" @@ -743,15 +708,13 @@ def test_default(self) -> None: req_path = handle_requirements( package_root=cast(str, tmp_dir.path), dest_path=cast(str, tmp_dir.path), - requirements=cast( - Dict[str, bool], find_requirements(cast(str, tmp_dir.path)) - ), + requirements=cast(dict[str, bool], find_requirements(cast(str, tmp_dir.path))), ) - assert req_path == os.path.join(cast(str, tmp_dir.path), "requirements.txt") - assert not os.path.isfile( - os.path.join(cast(str, tmp_dir.path), "Pipfile.lock") + assert req_path == os.path.join( # noqa: PTH118 + cast(str, tmp_dir.path), "requirements.txt" ) + assert not (Path(cast(str, tmp_dir.path)) / "Pipfile.lock").is_file() assert tmp_dir.read("requirements.txt") == expected def test_explicit_pipenv(self, tmp_path: Path) -> None: @@ -764,7 +727,7 @@ def test_explicit_pipenv(self, tmp_path: Path) -> None: req_path = handle_requirements( package_root=str(tmp_path), dest_path=str(tmp_path), - requirements=cast(Dict[str, bool], find_requirements(str(tmp_path))), + requirements=cast(dict[str, bool], find_requirements(str(tmp_path))), use_pipenv=True, ) assert req_path == str(requirements_txt) @@ -788,13 +751,11 @@ def test_explicit_pipenv(self, tmp_path: Path) -> None: assert requirements_txt.read_text() == "\n".join(expected_text) + "\n" def test_frozen_pipenv( - self, caplog: LogCaptureFixture, monkeypatch: MonkeyPatch, tmp_path: Path + self, caplog: pytest.LogCaptureFixture, monkeypatch: pytest.MonkeyPatch, tmp_path: Path ) -> None: """Test use pipenv from Pyinstaller build.""" caplog.set_level(logging.ERROR, logger="runway.cfngin.hooks.aws_lambda") - monkeypatch.setattr( - "runway.cfngin.hooks.aws_lambda.sys.frozen", True, raising=False - ) + monkeypatch.setattr("runway.cfngin.hooks.aws_lambda.sys.frozen", True, raising=False) with pytest.raises(SystemExit) as excinfo: handle_requirements( @@ -807,9 +768,7 @@ def test_frozen_pipenv( }, ) assert excinfo.value.code == 1 - assert [ - "pipenv can only be used with python installed from PyPi" - ] == caplog.messages + assert caplog.messages == ["pipenv can only be used with python installed from PyPi"] def test_implicit_pipenv(self, tmp_path: Path) -> None: """Test implicit use of pipenv.""" @@ -820,7 +779,7 @@ def test_implicit_pipenv(self, tmp_path: Path) -> None: req_path = handle_requirements( package_root=str(tmp_path), dest_path=str(tmp_path), - requirements=cast(Dict[str, bool], find_requirements(str(tmp_path))), + requirements=cast(dict[str, bool], find_requirements(str(tmp_path))), use_pipenv=True, ) assert req_path == str(requirements_txt) @@ -845,17 +804,16 @@ def test_implicit_pipenv(self, tmp_path: Path) -> None: def test_raise_not_implimented(self) -> None: """Test NotImplimentedError is raised when no requirements file.""" - with TempDirectory() as tmp_dir: - with pytest.raises(NotImplementedError): - handle_requirements( - package_root=cast(str, tmp_dir.path), - dest_path=cast(str, tmp_dir.path), - requirements={ - "requirements.txt": False, - "Pipfile": False, - "Pipfile.lock": False, - }, - ) + with TempDirectory() as tmp_dir, pytest.raises(NotImplementedError): + handle_requirements( + package_root=cast(str, tmp_dir.path), + dest_path=cast(str, tmp_dir.path), + requirements={ + "requirements.txt": False, + "Pipfile": False, + "Pipfile.lock": False, + }, + ) class TestShouldUseDocker: diff --git a/tests/unit/cfngin/hooks/test_base.py b/tests/unit/cfngin/hooks/test_base.py index a9f497520..f4047077d 100644 --- a/tests/unit/cfngin/hooks/test_base.py +++ b/tests/unit/cfngin/hooks/test_base.py @@ -5,9 +5,9 @@ import logging from typing import TYPE_CHECKING +from unittest.mock import MagicMock, call, patch import pytest -from mock import MagicMock, call, patch from runway.cfngin.exceptions import StackFailed from runway.cfngin.hooks.base import Hook, HookDeployAction, HookDestroyAction @@ -21,9 +21,8 @@ ) if TYPE_CHECKING: - from pytest import LogCaptureFixture, MonkeyPatch - from ...factories import MockCFNginContext + from ...factories import MockCfnginContext COMPLETE_W_REASON = CompleteStatus("test successful") @@ -31,7 +30,7 @@ class TestHook: """Tests for runway.cfngin.hooks.base.Hook.""" - def test_attributes(self, cfngin_context: MockCFNginContext) -> None: + def test_attributes(self, cfngin_context: MockCfnginContext) -> None: """Test attributes set during __init__.""" provider = MagicMock() args = {"tags": {"key": "val"}} @@ -45,18 +44,18 @@ def test_attributes(self, cfngin_context: MockCFNginContext) -> None: assert not result.stack assert result.stack_name == "stack" - def test_tags(self, cfngin_context: MockCFNginContext) -> None: + def test_tags(self, cfngin_context: MockCfnginContext) -> None: """Test tags property.""" cfngin_context.config.tags = {"context_tag": "val"} - hook = Hook(cfngin_context, MagicMock(), **{"tags": {"arg_tag": "val"}}) + hook = Hook(cfngin_context, MagicMock(), tags={"arg_tag": "val"}) assert hook.tags.to_dict() == [ {"Key": "arg_tag", "Value": "val"}, {"Key": "context_tag", "Value": "val"}, ] - def test_get_template_description(self, cfngin_context: MockCFNginContext) -> None: + def test_get_template_description(self, cfngin_context: MockCfnginContext) -> None: """Test for get_template_description.""" hook = Hook(cfngin_context, MagicMock()) @@ -70,7 +69,7 @@ def test_get_template_description(self, cfngin_context: MockCFNginContext) -> No MagicMock(return_value=COMPLETE), ) def test_deploy_stack( - self, cfngin_context: MockCFNginContext, caplog: LogCaptureFixture + self, cfngin_context: MockCfnginContext, caplog: pytest.LogCaptureFixture ) -> None: """Test for deploy_stack.""" hook = Hook(cfngin_context, MagicMock()) @@ -87,7 +86,7 @@ def test_deploy_stack( MagicMock(side_effect=[SUBMITTED, COMPLETE]), ) def test_deploy_stack_wait( - self, cfngin_context: MockCFNginContext, caplog: LogCaptureFixture + self, cfngin_context: MockCfnginContext, caplog: pytest.LogCaptureFixture ) -> None: """Test for deploy_stack with wait.""" hook = Hook(cfngin_context, MagicMock()) @@ -106,7 +105,7 @@ def test_deploy_stack_wait( MagicMock(side_effect=[SKIPPED]), ) def test_deploy_stack_wait_skipped( - self, cfngin_context: MockCFNginContext, caplog: LogCaptureFixture + self, cfngin_context: MockCfnginContext, caplog: pytest.LogCaptureFixture ) -> None: """Test for deploy_stack with wait and skip.""" hook = Hook(cfngin_context, MagicMock()) @@ -118,10 +117,8 @@ def test_deploy_stack_wait_skipped( assert caplog.records[0].message == f"{stack.name}:{SKIPPED.name}" - @patch( - "runway.cfngin.hooks.base.HookDeployAction.run", MagicMock(side_effect=[FAILED]) - ) - def test_deploy_stack_wait_failed(self, cfngin_context: MockCFNginContext) -> None: + @patch("runway.cfngin.hooks.base.HookDeployAction.run", MagicMock(side_effect=[FAILED])) + def test_deploy_stack_wait_failed(self, cfngin_context: MockCfnginContext) -> None: """Test for deploy_stack with wait and skip.""" hook = Hook(cfngin_context, MagicMock()) stack = MagicMock() @@ -135,7 +132,7 @@ def test_deploy_stack_wait_failed(self, cfngin_context: MockCFNginContext) -> No MagicMock(side_effect=[SUBMITTED, COMPLETE_W_REASON]), ) def test_destroy_stack( - self, cfngin_context: MockCFNginContext, caplog: LogCaptureFixture + self, cfngin_context: MockCfnginContext, caplog: pytest.LogCaptureFixture ) -> None: """Test for destroy_stack with wait.""" hook = Hook(cfngin_context, MagicMock()) @@ -152,9 +149,7 @@ def test_destroy_stack( == f"{stack.name}:{COMPLETE_W_REASON.name} ({COMPLETE_W_REASON.reason})" ) - def test_wait_for_stack_till_reason( - self, cfngin_context: MockCFNginContext - ) -> None: + def test_wait_for_stack_till_reason(self, cfngin_context: MockCfnginContext) -> None: """Test _wait_for_stack till_reason option.""" hook = Hook(cfngin_context, MagicMock()) stack = MagicMock(fqn="test-stack", name="stack") @@ -166,14 +161,12 @@ def test_wait_for_stack_till_reason( COMPLETE, ] - result = hook._wait_for_stack( # pylint: disable=protected-access - action, stack=stack, till_reason="catch" - ) + result = hook._wait_for_stack(action, stack=stack, till_reason="catch") assert result == SUBMITTED assert result.reason == "catch" def test_wait_for_stack_log_change( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch + self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch ) -> None: """Test _wait_for_stack log status change.""" hook = Hook(cfngin_context, MagicMock()) @@ -185,7 +178,7 @@ def test_wait_for_stack_log_change( monkeypatch.setattr(hook, "_log_stack", mock_log) - hook._wait_for_stack( # pylint: disable=protected-access + hook._wait_for_stack( action, last_status=SubmittedStatus("original"), stack=stack, @@ -195,28 +188,28 @@ def test_wait_for_stack_log_change( mock_log.assert_has_calls([call(stack, new_status), call(stack, COMPLETE)]) assert mock_log.call_count == 2 - def test_post_deploy(self, cfngin_context: MockCFNginContext) -> None: + def test_post_deploy(self, cfngin_context: MockCfnginContext) -> None: """Test post_deploy.""" hook = Hook(cfngin_context, MagicMock()) with pytest.raises(NotImplementedError): hook.post_deploy() - def test_post_destroy(self, cfngin_context: MockCFNginContext) -> None: + def test_post_destroy(self, cfngin_context: MockCfnginContext) -> None: """Test post_destroy.""" hook = Hook(cfngin_context, MagicMock()) with pytest.raises(NotImplementedError): hook.post_destroy() - def test_pre_deploy(self, cfngin_context: MockCFNginContext) -> None: + def test_pre_deploy(self, cfngin_context: MockCfnginContext) -> None: """Test pre_deploy.""" hook = Hook(cfngin_context, MagicMock()) with pytest.raises(NotImplementedError): hook.pre_deploy() - def test_pre_destroy(self, cfngin_context: MockCFNginContext): + def test_pre_destroy(self, cfngin_context: MockCfnginContext) -> None: """Test pre_destroy.""" hook = Hook(cfngin_context, MagicMock()) @@ -227,23 +220,21 @@ def test_pre_destroy(self, cfngin_context: MockCFNginContext): class TestHookDeployAction: """Tests for runway.cfngin.hooks.base.HookDeployAction.""" - def test_provider(self, cfngin_context: MockCFNginContext) -> None: + def test_provider(self, cfngin_context: MockCfnginContext) -> None: """Test provider property.""" provider = MagicMock() obj = HookDeployAction(cfngin_context, provider) assert obj.provider == provider - def test_build_provider(self, cfngin_context: MockCFNginContext) -> None: + def test_build_provider(self, cfngin_context: MockCfnginContext) -> None: """Test build_provider.""" provider = MagicMock() obj = HookDeployAction(cfngin_context, provider) assert obj.build_provider() == provider - def test_run( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch - ) -> None: + def test_run(self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch) -> None: """Test run.""" obj = HookDeployAction(cfngin_context, MagicMock()) monkeypatch.setattr(obj, "_launch_stack", lambda: "success") @@ -254,9 +245,7 @@ def test_run( class TestHookDestroyAction: """Tests for runway.cfngin.hooks.base.HookDestroyAction.""" - def test_run( - self, cfngin_context: MockCFNginContext, monkeypatch: MonkeyPatch - ) -> None: + def test_run(self, cfngin_context: MockCfnginContext, monkeypatch: pytest.MonkeyPatch) -> None: """Test run.""" obj = HookDestroyAction(cfngin_context, MagicMock()) monkeypatch.setattr(obj, "_destroy_stack", lambda: "success") diff --git a/tests/unit/cfngin/hooks/test_cleanup_s3.py b/tests/unit/cfngin/hooks/test_cleanup_s3.py index 7c5b9422c..b9f9256cb 100644 --- a/tests/unit/cfngin/hooks/test_cleanup_s3.py +++ b/tests/unit/cfngin/hooks/test_cleanup_s3.py @@ -10,10 +10,10 @@ from runway.cfngin.hooks.cleanup_s3 import purge_bucket if TYPE_CHECKING: - from ...factories import MockCFNginContext + from ...factories import MockCfnginContext -def test_purge_bucket(cfngin_context: MockCFNginContext) -> None: +def test_purge_bucket(cfngin_context: MockCfnginContext) -> None: """Test purge_bucket.""" stub = cfngin_context.add_stubber("s3") @@ -24,7 +24,7 @@ def test_purge_bucket(cfngin_context: MockCFNginContext) -> None: stub.assert_no_pending_responses() -def test_purge_bucket_does_not_exist(cfngin_context: MockCFNginContext) -> None: +def test_purge_bucket_does_not_exist(cfngin_context: MockCfnginContext) -> None: """Test purge_bucket Bucket doesn't exist.""" stub = cfngin_context.add_stubber("s3") @@ -34,7 +34,7 @@ def test_purge_bucket_does_not_exist(cfngin_context: MockCFNginContext) -> None: stub.assert_no_pending_responses() -def test_purge_bucket_unhandled_exception(cfngin_context: MockCFNginContext) -> None: +def test_purge_bucket_unhandled_exception(cfngin_context: MockCfnginContext) -> None: """Test purge_bucket with unhandled exception.""" stub = cfngin_context.add_stubber("s3") diff --git a/tests/unit/cfngin/hooks/test_cleanup_ssm.py b/tests/unit/cfngin/hooks/test_cleanup_ssm.py index d62211c7d..9c2a5f5ac 100644 --- a/tests/unit/cfngin/hooks/test_cleanup_ssm.py +++ b/tests/unit/cfngin/hooks/test_cleanup_ssm.py @@ -7,10 +7,10 @@ from runway.cfngin.hooks.cleanup_ssm import delete_param if TYPE_CHECKING: - from ...factories import MockCFNginContext + from ...factories import MockCfnginContext -def test_delete_param(cfngin_context: MockCFNginContext) -> None: +def test_delete_param(cfngin_context: MockCfnginContext) -> None: """Test delete_param.""" stub = cfngin_context.add_stubber("ssm") @@ -19,7 +19,7 @@ def test_delete_param(cfngin_context: MockCFNginContext) -> None: assert delete_param(cfngin_context, parameter_name="foo") -def test_delete_param_not_found(cfngin_context: MockCFNginContext) -> None: +def test_delete_param_not_found(cfngin_context: MockCfnginContext) -> None: """Test delete_param.""" stub = cfngin_context.add_stubber("ssm") diff --git a/tests/unit/cfngin/hooks/test_command.py b/tests/unit/cfngin/hooks/test_command.py index 99aed4c7e..9d2d9aee4 100644 --- a/tests/unit/cfngin/hooks/test_command.py +++ b/tests/unit/cfngin/hooks/test_command.py @@ -26,9 +26,7 @@ def test_run_command(fake_process: FakeProcess) -> None: def test_run_command_capture(fake_process: FakeProcess) -> None: """Test run_command with ``capture``.""" - fake_process.register_subprocess( - ["foo"], returncode=0, stderr="bar", stdout="foobar" - ) + fake_process.register_subprocess(["foo"], returncode=0, stderr="bar", stdout="foobar") assert run_command(command=["foo"], capture=True) == { "returncode": 0, "stderr": b"bar", # for some reason, pytest-subprocess returns these as bytes diff --git a/tests/unit/cfngin/hooks/test_ecs.py b/tests/unit/cfngin/hooks/test_ecs.py index a2ca502be..4c6c33deb 100644 --- a/tests/unit/cfngin/hooks/test_ecs.py +++ b/tests/unit/cfngin/hooks/test_ecs.py @@ -1,6 +1,5 @@ """Tests for runway.cfngin.hooks.ecs.""" -# pyright: basic from __future__ import annotations from typing import TYPE_CHECKING @@ -9,16 +8,16 @@ from runway.cfngin.hooks.ecs import create_clusters if TYPE_CHECKING: + import pytest from mypy_boto3_ecs.type_defs import ClusterTypeDef - from pytest import LogCaptureFixture - from ...factories import MockCFNginContext + from ...factories import MockCfnginContext MODULE = "runway.cfngin.hooks.ecs" def test_create_clusters( - caplog: LogCaptureFixture, cfngin_context: MockCFNginContext + caplog: pytest.LogCaptureFixture, cfngin_context: MockCfnginContext ) -> None: """Test create_clusters.""" caplog.set_level(LogLevels.DEBUG, MODULE) @@ -28,12 +27,8 @@ def test_create_clusters( "bar": {"clusterName": "bar"}, } - stub.add_response( - "create_cluster", {"cluster": clusters["foo"]}, {"clusterName": "foo"} - ) - stub.add_response( - "create_cluster", {"cluster": clusters["bar"]}, {"clusterName": "bar"} - ) + stub.add_response("create_cluster", {"cluster": clusters["foo"]}, {"clusterName": "foo"}) + stub.add_response("create_cluster", {"cluster": clusters["bar"]}, {"clusterName": "bar"}) with stub: assert create_clusters(cfngin_context, clusters=list(clusters)) == { @@ -45,7 +40,7 @@ def test_create_clusters( assert f"creating ECS cluster: {cluster}" in caplog.messages -def test_create_clusters_str(cfngin_context: MockCFNginContext) -> None: +def test_create_clusters_str(cfngin_context: MockCfnginContext) -> None: """Test create_clusters with ``clusters`` provided as str.""" stub = cfngin_context.add_stubber("ecs") cluster_name = "foo" diff --git a/tests/unit/cfngin/hooks/test_iam.py b/tests/unit/cfngin/hooks/test_iam.py index 4da3c9649..666cca6f1 100644 --- a/tests/unit/cfngin/hooks/test_iam.py +++ b/tests/unit/cfngin/hooks/test_iam.py @@ -22,13 +22,13 @@ from pytest_mock import MockerFixture - from ...factories import MockCFNginContext + from ...factories import MockCfnginContext CREATE_DATE = datetime(2015, 1, 1) MODULE = "runway.cfngin.hooks.iam" -def test_create_ecs_service_role(cfngin_context: MockCFNginContext) -> None: +def test_create_ecs_service_role(cfngin_context: MockCfnginContext) -> None: """Test create_ecs_service_role.""" stub = cfngin_context.add_stubber("iam") @@ -64,7 +64,7 @@ def test_create_ecs_service_role(cfngin_context: MockCFNginContext) -> None: def test_create_ecs_service_role_already_exists( - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, ) -> None: """Test create_ecs_service_role already exists.""" stub = cfngin_context.add_stubber("iam") @@ -86,7 +86,7 @@ def test_create_ecs_service_role_already_exists( def test_create_ecs_service_role_raise_client_error( - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, ) -> None: """Test create_ecs_service_role raise ClientError.""" stub = cfngin_context.add_stubber("iam") @@ -99,7 +99,7 @@ def test_create_ecs_service_role_raise_client_error( def test_ensure_server_cert_exists( - cfngin_context: MockCFNginContext, mocker: MockerFixture, tmp_path: Path + cfngin_context: MockCfnginContext, mocker: MockerFixture, tmp_path: Path ) -> None: """Test ensure_server_cert_exists.""" cert_name = "foo" @@ -155,7 +155,7 @@ def test_ensure_server_cert_exists( def test_ensure_server_cert_exists_already_exists( - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, ) -> None: """Test ensure_server_cert_exists already exists.""" cert_name = "foo" @@ -188,7 +188,7 @@ def test_ensure_server_cert_exists_already_exists( def test_ensure_server_cert_exists_no_prompt_no_parameters( - cfngin_context: MockCFNginContext, mocker: MockerFixture + cfngin_context: MockCfnginContext, mocker: MockerFixture ) -> None: """Test ensure_server_cert_exists no prompt, not parameters.""" mocker.patch( @@ -200,14 +200,12 @@ def test_ensure_server_cert_exists_no_prompt_no_parameters( stub.add_client_error("get_server_certificate") with stub: - assert not ensure_server_cert_exists( - cfngin_context, cert_name="foo", prompt=False - ) + assert not ensure_server_cert_exists(cfngin_context, cert_name="foo", prompt=False) stub.assert_no_pending_responses() def test_ensure_server_cert_exists_prompt_no( - cfngin_context: MockCFNginContext, mocker: MockerFixture + cfngin_context: MockCfnginContext, mocker: MockerFixture ) -> None: """Test ensure_server_cert_exists prompt input no.""" mocker.patch( diff --git a/tests/unit/cfngin/hooks/test_keypair.py b/tests/unit/cfngin/hooks/test_keypair.py index 1a9c217ea..5567ffddd 100644 --- a/tests/unit/cfngin/hooks/test_keypair.py +++ b/tests/unit/cfngin/hooks/test_keypair.py @@ -1,16 +1,15 @@ """Tests for runway.cfngin.hooks.keypair.""" -# pylint: disable=redefined-outer-name # pyright: basic from __future__ import annotations import os import sys from contextlib import contextmanager -from typing import TYPE_CHECKING, Iterator, NamedTuple, Tuple +from typing import TYPE_CHECKING, NamedTuple +from unittest import mock import boto3 -import mock import pytest from moto import mock_ec2, mock_ssm @@ -19,6 +18,7 @@ from ..factories import mock_context if TYPE_CHECKING: + from collections.abc import Iterator from pathlib import Path from runway.context import CfnginContext @@ -46,7 +46,7 @@ def ssh_key(cfngin_fixtures: Path) -> SSHKey: ) -@pytest.fixture +@pytest.fixture() def context() -> CfnginContext: """Mock context.""" return mock_context(namespace="fake") @@ -63,9 +63,8 @@ def ec2(ssh_key: SSHKey) -> Iterator[None]: "fingerprint": ssh_key.fingerprint, "material": ssh_key.private_key.decode("ascii"), } - with mock.patch("moto.ec2.models.random_key_pair", side_effect=[key_pair]): - with mock_ec2(): - yield + with mock.patch("moto.ec2.models.random_key_pair", side_effect=[key_pair]), mock_ec2(): + yield @pytest.fixture(autouse=True) @@ -76,20 +75,18 @@ def ssm() -> Iterator[None]: @contextmanager -def mock_input( - lines: Tuple[str, ...] = (), isatty: bool = True -) -> Iterator[mock.MagicMock]: +def mock_input(lines: tuple[str, ...] = (), isatty: bool = True) -> Iterator[mock.MagicMock]: """Mock input.""" - with mock.patch( - "runway.cfngin.hooks.keypair.get_raw_input", side_effect=lines - ) as mock_get_raw_input: - with mock.patch.object(sys.stdin, "isatty", return_value=isatty): - yield mock_get_raw_input + with ( + mock.patch( + "runway.cfngin.hooks.keypair.get_raw_input", side_effect=lines + ) as mock_get_raw_input, + mock.patch.object(sys.stdin, "isatty", return_value=isatty), + ): + yield mock_get_raw_input -def assert_key_present( - hook_result: KeyPairInfo, key_name: str, fingerprint: str -) -> None: +def assert_key_present(hook_result: KeyPairInfo, key_name: str, fingerprint: str) -> None: """Assert key present.""" assert hook_result.get("key_name") == key_name assert hook_result.get("fingerprint") == fingerprint @@ -133,9 +130,7 @@ def test_import_file(tmp_path: Path, context: CfnginContext, ssh_key: SSHKey) -> pub_key = tmp_path / "id_rsa.pub" pub_key.write_bytes(ssh_key.public_key) - result = ensure_keypair_exists( - context, keypair=KEY_PAIR_NAME, public_key_path=str(pub_key) - ) + result = ensure_keypair_exists(context, keypair=KEY_PAIR_NAME, public_key_path=str(pub_key)) assert_key_present(result, KEY_PAIR_NAME, ssh_key.fingerprint) assert result.get("status") == "imported" @@ -145,16 +140,12 @@ def test_import_bad_key_data(tmp_path: Path, context: CfnginContext) -> None: pub_key = tmp_path / "id_rsa.pub" pub_key.write_text("garbage") - result = ensure_keypair_exists( - context, keypair=KEY_PAIR_NAME, public_key_path=str(pub_key) - ) + result = ensure_keypair_exists(context, keypair=KEY_PAIR_NAME, public_key_path=str(pub_key)) assert result == {} @pytest.mark.parametrize("ssm_key_id", ["my-key"]) -def test_create_in_ssm( - context: CfnginContext, ssh_key: SSHKey, ssm_key_id: str -) -> None: +def test_create_in_ssm(context: CfnginContext, ssh_key: SSHKey, ssm_key_id: str) -> None: """Test create in ssm.""" result = ensure_keypair_exists( context, @@ -168,9 +159,9 @@ def test_create_in_ssm( ssm = boto3.client("ssm") param = ssm.get_parameter(Name="param", WithDecryption=True).get("Parameter", {}) - assert param.get("Value", "").replace("\n", "") == ssh_key.private_key.decode( - "ascii" - ).replace(os.linesep, "") + assert param.get("Value", "").replace("\n", "") == ssh_key.private_key.decode("ascii").replace( + os.linesep, "" + ) assert param.get("Type") == "SecureString" params = ssm.describe_parameters().get("Parameters", []) @@ -199,9 +190,7 @@ def test_interactive_retry_cancel(context: CfnginContext) -> None: assert result == {} -def test_interactive_import( - tmp_path: Path, context: CfnginContext, ssh_key: SSHKey -) -> None: +def test_interactive_import(tmp_path: Path, context: CfnginContext, ssh_key: SSHKey) -> None: """.""" key_file = tmp_path / "id_rsa.pub" key_file.write_bytes(ssh_key.public_key) @@ -214,9 +203,7 @@ def test_interactive_import( assert result.get("status") == "imported" -def test_interactive_create( - tmp_path: Path, context: CfnginContext, ssh_key: SSHKey -) -> None: +def test_interactive_create(tmp_path: Path, context: CfnginContext, ssh_key: SSHKey) -> None: """Test interactive create.""" key_dir = tmp_path / "keys" key_dir.mkdir(parents=True, exist_ok=True) @@ -243,9 +230,7 @@ def test_interactive_create_bad_dir(tmp_path: Path, context: CfnginContext) -> N assert result == {} -def test_interactive_create_existing_file( - tmp_path: Path, context: CfnginContext -) -> None: +def test_interactive_create_existing_file(tmp_path: Path, context: CfnginContext) -> None: """Test interactive create existing file.""" key_dir = tmp_path / "keys" key_dir.mkdir(exist_ok=True, parents=True) diff --git a/tests/unit/cfngin/hooks/test_route53.py b/tests/unit/cfngin/hooks/test_route53.py index 96c9a969c..0c2ed79dd 100644 --- a/tests/unit/cfngin/hooks/test_route53.py +++ b/tests/unit/cfngin/hooks/test_route53.py @@ -9,26 +9,21 @@ if TYPE_CHECKING: from pytest_mock import MockerFixture - from ...factories import MockCFNginContext + from ...factories import MockCfnginContext MODULE = "runway.cfngin.hooks.route53" -def test_create_domain( - cfngin_context: MockCFNginContext, mocker: MockerFixture -) -> None: +def test_create_domain(cfngin_context: MockCfnginContext, mocker: MockerFixture) -> None: """Test create_domain.""" domain = "foo" - create_route53_zone = mocker.patch( - f"{MODULE}.create_route53_zone", return_value="bar" - ) + create_route53_zone = mocker.patch(f"{MODULE}.create_route53_zone", return_value="bar") _ = cfngin_context.add_stubber("route53") assert create_domain(cfngin_context, domain=domain) == { "domain": domain, "zone_id": create_route53_zone.return_value, } - # pylint: disable=protected-access create_route53_zone.assert_called_once_with( - cfngin_context._boto3_test_client[f"route53.{cfngin_context.env.aws_region}"], + cfngin_context.get_stubbed_client("route53"), domain, ) diff --git a/tests/unit/cfngin/hooks/test_utils.py b/tests/unit/cfngin/hooks/test_utils.py index 28b3976fa..1ba1ee152 100644 --- a/tests/unit/cfngin/hooks/test_utils.py +++ b/tests/unit/cfngin/hooks/test_utils.py @@ -1,15 +1,16 @@ """Tests for runway.cfngin.hooks.utils.""" -# pylint: disable=unused-argument, broad-exception-raised -# pyright: basic, reportUnknownArgumentType=none, reportUnknownVariableType=none +# pyright: reportUnknownArgumentType=none, reportUnknownVariableType=none from __future__ import annotations import queue import unittest -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any, ClassVar +from unittest.mock import call, patch -from mock import call, patch +import pytest +from runway.cfngin.hooks.base import HookArgsBaseModel from runway.cfngin.hooks.protocols import CfnginHookProtocol from runway.cfngin.hooks.utils import handle_hooks from runway.config.models.cfngin import CfnginHookDefinitionModel @@ -17,7 +18,7 @@ from ..factories import mock_context, mock_provider if TYPE_CHECKING: - from mock import MagicMock + from unittest.mock import MagicMock HOOK_QUEUE = queue.Queue() @@ -34,36 +35,34 @@ def test_empty_hook_stage(self) -> None: """Test empty hook stage.""" hooks = [] handle_hooks("fake", hooks, self.provider, self.context) - self.assertTrue(HOOK_QUEUE.empty()) + assert HOOK_QUEUE.empty() def test_missing_required_hook(self) -> None: """Test missing required hook.""" hooks = [CfnginHookDefinitionModel(path="not.a.real.path", required=True)] - with self.assertRaises(ImportError): + with pytest.raises(ImportError): handle_hooks("missing", hooks, self.provider, self.context) def test_missing_required_hook_method(self) -> None: """Test missing required hook method.""" - with self.assertRaises(AttributeError): - hooks = [ - CfnginHookDefinitionModel( - path="runway.cfngin.hooks.blah", required=True - ) - ] - handle_hooks("missing", hooks, self.provider, self.context) + with pytest.raises(AttributeError): + handle_hooks( + "missing", + [CfnginHookDefinitionModel(path="runway.cfngin.hooks.blah", required=True)], + self.provider, + self.context, + ) def test_missing_non_required_hook_method(self) -> None: """Test missing non required hook method.""" - hooks = [ - CfnginHookDefinitionModel(path="runway.cfngin.hooks.blah", required=False) - ] + hooks = [CfnginHookDefinitionModel(path="runway.cfngin.hooks.blah", required=False)] handle_hooks("missing", hooks, self.provider, self.context) - self.assertTrue(HOOK_QUEUE.empty()) + assert HOOK_QUEUE.empty() def test_default_required_hook(self) -> None: """Test default required hook.""" - hooks = [CfnginHookDefinitionModel(**{"path": "runway.cfngin.hooks.blah"})] - with self.assertRaises(AttributeError): + hooks = [CfnginHookDefinitionModel(path="runway.cfngin.hooks.blah")] + with pytest.raises(AttributeError): handle_hooks("missing", hooks, self.provider, self.context) @patch("runway.cfngin.hooks.utils.load_object_from_string") @@ -86,8 +85,8 @@ def test_valid_hook(self, mock_load: MagicMock) -> None: [call(hooks[0].path, try_reload=True), call(hooks[1].path, try_reload=True)] ) good = HOOK_QUEUE.get_nowait() - self.assertEqual(good["provider"].region, "us-east-1") - with self.assertRaises(queue.Empty): + assert good["provider"].region == "us-east-1" + with pytest.raises(queue.Empty): HOOK_QUEUE.get_nowait() def test_valid_enabled_hook(self) -> None: @@ -101,8 +100,8 @@ def test_valid_enabled_hook(self) -> None: ] handle_hooks("missing", hooks, self.provider, self.context) good = HOOK_QUEUE.get_nowait() - self.assertEqual(good["provider"].region, "us-east-1") - with self.assertRaises(queue.Empty): + assert good["provider"].region == "us-east-1" + with pytest.raises(queue.Empty): HOOK_QUEUE.get_nowait() def test_valid_enabled_false_hook(self) -> None: @@ -115,7 +114,7 @@ def test_valid_enabled_false_hook(self) -> None: ) ] handle_hooks("missing", hooks, self.provider, self.context) - self.assertTrue(HOOK_QUEUE.empty()) + assert HOOK_QUEUE.empty() def test_context_provided_to_hook(self) -> None: """Test context provided to hook.""" @@ -135,7 +134,7 @@ def test_hook_failure(self) -> None: required=True, ) ] - with self.assertRaises(SystemExit): + with pytest.raises(SystemExit): handle_hooks("fail", hooks, self.provider, self.context) hooks = [ CfnginHookDefinitionModel( @@ -143,7 +142,7 @@ def test_hook_failure(self) -> None: required=True, ) ] - with self.assertRaises(Exception): # noqa: B017 + with pytest.raises(Exception): # noqa: B017, PT011 handle_hooks("fail", hooks, self.provider, self.context) hooks = [ CfnginHookDefinitionModel( @@ -162,15 +161,13 @@ def test_return_data_hook(self) -> None: data_key="my_hook_results", ), # Shouldn't return data - CfnginHookDefinitionModel( - path="tests.unit.cfngin.hooks.test_utils.context_hook" - ), + CfnginHookDefinitionModel(path="tests.unit.cfngin.hooks.test_utils.context_hook"), ] handle_hooks("result", hooks, self.provider, self.context) - self.assertEqual(self.context.hook_data["my_hook_results"]["foo"], "bar") + assert self.context.hook_data["my_hook_results"]["foo"] == "bar" # Verify only the first hook resulted in stored data - self.assertEqual(list(self.context.hook_data.keys()), ["my_hook_results"]) + assert list(self.context.hook_data.keys()) == ["my_hook_results"] def test_return_data_hook_duplicate_key(self) -> None: """Test return data hook duplicate key.""" @@ -185,7 +182,7 @@ def test_return_data_hook_duplicate_key(self) -> None: ), ] - with self.assertRaises(KeyError): + with pytest.raises(KeyError): handle_hooks("result", hooks, self.provider, self.context) def test_resolve_lookups_in_args(self) -> None: @@ -199,63 +196,63 @@ def test_resolve_lookups_in_args(self) -> None: ] handle_hooks("lookups", hooks, self.provider, self.context) - self.assertEqual( - self.context.hook_data["my_hook_results"]["default_lookup"], "default_value" - ) + assert self.context.hook_data["my_hook_results"]["default_lookup"] == "default_value" class MockHook(CfnginHookProtocol): """Mock hook class.""" - args: Dict[str, Any] + ARGS_PARSER: ClassVar[type[HookArgsBaseModel]] = HookArgsBaseModel + + args: dict[str, Any] - def __init__(self, **kwargs: Any) -> None: # pylint: disable=super-init-not-called + def __init__(self, **_kwargs: Any) -> None: """Instantiate class.""" - self.args = {} + self.args = {} # type: ignore - def post_deploy(self) -> Dict[str, str]: + def post_deploy(self) -> dict[str, str]: """Run during the **post_deploy** stage.""" return {"status": "success"} - def post_destroy(self) -> Dict[str, str]: + def post_destroy(self) -> dict[str, str]: """Run during the **post_destroy** stage.""" return {"status": "success"} - def pre_deploy(self) -> Dict[str, str]: + def pre_deploy(self) -> dict[str, str]: """Run during the **pre_deploy** stage.""" return {"status": "success"} - def pre_destroy(self) -> Dict[str, str]: + def pre_destroy(self) -> dict[str, str]: """Run during the **pre_destroy** stage.""" return {"status": "success"} -def mock_hook(*args: Any, **kwargs: Any) -> bool: +def mock_hook(*_args: Any, **kwargs: Any) -> bool: """Mock hook.""" HOOK_QUEUE.put(kwargs) return True -def fail_hook(*args: Any, **kwargs: Any) -> None: +def fail_hook(*_args: Any, **_kwargs: Any) -> None: """Fail hook.""" - return None + return -def exception_hook(*args: Any, **kwargs: Any) -> None: +def exception_hook(*_args: Any, **_kwargs: Any) -> None: """Exception hook.""" raise Exception -def context_hook(*args: Any, **kwargs: Any) -> bool: +def context_hook(*_args: Any, **kwargs: Any) -> bool: """Context hook.""" return "context" in kwargs -def result_hook(*args: Any, **kwargs: Any) -> Dict[str, str]: +def result_hook(*_args: Any, **_kwargs: Any) -> dict[str, str]: """Results hook.""" return {"foo": "bar"} -def kwargs_hook(*args: Any, **kwargs: Any) -> Any: +def kwargs_hook(*_args: Any, **kwargs: Any) -> Any: """Kwargs hook.""" return kwargs diff --git a/tests/unit/cfngin/lookups/handlers/test_ami.py b/tests/unit/cfngin/lookups/handlers/test_ami.py index b1b09756c..86bc853da 100644 --- a/tests/unit/cfngin/lookups/handlers/test_ami.py +++ b/tests/unit/cfngin/lookups/handlers/test_ami.py @@ -10,7 +10,7 @@ from runway.cfngin.lookups.handlers.ami import AmiLookup, ImageNotFound if TYPE_CHECKING: - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext REGION = "us-east-1" @@ -18,7 +18,7 @@ class TestAMILookup: """Tests for runway.cfngin.lookups.handlers.ami.AmiLookup.""" - def test_basic_lookup_single_image(self, cfngin_context: MockCFNginContext) -> None: + def test_basic_lookup_single_image(self, cfngin_context: MockCfnginContext) -> None: """Test basic lookup single image.""" executable_users = ["123456789012", "234567890123"] stubber = cfngin_context.add_stubber("ec2") @@ -55,7 +55,7 @@ def test_basic_lookup_single_image(self, cfngin_context: MockCFNginContext) -> N == image_id ) - def test_basic_lookup_with_region(self, cfngin_context: MockCFNginContext) -> None: + def test_basic_lookup_with_region(self, cfngin_context: MockCfnginContext) -> None: """Test basic lookup with region.""" stubber = cfngin_context.add_stubber("ec2", region="us-west-1") image_id = "ami-fffccc111" @@ -86,9 +86,7 @@ def test_basic_lookup_with_region(self, cfngin_context: MockCFNginContext) -> No == image_id ) - def test_basic_lookup_multiple_images( - self, cfngin_context: MockCFNginContext - ) -> None: + def test_basic_lookup_multiple_images(self, cfngin_context: MockCfnginContext) -> None: """Test basic lookup multiple images.""" stubber = cfngin_context.add_stubber("ec2") image_id = "ami-fffccc111" @@ -139,7 +137,7 @@ def test_basic_lookup_multiple_images( ) def test_basic_lookup_multiple_images_name_match( - self, cfngin_context: MockCFNginContext + self, cfngin_context: MockCfnginContext ) -> None: """Test basic lookup multiple images name match.""" stubber = cfngin_context.add_stubber("ec2") @@ -180,9 +178,7 @@ def test_basic_lookup_multiple_images_name_match( == image_id ) - def test_basic_lookup_no_matching_images( - self, cfngin_context: MockCFNginContext - ) -> None: + def test_basic_lookup_no_matching_images(self, cfngin_context: MockCfnginContext) -> None: """Test basic lookup no matching images.""" stubber = cfngin_context.add_stubber("ec2") stubber.add_response("describe_images", {"Images": []}) @@ -193,7 +189,7 @@ def test_basic_lookup_no_matching_images( ) def test_basic_lookup_no_matching_images_from_name( - self, cfngin_context: MockCFNginContext + self, cfngin_context: MockCfnginContext ) -> None: """Test basic lookup no matching images from name.""" stubber = cfngin_context.add_stubber("ec2") @@ -216,6 +212,4 @@ def test_basic_lookup_no_matching_images_from_name( ) with stubber, pytest.raises(ImageNotFound): - AmiLookup.handle( - value=r"owners:self name_regex:MyImage\s\d", context=cfngin_context - ) + AmiLookup.handle(value=r"owners:self name_regex:MyImage\s\d", context=cfngin_context) diff --git a/tests/unit/cfngin/lookups/handlers/test_awslambda.py b/tests/unit/cfngin/lookups/handlers/test_awslambda.py index 40b72678c..4044271d3 100644 --- a/tests/unit/cfngin/lookups/handlers/test_awslambda.py +++ b/tests/unit/cfngin/lookups/handlers/test_awslambda.py @@ -1,35 +1,28 @@ """Test runway.cfngin.lookups.handlers.awslambda.""" -# pylint: disable=redefined-outer-name from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import Mock import pytest -from mock import Mock from troposphere.awslambda import Code, Content -from runway.cfngin.exceptions import CfnginOnlyLookupError from runway.cfngin.hooks.awslambda.base_classes import AwsLambdaHook from runway.cfngin.hooks.awslambda.models.responses import AwsLambdaHookDeployResponse from runway.cfngin.lookups.handlers.awslambda import AwsLambdaLookup -from runway.config import CfnginConfig -from runway.config.models.cfngin import ( - CfnginConfigDefinitionModel, - CfnginHookDefinitionModel, -) from runway.lookups.handlers.base import LookupHandler if TYPE_CHECKING: from pytest_mock import MockerFixture - from runway.context import CfnginContext, RunwayContext + from runway.context import CfnginContext MODULE = "runway.cfngin.lookups.handlers.awslambda" QUERY = "test::foo=bar" -@pytest.fixture(scope="function") +@pytest.fixture() def hook_data() -> AwsLambdaHookDeployResponse: """Fixture for hook response data.""" return AwsLambdaHookDeployResponse( @@ -47,14 +40,13 @@ def hook_data() -> AwsLambdaHookDeployResponse: class TestAwsLambdaLookup: """Test AwsLambdaLookup.""" - def test_get_deployment_package_data( - self, hook_data: AwsLambdaHookDeployResponse - ) -> None: + def test_get_deployment_package_data(self, hook_data: AwsLambdaHookDeployResponse) -> None: """Test get_deployment_package_data.""" data_key = "test.key" assert ( AwsLambdaLookup.get_deployment_package_data( - Mock(hook_data={data_key: hook_data.dict(by_alias=True)}), data_key + Mock(hook_data={data_key: hook_data.dict(by_alias=True)}), + data_key, ) == hook_data ) @@ -68,22 +60,13 @@ def test_get_deployment_package_data_set_hook_data( """Test get_deployment_package_data set hook_data when it's missing.""" data_key = "test.key" hook = Mock(plan=Mock(return_value=hook_data.dict(by_alias=True))) - init_hook_class = mocker.patch.object( - AwsLambdaLookup, "init_hook_class", return_value=hook - ) - get_required_hook_definition = mocker.patch.object( + init_hook_class = mocker.patch.object(AwsLambdaLookup, "init_hook_class", return_value=hook) + get_hook_definition = mocker.patch.object( AwsLambdaLookup, "get_required_hook_definition", return_value="hook_def" ) - assert ( - AwsLambdaLookup.get_deployment_package_data(cfngin_context, data_key) - == hook_data - ) - get_required_hook_definition.assert_called_once_with( - cfngin_context.config, data_key - ) - init_hook_class.assert_called_once_with( - cfngin_context, get_required_hook_definition.return_value - ) + assert AwsLambdaLookup.get_deployment_package_data(cfngin_context, data_key) == hook_data + get_hook_definition.assert_called_once_with(cfngin_context.config, data_key) + init_hook_class.assert_called_once_with(cfngin_context, get_hook_definition.return_value) hook.plan.assert_called_once_with() assert cfngin_context.hook_data[data_key] == hook_data.dict(by_alias=True) @@ -93,79 +76,7 @@ def test_get_deployment_package_data_raise_type_error(self) -> None: assert not AwsLambdaLookup.get_deployment_package_data( Mock(hook_data={"test": {"invalid": True}}), "test" ) - assert "expected AwsLambdaHookDeployResponseTypedDict, not " in str( - excinfo.value - ) - - def test_get_required_hook_definition(self) -> None: - """Test get_required_hook_definition.""" - data_key = "test.data" - expected_hook = CfnginHookDefinitionModel(data_key=data_key, path="foo.bar") - config = CfnginConfig( - CfnginConfigDefinitionModel( - namespace="test", - pre_deploy=[ - expected_hook, - CfnginHookDefinitionModel(data_key="foo", path="foo"), - ], - pre_destroy=[ - CfnginHookDefinitionModel(data_key=data_key, path="pre_destroy") - ], - post_deploy=[ - CfnginHookDefinitionModel(data_key=data_key, path="post_deploy") - ], - post_destroy=[ - CfnginHookDefinitionModel(data_key=data_key, path="post_destroy") - ], - ) - ) - assert ( - AwsLambdaLookup.get_required_hook_definition(config, data_key) - == expected_hook - ) - - def test_get_required_hook_definition_raise_value_error_more_than_one(self) -> None: - """Test get_required_hook_definition raise ValueError for more than one.""" - data_key = "test.data" - expected_hook = CfnginHookDefinitionModel(data_key=data_key, path="foo.bar") - config = CfnginConfig( - CfnginConfigDefinitionModel( - namespace="test", - pre_deploy=[expected_hook, expected_hook], - ) - ) - with pytest.raises(ValueError) as excinfo: - assert not AwsLambdaLookup.get_required_hook_definition(config, data_key) - assert ( - str(excinfo.value) - == f"more than one hook definition found with data_key {data_key}" - ) - - def test_get_required_hook_definition_raise_value_error_none(self) -> None: - """Test get_required_hook_definition raise ValueError none found.""" - data_key = "test.data" - config = CfnginConfig( - CfnginConfigDefinitionModel( - namespace="test", - pre_deploy=[ - CfnginHookDefinitionModel(data_key="foo", path="foo"), - ], - pre_destroy=[ - CfnginHookDefinitionModel(data_key=data_key, path="pre_destroy") - ], - post_deploy=[ - CfnginHookDefinitionModel(data_key=data_key, path="post_deploy") - ], - post_destroy=[ - CfnginHookDefinitionModel(data_key=data_key, path="post_destroy") - ], - ) - ) - with pytest.raises(ValueError) as excinfo: - assert not AwsLambdaLookup.get_required_hook_definition(config, data_key) - assert ( - str(excinfo.value) == f"no hook definition found with data_key {data_key}" - ) + assert "expected AwsLambdaHookDeployResponseTypedDict, not " in str(excinfo.value) def test_handle(self, mocker: MockerFixture) -> None: """Test handle.""" @@ -176,12 +87,9 @@ def test_handle(self, mocker: MockerFixture) -> None: mock_get_deployment_package_data = mocker.patch.object( AwsLambdaLookup, "get_deployment_package_data", return_value="success" ) - mock_parse = mocker.patch.object( - AwsLambdaLookup, "parse", return_value=("query", {}) - ) + mock_parse = mocker.patch.object(AwsLambdaLookup, "parse", return_value=("query", {})) assert ( - AwsLambdaLookup.handle(QUERY, context) - == mock_get_deployment_package_data.return_value + AwsLambdaLookup.handle(QUERY, context) == mock_get_deployment_package_data.return_value ) mock_parse.assert_called_once_with(QUERY) mock_get_deployment_package_data.assert_called_once_with( @@ -189,13 +97,6 @@ def test_handle(self, mocker: MockerFixture) -> None: ) mock_format_results.assert_not_called() - def test_handle_raise_cfngin_only_lookup_error( - self, runway_context: RunwayContext - ) -> None: - """Test handle raise CfnginOnlyLookupError.""" - with pytest.raises(CfnginOnlyLookupError): - AwsLambdaLookup.handle("test", runway_context) - def test_init_hook_class(self, mocker: MockerFixture) -> None: """Test init_hook_class.""" context = Mock() @@ -207,19 +108,14 @@ def test_init_hook_class(self, mocker: MockerFixture) -> None: mock_isinstance = mocker.patch(f"{MODULE}.isinstance", return_value=True) mock_hasattr = mocker.patch(f"{MODULE}.hasattr", return_value=True) mock_issubclass = mocker.patch(f"{MODULE}.issubclass", return_value=True) - assert ( - AwsLambdaLookup.init_hook_class(context, hook_def) - == hook_class.return_value - ) + assert AwsLambdaLookup.init_hook_class(context, hook_def) == hook_class.return_value load_object_from_string.assert_called_once_with(hook_def.path) mock_isinstance.assert_called_once_with(hook_class, type) mock_hasattr.assert_called_once_with(hook_class, "__subclasscheck__") mock_issubclass.assert_called_once_with(hook_class, AwsLambdaHook) hook_class.assert_called_once_with(context, **hook_def.args) - def test_init_hook_class_raise_type_error_not_class( - self, mocker: MockerFixture - ) -> None: + def test_init_hook_class_raise_type_error_not_class(self, mocker: MockerFixture) -> None: """Test init_hook_class raise TypeError not a class.""" def _test_func() -> None: @@ -235,9 +131,7 @@ def _test_func() -> None: "must be a subclass of AwsLambdaHook to use this lookup" ) - def test_init_hook_class_raise_type_error_not_subclass( - self, mocker: MockerFixture - ) -> None: + def test_init_hook_class_raise_type_error_not_subclass(self, mocker: MockerFixture) -> None: """Test init_hook_class raise TypeError not a class.""" hook_class = Mock(return_value="success") context = Mock() @@ -256,299 +150,241 @@ def test_init_hook_class_raise_type_error_not_subclass( class TestAwsLambdaLookupCode: """Test TestAwsLambdaLookup.Code.""" - def test_handle( - self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture - ) -> None: + def test_handle(self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture) -> None: """Test handle.""" context = Mock() mock_format_results = mocker.patch.object( LookupHandler, "format_results", return_value="success" ) - mock_handle = mocker.patch.object( - AwsLambdaLookup, "handle", return_value=hook_data - ) - result = AwsLambdaLookup.Code.handle(QUERY, context, "arg", foo="bar") + mock_handle = mocker.patch.object(AwsLambdaLookup, "handle", return_value=hook_data) + result = AwsLambdaLookup.Code.handle(QUERY, context, foo="bar") assert isinstance(result, Code) assert not hasattr(result, "ImageUri") assert result.S3Bucket == hook_data.bucket_name assert result.S3Key == hook_data.object_key assert result.S3ObjectVersion == hook_data.object_version_id assert not hasattr(result, "ZipFile") - mock_handle.assert_called_once_with(QUERY, context, "arg", foo="bar") + mock_handle.assert_called_once_with(QUERY, context, foo="bar") mock_format_results.assert_not_called() def test_type_name(self) -> None: """Test TYPE_NAME.""" assert ( - AwsLambdaLookup.Code.TYPE_NAME - == f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.Code.__name__}" + f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.Code.__name__}" + == AwsLambdaLookup.Code.TYPE_NAME ) class TestAwsLambdaLookupCodeSha256: """Test TestAwsLambdaLookup.CodeSha256.""" - def test_handle( - self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture - ) -> None: + def test_handle(self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture) -> None: """Test handle.""" context = Mock() mock_format_results = mocker.patch.object( LookupHandler, "format_results", return_value="success" ) - mock_handle = mocker.patch.object( - AwsLambdaLookup, "handle", return_value=hook_data - ) - assert ( - AwsLambdaLookup.CodeSha256.handle(QUERY, context, "arg", foo="bar") - == hook_data.code_sha256 - ) - mock_handle.assert_called_once_with(QUERY, context, "arg", foo="bar") + mock_handle = mocker.patch.object(AwsLambdaLookup, "handle", return_value=hook_data) + assert AwsLambdaLookup.CodeSha256.handle(QUERY, context, foo="bar") == hook_data.code_sha256 + mock_handle.assert_called_once_with(QUERY, context, foo="bar") mock_format_results.assert_not_called() def test_type_name(self) -> None: """Test TYPE_NAME.""" assert ( - AwsLambdaLookup.CodeSha256.TYPE_NAME - == f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.CodeSha256.__name__}" + f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.CodeSha256.__name__}" + == AwsLambdaLookup.CodeSha256.TYPE_NAME ) class TestAwsLambdaLookupCompatibleArchitectures: """Test TestAwsLambdaLookup.CompatibleArchitectures.""" - def test_handle( - self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture - ) -> None: + def test_handle(self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture) -> None: """Test handle.""" context = Mock() mock_format_results = mocker.patch.object( LookupHandler, "format_results", return_value="success" ) - mock_handle = mocker.patch.object( - AwsLambdaLookup, "handle", return_value=hook_data - ) + mock_handle = mocker.patch.object(AwsLambdaLookup, "handle", return_value=hook_data) assert ( - AwsLambdaLookup.CompatibleArchitectures.handle( - QUERY, context, "arg", foo="bar" - ) + AwsLambdaLookup.CompatibleArchitectures.handle(QUERY, context, foo="bar") == mock_format_results.return_value ) - mock_handle.assert_called_once_with(QUERY, context, "arg", foo="bar") - mock_format_results.assert_called_once_with( - hook_data.compatible_architectures, foo="bar" - ) + mock_handle.assert_called_once_with(QUERY, context, foo="bar") + mock_format_results.assert_called_once_with(hook_data.compatible_architectures, foo="bar") def test_type_name(self) -> None: """Test TYPE_NAME.""" assert ( - AwsLambdaLookup.CompatibleArchitectures.TYPE_NAME - == f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.CompatibleArchitectures.__name__}" + f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.CompatibleArchitectures.__name__}" + == AwsLambdaLookup.CompatibleArchitectures.TYPE_NAME ) class TestAwsLambdaLookupCompatibleRuntimes: """Test TestAwsLambdaLookup.CompatibleRuntimes.""" - def test_handle( - self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture - ) -> None: + def test_handle(self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture) -> None: """Test handle.""" context = Mock() mock_format_results = mocker.patch.object( LookupHandler, "format_results", return_value="success" ) - mock_handle = mocker.patch.object( - AwsLambdaLookup, "handle", return_value=hook_data - ) + mock_handle = mocker.patch.object(AwsLambdaLookup, "handle", return_value=hook_data) assert ( - AwsLambdaLookup.CompatibleRuntimes.handle(QUERY, context, "arg", foo="bar") + AwsLambdaLookup.CompatibleRuntimes.handle(QUERY, context, foo="bar") == mock_format_results.return_value ) - mock_handle.assert_called_once_with(QUERY, context, "arg", foo="bar") - mock_format_results.assert_called_once_with( - hook_data.compatible_runtimes, foo="bar" - ) + mock_handle.assert_called_once_with(QUERY, context, foo="bar") + mock_format_results.assert_called_once_with(hook_data.compatible_runtimes, foo="bar") def test_type_name(self) -> None: """Test TYPE_NAME.""" assert ( - AwsLambdaLookup.CompatibleRuntimes.TYPE_NAME - == f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.CompatibleRuntimes.__name__}" + f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.CompatibleRuntimes.__name__}" + == AwsLambdaLookup.CompatibleRuntimes.TYPE_NAME ) class TestAwsLambdaLookupContent: """Test TestAwsLambdaLookup.Content.""" - def test_handle( - self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture - ) -> None: + def test_handle(self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture) -> None: """Test handle.""" context = Mock() mock_format_results = mocker.patch.object( LookupHandler, "format_results", return_value="success" ) - mock_handle = mocker.patch.object( - AwsLambdaLookup, "handle", return_value=hook_data - ) - result = AwsLambdaLookup.Content.handle(QUERY, context, "arg", foo="bar") + mock_handle = mocker.patch.object(AwsLambdaLookup, "handle", return_value=hook_data) + result = AwsLambdaLookup.Content.handle(QUERY, context, foo="bar") assert isinstance(result, Content) assert not hasattr(result, "ImageUri") assert result.S3Bucket == hook_data.bucket_name assert result.S3Key == hook_data.object_key assert result.S3ObjectVersion == hook_data.object_version_id - mock_handle.assert_called_once_with(QUERY, context, "arg", foo="bar") + mock_handle.assert_called_once_with(QUERY, context, foo="bar") mock_format_results.assert_not_called() def test_type_name(self) -> None: """Test TYPE_NAME.""" assert ( - AwsLambdaLookup.Content.TYPE_NAME - == f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.Content.__name__}" + f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.Content.__name__}" + == AwsLambdaLookup.Content.TYPE_NAME ) class TestAwsLambdaLookupLicenseInfo: """Test TestAwsLambdaLookup.LicenseInfo.""" - def test_handle( - self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture - ) -> None: + def test_handle(self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture) -> None: """Test handle.""" context = Mock() mock_format_results = mocker.patch.object( LookupHandler, "format_results", return_value="success" ) - mock_handle = mocker.patch.object( - AwsLambdaLookup, "handle", return_value=hook_data - ) + mock_handle = mocker.patch.object(AwsLambdaLookup, "handle", return_value=hook_data) assert ( - AwsLambdaLookup.LicenseInfo.handle(QUERY, context, "arg", foo="bar") + AwsLambdaLookup.LicenseInfo.handle(QUERY, context, foo="bar") == mock_format_results.return_value ) - mock_handle.assert_called_once_with(QUERY, context, "arg", foo="bar") + mock_handle.assert_called_once_with(QUERY, context, foo="bar") mock_format_results.assert_called_once_with(hook_data.license, foo="bar") def test_type_name(self) -> None: """Test TYPE_NAME.""" assert ( - AwsLambdaLookup.LicenseInfo.TYPE_NAME - == f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.LicenseInfo.__name__}" + f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.LicenseInfo.__name__}" + == AwsLambdaLookup.LicenseInfo.TYPE_NAME ) class TestAwsLambdaLookupRuntime: """Test TestAwsLambdaLookup.Runtime.""" - def test_handle( - self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture - ) -> None: + def test_handle(self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture) -> None: """Test handle.""" context = Mock() mock_format_results = mocker.patch.object( LookupHandler, "format_results", return_value="success" ) - mock_handle = mocker.patch.object( - AwsLambdaLookup, "handle", return_value=hook_data - ) - assert ( - AwsLambdaLookup.Runtime.handle(QUERY, context, "arg", foo="bar") - == hook_data.runtime - ) - mock_handle.assert_called_once_with(QUERY, context, "arg", foo="bar") + mock_handle = mocker.patch.object(AwsLambdaLookup, "handle", return_value=hook_data) + assert AwsLambdaLookup.Runtime.handle(QUERY, context, foo="bar") == hook_data.runtime + mock_handle.assert_called_once_with(QUERY, context, foo="bar") mock_format_results.assert_not_called() def test_type_name(self) -> None: """Test TYPE_NAME.""" assert ( - AwsLambdaLookup.Runtime.TYPE_NAME - == f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.Runtime.__name__}" + f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.Runtime.__name__}" + == AwsLambdaLookup.Runtime.TYPE_NAME ) class TestAwsLambdaLookupS3Bucket: """Test TestAwsLambdaLookup.S3Bucket.""" - def test_handle( - self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture - ) -> None: + def test_handle(self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture) -> None: """Test handle.""" context = Mock() mock_format_results = mocker.patch.object( LookupHandler, "format_results", return_value="success" ) - mock_handle = mocker.patch.object( - AwsLambdaLookup, "handle", return_value=hook_data - ) - assert ( - AwsLambdaLookup.S3Bucket.handle(QUERY, context, "arg", foo="bar") - == hook_data.bucket_name - ) - mock_handle.assert_called_once_with(QUERY, context, "arg", foo="bar") + mock_handle = mocker.patch.object(AwsLambdaLookup, "handle", return_value=hook_data) + assert AwsLambdaLookup.S3Bucket.handle(QUERY, context, foo="bar") == hook_data.bucket_name + mock_handle.assert_called_once_with(QUERY, context, foo="bar") mock_format_results.assert_not_called() def test_type_name(self) -> None: """Test TYPE_NAME.""" assert ( - AwsLambdaLookup.S3Bucket.TYPE_NAME - == f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.S3Bucket.__name__}" + f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.S3Bucket.__name__}" + == AwsLambdaLookup.S3Bucket.TYPE_NAME ) class TestAwsLambdaLookupS3Key: """Test TestAwsLambdaLookup.S3Key.""" - def test_handle( - self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture - ) -> None: + def test_handle(self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture) -> None: """Test handle.""" context = Mock() mock_format_results = mocker.patch.object( LookupHandler, "format_results", return_value="success" ) - mock_handle = mocker.patch.object( - AwsLambdaLookup, "handle", return_value=hook_data - ) - assert ( - AwsLambdaLookup.S3Key.handle(QUERY, context, "arg", foo="bar") - == hook_data.object_key - ) - mock_handle.assert_called_once_with(QUERY, context, "arg", foo="bar") + mock_handle = mocker.patch.object(AwsLambdaLookup, "handle", return_value=hook_data) + assert AwsLambdaLookup.S3Key.handle(QUERY, context, foo="bar") == hook_data.object_key + mock_handle.assert_called_once_with(QUERY, context, foo="bar") mock_format_results.assert_not_called() def test_type_name(self) -> None: """Test TYPE_NAME.""" assert ( - AwsLambdaLookup.S3Key.TYPE_NAME - == f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.S3Key.__name__}" + f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.S3Key.__name__}" + == AwsLambdaLookup.S3Key.TYPE_NAME ) class TestAwsLambdaLookupS3ObjectVersion: """Test TestAwsLambdaLookup.S3ObjectVersion.""" - def test_handle( - self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture - ) -> None: + def test_handle(self, hook_data: AwsLambdaHookDeployResponse, mocker: MockerFixture) -> None: """Test handle.""" context = Mock() mock_format_results = mocker.patch.object( LookupHandler, "format_results", return_value="success" ) - mock_handle = mocker.patch.object( - AwsLambdaLookup, "handle", return_value=hook_data - ) + mock_handle = mocker.patch.object(AwsLambdaLookup, "handle", return_value=hook_data) assert ( - AwsLambdaLookup.S3ObjectVersion.handle(QUERY, context, "arg", foo="bar") + AwsLambdaLookup.S3ObjectVersion.handle(QUERY, context, foo="bar") == hook_data.object_version_id ) - mock_handle.assert_called_once_with(QUERY, context, "arg", foo="bar") + mock_handle.assert_called_once_with(QUERY, context, foo="bar") mock_format_results.assert_not_called() def test_type_name(self) -> None: """Test TYPE_NAME.""" assert ( - AwsLambdaLookup.S3ObjectVersion.TYPE_NAME - == f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.S3ObjectVersion.__name__}" + f"{AwsLambdaLookup.TYPE_NAME}.{AwsLambdaLookup.S3ObjectVersion.__name__}" + == AwsLambdaLookup.S3ObjectVersion.TYPE_NAME ) diff --git a/tests/unit/cfngin/lookups/handlers/test_default.py b/tests/unit/cfngin/lookups/handlers/test_default.py index 173766fb2..ea77f9783 100644 --- a/tests/unit/cfngin/lookups/handlers/test_default.py +++ b/tests/unit/cfngin/lookups/handlers/test_default.py @@ -1,9 +1,9 @@ """Tests for runway.cfngin.lookups.handlers.default.""" -# pyright: basic import unittest +from unittest.mock import MagicMock -from mock import MagicMock +import pytest from runway.cfngin.lookups.handlers.default import DefaultLookup from runway.context import CfnginContext @@ -15,28 +15,21 @@ class TestDefaultLookup(unittest.TestCase): def setUp(self) -> None: """Run before tests.""" self.provider = MagicMock() - self.context = CfnginContext( - parameters={"namespace": "test", "env_var": "val_in_env"} - ) + self.context = CfnginContext(parameters={"namespace": "test", "env_var": "val_in_env"}) def test_env_var_present(self) -> None: """Test env var present.""" lookup_val = "env_var::fallback" - value = DefaultLookup.handle( - lookup_val, provider=self.provider, context=self.context - ) + value = DefaultLookup.handle(lookup_val, provider=self.provider, context=self.context) assert value == "val_in_env" def test_env_var_missing(self) -> None: """Test env var missing.""" lookup_val = "bad_env_var::fallback" - value = DefaultLookup.handle( - lookup_val, provider=self.provider, context=self.context - ) + value = DefaultLookup.handle(lookup_val, provider=self.provider, context=self.context) assert value == "fallback" def test_invalid_value(self) -> None: """Test invalid value.""" - with self.assertRaises(ValueError): - value = "env_var:fallback" - DefaultLookup.handle(value, provider=self.provider, context=self.context) + with pytest.raises(ValueError): # noqa: PT011 + DefaultLookup.handle("env_var:fallback", provider=self.provider, context=self.context) diff --git a/tests/unit/cfngin/lookups/handlers/test_dynamodb.py b/tests/unit/cfngin/lookups/handlers/test_dynamodb.py index 3cba59350..c0600680f 100644 --- a/tests/unit/cfngin/lookups/handlers/test_dynamodb.py +++ b/tests/unit/cfngin/lookups/handlers/test_dynamodb.py @@ -1,16 +1,15 @@ """Tests for runway.cfngin.lookups.handlers.dynamodb.""" -# pyright: basic from __future__ import annotations -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any import pytest from runway.cfngin.lookups.handlers.dynamodb import DynamodbLookup, QueryDataModel if TYPE_CHECKING: - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext GET_ITEM_RESPONSE = { "Item": { @@ -57,7 +56,7 @@ class TestDynamoDBHandler: ) def test_handle( self, - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, expected_projection: str, expected_result: str, query: str, @@ -71,12 +70,10 @@ def test_handle( } stubber.add_response("get_item", GET_ITEM_RESPONSE, expected_params) with stubber: - assert ( - DynamodbLookup.handle(query, context=cfngin_context) == expected_result - ) + assert DynamodbLookup.handle(query, context=cfngin_context) == expected_result stubber.assert_no_pending_responses() - def test_handle_client_error(self, cfngin_context: MockCFNginContext) -> None: + def test_handle_client_error(self, cfngin_context: MockCfnginContext) -> None: """Test handle ClientError.""" stubber = cfngin_context.add_stubber("dynamodb") expected_params = { @@ -89,23 +86,20 @@ def test_handle_client_error(self, cfngin_context: MockCFNginContext) -> None: expected_params=expected_params, ) query = "TestTable@FakeKey:TestVal.TestMap[M].String1" - with stubber, pytest.raises(ValueError) as excinfo: + with ( + stubber, + pytest.raises(ValueError, match="The DynamoDB lookup '.*' encountered an error: .*"), + ): DynamodbLookup.handle(query, context=cfngin_context) stubber.assert_no_pending_responses() - assert str(excinfo.value).startswith( - f"The DynamoDB lookup '{query}' encountered an error: " - ) - def test_handle_empty_table_name(self, cfngin_context: MockCFNginContext) -> None: + def test_handle_empty_table_name(self, cfngin_context: MockCfnginContext) -> None: """Test handle with empty table_name.""" query = "@TestKey:TestVal.TestMap[M].String1" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="Query '.*' doesn't match regex:"): DynamodbLookup.handle(query, context=cfngin_context) - assert str(excinfo.value).startswith(f"Query '{query}' doesn't match regex:") - def test_handle_invalid_partition_key( - self, cfngin_context: MockCFNginContext - ) -> None: + def test_handle_invalid_partition_key(self, cfngin_context: MockCfnginContext) -> None: """Test handle with invalid partition key.""" stubber = cfngin_context.add_stubber("dynamodb") expected_params = { @@ -120,19 +114,19 @@ def test_handle_invalid_partition_key( expected_params=expected_params, ) - with stubber, pytest.raises(ValueError) as excinfo: + with ( + stubber, + pytest.raises( + ValueError, + match="No DynamoDB record matched the partition key: FakeKey", + ), + ): DynamodbLookup.handle( "TestTable@FakeKey:TestVal.TestMap[M].String1", context=cfngin_context ) stubber.assert_no_pending_responses() - assert ( - str(excinfo.value) - == "No DynamoDB record matched the partition key: FakeKey" - ) - def test_handle_invalid_partition_value( - self, cfngin_context: MockCFNginContext - ) -> None: + def test_handle_invalid_partition_value(self, cfngin_context: MockCfnginContext) -> None: """Test handle with invalid partition value.""" stubber = cfngin_context.add_stubber("dynamodb") expected_params = { @@ -140,19 +134,21 @@ def test_handle_invalid_partition_value( "Key": {"TestKey": {"S": "FakeVal"}}, "ProjectionExpression": "TestKey,TestMap,String1", } - empty_response: Dict[str, Any] = {"ResponseMetadata": {}} + empty_response: dict[str, Any] = {"ResponseMetadata": {}} stubber.add_response("get_item", empty_response, expected_params) - with stubber, pytest.raises(ValueError) as excinfo: + with ( + stubber, + pytest.raises( + ValueError, + match="The DynamoDB record could not be found using the following: " + "{'TestKey': {'S': 'FakeVal'}}", + ), + ): DynamodbLookup.handle( "TestTable@TestKey:FakeVal.TestMap[M].String1", context=cfngin_context ) - assert ( - str(excinfo.value) - == "The DynamoDB record could not be found using the following: " - "{'TestKey': {'S': 'FakeVal'}}" - ) - def test_handle_list(self, cfngin_context: MockCFNginContext) -> None: + def test_handle_list(self, cfngin_context: MockCfnginContext) -> None: """Test handle return list.""" stubber = cfngin_context.add_stubber("dynamodb") expected_params = { @@ -167,16 +163,13 @@ def test_handle_list(self, cfngin_context: MockCFNginContext) -> None: ) == ["ListVal1", "ListVal2"] stubber.assert_no_pending_responses() - def test_handle_missing_table_name(self, cfngin_context: MockCFNginContext) -> None: + def test_handle_missing_table_name(self, cfngin_context: MockCfnginContext) -> None: """Test handle missing table_name.""" query = "TestKey:TestVal.TestMap[M].String1" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="'.*' missing delimiter for DynamoDB Table name:"): DynamodbLookup.handle(query, context=cfngin_context) - assert str(excinfo.value).startswith( - f"'{query}' missing delimiter for DynamoDB Table name:" - ) - def test_handle_number(self, cfngin_context: MockCFNginContext) -> None: + def test_handle_number(self, cfngin_context: MockCfnginContext) -> None: """Test handle return number.""" stubber = cfngin_context.add_stubber("dynamodb") expected_params = { @@ -196,7 +189,7 @@ def test_handle_number(self, cfngin_context: MockCFNginContext) -> None: ) stubber.assert_no_pending_responses() - def test_handle_table_not_found(self, cfngin_context: MockCFNginContext) -> None: + def test_handle_table_not_found(self, cfngin_context: MockCfnginContext) -> None: """Test handle DDB Table not found.""" stubber = cfngin_context.add_stubber("dynamodb") expected_params = { @@ -210,24 +203,21 @@ def test_handle_table_not_found(self, cfngin_context: MockCFNginContext) -> None service_error_code=service_error_code, expected_params=expected_params, ) - with stubber, pytest.raises(ValueError) as excinfo: + with ( + stubber, + pytest.raises(ValueError, match="Can't find the DynamoDB table: FakeTable"), + ): DynamodbLookup.handle( "FakeTable@TestKey:TestVal.TestMap[M].String1", context=cfngin_context ) stubber.assert_no_pending_responses() - assert str(excinfo.value) == "Can't find the DynamoDB table: FakeTable" - def test_handle_unsupported_data_type( - self, cfngin_context: MockCFNginContext - ) -> None: + def test_handle_unsupported_data_type(self, cfngin_context: MockCfnginContext) -> None: """Test handle with unsupported data type.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="CFNgin does not support looking up the data type: B"): DynamodbLookup.handle( "TestTable@TestKey:FakeVal.TestStringSet[B]", context=cfngin_context ) - assert ( - str(excinfo.value) == "CFNgin does not support looking up the data type: B" - ) class TestQueryDataModel: @@ -242,7 +232,7 @@ class TestQueryDataModel: ("TestVal[S]", {"S": "TestVal"}), ], ) - def test_item_key(self, expected: Dict[str, Any], value: str) -> None: + def test_item_key(self, expected: dict[str, Any], value: str) -> None: """Test item_key.""" assert QueryDataModel( attribute="", @@ -259,8 +249,8 @@ def test_item_key_no_match(self) -> None: partition_key_value="TestVal[L]", table_name="", ) - with pytest.raises(ValueError) as excinfo: + with pytest.raises( + ValueError, + match="Partition key value '.*' doesn't match regex: .*", + ): assert obj.item_key - assert str(excinfo.value).startswith( - f"Partition key value '{obj.partition_key_value}' doesn't match regex:" - ) diff --git a/tests/unit/cfngin/lookups/handlers/test_envvar.py b/tests/unit/cfngin/lookups/handlers/test_envvar.py index f5d011d5a..c7e3f6703 100644 --- a/tests/unit/cfngin/lookups/handlers/test_envvar.py +++ b/tests/unit/cfngin/lookups/handlers/test_envvar.py @@ -1,9 +1,10 @@ """Tests for runway.cfngin.lookups.handlers.envvar.""" -# pyright: basic import os import unittest +import pytest + from runway.cfngin.lookups.handlers.envvar import EnvvarLookup @@ -20,9 +21,9 @@ def setUp(self) -> None: def test_valid_envvar(self) -> None: """Test valid envvar.""" value = EnvvarLookup.handle(self.testkey) - self.assertEqual(value, self.testval) + assert value == self.testval def test_invalid_envvar(self) -> None: """Test invalid envvar.""" - with self.assertRaises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 EnvvarLookup.handle(self.invalidtestkey) diff --git a/tests/unit/cfngin/lookups/handlers/test_file.py b/tests/unit/cfngin/lookups/handlers/test_file.py index fcd5aff37..79e798123 100644 --- a/tests/unit/cfngin/lookups/handlers/test_file.py +++ b/tests/unit/cfngin/lookups/handlers/test_file.py @@ -91,9 +91,7 @@ def test_handle_json_parameterized(self, tmp_path: Path) -> None: tmp_file = tmp_path / "test" tmp_file.write_text(data, encoding="utf-8") - assert_template_dicts( - FileLookup.handle(f"json-parameterized:file://{tmp_file}"), expected - ) + assert_template_dicts(FileLookup.handle(f"json-parameterized:file://{tmp_file}"), expected) assert_template_dicts(FileLookup.handle(f"json-parameterized:{data}"), expected) @pytest.mark.parametrize( @@ -106,16 +104,12 @@ def test_handle_json_parameterized(self, tmp_path: Path) -> None: ("Test Without Interpolation Here", "Test Without Interpolation Here"), ], ) - def test_handle_parameterized( - self, data: str, expected: Any, tmp_path: Path - ) -> None: + def test_handle_parameterized(self, data: str, expected: Any, tmp_path: Path) -> None: """Test handle parameterized.""" tmp_file = tmp_path / "test" tmp_file.write_text(data, encoding="utf-8") - assert_template_dicts( - FileLookup.handle(f"parameterized:file://{tmp_file}"), expected - ) + assert_template_dicts(FileLookup.handle(f"parameterized:file://{tmp_file}"), expected) assert_template_dicts(FileLookup.handle(f"parameterized:{data}"), expected) @pytest.mark.parametrize( @@ -131,16 +125,12 @@ def test_handle_parameterized( ), ], ) - def test_handle_parameterized_b64( - self, data: str, expected: Base64, tmp_path: Path - ) -> None: + def test_handle_parameterized_b64(self, data: str, expected: Base64, tmp_path: Path) -> None: """Test handle parameterized-b64.""" tmp_file = tmp_path / "test" tmp_file.write_text(data, encoding="utf-8") - assert_template_dicts( - FileLookup.handle(f"parameterized-b64:file://{tmp_file}"), expected - ) + assert_template_dicts(FileLookup.handle(f"parameterized-b64:file://{tmp_file}"), expected) assert_template_dicts(FileLookup.handle(f"parameterized-b64:{data}"), expected) def test_handle_plain(self, tmp_path: Path) -> None: @@ -166,13 +156,8 @@ def test_handle_raise_validation_error(self) -> None: def test_handle_raise_value_error(self) -> None: """Test handle raise ValueError.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="Query 'foo' doesn't match regex: "): FileLookup.handle("foo") - assert ( - str(excinfo.value) == "Query 'foo' doesn't match regex: " - "^(?P[base64|json|json-parameterized|parameterized|" - "parameterized-b64|plain|yaml|yaml-parameterized]:.+$)" - ) def test_handle_yaml(self, tmp_path: Path) -> None: """Test handle yaml.""" @@ -199,7 +184,5 @@ def test_handle_yaml_parameterized(self, tmp_path: Path) -> None: tmp_file = tmp_path / "test" tmp_file.write_text(data, encoding="utf-8") - assert_template_dicts( - FileLookup.handle(f"yaml-parameterized:file://{tmp_file}"), expected - ) + assert_template_dicts(FileLookup.handle(f"yaml-parameterized:file://{tmp_file}"), expected) assert_template_dicts(FileLookup.handle(f"yaml-parameterized:{data}"), expected) diff --git a/tests/unit/cfngin/lookups/handlers/test_hook_data.py b/tests/unit/cfngin/lookups/handlers/test_hook_data.py index 33fcd1136..bd50703b9 100644 --- a/tests/unit/cfngin/lookups/handlers/test_hook_data.py +++ b/tests/unit/cfngin/lookups/handlers/test_hook_data.py @@ -1,6 +1,5 @@ """Tests for runway.cfngin.lookups.handlers.hook_data.""" -# pylint: disable=protected-access # pyright: basic from __future__ import annotations @@ -13,13 +12,13 @@ from runway.variables import Variable if TYPE_CHECKING: - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext class TestHookDataLookup: """Tests for runway.cfngin.lookups.handlers.hook_data.HookDataLookup.""" - def test_handle(self, cfngin_context: MockCFNginContext) -> None: + def test_handle(self, cfngin_context: MockCfnginContext) -> None: """Test handle with simple usage.""" cfngin_context.set_hook_data("fake_hook", {"nested": {"result": "good"}}) var_top = Variable("test", "${hook_data fake_hook}", variable_type="cfngin") @@ -32,7 +31,7 @@ def test_handle(self, cfngin_context: MockCFNginContext) -> None: assert var_top.value == {"nested": {"result": "good"}} assert var_nested.value == "good" - def test_default(self, cfngin_context: MockCFNginContext) -> None: + def test_default(self, cfngin_context: MockCfnginContext) -> None: """Test handle with a default value.""" cfngin_context.set_hook_data("fake_hook", {"nested": {"result": "good"}}) var_top = Variable( @@ -40,8 +39,7 @@ def test_default(self, cfngin_context: MockCFNginContext) -> None: ) var_nested = Variable( "test", - "${hook_data fake_hook.bad." - + "result::default=something,load=json,get=key}", + "${hook_data fake_hook.bad." + "result::default=something,load=json,get=key}", variable_type="cfngin", ) var_top.resolve(cfngin_context) @@ -50,11 +48,9 @@ def test_default(self, cfngin_context: MockCFNginContext) -> None: assert var_top.value == "something" assert var_nested.value == "something" - def test_not_found(self, cfngin_context: MockCFNginContext) -> None: + def test_not_found(self, cfngin_context: MockCfnginContext) -> None: """Test value not found and no default.""" - variable = Variable( - "test", "${hook_data fake_hook.bad.result}", variable_type="cfngin" - ) + variable = Variable("test", "${hook_data fake_hook.bad.result}", variable_type="cfngin") with pytest.raises(FailedVariableLookup) as err: variable.resolve(cfngin_context) @@ -63,13 +59,11 @@ def test_not_found(self, cfngin_context: MockCFNginContext) -> None: ) assert "Could not find a value for" in str(err.value.__cause__) - def test_troposphere(self, cfngin_context: MockCFNginContext) -> None: + def test_troposphere(self, cfngin_context: MockCfnginContext) -> None: """Test with troposphere object like returned from lambda hook.""" bucket = "test-bucket" s3_key = "lambda_functions/my_function" - cfngin_context.set_hook_data( - "lambda", {"my_function": Code(S3Bucket=bucket, S3Key=s3_key)} - ) + cfngin_context.set_hook_data("lambda", {"my_function": Code(S3Bucket=bucket, S3Key=s3_key)}) var_bucket = Variable( "test", "${hook_data lambda.my_function::" + "load=troposphere,get=S3Bucket}", diff --git a/tests/unit/cfngin/lookups/handlers/test_kms.py b/tests/unit/cfngin/lookups/handlers/test_kms.py index 513b71b20..cbcfc06da 100644 --- a/tests/unit/cfngin/lookups/handlers/test_kms.py +++ b/tests/unit/cfngin/lookups/handlers/test_kms.py @@ -12,7 +12,7 @@ from runway.cfngin.lookups.handlers.kms import KmsLookup if TYPE_CHECKING: - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext SECRET = "my secret" @@ -20,7 +20,7 @@ class TestKMSHandler: """Tests for runway.cfngin.lookups.handlers.kms.KmsLookup.""" - def test_handle(self, cfngin_context: MockCFNginContext) -> None: + def test_handle(self, cfngin_context: MockCfnginContext) -> None: """Test handle.""" stubber = cfngin_context.add_stubber("kms") stubber.add_response( @@ -33,12 +33,8 @@ def test_handle(self, cfngin_context: MockCFNginContext) -> None: assert KmsLookup.handle(SECRET, context=cfngin_context) == SECRET stubber.assert_no_pending_responses() - @pytest.mark.parametrize( - "template", ["${region}@${blob}", "${blob}::region=${region}"] - ) - def test_handle_with_region( - self, cfngin_context: MockCFNginContext, template: str - ) -> None: + @pytest.mark.parametrize("template", ["${region}@${blob}", "${blob}::region=${region}"]) + def test_handle_with_region(self, cfngin_context: MockCfnginContext, template: str) -> None: """Test handle with region.""" region = "us-west-2" query = string.Template(template).substitute({"blob": SECRET, "region": region}) diff --git a/tests/unit/cfngin/lookups/handlers/test_output.py b/tests/unit/cfngin/lookups/handlers/test_output.py index 1229753ad..d2fa6592e 100644 --- a/tests/unit/cfngin/lookups/handlers/test_output.py +++ b/tests/unit/cfngin/lookups/handlers/test_output.py @@ -1,12 +1,11 @@ """Tests for runway.cfngin.lookups.handlers.output.""" -# pylint: disable=protected-access from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import MagicMock import pytest -from mock import MagicMock from runway._logging import LogLevels from runway.cfngin.exceptions import StackDoesNotExist @@ -18,10 +17,9 @@ from ...factories import generate_definition if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext MODULE = "runway.cfngin.lookups.handlers.output" @@ -62,27 +60,19 @@ def test_dependencies_not_resolved(self) -> None: ("stack-name.foo::default=bar", "bar"), ], ) - def test_handle( - self, cfngin_context: MockCFNginContext, expected: str, provided: str - ) -> None: + def test_handle(self, cfngin_context: MockCfnginContext, expected: str, provided: str) -> None: """Test handle.""" - stack = Stack( - definition=generate_definition("stack-name"), context=cfngin_context - ) + stack = Stack(definition=generate_definition("stack-name"), context=cfngin_context) stack.set_outputs({"Output": "output-val"}) cfngin_context.stacks_dict[cfngin_context.get_fqn(stack.name)] = stack assert OutputLookup.handle(provided, context=cfngin_context) == expected - @pytest.mark.parametrize( - "provided", ["stack-name.MissingOutput", "stack-name::MissingOutput"] - ) + @pytest.mark.parametrize("provided", ["stack-name.MissingOutput", "stack-name::MissingOutput"]) def test_handle_raise_output_does_not_exist( - self, cfngin_context: MockCFNginContext, provided: str + self, cfngin_context: MockCfnginContext, provided: str ) -> None: """Test handle raise OutputDoesNotExist.""" - stack = Stack( - definition=generate_definition("stack-name"), context=cfngin_context - ) + stack = Stack(definition=generate_definition("stack-name"), context=cfngin_context) stack.set_outputs({"Output": "output-val"}) cfngin_context.stacks_dict[cfngin_context.get_fqn(stack.name)] = stack with pytest.raises( @@ -94,7 +84,7 @@ def test_handle_raise_output_does_not_exist( @pytest.mark.parametrize("provided", ["stack-name.Output", "stack-name::Output"]) def test_handle_raise_stack_does_not_exist( - self, cfngin_context: MockCFNginContext, provided: str + self, cfngin_context: MockCfnginContext, provided: str ) -> None: """Test handle raise StackDoesNotExist.""" with pytest.raises( @@ -103,9 +93,7 @@ def test_handle_raise_stack_does_not_exist( ): OutputLookup.handle(provided, context=cfngin_context) - def test_legacy_parse( - self, caplog: LogCaptureFixture, mocker: MockerFixture - ) -> None: + def test_legacy_parse(self, caplog: pytest.LogCaptureFixture, mocker: MockerFixture) -> None: """Test legacy_parse.""" query = "foo" caplog.set_level(LogLevels.WARNING, MODULE) diff --git a/tests/unit/cfngin/lookups/handlers/test_rxref.py b/tests/unit/cfngin/lookups/handlers/test_rxref.py index 1c0571d2d..43bb4a62d 100644 --- a/tests/unit/cfngin/lookups/handlers/test_rxref.py +++ b/tests/unit/cfngin/lookups/handlers/test_rxref.py @@ -1,21 +1,19 @@ """Tests for runway.cfngin.lookups.handlers.rxref.""" -# pylint: disable=protected-access from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import Mock import pytest -from mock import Mock from runway._logging import LogLevels from runway.cfngin.lookups.handlers.rxref import RxrefLookup if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture - from ....factories import MockCFNginContext + from ....factories import MockCfnginContext MODULE = "runway.cfngin.lookups.handlers.rxref" @@ -36,7 +34,7 @@ class TestRxrefLookup: ) def test_handle( self, - cfngin_context: MockCFNginContext, + cfngin_context: MockCfnginContext, expected: str, mocker: MockerFixture, provided: str, @@ -47,13 +45,9 @@ def test_handle( cfn.handle.return_value = "success" provider = Mock(name="provider") assert RxrefLookup.handle(provided, context=cfngin_context, provider=provider) - cfn.handle.assert_called_once_with( - expected, context=cfngin_context, provider=provider - ) + cfn.handle.assert_called_once_with(expected, context=cfngin_context, provider=provider) - def test_legacy_parse( - self, caplog: LogCaptureFixture, mocker: MockerFixture - ) -> None: + def test_legacy_parse(self, caplog: pytest.LogCaptureFixture, mocker: MockerFixture) -> None: """Test legacy_parse.""" query = "foo" caplog.set_level(LogLevels.WARNING, MODULE) diff --git a/tests/unit/cfngin/lookups/handlers/test_split.py b/tests/unit/cfngin/lookups/handlers/test_split.py index aea2141bd..68beb1386 100644 --- a/tests/unit/cfngin/lookups/handlers/test_split.py +++ b/tests/unit/cfngin/lookups/handlers/test_split.py @@ -1,8 +1,9 @@ """Tests for runway.cfngin.lookups.handlers.split.""" -# pyright: basic import unittest +import pytest + from runway.cfngin.lookups.handlers.split import SplitLookup @@ -24,5 +25,5 @@ def test_multi_character_split(self) -> None: def test_invalid_value_split(self) -> None: """Test invalid value split.""" value = ",:a,b,c" - with self.assertRaises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 SplitLookup.handle(value) diff --git a/tests/unit/cfngin/lookups/handlers/test_xref.py b/tests/unit/cfngin/lookups/handlers/test_xref.py index dd7472058..ec389d604 100644 --- a/tests/unit/cfngin/lookups/handlers/test_xref.py +++ b/tests/unit/cfngin/lookups/handlers/test_xref.py @@ -2,8 +2,7 @@ # pyright: basic, reportUnknownArgumentType=none, reportUnknownVariableType=none import unittest - -from mock import MagicMock +from unittest.mock import MagicMock from runway.cfngin.lookups.handlers.xref import XrefLookup @@ -24,8 +23,8 @@ def test_xref_handler(self) -> None: provider=self.provider, context=self.context, ) - self.assertEqual(value, "Test Output") - self.assertEqual(self.context.get_fqn.call_count, 0) + assert value == "Test Output" + assert self.context.get_fqn.call_count == 0 args = self.provider.get_output.call_args - self.assertEqual(args[0][0], "fully-qualified-stack-name") - self.assertEqual(args[0][1], "SomeOutput") + assert args[0][0] == "fully-qualified-stack-name" + assert args[0][1] == "SomeOutput" diff --git a/tests/unit/cfngin/lookups/test_registry.py b/tests/unit/cfngin/lookups/test_registry.py index e44aa4f6f..dd13b7501 100644 --- a/tests/unit/cfngin/lookups/test_registry.py +++ b/tests/unit/cfngin/lookups/test_registry.py @@ -51,9 +51,7 @@ def test_autoloaded_lookup_handlers(mocker: MockerFixture) -> None: "xref", ] for handler in handlers: - assert ( - handler in CFNGIN_LOOKUP_HANDLERS - ), f'Lookup handler: "{handler}" not registered' + assert handler in CFNGIN_LOOKUP_HANDLERS, f'Lookup handler: "{handler}" not registered' assert len(CFNGIN_LOOKUP_HANDLERS) == len( handlers ), f"expected {len(handlers)} autoloaded handlers but found {len(CFNGIN_LOOKUP_HANDLERS)}" @@ -82,9 +80,7 @@ class FakeLookup: def test_register_lookup_handler_str(mocker: MockerFixture) -> None: """Test register_lookup_handler from string.""" mocker.patch.dict(CFNGIN_LOOKUP_HANDLERS, {}) - register_lookup_handler( - "test", "runway.cfngin.lookups.handlers.default.DefaultLookup" - ) + register_lookup_handler("test", "runway.cfngin.lookups.handlers.default.DefaultLookup") assert "test" in CFNGIN_LOOKUP_HANDLERS assert CFNGIN_LOOKUP_HANDLERS["test"] == DefaultLookup diff --git a/tests/unit/cfngin/providers/aws/test_default.py b/tests/unit/cfngin/providers/aws/test_default.py index 9d7093aab..118845425 100644 --- a/tests/unit/cfngin/providers/aws/test_default.py +++ b/tests/unit/cfngin/providers/aws/test_default.py @@ -1,26 +1,23 @@ """Tests for runway.cfngin.providers.aws.default.""" -# pylint: disable=too-many-lines -# pyright: basic from __future__ import annotations import copy import locale -import os.path import random import string import threading import unittest +from contextlib import suppress from datetime import datetime from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional +from typing import TYPE_CHECKING, Any, Optional +from unittest.mock import MagicMock, patch import boto3 import pytest from botocore.exceptions import ClientError, UnStubbedResponseError from botocore.stub import Stubber -from mock import MagicMock, patch -from typing_extensions import Literal from runway.cfngin import exceptions from runway.cfngin.actions.diff import DictValue @@ -49,6 +46,7 @@ StackTypeDef, ) from pytest_mock import MockerFixture + from typing_extensions import Literal from runway.core.providers.aws.type_defs import TagSetTypeDef @@ -60,7 +58,7 @@ def random_string(length: int = 12) -> str: length: The # of characters to use in the random string. """ - return "".join([random.choice(string.ascii_letters) for _ in range(length)]) + return "".join([random.choice(string.ascii_letters) for _ in range(length)]) # noqa: S311 def generate_describe_stacks_stack( @@ -106,20 +104,16 @@ def generate_describe_stacks_stack( def generate_get_template( - file_name: str = "cfn_template.json", stages_available: Optional[List[str]] = None -) -> Dict[str, Any]: + file_name: str = "cfn_template.json", stages_available: list[str] | None = None +) -> dict[str, Any]: """Generate get template.""" - fixture_dir = os.path.join(os.path.dirname(__file__), "../../fixtures") - with open(os.path.join(fixture_dir, file_name), "r", encoding="utf-8") as _file: - return { - "StagesAvailable": stages_available or ["Original"], - "TemplateBody": _file.read(), - } + return { + "StagesAvailable": stages_available or ["Original"], + "TemplateBody": (Path(__file__).parent.parent.parent / "fixtures" / file_name).read_text(), + } -def generate_stack_object( - stack_name: str, outputs: Optional[Dict[str, Any]] = None -) -> MagicMock: +def generate_stack_object(stack_name: str, outputs: Optional[dict[str, Any]] = None) -> MagicMock: """Generate stack object.""" mock_stack = MagicMock(["name", "fqn", "blueprint"]) if not outputs: @@ -151,9 +145,9 @@ def generate_resource_change(replacement: bool = True) -> ChangeTypeDef: def generate_change_set_response( status: str, execution_status: str = "AVAILABLE", - changes: Optional[List[Dict[str, Any]]] = None, + changes: Optional[list[dict[str, Any]]] = None, status_reason: str = "FAKE", -) -> Dict[str, Any]: +) -> dict[str, Any]: """Generate change set response.""" return { "ChangeSetName": "string", @@ -185,7 +179,7 @@ def generate_change( resource_type: str = "EC2::Instance", replacement: str = "False", requires_recreation: str = "Never", -) -> Dict[str, Any]: +) -> dict[str, Any]: """Generate a minimal change for a changeset.""" return { "Type": "Resource", @@ -228,18 +222,14 @@ def test_requires_replacement(self) -> None: generate_resource_change(), ] replacement = requires_replacement(changeset) - self.assertEqual(len(replacement), 2) + assert len(replacement) == 2 for resource in replacement: - self.assertEqual( - resource.get("ResourceChange", {}).get("Replacement"), "True" - ) + assert resource.get("ResourceChange", {}).get("Replacement") == "True" def test_summarize_params_diff(self) -> None: """Test summarize params diff.""" unmodified_param = DictValue("ParamA", "new-param-value", "new-param-value") - modified_param = DictValue( - "ParamB", "param-b-old-value", "param-b-new-value-delta" - ) + modified_param = DictValue("ParamB", "param-b-old-value", "param-b-new-value-delta") added_param = DictValue("ParamC", None, "param-c-new-value") removed_param = DictValue("ParamD", "param-d-old-value", None) @@ -249,54 +239,39 @@ def test_summarize_params_diff(self) -> None: added_param, removed_param, ] - self.assertEqual(summarize_params_diff([]), "") - self.assertEqual( - summarize_params_diff(params_diff), - "\n".join( - [ - "Parameters Added: ParamC", - "Parameters Removed: ParamD", - "Parameters Modified: ParamB\n", - ] - ), + assert summarize_params_diff([]) == "" + assert ( + summarize_params_diff(params_diff) + == "Parameters Added: ParamC\nParameters Removed: ParamD\nParameters Modified: ParamB\n" ) only_modified_params_diff = [modified_param] - self.assertEqual( - summarize_params_diff(only_modified_params_diff), - "Parameters Modified: ParamB\n", - ) + assert summarize_params_diff(only_modified_params_diff) == "Parameters Modified: ParamB\n" only_added_params_diff = [added_param] - self.assertEqual( - summarize_params_diff(only_added_params_diff), "Parameters Added: ParamC\n" - ) + assert summarize_params_diff(only_added_params_diff) == "Parameters Added: ParamC\n" only_removed_params_diff = [removed_param] - self.assertEqual( - summarize_params_diff(only_removed_params_diff), - "Parameters Removed: ParamD\n", - ) + assert summarize_params_diff(only_removed_params_diff) == "Parameters Removed: ParamD\n" def test_ask_for_approval(self) -> None: """Test ask for approval.""" get_input_path = "runway.cfngin.ui.get_raw_input" with patch(get_input_path, return_value="y"): - self.assertIsNone(ask_for_approval([], [], False)) + assert ask_for_approval([], [], False) is None for v in ("n", "N", "x", "\n"): - with patch(get_input_path, return_value=v): - with self.assertRaises(exceptions.CancelExecution): - ask_for_approval([], []) + with patch(get_input_path, return_value=v), pytest.raises(exceptions.CancelExecution): + ask_for_approval([], []) with patch(get_input_path, side_effect=["v", "n"]) as mock_get_input: with patch( "runway.cfngin.providers.aws.default.output_full_changeset" ) as mock_full_changeset: - with self.assertRaises(exceptions.CancelExecution): + with pytest.raises(exceptions.CancelExecution): ask_for_approval([], [], True) - self.assertEqual(mock_full_changeset.call_count, 1) - self.assertEqual(mock_get_input.call_count, 2) + assert mock_full_changeset.call_count == 1 + assert mock_get_input.call_count == 2 def test_ask_for_approval_with_params_diff(self) -> None: """Test ask for approval with params diff.""" @@ -306,21 +281,20 @@ def test_ask_for_approval_with_params_diff(self) -> None: DictValue("ParamB", "param-b-old-value", "param-b-new-value-delta"), ] with patch(get_input_path, return_value="y"): - self.assertIsNone(ask_for_approval([], params_diff, False)) + assert ask_for_approval([], params_diff, False) is None for v in ("n", "N", "x", "\n"): - with patch(get_input_path, return_value=v): - with self.assertRaises(exceptions.CancelExecution): - ask_for_approval([], params_diff) + with patch(get_input_path, return_value=v), pytest.raises(exceptions.CancelExecution): + ask_for_approval([], params_diff) with patch(get_input_path, side_effect=["v", "n"]) as mock_get_input: with patch( "runway.cfngin.providers.aws.default.output_full_changeset" ) as mock_full_changeset: - with self.assertRaises(exceptions.CancelExecution): + with pytest.raises(exceptions.CancelExecution): ask_for_approval([], params_diff, True) - self.assertEqual(mock_full_changeset.call_count, 1) - self.assertEqual(mock_get_input.call_count, 2) + assert mock_full_changeset.call_count == 1 + assert mock_get_input.call_count == 2 @patch("runway.cfngin.providers.aws.default.format_params_diff") @patch("runway.cfngin.providers.aws.default.yaml.safe_dump") @@ -334,27 +308,21 @@ def test_output_full_changeset( for v in ["y", "v", "Y", "V"]: with patch(get_input_path, return_value=v) as prompt: - self.assertIsNone( - output_full_changeset(full_changeset=[], params_diff=[], fqn=None) - ) - self.assertEqual(prompt.call_count, 1) + assert output_full_changeset(full_changeset=[], params_diff=[], fqn=None) is None + assert prompt.call_count == 1 safe_dump_counter += 1 - self.assertEqual(mock_safe_dump.call_count, safe_dump_counter) - self.assertEqual(patched_format.call_count, 0) + assert mock_safe_dump.call_count == safe_dump_counter + assert patched_format.call_count == 0 for v in ["n", "N"]: with patch(get_input_path, return_value=v) as prompt: - output_full_changeset( - full_changeset=[], params_diff=[], answer=None, fqn=None - ) - self.assertEqual(prompt.call_count, 1) - self.assertEqual(mock_safe_dump.call_count, safe_dump_counter) - self.assertEqual(patched_format.call_count, 0) + output_full_changeset(full_changeset=[], params_diff=[], answer=None, fqn=None) + assert prompt.call_count == 1 + assert mock_safe_dump.call_count == safe_dump_counter + assert patched_format.call_count == 0 - with self.assertRaises(exceptions.CancelExecution): - output_full_changeset( - full_changeset=[], params_diff=[], answer="x", fqn=None - ) + with pytest.raises(exceptions.CancelExecution): + output_full_changeset(full_changeset=[], params_diff=[], answer="x", fqn=None) output_full_changeset( full_changeset=[], @@ -363,8 +331,8 @@ def test_output_full_changeset( fqn=None, ) safe_dump_counter += 1 - self.assertEqual(mock_safe_dump.call_count, safe_dump_counter) - self.assertEqual(patched_format.call_count, 1) + assert mock_safe_dump.call_count == safe_dump_counter + assert patched_format.call_count == 1 def test_wait_till_change_set_complete_success(self) -> None: """Test wait till change set complete success.""" @@ -374,9 +342,7 @@ def test_wait_till_change_set_complete_success(self) -> None: with self.stubber: wait_till_change_set_complete(self.cfn, "FAKEID") - self.stubber.add_response( - "describe_change_set", generate_change_set_response("FAILED") - ) + self.stubber.add_response("describe_change_set", generate_change_set_response("FAILED")) with self.stubber: wait_till_change_set_complete(self.cfn, "FAKEID") @@ -387,97 +353,79 @@ def test_wait_till_change_set_complete_failed(self) -> None: self.stubber.add_response( "describe_change_set", generate_change_set_response("CREATE_PENDING") ) - with self.stubber: - with self.assertRaises(exceptions.ChangesetDidNotStabilize): - wait_till_change_set_complete( - self.cfn, "FAKEID", try_count=2, sleep_time=0.1 - ) + with self.stubber, pytest.raises(exceptions.ChangesetDidNotStabilize): + wait_till_change_set_complete(self.cfn, "FAKEID", try_count=2, sleep_time=0.1) def test_create_change_set_stack_did_not_change(self) -> None: """Test create change set stack did not change.""" - self.stubber.add_response( - "create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"} - ) + self.stubber.add_response("create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"}) self.stubber.add_response( "describe_change_set", - generate_change_set_response( - "FAILED", status_reason="Stack didn't contain changes." - ), + generate_change_set_response("FAILED", status_reason="Stack didn't contain changes."), ) self.stubber.add_response( "delete_change_set", {}, expected_params={"ChangeSetName": "CHANGESETID"} ) - with self.stubber: - with self.assertRaises(exceptions.StackDidNotChange): - create_change_set( - cfn_client=self.cfn, - fqn="my-fake-stack", - template=Template(url="http://fake.template.url.com/"), - parameters=[], - tags=[], - ) + with self.stubber, pytest.raises(exceptions.StackDidNotChange): + create_change_set( + cfn_client=self.cfn, + fqn="my-fake-stack", + template=Template(url="http://fake.template.url.com/"), + parameters=[], + tags=[], + ) def test_create_change_set_unhandled_failed_status(self) -> None: """Test create change set unhandled failed status.""" - self.stubber.add_response( - "create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"} - ) + self.stubber.add_response("create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"}) self.stubber.add_response( "describe_change_set", - generate_change_set_response( - "FAILED", status_reason="Some random bad thing." - ), + generate_change_set_response("FAILED", status_reason="Some random bad thing."), ) - with self.stubber: - with self.assertRaises(exceptions.UnhandledChangeSetStatus): - create_change_set( - cfn_client=self.cfn, - fqn="my-fake-stack", - template=Template(url="http://fake.template.url.com/"), - parameters=[], - tags=[], - ) + with self.stubber, pytest.raises(exceptions.UnhandledChangeSetStatus): + create_change_set( + cfn_client=self.cfn, + fqn="my-fake-stack", + template=Template(url="http://fake.template.url.com/"), + parameters=[], + tags=[], + ) def test_create_change_set_bad_execution_status(self) -> None: """Test create change set bad execution status.""" - self.stubber.add_response( - "create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"} - ) + self.stubber.add_response("create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"}) self.stubber.add_response( "describe_change_set", - generate_change_set_response( - status="CREATE_COMPLETE", execution_status="UNAVAILABLE" - ), + generate_change_set_response(status="CREATE_COMPLETE", execution_status="UNAVAILABLE"), ) - with self.stubber: - with self.assertRaises(exceptions.UnableToExecuteChangeSet): - create_change_set( - cfn_client=self.cfn, - fqn="my-fake-stack", - template=Template(url="http://fake.template.url.com/"), - parameters=[], - tags=[], - ) + with self.stubber, pytest.raises(exceptions.UnableToExecuteChangeSet): + create_change_set( + cfn_client=self.cfn, + fqn="my-fake-stack", + template=Template(url="http://fake.template.url.com/"), + parameters=[], + tags=[], + ) def test_generate_cloudformation_args(self) -> None: """Test generate cloudformation args.""" stack_name = "mystack" template_url = "http://fake.s3url.com/blah.json" template_body = '{"fake_body": "woot"}' - std_args: Dict[str, Any] = { + std_args: dict[str, Any] = { "stack_name": stack_name, "parameters": [], "tags": [], "template": Template(url=template_url), } - std_return: Dict[str, Any] = { + std_return: dict[str, Any] = { "StackName": stack_name, "Parameters": [], "Tags": [], @@ -485,24 +433,24 @@ def test_generate_cloudformation_args(self) -> None: "TemplateURL": template_url, } result = generate_cloudformation_args(**std_args) - self.assertEqual(result, std_return) + assert result == std_return result = generate_cloudformation_args(service_role="FakeRole", **std_args) service_role_result = copy.deepcopy(std_return) service_role_result["RoleARN"] = "FakeRole" - self.assertEqual(result, service_role_result) + assert result == service_role_result result = generate_cloudformation_args(change_set_name="MyChanges", **std_args) change_set_result = copy.deepcopy(std_return) change_set_result["ChangeSetName"] = "MyChanges" - self.assertEqual(result, change_set_result) + assert result == change_set_result # Check stack policy stack_policy = Template(body="{}") result = generate_cloudformation_args(stack_policy=stack_policy, **std_args) stack_policy_result = copy.deepcopy(std_return) stack_policy_result["StackPolicyBody"] = "{}" - self.assertEqual(result, stack_policy_result) + assert result == stack_policy_result # If not TemplateURL is provided, use TemplateBody std_args["template"] = Template(body=template_body) @@ -510,7 +458,7 @@ def test_generate_cloudformation_args(self) -> None: del template_body_result["TemplateURL"] template_body_result["TemplateBody"] = template_body result = generate_cloudformation_args(**std_args) - self.assertEqual(result, template_body_result) + assert result == template_body_result class TestProvider: @@ -538,9 +486,7 @@ def test_get_event_by_resource_status(self, mocker: MockerFixture) -> None: {"StackName": "2", "ResourceStatus": "match"}, {"StackName": "3", "ResourceStatus": "match"}, ] - mock_get_events = mocker.patch.object( - Provider, "get_events", return_value=events - ) + mock_get_events = mocker.patch.object(Provider, "get_events", return_value=events) obj = Provider(MagicMock()) result = obj.get_event_by_resource_status("test", "match") @@ -548,9 +494,7 @@ def test_get_event_by_resource_status(self, mocker: MockerFixture) -> None: assert result["StackName"] == "2" mock_get_events.assert_called_once_with("test", chronological=True) - assert not obj.get_event_by_resource_status( - "test", "missing", chronological=False - ) + assert not obj.get_event_by_resource_status("test", "missing", chronological=False) mock_get_events.assert_called_with("test", chronological=False) def test_get_rollback_status_reason(self, mocker: MockerFixture) -> None: @@ -612,23 +556,17 @@ def test_create_stack_no_changeset(self) -> None: """Test create_stack, no changeset, template url.""" stack_name = "fake_stack" template = Template(url="http://fake.template.url.com/") - parameters: List[Any] = [] - tags: List[Any] = [] + parameters: list[Any] = [] + tags: list[Any] = [] - expected_args = generate_cloudformation_args( - stack_name, parameters, tags, template - ) + expected_args = generate_cloudformation_args(stack_name, parameters, tags, template) expected_args["EnableTerminationProtection"] = False expected_args["TimeoutInMinutes"] = 60 - self.stubber.add_response( - "create_stack", {"StackId": stack_name}, expected_args - ) + self.stubber.add_response("create_stack", {"StackId": stack_name}, expected_args) with self.stubber: - self.provider.create_stack( - stack_name, template, parameters, tags, timeout=60 - ) + self.provider.create_stack(stack_name, template, parameters, tags, timeout=60) self.stubber.assert_no_pending_responses() @patch("runway.cfngin.providers.aws.default.Provider.update_termination_protection") @@ -640,20 +578,16 @@ def test_create_stack_with_changeset( stack_name = "fake_stack" template_path = Path("./tests/unit/cfngin/fixtures/cfn_template.yaml") template = Template( - body=template_path.read_text( - encoding=locale.getpreferredencoding(do_setlocale=False) - ) + body=template_path.read_text(encoding=locale.getpreferredencoding(do_setlocale=False)) ) - parameters: List[Any] = [] - tags: List[Any] = [] + parameters: list[Any] = [] + tags: list[Any] = [] changeset_id = "CHANGESETID" patched_create_change_set.return_value = ([], changeset_id) - self.stubber.add_response( - "execute_change_set", {}, {"ChangeSetName": changeset_id} - ) + self.stubber.add_response("execute_change_set", {}, {"ChangeSetName": changeset_id}) with self.stubber: self.provider.create_stack( @@ -684,7 +618,7 @@ def test_destroy_stack(self) -> None: self.stubber.add_response("delete_stack", {}, stack) with self.stubber: - self.assertIsNone(self.provider.destroy_stack(stack)) # type: ignore + assert self.provider.destroy_stack(stack) is None # type: ignore self.stubber.assert_no_pending_responses() def test_get_stack_stack_does_not_exist(self) -> None: @@ -697,9 +631,8 @@ def test_get_stack_stack_does_not_exist(self) -> None: expected_params={"StackName": stack_name}, ) - with self.assertRaises(exceptions.StackDoesNotExist): - with self.stubber: - self.provider.get_stack(stack_name) + with pytest.raises(exceptions.StackDoesNotExist), self.stubber: + self.provider.get_stack(stack_name) def test_get_stack_stack_exists(self) -> None: """Test get stack stack exists.""" @@ -712,7 +645,7 @@ def test_get_stack_stack_exists(self) -> None: with self.stubber: response = self.provider.get_stack(stack_name) - self.assertEqual(response["StackName"], stack_name) + assert response["StackName"] == stack_name def test_select_destroy_method(self) -> None: """Test select destroy method.""" @@ -720,9 +653,7 @@ def test_select_destroy_method(self) -> None: [{"force_interactive": False}, self.provider.noninteractive_destroy_stack], [{"force_interactive": True}, self.provider.interactive_destroy_stack], ]: - self.assertEqual( - self.provider.select_destroy_method(**i[0]), i[1] # type: ignore - ) + assert self.provider.select_destroy_method(**i[0]) == i[1] # type: ignore def test_select_update_method(self) -> None: """Test select update method.""" @@ -744,99 +675,77 @@ def test_select_update_method(self) -> None: self.provider.interactive_update_stack, ], ]: - self.assertEqual( - self.provider.select_update_method(**i[0]), i[1] # type: ignore - ) + assert self.provider.select_update_method(**i[0]) == i[1] # type: ignore def test_prepare_stack_for_update_completed(self) -> None: """Test prepare stack for update completed.""" with self.stubber: stack_name = "MockStack" - stack = generate_describe_stacks_stack( - stack_name, stack_status="UPDATE_COMPLETE" - ) + stack = generate_describe_stacks_stack(stack_name, stack_status="UPDATE_COMPLETE") - self.assertTrue(self.provider.prepare_stack_for_update(stack, [])) + assert self.provider.prepare_stack_for_update(stack, []) def test_prepare_stack_for_update_in_progress(self) -> None: """Test prepare stack for update in progress.""" stack_name = "MockStack" - stack = generate_describe_stacks_stack( - stack_name, stack_status="UPDATE_IN_PROGRESS" - ) + stack = generate_describe_stacks_stack(stack_name, stack_status="UPDATE_IN_PROGRESS") - with self.assertRaises(exceptions.StackUpdateBadStatus) as raised: - with self.stubber: - self.provider.prepare_stack_for_update(stack, []) + with self.stubber, pytest.raises(exceptions.StackUpdateBadStatus) as raised: + self.provider.prepare_stack_for_update(stack, []) - self.assertIn("in-progress", str(raised.exception)) + assert "in-progress" in str(raised.value) def test_prepare_stack_for_update_non_recreatable(self) -> None: """Test prepare stack for update non recreatable.""" stack_name = "MockStack" - stack = generate_describe_stacks_stack( - stack_name, stack_status="REVIEW_IN_PROGRESS" - ) + stack = generate_describe_stacks_stack(stack_name, stack_status="REVIEW_IN_PROGRESS") - with self.assertRaises(exceptions.StackUpdateBadStatus) as raised: - with self.stubber: - self.provider.prepare_stack_for_update(stack, []) + with pytest.raises(exceptions.StackUpdateBadStatus) as excinfo, self.stubber: + self.provider.prepare_stack_for_update(stack, []) - self.assertIn("Unsupported state", str(raised.exception)) + assert "Unsupported state" in str(excinfo.value) def test_prepare_stack_for_update_disallowed(self) -> None: """Test prepare stack for update disallowed.""" stack_name = "MockStack" - stack = generate_describe_stacks_stack( - stack_name, stack_status="ROLLBACK_COMPLETE" - ) + stack = generate_describe_stacks_stack(stack_name, stack_status="ROLLBACK_COMPLETE") - with self.assertRaises(exceptions.StackUpdateBadStatus) as raised: - with self.stubber: - self.provider.prepare_stack_for_update(stack, []) + with pytest.raises(exceptions.StackUpdateBadStatus) as excinfo, self.stubber: + self.provider.prepare_stack_for_update(stack, []) - self.assertIn("re-creation is disabled", str(raised.exception)) + assert "re-creation is disabled" in str(excinfo.value) # Ensure we point out to the user how to enable re-creation - self.assertIn("--recreate-failed", str(raised.exception)) + assert "--recreate-failed" in str(excinfo.value) def test_prepare_stack_for_update_bad_tags(self) -> None: """Test prepare stack for update bad tags.""" stack_name = "MockStack" - stack = generate_describe_stacks_stack( - stack_name, stack_status="ROLLBACK_COMPLETE" - ) + stack = generate_describe_stacks_stack(stack_name, stack_status="ROLLBACK_COMPLETE") self.provider.recreate_failed = True - with self.assertRaises(exceptions.StackUpdateBadStatus) as raised: - with self.stubber: - self.provider.prepare_stack_for_update( - stack, tags=[{"Key": "cfngin_namespace", "Value": "test"}] - ) + with pytest.raises(exceptions.StackUpdateBadStatus) as excinfo, self.stubber: + self.provider.prepare_stack_for_update( + stack, tags=[{"Key": "cfngin_namespace", "Value": "test"}] + ) - self.assertIn("tags differ", str(raised.exception).lower()) + assert "tags differ" in str(excinfo.value).lower() def test_prepare_stack_for_update_recreate(self) -> None: """Test prepare stack for update recreate.""" stack_name = "MockStack" - stack = generate_describe_stacks_stack( - stack_name, stack_status="ROLLBACK_COMPLETE" - ) + stack = generate_describe_stacks_stack(stack_name, stack_status="ROLLBACK_COMPLETE") - self.stubber.add_response( - "delete_stack", {}, expected_params={"StackName": stack_name} - ) + self.stubber.add_response("delete_stack", {}, expected_params={"StackName": stack_name}) self.provider.recreate_failed = True with self.stubber: - self.assertFalse(self.provider.prepare_stack_for_update(stack, [])) + assert not self.provider.prepare_stack_for_update(stack, []) def test_noninteractive_changeset_update_no_stack_policy(self) -> None: """Test noninteractive changeset update no stack policy.""" - self.stubber.add_response( - "create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"} - ) + self.stubber.add_response("create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"}) changes = [generate_change()] self.stubber.add_response( "describe_change_set", @@ -860,9 +769,7 @@ def test_noninteractive_changeset_update_no_stack_policy(self) -> None: def test_noninteractive_changeset_update_with_stack_policy(self) -> None: """Test noninteractive changeset update with stack policy.""" - self.stubber.add_response( - "create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"} - ) + self.stubber.add_response("create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"}) changes = [generate_change()] self.stubber.add_response( "describe_change_set", @@ -888,7 +795,7 @@ def test_noninteractive_destroy_stack_termination_protected(self) -> None: """Test noninteractive_destroy_stack with termination protection.""" self.stubber.add_client_error("delete_stack") - with self.stubber, self.assertRaises(ClientError): + with self.stubber, pytest.raises(ClientError): self.provider.noninteractive_destroy_stack("fake-stack") self.stubber.assert_no_pending_responses() @@ -901,12 +808,8 @@ def test_get_stack_changes_update(self, mock_output_full_cs: MagicMock) -> None: self.stubber.add_response( "describe_stacks", {"Stacks": [generate_describe_stacks_stack(stack_name)]} ) - self.stubber.add_response( - "get_template", generate_get_template("cfn_template.yaml") - ) - self.stubber.add_response( - "create_change_set", {"Id": "CHANGESETID", "StackId": stack_name} - ) + self.stubber.add_response("get_template", generate_get_template("cfn_template.yaml")) + self.stubber.add_response("create_change_set", {"Id": "CHANGESETID", "StackId": stack_name}) changes = [generate_change()] self.stubber.add_response( "describe_change_set", @@ -933,8 +836,8 @@ def test_get_stack_changes_update(self, mock_output_full_cs: MagicMock) -> None: expected_outputs = { "FakeOutput": "" } - self.assertEqual(self.provider.get_outputs(stack_name), expected_outputs) - self.assertEqual(result, expected_outputs) + assert self.provider.get_outputs(stack_name) == expected_outputs + assert result == expected_outputs @patch("runway.cfngin.providers.aws.default.output_full_changeset") def test_get_stack_changes_create(self, mock_output_full_cs: MagicMock) -> None: @@ -946,15 +849,11 @@ def test_get_stack_changes_create(self, mock_output_full_cs: MagicMock) -> None: "describe_stacks", { "Stacks": [ - generate_describe_stacks_stack( - stack_name, stack_status="REVIEW_IN_PROGRESS" - ) + generate_describe_stacks_stack(stack_name, stack_status="REVIEW_IN_PROGRESS") ] }, ) - self.stubber.add_response( - "create_change_set", {"Id": "CHANGESETID", "StackId": stack_name} - ) + self.stubber.add_response("create_change_set", {"Id": "CHANGESETID", "StackId": stack_name}) changes = [generate_change()] self.stubber.add_response( "describe_change_set", @@ -967,9 +866,7 @@ def test_get_stack_changes_create(self, mock_output_full_cs: MagicMock) -> None: "describe_stacks", { "Stacks": [ - generate_describe_stacks_stack( - stack_name, stack_status="REVIEW_IN_PROGRESS" - ) + generate_describe_stacks_stack(stack_name, stack_status="REVIEW_IN_PROGRESS") ] }, ) @@ -977,9 +874,7 @@ def test_get_stack_changes_create(self, mock_output_full_cs: MagicMock) -> None: "describe_stacks", { "Stacks": [ - generate_describe_stacks_stack( - stack_name, stack_status="REVIEW_IN_PROGRESS" - ) + generate_describe_stacks_stack(stack_name, stack_status="REVIEW_IN_PROGRESS") ] }, ) @@ -1020,9 +915,8 @@ def test_tail_stack_retry_on_missing_stack(self) -> None: try: self.provider.tail_stack(stack, threading.Event()) except ClientError as exc: - self.assertEqual( - exc.response.get("ResponseMetadata", {}).get("attempt"), - MAX_TAIL_RETRIES, + assert ( # noqa: PT017 + exc.response.get("ResponseMetadata", {}).get("attempt") == MAX_TAIL_RETRIES ) def test_tail_stack_retry_on_missing_stack_eventual_success(self) -> None: @@ -1032,14 +926,13 @@ def test_tail_stack_retry_on_missing_stack_eventual_success(self) -> None: stack.fqn = f"my-namespace-{stack_name}" default.TAIL_RETRY_SLEEP = 0.01 - default.GET_EVENTS_SLEEP = 0.01 - received_events: List[Any] = [] + received_events: list[Any] = [] def mock_log_func(event: Any) -> None: received_events.append(event) - def valid_event_response(stack: Stack, event_id: str) -> Dict[str, Any]: + def valid_event_response(stack: Stack, event_id: str) -> dict[str, Any]: return { "StackEvents": [ { @@ -1065,24 +958,17 @@ def valid_event_response(stack: Stack, event_id: str) -> Dict[str, Any]: "describe_stack_events", valid_event_response(stack, "InitialEvents") ) - self.stubber.add_response( - "describe_stack_events", valid_event_response(stack, "Event1") - ) + self.stubber.add_response("describe_stack_events", valid_event_response(stack, "Event1")) - with self.stubber: - try: - self.provider.tail_stack( - stack, threading.Event(), log_func=mock_log_func - ) - except UnStubbedResponseError: - # Eventually we run out of responses - could not happen in - # regular execution - # normally this would just be dealt with when the threads were - # shutdown, but doing so here is a little difficult because - # we can't control the `tail_stack` loop - pass + with self.stubber, suppress(UnStubbedResponseError): + # Eventually we run out of responses - could not happen in + # regular execution + # normally this would just be dealt with when the threads were + # shutdown, but doing so here is a little difficult because + # we can't control the `tail_stack` loop + self.provider.tail_stack(stack, threading.Event(), log_func=mock_log_func) - self.assertEqual(received_events[0]["EventId"], "Event1") + assert received_events[0]["EventId"] == "Event1" def test_update_termination_protection(self) -> None: """Test update_termination_protection.""" @@ -1140,7 +1026,7 @@ def test_interactive_destroy_stack(self, patched_input: MagicMock) -> None: self.stubber.add_response("delete_stack", {}, stack) with self.stubber: - self.assertIsNone(self.provider.interactive_destroy_stack(stack_name)) + assert self.provider.interactive_destroy_stack(stack_name) is None self.stubber.assert_no_pending_responses() @patch("runway.cfngin.providers.aws.default.Provider.update_termination_protection") @@ -1153,9 +1039,7 @@ def test_interactive_destroy_stack_termination_protected( stack = {"StackName": stack_name} patched_input.return_value = "y" - self.stubber.add_client_error( - "delete_stack", service_message="TerminationProtection" - ) + self.stubber.add_client_error("delete_stack", service_message="TerminationProtection") self.stubber.add_response("delete_stack", {}, stack) with self.stubber: @@ -1169,17 +1053,14 @@ def test_destroy_stack_canceled(self, patched_input: MagicMock) -> None: """Test destroy stack canceled.""" patched_input.return_value = "n" - with self.assertRaises(exceptions.CancelExecution): - stack = {"StackName": "MockStack"} - self.provider.destroy_stack(stack) # type: ignore + with pytest.raises(exceptions.CancelExecution): + self.provider.destroy_stack({"StackName": "MockStack"}) # type: ignore def test_successful_init(self) -> None: """Test successful init.""" replacements = True - provider = Provider( - self.session, interactive=True, replacements_only=replacements - ) - self.assertEqual(provider.replacements_only, replacements) + provider = Provider(self.session, interactive=True, replacements_only=replacements) + assert provider.replacements_only == replacements @patch("runway.cfngin.providers.aws.default.Provider.update_termination_protection") @patch("runway.cfngin.providers.aws.default.ask_for_approval") @@ -1189,9 +1070,7 @@ def test_update_stack_execute_success_no_stack_policy( """Test update stack execute success no stack policy.""" stack_name = "my-fake-stack" - self.stubber.add_response( - "create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"} - ) + self.stubber.add_response("create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"}) changes = [generate_change()] self.stubber.add_response( @@ -1225,9 +1104,7 @@ def test_update_stack_execute_success_with_stack_policy( """Test update stack execute success with stack policy.""" stack_name = "my-fake-stack" - self.stubber.add_response( - "create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"} - ) + self.stubber.add_response("create_change_set", {"Id": "CHANGESETID", "StackId": "STACKID"}) changes = [generate_change()] self.stubber.add_response( @@ -1262,9 +1139,7 @@ def test_select_destroy_method(self) -> None: [{"force_interactive": False}, self.provider.interactive_destroy_stack], [{"force_interactive": True}, self.provider.interactive_destroy_stack], ]: - self.assertEqual( - self.provider.select_destroy_method(**i[0]), i[1] # type: ignore - ) + assert self.provider.select_destroy_method(**i[0]) == i[1] # type: ignore def test_select_update_method(self) -> None: """Test select update method.""" @@ -1286,9 +1161,7 @@ def test_select_update_method(self) -> None: self.provider.interactive_update_stack, ], ]: - self.assertEqual( - self.provider.select_update_method(**i[0]), i[1] # type: ignore - ) + assert self.provider.select_update_method(**i[0]) == i[1] # type: ignore @patch("runway.cfngin.providers.aws.default.output_full_changeset") @patch("runway.cfngin.providers.aws.default.output_summary") @@ -1302,12 +1175,8 @@ def test_get_stack_changes_interactive( self.stubber.add_response( "describe_stacks", {"Stacks": [generate_describe_stacks_stack(stack_name)]} ) - self.stubber.add_response( - "get_template", generate_get_template("cfn_template.yaml") - ) - self.stubber.add_response( - "create_change_set", {"Id": "CHANGESETID", "StackId": stack_name} - ) + self.stubber.add_response("get_template", generate_get_template("cfn_template.yaml")) + self.stubber.add_response("create_change_set", {"Id": "CHANGESETID", "StackId": stack_name}) changes = [generate_change()] self.stubber.add_response( "describe_change_set", diff --git a/tests/unit/cfngin/test_cfngin.py b/tests/unit/cfngin/test_cfngin.py index c9ed553a0..b5051dd7f 100644 --- a/tests/unit/cfngin/test_cfngin.py +++ b/tests/unit/cfngin/test_cfngin.py @@ -1,13 +1,12 @@ """Tests for runway.cfngin entry point.""" -# pylint: disable=redefined-outer-name, unnecessary-dunder-call from __future__ import annotations import shutil from typing import TYPE_CHECKING +from unittest.mock import Mock, call import pytest -from mock import Mock, call from yaml.constructor import ConstructorError from runway.cfngin.cfngin import CFNgin @@ -28,15 +27,11 @@ def copy_fixture(src: Path, dest: Path) -> Path: def copy_basic_fixtures(cfngin_fixtures: Path, tmp_path: Path) -> None: """Copy the basic env file and config file to a tmp_path.""" - copy_fixture( - src=cfngin_fixtures / "envs" / "basic.env", dest=tmp_path / "test-us-east-1.env" - ) - copy_fixture( - src=cfngin_fixtures / "configs" / "basic.yml", dest=tmp_path / "basic.yml" - ) + copy_fixture(src=cfngin_fixtures / "envs" / "basic.env", dest=tmp_path / "test-us-east-1.env") + copy_fixture(src=cfngin_fixtures / "configs" / "basic.yml", dest=tmp_path / "basic.yml") -@pytest.fixture(scope="function") +@pytest.fixture() def patch_safehaven(mocker: MockerFixture) -> Mock: """Patch SafeHaven.""" mock_haven = mocker.patch("runway.cfngin.cfngin.SafeHaven") @@ -58,9 +53,7 @@ def configure_mock_action_instance(mock_action: Mock) -> Mock: @staticmethod def get_context(name: str = "test", region: str = "us-east-1") -> MockRunwayContext: """Create a basic Runway context object.""" - context = MockRunwayContext( - deploy_environment=DeployEnvironment(explicit_name=name) - ) + context = MockRunwayContext(deploy_environment=DeployEnvironment(explicit_name=name)) context.env.aws_region = region return context @@ -87,9 +80,7 @@ def test_env_file(self, tmp_path: Path) -> None: result = CFNgin(ctx=self.get_context(region="us-west-2"), sys_path=tmp_path) assert result.env_file["test_value"] == "test-us-west-2" - result = CFNgin( - ctx=self.get_context(name="lab", region="ca-central-1"), sys_path=tmp_path - ) + result = CFNgin(ctx=self.get_context(name="lab", region="ca-central-1"), sys_path=tmp_path) assert result.env_file["test_value"] == "lab-ca-central-1" def test_deploy( @@ -103,9 +94,7 @@ def test_deploy( mock_action = mocker.patch("runway.cfngin.actions.deploy.Action", Mock()) mock_instance = self.configure_mock_action_instance(mock_action) copy_basic_fixtures(cfngin_fixtures, tmp_path) - copy_fixture( - src=cfngin_fixtures / "configs" / "basic.yml", dest=tmp_path / "basic2.yml" - ) + copy_fixture(src=cfngin_fixtures / "configs" / "basic.yml", dest=tmp_path / "basic2.yml") context = self.get_context() context.env.vars["CI"] = "1" @@ -184,9 +173,7 @@ def test_destroy( cfngin.destroy() mock_action.assert_called_once() - mock_instance.execute.assert_called_once_with( - concurrency=0, force=True, tail=False - ) + mock_instance.execute.assert_called_once_with(concurrency=0, force=True, tail=False) patch_safehaven.assert_has_calls( [ call(environ=context.env.vars), @@ -273,9 +260,7 @@ def test_load(self, cfngin_fixtures: Path, tmp_path: Path) -> None: assert len(result.stacks) == 1 assert result.stacks[0].name == "test-stack" - def test_load_raise_constructor_error( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test_load_raise_constructor_error(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test load raise ConstructorError.""" config = Mock(load=Mock(side_effect=ConstructorError(problem="something else"))) get_config = mocker.patch.object(CFNgin, "_get_config", return_value=config) diff --git a/tests/unit/cfngin/test_dag.py b/tests/unit/cfngin/test_dag.py index 8342ef9d1..09b146854 100644 --- a/tests/unit/cfngin/test_dag.py +++ b/tests/unit/cfngin/test_dag.py @@ -2,7 +2,7 @@ # pyright: basic import threading -from typing import Any, List +from typing import Any import pytest @@ -65,7 +65,7 @@ def test_walk(empty_dag: DAG) -> None: # b and c should be executed at the same time. dag.from_dict({"a": ["b", "c"], "b": ["d"], "c": ["d"], "d": []}) - nodes: List[Any] = [] + nodes: list[Any] = [] def walk_func(node: Any) -> bool: nodes.append(node) @@ -172,9 +172,7 @@ def test_transitive_reduction(empty_dag: DAG) -> None: """Test transitive reduction.""" dag = empty_dag # https://en.wikipedia.org/wiki/Transitive_reduction#/media/File:Tred-G.svg - dag.from_dict( - {"a": ["b", "c", "d", "e"], "b": ["d"], "c": ["d", "e"], "d": ["e"], "e": []} - ) + dag.from_dict({"a": ["b", "c", "d", "e"], "b": ["d"], "c": ["d", "e"], "d": ["e"], "e": []}) dag.transitive_reduction() # https://en.wikipedia.org/wiki/Transitive_reduction#/media/File:Tred-Gprime.svg assert dag.graph == { @@ -206,7 +204,7 @@ def test_threaded_walker(empty_dag: DAG) -> None: dag.from_dict({"a": ["b", "c"], "b": ["d"], "c": ["d"], "d": []}) lock = threading.Lock() # Protects nodes from concurrent access - nodes: List[Any] = [] + nodes: list[Any] = [] def walk_func(node: Any) -> bool: with lock: diff --git a/tests/unit/cfngin/test_environment.py b/tests/unit/cfngin/test_environment.py index a57ad3ef1..9ad4c5c1f 100644 --- a/tests/unit/cfngin/test_environment.py +++ b/tests/unit/cfngin/test_environment.py @@ -1,7 +1,7 @@ """Tests for runway.cfngin.environment.""" -# pyright: basic, reportUnnecessaryIsInstance=none -import unittest +# pyright: reportUnnecessaryIsInstance=none +import pytest from runway.cfngin.environment import parse_environment @@ -27,27 +27,27 @@ """ -class TestEnvironment(unittest.TestCase): +class TestEnvironment: """Tests for runway.cfngin.environment.""" def test_simple_key_value_parsing(self) -> None: """Test simple key value parsing.""" parsed_env = parse_environment(TEST_ENV) - self.assertTrue(isinstance(parsed_env, dict)) - self.assertEqual(parsed_env["key1"], "value1") - self.assertEqual(parsed_env["key2"], "value2") - self.assertEqual(parsed_env["key3"], "some:complex::value") - self.assertEqual(parsed_env["key4"], ":otherValue:") - self.assertEqual(parsed_env["key5"], "@value") - self.assertEqual(len(parsed_env), 5) + assert isinstance(parsed_env, dict) + assert parsed_env["key1"] == "value1" + assert parsed_env["key2"] == "value2" + assert parsed_env["key3"] == "some:complex::value" + assert parsed_env["key4"] == ":otherValue:" + assert parsed_env["key5"] == "@value" + assert len(parsed_env) == 5 def test_simple_key_value_parsing_exception(self) -> None: """Test simple key value parsing exception.""" - with self.assertRaises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 parse_environment(TEST_ERROR_ENV) def test_blank_value(self) -> None: """Test blank value.""" env = """key1:""" parsed = parse_environment(env) - self.assertEqual(parsed["key1"], "") + assert not parsed["key1"] diff --git a/tests/unit/cfngin/test_exceptions.py b/tests/unit/cfngin/test_exceptions.py index 2c6498612..6a79f25c4 100644 --- a/tests/unit/cfngin/test_exceptions.py +++ b/tests/unit/cfngin/test_exceptions.py @@ -3,7 +3,7 @@ from __future__ import annotations from pathlib import Path -from typing import TYPE_CHECKING, List, Optional, Union +from typing import TYPE_CHECKING, Optional, Union import pytest @@ -51,7 +51,7 @@ class TestInvalidConfig: [("error", "error"), (["error0", "error1"], "error0\nerror1")], ) def test___init__( - self, errors: Union[str, List[Union[Exception, str]]], expected_msg: str + self, errors: Union[str, list[Union[Exception, str]]], expected_msg: str ) -> None: """Test __init__.""" obj = InvalidConfig(errors) diff --git a/tests/unit/cfngin/test_plan.py b/tests/unit/cfngin/test_plan.py index 77670f33b..78620fe6d 100644 --- a/tests/unit/cfngin/test_plan.py +++ b/tests/unit/cfngin/test_plan.py @@ -1,17 +1,17 @@ """Tests for runway.cfngin.plan.""" -# pylint: disable=protected-access,unused-argument -# pyright: basic +# ruff: noqa: SLF001 from __future__ import annotations import json -import os import shutil import tempfile import unittest -from typing import TYPE_CHECKING, Any, Dict, List, Optional +from pathlib import Path +from typing import TYPE_CHECKING, Any +from unittest import mock -import mock +import pytest from runway.cfngin.dag import walk from runway.cfngin.exceptions import ( @@ -50,23 +50,23 @@ def setUp(self) -> None: def test_status(self) -> None: """Test status.""" - self.assertFalse(self.step.submitted) - self.assertFalse(self.step.completed) + assert not self.step.submitted + assert not self.step.completed self.step.submit() - self.assertEqual(self.step.status, SUBMITTED) - self.assertTrue(self.step.submitted) - self.assertFalse(self.step.completed) + assert self.step.status == SUBMITTED + assert self.step.submitted + assert not self.step.completed self.step.complete() - self.assertEqual(self.step.status, COMPLETE) - self.assertNotEqual(self.step.status, SUBMITTED) - self.assertTrue(self.step.submitted) - self.assertTrue(self.step.completed) + assert self.step.status == COMPLETE + assert self.step.status != SUBMITTED + assert self.step.submitted + assert self.step.completed - self.assertNotEqual(self.step.status, True) - self.assertNotEqual(self.step.status, False) - self.assertNotEqual(self.step.status, "banana") + assert self.step.status is not True + assert self.step.status is not False + assert self.step.status != "banana" def test_from_stack_name(self) -> None: """Return step from step name.""" @@ -74,21 +74,21 @@ def test_from_stack_name(self) -> None: stack_name = "test-stack" result = Step.from_stack_name(stack_name, context) - self.assertIsInstance(result, Step) - self.assertEqual(stack_name, result.stack.name) + assert isinstance(result, Step) + assert stack_name == result.stack.name def test_from_persistent_graph(self) -> None: """Return list of steps from graph dict.""" context = mock_context() - graph_dict: Dict[str, Any] = {"stack1": [], "stack2": ["stack1"]} + graph_dict: dict[str, Any] = {"stack1": [], "stack2": ["stack1"]} result = Step.from_persistent_graph(graph_dict, context) - self.assertEqual(2, len(result)) - self.assertIsInstance(result, list) + assert len(result) == 2 + assert isinstance(result, list) for step in result: - self.assertIsInstance(step, Step) - self.assertIn(step.stack.name, graph_dict.keys()) + assert isinstance(step, Step) + assert step.stack.name in graph_dict class TestGraph(unittest.TestCase): @@ -97,7 +97,7 @@ class TestGraph(unittest.TestCase): def setUp(self) -> None: """Run before tests.""" self.context = mock_context() - self.graph_dict: Dict[str, Any] = {"stack1": [], "stack2": ["stack1"]} + self.graph_dict: dict[str, Any] = {"stack1": [], "stack2": ["stack1"]} self.graph_dict_expected = {"stack1": set(), "stack2": {"stack1"}} self.steps = Step.from_persistent_graph(self.graph_dict, self.context) @@ -106,9 +106,9 @@ def test_add_steps(self) -> None: graph = Graph() graph.add_steps(self.steps) - self.assertEqual(self.steps, list(graph.steps.values())) - self.assertEqual([step.name for step in self.steps], list(graph.steps.keys())) - self.assertEqual(self.graph_dict_expected, graph.to_dict()) + assert self.steps == list(graph.steps.values()) + assert [step.name for step in self.steps] == list(graph.steps.keys()) + assert self.graph_dict_expected == graph.to_dict() def test_pop(self) -> None: """Test pop.""" @@ -117,31 +117,31 @@ def test_pop(self) -> None: stack2 = next(step for step in self.steps if step.name == "stack2") - self.assertEqual(stack2, graph.pop(stack2)) - self.assertEqual({"stack1": set()}, graph.to_dict()) + assert stack2 == graph.pop(stack2) + assert graph.to_dict() == {"stack1": set()} def test_dumps(self) -> None: """Test dumps.""" graph = Graph() graph.add_steps(self.steps) - self.assertEqual(json.dumps(self.graph_dict), graph.dumps()) + assert json.dumps(self.graph_dict) == graph.dumps() def test_from_dict(self) -> None: """Test from dict.""" graph = Graph.from_dict(self.graph_dict, self.context) - self.assertIsInstance(graph, Graph) - self.assertEqual([step.name for step in self.steps], list(graph.steps.keys())) - self.assertEqual(self.graph_dict_expected, graph.to_dict()) + assert isinstance(graph, Graph) + assert [step.name for step in self.steps] == list(graph.steps.keys()) + assert self.graph_dict_expected == graph.to_dict() def test_from_steps(self) -> None: """Test from steps.""" graph = Graph.from_steps(self.steps) - self.assertEqual(self.steps, list(graph.steps.values())) - self.assertEqual([step.name for step in self.steps], list(graph.steps.keys())) - self.assertEqual(self.graph_dict_expected, graph.to_dict()) + assert self.steps == list(graph.steps.values()) + assert [step.name for step in self.steps] == list(graph.steps.keys()) + assert self.graph_dict_expected == graph.to_dict() class TestPlan(unittest.TestCase): @@ -156,9 +156,8 @@ def setUp(self) -> None: class FakeLookup(LookupHandler): """False Lookup.""" - # pylint: disable=arguments-differ @classmethod - def handle(cls, value: str, *__args: Any, **__kwargs: Any) -> str: # type: ignore + def handle(cls, _value: str, *__args: Any, **__kwargs: Any) -> str: # type: ignore """Perform the lookup.""" return "test" @@ -179,7 +178,7 @@ def test_plan(self) -> None: graph = Graph.from_steps([Step(vpc, fn=None), Step(bastion, fn=None)]) plan = Plan(description="Test", graph=graph) - self.assertEqual(plan.graph.to_dict(), {"bastion-1": {"vpc-1"}, "vpc-1": set()}) + assert plan.graph.to_dict() == {"bastion-1": {"vpc-1"}, "vpc-1": set()} def test_plan_reverse(self) -> None: """Test plan reverse.""" @@ -193,8 +192,8 @@ def test_plan_reverse(self) -> None: # order is different between python2/3 so can't compare dicts result_graph_dict = plan.graph.to_dict() - self.assertEqual(set(), result_graph_dict.get("bastion-1")) - self.assertEqual({"bastion-1"}, result_graph_dict.get("vpc-1")) + assert set() == result_graph_dict.get("bastion-1") + assert {"bastion-1"} == result_graph_dict.get("vpc-1") def test_plan_targeted(self) -> None: """Test plan targeted.""" @@ -208,7 +207,7 @@ def test_plan_targeted(self) -> None: graph = Graph.from_steps([Step(vpc, fn=None), Step(bastion, fn=None)]) plan = Plan(description="Test", graph=graph, context=context) - self.assertEqual({vpc.name: set()}, plan.graph.to_dict()) + assert plan.graph.to_dict() == {vpc.name: set()} def test_execute_plan(self) -> None: """Test execute plan.""" @@ -219,18 +218,16 @@ def test_execute_plan(self) -> None: definition=generate_definition("bastion", 1, requires=[vpc.name]), context=context, ) - removed = Stack( - definition=generate_definition("removed", 1, requires=[]), context=context - ) + removed = Stack(definition=generate_definition("removed", 1, requires=[]), context=context) context._persistent_graph = Graph.from_steps([Step(removed)]) - calls: List[str] = [] + calls: list[str] = [] - def _launch_stack(stack: Stack, status: Optional[Status] = None) -> Status: + def _launch_stack(stack: Stack, status: Status | None = None) -> Status: # noqa: ARG001 calls.append(stack.fqn) return COMPLETE - def _destroy_stack(stack: Stack, status: Optional[Status] = None) -> Status: + def _destroy_stack(stack: Stack, status: Status | None = None) -> Status: # noqa: ARG001 calls.append(stack.fqn) return COMPLETE @@ -246,17 +243,17 @@ def _destroy_stack(stack: Stack, status: Optional[Status] = None) -> Status: plan.execute(walk) # the order these are appended changes between python2/3 - self.assertIn("namespace-vpc-1", calls) - self.assertIn("namespace-bastion-1", calls) - self.assertIn("namespace-removed-1", calls) + assert "namespace-vpc-1" in calls + assert "namespace-bastion-1" in calls + assert "namespace-removed-1" in calls context.put_persistent_graph.assert_called() # order is different between python2/3 so can't compare dicts result_graph_dict = context.persistent_graph.to_dict() # type: ignore - self.assertEqual(2, len(result_graph_dict)) - self.assertEqual(set(), result_graph_dict.get("vpc-1")) - self.assertEqual({"vpc-1"}, result_graph_dict.get("bastion-1")) - self.assertIsNone(result_graph_dict.get("namespace-removed-1")) + assert len(result_graph_dict) == 2 + assert set() == result_graph_dict.get("vpc-1") + assert {"vpc-1"} == result_graph_dict.get("bastion-1") + assert result_graph_dict.get("namespace-removed-1") is None def test_execute_plan_no_persist(self) -> None: """Test execute plan with no persistent graph.""" @@ -268,20 +265,18 @@ def test_execute_plan_no_persist(self) -> None: context=context, ) - calls: List[str] = [] + calls: list[str] = [] - def _launch_stack(stack: Stack, status: Optional[Status] = None) -> Status: + def _launch_stack(stack: Stack, status: Status | None = None) -> Status: # noqa: ARG001 calls.append(stack.fqn) return COMPLETE - graph = Graph.from_steps( - [Step(vpc, fn=_launch_stack), Step(bastion, fn=_launch_stack)] - ) + graph = Graph.from_steps([Step(vpc, fn=_launch_stack), Step(bastion, fn=_launch_stack)]) plan = Plan(description="Test", graph=graph, context=context) plan.execute(walk) - self.assertEqual(calls, ["namespace-vpc-1", "namespace-bastion-1"]) + assert calls == ["namespace-vpc-1", "namespace-bastion-1"] context.put_persistent_graph.assert_not_called() def test_execute_plan_locked(self) -> None: @@ -293,14 +288,13 @@ def test_execute_plan_locked(self) -> None: """ vpc = Stack(definition=generate_definition("vpc", 1), context=self.context) bastion = Stack( - definition=generate_definition("bastion", 1, requires=[vpc.name]), - locked=True, + definition=generate_definition("bastion", 1, locked=True, requires=[vpc.name]), context=self.context, ) - calls: List[str] = [] + calls: list[str] = [] - def fn(stack: Stack, status: Optional[Status] = None) -> Status: + def fn(stack: Stack, status: Status | None = None) -> Status: # noqa: ARG001 calls.append(stack.fqn) return COMPLETE @@ -308,7 +302,7 @@ def fn(stack: Stack, status: Optional[Status] = None) -> Status: plan = Plan(description="Test", graph=graph) plan.execute(walk) - self.assertEqual(calls, ["namespace-vpc-1", "namespace-bastion-1"]) + assert calls == ["namespace-vpc-1", "namespace-bastion-1"] def test_execute_plan_filtered(self) -> None: """Test execute plan filtered.""" @@ -322,9 +316,9 @@ def test_execute_plan_filtered(self) -> None: context=self.context, ) - calls: List[str] = [] + calls: list[str] = [] - def fn(stack: Stack, status: Optional[Status] = None) -> Status: + def fn(stack: Stack, status: Status | None = None) -> Status: # noqa: ARG001 calls.append(stack.fqn) return COMPLETE @@ -335,7 +329,7 @@ def fn(stack: Stack, status: Optional[Status] = None) -> Status: plan = Plan(context=context, description="Test", graph=graph) plan.execute(walk) - self.assertEqual(calls, ["namespace-vpc-1", "namespace-db-1"]) + assert calls == ["namespace-vpc-1", "namespace-db-1"] def test_execute_plan_exception(self) -> None: """Test execute plan exception.""" @@ -345,9 +339,9 @@ def test_execute_plan_exception(self) -> None: context=self.context, ) - calls: List[str] = [] + calls: list[str] = [] - def fn(stack: Stack, status: Optional[Status] = None) -> Status: + def fn(stack: Stack, status: Status | None = None) -> Status: # noqa: ARG001 calls.append(stack.fqn) if stack.name == vpc_step.name: raise ValueError("Boom") @@ -359,11 +353,11 @@ def fn(stack: Stack, status: Optional[Status] = None) -> Status: graph = Graph.from_steps([vpc_step, bastion_step]) plan = Plan(description="Test", graph=graph) - with self.assertRaises(PlanFailed): + with pytest.raises(PlanFailed): plan.execute(walk) - self.assertEqual(calls, ["namespace-vpc-1"]) - self.assertEqual(vpc_step.status, FAILED) + assert calls == ["namespace-vpc-1"] + assert vpc_step.status == FAILED def test_execute_plan_skipped(self) -> None: """Test execute plan skipped.""" @@ -373,9 +367,9 @@ def test_execute_plan_skipped(self) -> None: context=self.context, ) - calls: List[str] = [] + calls: list[str] = [] - def fn(stack: Stack, status: Optional[Status] = None) -> Status: + def fn(stack: Stack, status: Status | None = None) -> Status: # noqa: ARG001 calls.append(stack.fqn) if stack.fqn == vpc_step.name: return SKIPPED @@ -388,7 +382,7 @@ def fn(stack: Stack, status: Optional[Status] = None) -> Status: plan = Plan(description="Test", graph=graph) plan.execute(walk) - self.assertEqual(calls, ["namespace-vpc-1", "namespace-bastion-1"]) + assert calls == ["namespace-vpc-1", "namespace-bastion-1"] def test_execute_plan_failed(self) -> None: """Test execute plan failed.""" @@ -399,9 +393,9 @@ def test_execute_plan_failed(self) -> None: ) db = Stack(definition=generate_definition("db", 1), context=self.context) - calls: List[str] = [] + calls: list[str] = [] - def fn(stack: Stack, status: Optional[Status] = None) -> Status: + def fn(stack: Stack, status: Status | None = None) -> Status: # noqa: ARG001 calls.append(stack.fqn) if stack.name == vpc_step.name: return FAILED @@ -413,12 +407,12 @@ def fn(stack: Stack, status: Optional[Status] = None) -> Status: graph = Graph.from_steps([vpc_step, bastion_step, db_step]) plan = Plan(description="Test", graph=graph) - with self.assertRaises(PlanFailed): + with pytest.raises(PlanFailed): plan.execute(walk) calls.sort() - self.assertEqual(calls, ["namespace-db-1", "namespace-vpc-1"]) + assert calls == ["namespace-db-1", "namespace-vpc-1"] def test_execute_plan_cancelled(self) -> None: """Test execute plan cancelled.""" @@ -428,9 +422,9 @@ def test_execute_plan_cancelled(self) -> None: context=self.context, ) - calls: List[str] = [] + calls: list[str] = [] - def fn(stack: Stack, status: Optional[Status] = None) -> Status: + def fn(stack: Stack, status: Status | None = None) -> Status: # noqa: ARG001 calls.append(stack.fqn) if stack.fqn == vpc_step.name: raise CancelExecution @@ -443,7 +437,7 @@ def fn(stack: Stack, status: Optional[Status] = None) -> Status: plan = Plan(description="Test", graph=graph) plan.execute(walk) - self.assertEqual(calls, ["namespace-vpc-1", "namespace-bastion-1"]) + assert calls == ["namespace-vpc-1", "namespace-bastion-1"] def test_execute_plan_graph_locked(self) -> None: """Test execute plan with locked persistent graph.""" @@ -451,7 +445,7 @@ def test_execute_plan_graph_locked(self) -> None: context._persistent_graph = Graph.from_dict({"stack1": []}, context) context._persistent_graph_lock_code = "1111" plan = Plan(description="Test", graph=Graph(), context=context) - with self.assertRaises(PersistentGraphLocked): + with pytest.raises(PersistentGraphLocked): plan.execute() def test_build_graph_missing_dependency(self) -> None: @@ -461,14 +455,12 @@ def test_build_graph_missing_dependency(self) -> None: context=self.context, ) - with self.assertRaises(GraphError) as expected: + with pytest.raises(GraphError) as expected: Graph.from_steps([Step(bastion)]) - message_starts = ( - "Error detected when adding 'vpc-1' as a dependency of 'bastion-1':" - ) + message_starts = "Error detected when adding 'vpc-1' as a dependency of 'bastion-1':" message_contains = "dependent node vpc-1 does not exist" - self.assertTrue(str(expected.exception).startswith(message_starts)) - self.assertTrue(message_contains in str(expected.exception)) + assert str(expected.value).startswith(message_starts) + assert message_contains in str(expected.value) def test_build_graph_cyclic_dependencies(self) -> None: """Test build graph cyclic dependencies.""" @@ -482,19 +474,19 @@ def test_build_graph_cyclic_dependencies(self) -> None: context=self.context, ) - with self.assertRaises(GraphError) as expected: + with pytest.raises(GraphError) as expected: Graph.from_steps([Step(vpc), Step(db), Step(app)]) message = ( "Error detected when adding 'db-1' " "as a dependency of 'app-1': graph is " "not acyclic" ) - self.assertEqual(str(expected.exception), message) + assert str(expected.value) == message def test_dump(self) -> None: """Test dump.""" - requires: List[str] = [] - steps: List[Step] = [] + requires: list[str] = [] + steps: list[Step] = [] for i in range(5): overrides = { @@ -523,9 +515,6 @@ def test_dump(self) -> None: plan.dump(directory=tmp_dir, context=self.context) for step in plan.steps: - template_path = os.path.join( - tmp_dir, stack_template_key_name(step.stack.blueprint) # type: ignore - ) - self.assertTrue(os.path.isfile(template_path)) + assert (Path(tmp_dir) / stack_template_key_name(step.stack.blueprint)).is_file() finally: shutil.rmtree(tmp_dir) diff --git a/tests/unit/cfngin/test_stack.py b/tests/unit/cfngin/test_stack.py index 5102c2bc0..a1b3644cf 100644 --- a/tests/unit/cfngin/test_stack.py +++ b/tests/unit/cfngin/test_stack.py @@ -1,124 +1,193 @@ """Tests for runway.cfngin.stack.""" -# pyright: basic -import unittest -from typing import Any +from __future__ import annotations -from mock import MagicMock +from typing import TYPE_CHECKING, Any, ClassVar +from unittest.mock import Mock + +import pytest from runway.cfngin.lookups.registry import ( register_lookup_handler, unregister_lookup_handler, ) from runway.cfngin.stack import Stack -from runway.config import CfnginConfig -from runway.context import CfnginContext +from runway.config import CfnginStackDefinitionModel from runway.lookups.handlers.base import LookupHandler -from .factories import generate_definition +if TYPE_CHECKING: + from collections.abc import Iterator + from pathlib import Path + from pytest_mock import MockerFixture -class TestStack(unittest.TestCase): - """Tests for runway.cfngin.stack.Stack.""" + from ..factories import MockCfnginContext - def setUp(self) -> None: - """Run before tests.""" - self.sd = {"name": "test"} # pylint: disable=invalid-name - self.config = CfnginConfig.parse_obj({"namespace": "namespace"}) - self.context = CfnginContext(config=self.config) - self.stack = Stack( - definition=generate_definition("vpc", 1), context=self.context - ) +MODULE = "runway.cfngin.stack" - class FakeLookup(LookupHandler): - """False Lookup.""" - - # pylint: disable=arguments-differ,unused-argument - @classmethod - def handle(cls, value: str, *__args: Any, **__kwargs: Any) -> str: # type: ignore - """Perform the lookup.""" - return "test" - - register_lookup_handler("noop", FakeLookup) - - def tearDown(self) -> None: - """Run after tests.""" - unregister_lookup_handler("noop") - return super().tearDown() - - def test_stack_requires(self) -> None: - """Test stack requires.""" - definition = generate_definition( - base_name="vpc", - stack_id=1, - variables={ - "Var1": "${noop fakeStack3::FakeOutput}", - "Var2": ( - "some.template.value:${output fakeStack2.FakeOutput}:" - "${output fakeStack.FakeOutput}" - ), - "Var3": "${output fakeStack.FakeOutput}," - "${output fakeStack2.FakeOutput}", - }, - requires=["fakeStack"], + +@pytest.fixture(autouse=True, scope="module") +def fake_lookup() -> Iterator[None]: + """Register a fake lookup handler for testing.""" + + class FakeLookup(LookupHandler): + """False Lookup.""" + + TYPE_NAME: ClassVar[str] = "fake" + + @classmethod + def handle(cls, value: str, *__args: Any, **__kwargs: Any) -> str: # type: ignore # noqa: ARG003 + """Perform the lookup.""" + return "test" + + register_lookup_handler(FakeLookup.TYPE_NAME, FakeLookup) + yield + unregister_lookup_handler(FakeLookup.TYPE_NAME) + + +def generate_stack_definition( + base_name: str, stack_id: Any = None, **overrides: Any +) -> CfnginStackDefinitionModel: + """Generate stack definition.""" + definition: dict[str, Any] = { + "name": f"{base_name}-{stack_id}" if stack_id else base_name, + "class_path": f"tests.unit.cfngin.fixtures.mock_blueprints.{base_name.upper()}", + "requires": [], + } + definition.update(overrides) + return CfnginStackDefinitionModel(**definition) + + +class TestStack: + """Test Stack.""" + + def test_required_by(self, cfngin_context: MockCfnginContext) -> None: + """Test required_by.""" + stack = Stack( + definition=generate_stack_definition( + base_name="vpc", + required_by=["fakeStack0"], + variables={"Param1": "${output fakeStack.FakeOutput}"}, + ), + context=cfngin_context, ) - stack = Stack(definition=definition, context=self.context) - self.assertEqual(len(stack.requires), 2) - self.assertIn("fakeStack", stack.requires) - self.assertIn("fakeStack2", stack.requires) - - def test_stack_requires_circular_ref(self) -> None: - """Test stack requires circular ref.""" - definition = generate_definition( - base_name="vpc", - stack_id=1, - variables={"Var1": "${output vpc-1.FakeOutput}"}, + assert stack.required_by == {"fakeStack0"} + + def test_requires(self, cfngin_context: MockCfnginContext) -> None: + """Test requires.""" + stack = Stack( + definition=generate_stack_definition( + base_name="vpc", + variables={ + "Var1": "${fake fakeStack2::FakeOutput}", + "Var2": ( + "some.template.value:${output fakeStack1.FakeOutput}:" + "${output fakeStack0.FakeOutput}" + ), + "Var3": "${output fakeStack0.FakeOutput},${output fakeStack1.FakeOutput}", + }, + requires=["fakeStack0"], + ), + context=cfngin_context, ) - stack = Stack(definition=definition, context=self.context) - with self.assertRaises(ValueError): - stack.requires # pylint: disable=pointless-statement - - def test_stack_cfn_parameters(self) -> None: - """Test stack cfn parameters.""" - definition = generate_definition( - base_name="vpc", - stack_id=1, - variables={"Param1": "${output fakeStack.FakeOutput}"}, + assert len(stack.requires) == 2 + assert "fakeStack0" in stack.requires + assert "fakeStack1" in stack.requires + + def test_requires_cyclic_dependency(self, cfngin_context: MockCfnginContext) -> None: + """Test requires cyclic dependency.""" + stack = Stack( + definition=generate_stack_definition( + base_name="vpc", + variables={"Var1": "${output vpc.FakeOutput}"}, + ), + context=cfngin_context, ) - stack = Stack(definition=definition, context=self.context) - # pylint: disable=protected-access - stack._blueprint = MagicMock() - stack._blueprint.parameter_values = { - "Param2": "Some Resolved Value", - } - param = stack.parameter_values["Param2"] - self.assertEqual(param, "Some Resolved Value") - - def test_stack_tags_default(self) -> None: - """Test stack tags default.""" - self.config.tags = {"environment": "prod"} - definition = generate_definition(base_name="vpc", stack_id=1) - stack = Stack(definition=definition, context=self.context) - self.assertEqual(stack.tags, {"environment": "prod"}) - - def test_stack_tags_override(self) -> None: - """Test stack tags override.""" - self.config.tags = {"environment": "prod"} - definition = generate_definition( - base_name="vpc", stack_id=1, tags={"environment": "stage"} + with pytest.raises(ValueError, match="has a circular reference"): + assert stack.requires + + def test_resolve(self, cfngin_context: MockCfnginContext, mocker: MockerFixture) -> None: + """Test resolve.""" + mock_resolve_variables = mocker.patch(f"{MODULE}.resolve_variables") + mock_provider = Mock() + stack = Stack( + definition=generate_stack_definition(base_name="vpc"), + context=cfngin_context, ) - stack = Stack(definition=definition, context=self.context) - self.assertEqual(stack.tags, {"environment": "stage"}) - - def test_stack_tags_extra(self) -> None: - """Test stack tags extra.""" - self.config.tags = {"environment": "prod"} - definition = generate_definition( - base_name="vpc", stack_id=1, tags={"app": "graph"} + stack._blueprint = Mock() + assert not stack.resolve(cfngin_context, mock_provider) + mock_resolve_variables.assert_called_once_with( + stack.variables, cfngin_context, mock_provider ) - stack = Stack(definition=definition, context=self.context) - self.assertEqual(stack.tags, {"environment": "prod", "app": "graph"}) + stack._blueprint.resolve_variables.assert_called_once_with(stack.variables) + def test_set_outputs(self, cfngin_context: MockCfnginContext) -> None: + """Test set_outputs.""" + stack = Stack( + definition=generate_stack_definition(base_name="vpc"), + context=cfngin_context, + ) + assert not stack.outputs + outputs = {"foo": "bar"} + assert not stack.set_outputs(outputs) + assert stack.outputs == outputs + + def test_stack_policy(self, cfngin_context: MockCfnginContext, tmp_path: Path) -> None: + """Test stack_policy.""" + stack_policy_path = tmp_path / "stack_policy.json" + stack_policy_path.write_text("success") + assert ( + Stack( + definition=generate_stack_definition( + base_name="vpc", stack_policy_path=stack_policy_path + ), + context=cfngin_context, + ).stack_policy + == "success" + ) -if __name__ == "__main__": - unittest.main() + def test_stack_policy_not_provided(self, cfngin_context: MockCfnginContext) -> None: + """Test stack_policy.""" + assert not Stack( + definition=generate_stack_definition(base_name="vpc"), + context=cfngin_context, + ).stack_policy + + def test_tags(self, cfngin_context: MockCfnginContext) -> None: + """Test tags.""" + cfngin_context.config.tags = {"environment": "prod"} + assert Stack( + definition=generate_stack_definition( + base_name="vpc", tags={"app": "graph", "environment": "stage"} + ), + context=cfngin_context, + ).tags == {"app": "graph", "environment": "stage"} + + def test_tags_default(self, cfngin_context: MockCfnginContext) -> None: + """Test tags.""" + cfngin_context.config.tags = {"environment": "prod"} + assert Stack( + definition=generate_stack_definition(base_name="vpc"), + context=cfngin_context, + ).tags == {"environment": "prod"} + + @pytest.mark.parametrize( + "termination_protection, expected", + [(False, False), (True, True)], + ) + def test_termination_protection( + self, + cfngin_context: MockCfnginContext, + expected: str, + termination_protection: bool | str, + ) -> None: + """Test termination_protection.""" + assert ( + Stack( + definition=generate_stack_definition( + base_name="vpc", termination_protection=termination_protection + ), + context=cfngin_context, + ).termination_protection + is expected + ) diff --git a/tests/unit/cfngin/test_tokenize_userdata.py b/tests/unit/cfngin/test_tokenize_userdata.py index 125bc83d9..ec08288cd 100644 --- a/tests/unit/cfngin/test_tokenize_userdata.py +++ b/tests/unit/cfngin/test_tokenize_userdata.py @@ -16,8 +16,8 @@ def test_tokenize(self) -> None: user_data = ["field0", 'Ref("SshKey")', "field1", 'Fn::GetAtt("Blah", "Woot")'] user_data_dump = yaml.dump(user_data) parts = cf_tokenize(user_data_dump) - self.assertIsInstance(parts[1], dict) - self.assertIsInstance(parts[3], dict) - self.assertEqual(parts[1]["Ref"], "SshKey") # type: ignore - self.assertEqual(parts[3]["Fn::GetAtt"], ["Blah", "Woot"]) # type: ignore - self.assertEqual(len(parts), 5) + assert isinstance(parts[1], dict) + assert isinstance(parts[3], dict) + assert parts[1]["Ref"] == "SshKey" # type: ignore + assert parts[3]["Fn::GetAtt"] == ["Blah", "Woot"] # type: ignore + assert len(parts) == 5 diff --git a/tests/unit/cfngin/test_utils.py b/tests/unit/cfngin/test_utils.py index ac35b8ff7..7863e832e 100644 --- a/tests/unit/cfngin/test_utils.py +++ b/tests/unit/cfngin/test_utils.py @@ -1,6 +1,5 @@ """Tests for runway.cfngin.utils.""" -# pylint: disable=unused-argument,invalid-name, broad-exception-raised # pyright: basic from __future__ import annotations @@ -11,10 +10,10 @@ import tempfile import unittest from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, cast +from typing import TYPE_CHECKING, Any, cast +from unittest import mock import boto3 -import mock import pytest from botocore.exceptions import ClientError from botocore.stub import Stubber @@ -41,7 +40,6 @@ from runway.config.models.cfngin import GitCfnginPackageSourceDefinitionModel if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture AWS_REGIONS = [ @@ -60,7 +58,7 @@ MODULE = "runway.cfngin.utils" -def mock_create_cache_directories(self: Any, **kwargs: Any) -> int: +def mock_create_cache_directories(self: Any, **kwargs: Any) -> int: # noqa: ARG001 """Mock create cache directories. Don't actually need the directories created in testing @@ -79,7 +77,7 @@ def test_ensure_s3_bucket() -> None: stubber.assert_no_pending_responses() -def test_ensure_s3_bucket_forbidden(caplog: LogCaptureFixture) -> None: +def test_ensure_s3_bucket_forbidden(caplog: pytest.LogCaptureFixture) -> None: """Test ensure_s3_bucket.""" caplog.set_level(logging.ERROR, logger=MODULE) s3_client = boto3.client("s3") @@ -144,22 +142,20 @@ def test_ensure_s3_bucket_not_found_persist_graph() -> None: stubber.assert_no_pending_responses() -def test_ensure_s3_bucket_persist_graph(caplog: LogCaptureFixture) -> None: +def test_ensure_s3_bucket_persist_graph(caplog: pytest.LogCaptureFixture) -> None: """Test ensure_s3_bucket.""" caplog.set_level(logging.WARNING, logger=MODULE) s3_client = boto3.client("s3") stubber = Stubber(s3_client) stubber.add_response("head_bucket", {}, {"Bucket": "test-bucket"}) - stubber.add_response( - "get_bucket_versioning", {"Status": "Enabled"}, {"Bucket": "test-bucket"} - ) + stubber.add_response("get_bucket_versioning", {"Status": "Enabled"}, {"Bucket": "test-bucket"}) with stubber: assert not ensure_s3_bucket(s3_client, "test-bucket", persist_graph=True) stubber.assert_no_pending_responses() assert not caplog.messages -def test_ensure_s3_bucket_persist_graph_mfa_delete(caplog: LogCaptureFixture) -> None: +def test_ensure_s3_bucket_persist_graph_mfa_delete(caplog: pytest.LogCaptureFixture) -> None: """Test ensure_s3_bucket.""" caplog.set_level(logging.WARNING, logger=MODULE) s3_client = boto3.client("s3") @@ -175,8 +171,7 @@ def test_ensure_s3_bucket_persist_graph_mfa_delete(caplog: LogCaptureFixture) -> stubber.assert_no_pending_responses() assert ( 'MFADelete must be disabled on bucket "test-bucket" when using persistent ' - "graphs to allow for proper management of the graphs" - in "\n".join(caplog.messages) + "graphs to allow for proper management of the graphs" in "\n".join(caplog.messages) ) @@ -184,26 +179,23 @@ def test_ensure_s3_bucket_persist_graph_mfa_delete(caplog: LogCaptureFixture) -> "versioning_response", [{"Status": "Disabled"}, {"Status": "Suspended"}, {}] ) def test_ensure_s3_bucket_persist_graph_versioning_not_enabled( - caplog: LogCaptureFixture, versioning_response: Dict[str, Any] + caplog: pytest.LogCaptureFixture, versioning_response: dict[str, Any] ) -> None: """Test ensure_s3_bucket.""" caplog.set_level(logging.WARNING, logger=MODULE) s3_client = boto3.client("s3") stubber = Stubber(s3_client) stubber.add_response("head_bucket", {}, {"Bucket": "test-bucket"}) - stubber.add_response( - "get_bucket_versioning", versioning_response, {"Bucket": "test-bucket"} - ) + stubber.add_response("get_bucket_versioning", versioning_response, {"Bucket": "test-bucket"}) with stubber: assert not ensure_s3_bucket(s3_client, "test-bucket", persist_graph=True) stubber.assert_no_pending_responses() - assert ( - "it is recommended to enable versioning when using persistent graphs" - in "\n".join(caplog.messages) + assert "it is recommended to enable versioning when using persistent graphs" in "\n".join( + caplog.messages ) -def test_ensure_s3_bucket_raise_client_error(caplog: LogCaptureFixture) -> None: +def test_ensure_s3_bucket_raise_client_error(caplog: pytest.LogCaptureFixture) -> None: """Test ensure_s3_bucket.""" caplog.set_level(logging.ERROR, logger=MODULE) s3_client = boto3.client("s3") @@ -224,13 +216,13 @@ def test_read_value_from_path_abs(tmp_path: Path) -> None: def test_read_value_from_path_dir(tmp_path: Path) -> None: """Test read_value_from_path directory.""" - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 read_value_from_path(f"file://{tmp_path.absolute()}") def test_read_value_from_path_not_exist(tmp_path: Path) -> None: """Test read_value_from_path does not exist.""" - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 read_value_from_path(f"file://{(tmp_path / 'something.txt').absolute()}") @@ -245,10 +237,7 @@ def test_read_value_from_path_root_path_dir(tmp_path: Path) -> None: """Test read_value_from_path root_path is dir.""" test_file = tmp_path / "test.txt" test_file.write_text("success") - assert ( - read_value_from_path(f"file://./{test_file.name}", root_path=tmp_path) - == "success" - ) + assert read_value_from_path(f"file://./{test_file.name}", root_path=tmp_path) == "success" def test_read_value_from_path_root_path_file(tmp_path: Path) -> None: @@ -256,9 +245,7 @@ def test_read_value_from_path_root_path_file(tmp_path: Path) -> None: test_file = tmp_path / "test.txt" test_file.write_text("success") assert ( - read_value_from_path( - f"file://./{test_file.name}", root_path=tmp_path / "something.json" - ) + read_value_from_path(f"file://./{test_file.name}", root_path=tmp_path / "something.json") == "success" ) @@ -283,7 +270,7 @@ def setUp(self) -> None: # Create a tar file using the temporary directory with tarfile.open(self.tmp_path / self.tar_file, "w") as tar: - tar.add(self.tmp_path, arcname=os.path.basename(self.tmp_path)) + tar.add(self.tmp_path, arcname=os.path.basename(self.tmp_path)) # noqa: PTH119 def tearDown(self) -> None: """Tear down test case.""" @@ -293,7 +280,7 @@ def test_cf_safe_name(self) -> None: """Test cf safe name.""" tests = (("abc-def", "AbcDef"), ("GhI", "GhI"), ("jKlm.noP", "JKlmNoP")) for test in tests: - self.assertEqual(cf_safe_name(test[0]), test[1]) + assert cf_safe_name(test[0]) == test[1] def test_camel_to_snake(self) -> None: """Test camel to snake.""" @@ -304,7 +291,7 @@ def test_camel_to_snake(self) -> None: ("testtemplate", "testtemplate"), ) for test in tests: - self.assertEqual(camel_to_snake(test[0]), test[1]) + assert camel_to_snake(test[0]) == test[1] def test_yaml_to_ordered_dict(self) -> None: """Test yaml to ordered dict.""" @@ -316,27 +303,27 @@ def test_yaml_to_ordered_dict(self) -> None: path: foo1.bar1 """ config = yaml_to_ordered_dict(raw_config) - self.assertEqual(list(config["pre_deploy"].keys())[0], "hook2") - self.assertEqual(config["pre_deploy"]["hook2"]["path"], "foo.bar") + assert next(iter(config["pre_deploy"].keys())) == "hook2" + assert config["pre_deploy"]["hook2"]["path"] == "foo.bar" def test_get_client_region(self) -> None: """Test get client region.""" regions = ["us-east-1", "us-west-1", "eu-west-1", "sa-east-1"] for region in regions: client = boto3.client("s3", region_name=region) - self.assertEqual(get_client_region(client), region) + assert get_client_region(client) == region def test_get_s3_endpoint(self) -> None: """Test get s3 endpoint.""" endpoint_url = "https://example.com" client = boto3.client("s3", region_name="us-east-1", endpoint_url=endpoint_url) - self.assertEqual(get_s3_endpoint(client), endpoint_url) + assert get_s3_endpoint(client) == endpoint_url def test_s3_bucket_location_constraint(self) -> None: """Test s3 bucket location constraint.""" tests = (("us-east-1", ""), ("us-west-1", "us-west-1")) for region, result in tests: - self.assertEqual(s3_bucket_location_constraint(region), result) + assert s3_bucket_location_constraint(region) == result def test_parse_cloudformation_template(self) -> None: """Test parse cloudformation template.""" @@ -374,54 +361,52 @@ def test_parse_cloudformation_template(self) -> None: } }, } - self.assertEqual(parse_cloudformation_template(template), parsed_template) + assert parse_cloudformation_template(template) == parsed_template - def test_is_within_directory(self): + def test_is_within_directory(self) -> None: """Test is within directory.""" directory = Path("my_directory") # Assert if the target is within the directory. target = "my_directory/sub_directory/file.txt" - self.assertTrue(is_within_directory(directory, target)) + assert is_within_directory(directory, target) # Assert if the target is NOT within the directory. target = "other_directory/file.txt" - self.assertFalse(is_within_directory(directory, target)) + assert not is_within_directory(directory, target) # Assert if the target is the directory. target = "my_directory" - self.assertTrue(is_within_directory(directory, target)) + assert is_within_directory(directory, target) - def test_safe_tar_extract_all_within(self): + def test_safe_tar_extract_all_within(self) -> None: """Test when all tar file contents are within the specified directory.""" path = self.tmp_path / "my_directory" with tarfile.open(self.tmp_path / self.tar_file, "r") as tar: - self.assertIsNone(safe_tar_extract(tar, path)) + assert safe_tar_extract(tar, path) is None - def test_safe_tar_extract_path_traversal(self): + def test_safe_tar_extract_path_traversal(self) -> None: """Test when a tar file tries to go outside the specified area.""" with tarfile.open(self.tmp_path / self.tar_file, "r") as tar: for member in tar.getmembers(): member.name = f"../{member.name}" path = self.tmp_path / "my_directory" - with self.assertRaises(Exception) as context: + with pytest.raises(Exception) as excinfo: # noqa: PT011 safe_tar_extract(tar, path) - self.assertEqual( - str(context.exception), "Attempted Path Traversal in Tar File" - ) + assert str(excinfo.value) == "Attempted Path Traversal in Tar File" # type: ignore - def test_extractors(self): + def test_extractors(self) -> None: """Test extractors.""" - self.assertEqual(Extractor(Path("test.zip")).archive, Path("test.zip")) - self.assertEqual(TarExtractor().extension, ".tar") - self.assertEqual(TarGzipExtractor().extension, ".tar.gz") - self.assertEqual(ZipExtractor().extension, ".zip") + assert Extractor(Path("test.zip")).archive == Path("test.zip") + assert TarExtractor().extension == ".tar" + assert TarGzipExtractor().extension == ".tar.gz" + assert ZipExtractor().extension == ".zip" for i in [TarExtractor(), ZipExtractor(), ZipExtractor()]: i.set_archive(Path("/tmp/foo")) - self.assertEqual(i.archive.name.endswith(i.extension), True) # type: ignore + assert i.archive.name.endswith(i.extension) is True # type: ignore - def test_SourceProcessor_helpers(self): # noqa: N802 + def test_SourceProcessor_helpers(self) -> None: # noqa: N802 """Test SourceProcessor helpers.""" with mock.patch.object( SourceProcessor, @@ -430,37 +415,34 @@ def test_SourceProcessor_helpers(self): # noqa: N802 ): sp = SourceProcessor(cache_dir=self.tmp_path, sources={}) # type: ignore - self.assertEqual( - sp.sanitize_git_path("git@github.com:foo/bar.git"), - "git_github.com_foo_bar", + assert sp.sanitize_git_path("git@github.com:foo/bar.git") == "git_github.com_foo_bar" + assert ( + sp.sanitize_uri_path("http://example.com/foo/bar.gz@1") + == "http___example.com_foo_bar.gz_1" ) - self.assertEqual( - sp.sanitize_uri_path("http://example.com/foo/bar.gz@1"), - "http___example.com_foo_bar.gz_1", + assert ( + sp.sanitize_git_path("git@github.com:foo/bar.git", "v1") + == "git_github.com_foo_bar-v1" ) - self.assertEqual( - sp.sanitize_git_path("git@github.com:foo/bar.git", "v1"), - "git_github.com_foo_bar-v1", - ) - self.assertEqual( + assert ( sp.determine_git_ls_remote_ref( GitCfnginPackageSourceDefinitionModel(branch="foo", uri="test") - ), - "refs/heads/foo", + ) + == "refs/heads/foo" ) - for i in [cast(Dict[str, Any], {}), {"tag": "foo"}, {"commit": "1234"}]: - self.assertEqual( + for i in [cast(dict[str, Any], {}), {"tag": "foo"}, {"commit": "1234"}]: + assert ( sp.determine_git_ls_remote_ref( GitCfnginPackageSourceDefinitionModel(uri="git@foo", **i) - ), - "HEAD", + ) + == "HEAD" ) - self.assertEqual( + assert ( sp.git_ls_remote( "https://github.com/remind101/stacker.git", "refs/heads/release-1.0" - ), - "857b4834980e582874d70feef77bb064b60762d1", + ) + == "857b4834980e582874d70feef77bb064b60762d1" ) bad_configs = [ @@ -471,33 +453,28 @@ def test_SourceProcessor_helpers(self): # noqa: N802 {"uri": "x", "commit": "1234", "branch": "x"}, ] for i in bad_configs: - with self.assertRaises(ValidationError): + with pytest.raises(ValidationError): sp.determine_git_ref(GitCfnginPackageSourceDefinitionModel(**i)) - self.assertEqual( + assert ( sp.determine_git_ref( GitCfnginPackageSourceDefinitionModel( - uri="https://github.com/remind101/stacker.git", - branch="release-1.0", + uri="https://github.com/remind101/stacker.git", branch="release-1.0" ) - ), - "857b4834980e582874d70feef77bb064b60762d1", + ) + == "857b4834980e582874d70feef77bb064b60762d1" ) - self.assertEqual( + assert ( sp.determine_git_ref( - GitCfnginPackageSourceDefinitionModel( - **{"uri": "git@foo", "commit": "1234"} - ) - ), - "1234", + GitCfnginPackageSourceDefinitionModel(uri="git@foo", commit="1234") + ) + == "1234" ) - self.assertEqual( + assert ( sp.determine_git_ref( - GitCfnginPackageSourceDefinitionModel( - **{"uri": "git@foo", "tag": "v1.0.0"} - ) - ), - "v1.0.0", + GitCfnginPackageSourceDefinitionModel(uri="git@foo", tag="v1.0.0") + ) + == "v1.0.0" ) @@ -516,25 +493,19 @@ def setUp(self) -> None: """Run before tests.""" self.counter = 0 - def _works_immediately( - self, a: Any, b: Any, x: Any = None, y: Any = None - ) -> List[Any]: + def _works_immediately(self, a: Any, b: Any, x: Any = None, y: Any = None) -> list[Any]: """Works immediately.""" self.counter += 1 return [a, b, x, y] - def _works_second_attempt( - self, a: Any, b: Any, x: Any = None, y: Any = None - ) -> List[Any]: + def _works_second_attempt(self, a: Any, b: Any, x: Any = None, y: Any = None) -> list[Any]: """Works second_attempt.""" self.counter += 1 if self.counter == 2: return [a, b, x, y] raise Exception("Broke.") - def _second_raises_exception2( - self, a: Any, b: Any, x: Any = None, y: Any = None - ) -> List[Any]: + def _second_raises_exception2(self, a: Any, b: Any, x: Any = None, y: Any = None) -> list[Any]: """Second raises exception2.""" self.counter += 1 if self.counter == 2: @@ -542,8 +513,8 @@ def _second_raises_exception2( raise MockException("Broke.") def _throws_exception2( - self, a: Any, b: Any, x: Any = None, y: Any = None - ) -> List[Any]: + self, a: Any, b: Any, x: Any = None, y: Any = None # noqa: ARG002 + ) -> list[Any]: """Throws exception2.""" self.counter += 1 raise MockException("Broke.") diff --git a/tests/unit/config/components/runway/test_base.py b/tests/unit/config/components/runway/test_base.py index 92054cf22..71836e5ff 100644 --- a/tests/unit/config/components/runway/test_base.py +++ b/tests/unit/config/components/runway/test_base.py @@ -1,13 +1,12 @@ """Test runway.config.components.runway.base.""" -# pylint: disable=protected-access # pyright: basic from __future__ import annotations from typing import TYPE_CHECKING, Any +from unittest.mock import MagicMock, call import pytest -from mock import MagicMock, call from pydantic import Extra from runway.config.components.runway import RunwayVariablesDefinition @@ -16,7 +15,6 @@ from runway.exceptions import UnresolvedVariable if TYPE_CHECKING: - from pytest import MonkeyPatch from ....factories import MockRunwayContext @@ -80,9 +78,7 @@ def parse_obj(cls, obj: Any) -> SampleConfigComponentDefinition: class TestConfigComponentDefinition: """Test runway.config.components.runway.base.ConfigComponentDefinition.""" - VARIABLES = RunwayVariablesDefinition.parse_obj( - {"key": "val", "test": {"key": "test-val"}} - ) + VARIABLES = RunwayVariablesDefinition.parse_obj({"key": "val", "test": {"key": "test-val"}}) def test_contains(self) -> None: """Test __contains__.""" @@ -98,7 +94,8 @@ def test_default(self) -> None: obj = SampleConfigComponentDefinition(data) assert obj._data == data assert obj.data == data.dict() - assert not obj._vars and isinstance(obj._vars, dict) + assert not obj._vars + assert isinstance(obj._vars, dict) def test_get(self) -> None: """Test get.""" @@ -113,9 +110,7 @@ def test_getattr(self, runway_context: MockRunwayContext) -> None: var_attr="${var ${env DEPLOY_ENVIRONMENT}.key}", var_attr_pre="${var key}" ) obj = SampleConfigComponentDefinition(data) - assert not obj.resolve( - runway_context, pre_process=True, variables=self.VARIABLES - ) + assert not obj.resolve(runway_context, pre_process=True, variables=self.VARIABLES) assert obj.var_attr_pre == self.VARIABLES["key"] with pytest.raises(UnresolvedVariable): @@ -123,12 +118,10 @@ def test_getattr(self, runway_context: MockRunwayContext) -> None: with pytest.raises(AttributeError): assert not obj.missing - def test_getitem(self, monkeypatch: MonkeyPatch) -> None: + def test_getitem(self, monkeypatch: pytest.MonkeyPatch) -> None: """Test __getitem__.""" mock_getattr = MagicMock(side_effect=["val", AttributeError]) - monkeypatch.setattr( - SampleConfigComponentDefinition, "__getattr__", mock_getattr - ) + monkeypatch.setattr(SampleConfigComponentDefinition, "__getattr__", mock_getattr) obj = SampleConfigComponentDefinition.parse_obj({}) assert obj["key"] == "val" @@ -175,9 +168,7 @@ def test_resolve_pre_process(self, runway_context: MockRunwayContext) -> None: var_attr="${var ${env DEPLOY_ENVIRONMENT}.key}", var_attr_pre="${var key}" ) obj = SampleConfigComponentDefinition(data) - assert not obj.resolve( - runway_context, pre_process=True, variables=self.VARIABLES - ) + assert not obj.resolve(runway_context, pre_process=True, variables=self.VARIABLES) assert not obj._vars["var_attr"].resolved with pytest.raises(UnresolvedVariable): @@ -191,7 +182,7 @@ def test_setattr(self) -> None: """Test __setattr__.""" obj = SampleConfigComponentDefinition.parse_obj({}) assert not obj._data.get("key") - obj.key = "val" # pylint: disable=attribute-defined-outside-init + obj.key = "val" assert obj._data["key"] == "val" assert obj.key == "val" @@ -207,7 +198,7 @@ def test_setattr_property(self) -> None: def test_setattr_underscore(self) -> None: """Test __setattr__ underscore.""" obj = SampleConfigComponentDefinition.parse_obj({}) - obj._key = "_val" # pylint: disable=attribute-defined-outside-init + obj._key = "_val" assert "_key" not in obj._data assert obj._key == "_val" diff --git a/tests/unit/config/components/runway/test_deployment_def.py b/tests/unit/config/components/runway/test_deployment_def.py index da7163d3d..077a36956 100644 --- a/tests/unit/config/components/runway/test_deployment_def.py +++ b/tests/unit/config/components/runway/test_deployment_def.py @@ -1,8 +1,7 @@ """Test runway.config.components.runway._deployment_dev.""" -# pylint: disable=protected-access # pyright: basic -from typing import Any, Dict, List +from typing import Any import pytest @@ -72,7 +71,7 @@ class TestRunwayDeploymentDefinition: ), ], ) - def test_menu_entry(self, data: Dict[str, Any], expected: str) -> None: + def test_menu_entry(self, data: dict[str, Any], expected: str) -> None: """Test menu_entry.""" assert RunwayDeploymentDefinition.parse_obj(data).menu_entry == expected @@ -108,56 +107,46 @@ def test_modules_setter_not_list(self) -> None: obj.modules = None # type: ignore with pytest.raises(TypeError): obj.modules = [ # type: ignore - RunwayDeploymentDefinitionModel( - modules=[], name="test-01", regions=["us-east-1"] - ) + RunwayDeploymentDefinitionModel(modules=[], name="test-01", regions=["us-east-1"]) ] def test_models_setter_invalid_list_item(self) -> None: """Test modules.setter when list item is now supported.""" + obj = RunwayDeploymentDefinition.parse_obj({"regions": ["us-east-1"]}) with pytest.raises(TypeError): - obj = RunwayDeploymentDefinition.parse_obj({"regions": ["us-east-1"]}) obj.modules = [RunwayModuleDefinitionModel(path="./"), "invalid"] # type: ignore def test_parse_obj(self) -> None: """Test parse_obj.""" - data: Dict[str, Any] = {"name": "test", "modules": [], "regions": ["us-east-1"]} + data: dict[str, Any] = {"name": "test", "modules": [], "regions": ["us-east-1"]} obj = RunwayDeploymentDefinition.parse_obj(data) assert obj._data.dict(exclude_unset=True) == data def test_parse_obj_list(self) -> None: """Test parse_obj list.""" - data: List[Dict[str, Any]] = [ - {"name": "test", "modules": [], "regions": ["us-east-1"]} - ] + data: list[dict[str, Any]] = [{"name": "test", "modules": [], "regions": ["us-east-1"]}] result = RunwayDeploymentDefinition.parse_obj(data) assert isinstance(result, list) assert len(result) == 1 - # for some reason, the current version of pylint does not see this as list - # pylint: disable=unsubscriptable-object assert result[0]._data.dict(exclude_unset=True) == data[0] def test_register_variable(self) -> None: """Test _register_variable.""" - obj = RunwayDeploymentDefinition.parse_obj( - {"name": "test", "regions": ["us-east-1"]} - ) + obj = RunwayDeploymentDefinition.parse_obj({"name": "test", "regions": ["us-east-1"]}) assert obj._vars["regions"].name == "test.regions" def test_reverse(self) -> None: """Test reverse.""" - data: RunwayDeploymentDefinitionModel = ( - RunwayDeploymentDefinitionModel.parse_obj( - { - "name": "test", - "modules": [ - {"name": "test-01", "path": "./"}, - {"name": "test-02", "path": "./"}, - ], - "regions": ["us-east-1", "us-west-2"], - } - ) + data: RunwayDeploymentDefinitionModel = RunwayDeploymentDefinitionModel.parse_obj( + { + "name": "test", + "modules": [ + {"name": "test-01", "path": "./"}, + {"name": "test-02", "path": "./"}, + ], + "regions": ["us-east-1", "us-west-2"], + } ) obj = RunwayDeploymentDefinition(data) assert not obj.reverse() @@ -168,21 +157,19 @@ def test_reverse(self) -> None: def test_reverse_parallel_modules(self) -> None: """Test reverse parallel modules.""" - data: RunwayDeploymentDefinitionModel = ( - RunwayDeploymentDefinitionModel.parse_obj( - { - "name": "test", - "modules": [ - { - "parallel": [ - {"name": "test-01", "path": "./"}, - {"name": "test-02", "path": "./"}, - ] - }, - ], - "regions": ["us-east-1", "us-west-2"], - } - ) + data: RunwayDeploymentDefinitionModel = RunwayDeploymentDefinitionModel.parse_obj( + { + "name": "test", + "modules": [ + { + "parallel": [ + {"name": "test-01", "path": "./"}, + {"name": "test-02", "path": "./"}, + ] + }, + ], + "regions": ["us-east-1", "us-west-2"], + } ) obj = RunwayDeploymentDefinition(data) assert not obj.reverse() @@ -194,14 +181,12 @@ def test_reverse_parallel_modules(self) -> None: def test_reverse_parallel_regions(self) -> None: """Test reverse parallel regions.""" - data: RunwayDeploymentDefinitionModel = ( - RunwayDeploymentDefinitionModel.parse_obj( - { - "name": "test", - "modules": [{"name": "test-01", "path": "./"}], - "parallel_regions": ["us-east-1", "us-west-2"], - } - ) + data: RunwayDeploymentDefinitionModel = RunwayDeploymentDefinitionModel.parse_obj( + { + "name": "test", + "modules": [{"name": "test-01", "path": "./"}], + "parallel_regions": ["us-east-1", "us-west-2"], + } ) obj = RunwayDeploymentDefinition(data) assert not obj.reverse() diff --git a/tests/unit/config/components/runway/test_module_def.py b/tests/unit/config/components/runway/test_module_def.py index 4c2656b2a..d6a98922f 100644 --- a/tests/unit/config/components/runway/test_module_def.py +++ b/tests/unit/config/components/runway/test_module_def.py @@ -1,9 +1,8 @@ """Test runway.config.components.runway._module_def.""" -# pylint: disable=protected-access # pyright: basic from pathlib import Path -from typing import Any, Dict +from typing import Any import pytest @@ -47,11 +46,11 @@ def test_child_modules_setter_not_list(self) -> None: def test_child_modules_setter_invalid_list_item(self) -> None: """Test child_modules.setter when list item is now supported.""" + obj = RunwayModuleDefinition.parse_obj({"path": "./"}) with pytest.raises(TypeError): - obj = RunwayModuleDefinition.parse_obj({"path": "./"}) - obj.child_modules = [ # type: ignore + obj.child_modules = [ RunwayModuleDefinitionModel(path="./"), - "invalid", + "invalid", # type: ignore ] @pytest.mark.parametrize( @@ -81,7 +80,7 @@ def test_child_modules_setter_invalid_list_item(self) -> None: ), ], ) - def test_is_parent(self, data: Dict[str, Any], expected: bool) -> None: + def test_is_parent(self, data: dict[str, Any], expected: bool) -> None: """Test is_parent.""" assert RunwayModuleDefinition.parse_obj(data).is_parent is expected @@ -115,7 +114,7 @@ def test_is_parent(self, data: Dict[str, Any], expected: bool) -> None: ), ], ) - def test_menu_entry(self, data: Dict[str, Any], expected: str) -> None: + def test_menu_entry(self, data: dict[str, Any], expected: str) -> None: """Test menu entry.""" assert RunwayModuleDefinition.parse_obj(data).menu_entry == expected diff --git a/tests/unit/config/components/runway/test_test_def.py b/tests/unit/config/components/runway/test_test_def.py index 3cad04376..cffcb1ca1 100644 --- a/tests/unit/config/components/runway/test_test_def.py +++ b/tests/unit/config/components/runway/test_test_def.py @@ -1,6 +1,5 @@ """Test runway.config.components.runway._test_def.""" -# pylint: disable=protected-access # pyright: basic import pytest from pydantic import ValidationError @@ -23,9 +22,7 @@ class TestCfnLintRunwayTestDefinition: def test_parse_obj(self) -> None: """Test parse_obj.""" - assert isinstance( - CfnLintRunwayTestDefinition.parse_obj({}), CfnLintRunwayTestDefinition - ) + assert isinstance(CfnLintRunwayTestDefinition.parse_obj({}), CfnLintRunwayTestDefinition) class TestRunwayTestDefinition: @@ -97,9 +94,7 @@ class TestScriptRunwayTestDefinition: def test_parse_obj(self) -> None: """Test parse_obj.""" - assert isinstance( - ScriptRunwayTestDefinition.parse_obj({}), ScriptRunwayTestDefinition - ) + assert isinstance(ScriptRunwayTestDefinition.parse_obj({}), ScriptRunwayTestDefinition) class TestYamlLintRunwayTestDefinition: @@ -107,6 +102,4 @@ class TestYamlLintRunwayTestDefinition: def test_parse_obj(self) -> None: """Test parse_obj.""" - assert isinstance( - YamlLintRunwayTestDefinition.parse_obj({}), YamlLintRunwayTestDefinition - ) + assert isinstance(YamlLintRunwayTestDefinition.parse_obj({}), YamlLintRunwayTestDefinition) diff --git a/tests/unit/config/components/runway/test_variables_def.py b/tests/unit/config/components/runway/test_variables_def.py index be6701f2f..2b800a105 100644 --- a/tests/unit/config/components/runway/test_variables_def.py +++ b/tests/unit/config/components/runway/test_variables_def.py @@ -17,18 +17,13 @@ def test_init_no_file(self, cd_tmp_path: Path) -> None: """Test init with no file.""" assert not RunwayVariablesDefinition.parse_obj({"sys_path": cd_tmp_path}) - @pytest.mark.parametrize( - "filename", ("runway.variables.yml", "runway.variables.yaml") - ) + @pytest.mark.parametrize("filename", ["runway.variables.yml", "runway.variables.yaml"]) def test_init_autofind_file(self, cd_tmp_path: Path, filename: str) -> None: """Test init autofind file.""" data = {"key": "val"} (cd_tmp_path / filename).write_text(yaml.dump(data)) (cd_tmp_path / "runway.yml").touch() - assert ( - RunwayVariablesDefinition.parse_obj({"sys_path": cd_tmp_path})["key"] - == "val" - ) + assert RunwayVariablesDefinition.parse_obj({"sys_path": cd_tmp_path})["key"] == "val" def test_init_defined_file_path(self, cd_tmp_path: Path) -> None: """Test init with file_path.""" @@ -36,10 +31,7 @@ def test_init_defined_file_path(self, cd_tmp_path: Path) -> None: file_path = cd_tmp_path / "anything.yml" file_path.write_text(yaml.dump(data)) (cd_tmp_path / "runway.yml").touch() - assert ( - RunwayVariablesDefinition.parse_obj({"file_path": file_path})["key"] - == "val" - ) + assert RunwayVariablesDefinition.parse_obj({"file_path": file_path})["key"] == "val" def test_init_defined_file_path_no_found(self, cd_tmp_path: Path) -> None: """Test init with file_path not found.""" diff --git a/tests/unit/config/models/cfngin/test_cfngin.py b/tests/unit/config/models/cfngin/test_cfngin.py index 82e8248ff..b78e18930 100644 --- a/tests/unit/config/models/cfngin/test_cfngin.py +++ b/tests/unit/config/models/cfngin/test_cfngin.py @@ -19,23 +19,21 @@ class TestCfnginConfigDefinitionModel: """Test runway.config.models.cfngin.CfnginConfigDefinitionModel.""" - @pytest.mark.parametrize( - "field", ["post_deploy", "post_destroy", "pre_deploy", "pre_destroy"] - ) + @pytest.mark.parametrize("field", ["post_deploy", "post_destroy", "pre_deploy", "pre_destroy"]) def test_convert_hook_definitions(self, field: str) -> None: """Test _convert_hook_definitions.""" dict_hook = {"name": {"path": "something"}} list_hook = [{"path": "something"}] assert ( - CfnginConfigDefinitionModel.parse_obj( - {"namespace": "test", field: dict_hook} - ).dict(exclude_unset=True)[field] + CfnginConfigDefinitionModel.parse_obj({"namespace": "test", field: dict_hook}).dict( + exclude_unset=True + )[field] == list_hook ) assert ( - CfnginConfigDefinitionModel.parse_obj( - {"namespace": "test", field: list_hook} - ).dict(exclude_unset=True)[field] + CfnginConfigDefinitionModel.parse_obj({"namespace": "test", field: list_hook}).dict( + exclude_unset=True + )[field] == list_hook ) @@ -47,14 +45,18 @@ def test_convert_stack_definitions(self) -> None: CfnginConfigDefinitionModel( namespace="test", stacks=dict_stack, # type: ignore - ).dict(exclude_unset=True)["stacks"] + ).dict( + exclude_unset=True + )["stacks"] == list_stack ) assert ( CfnginConfigDefinitionModel( namespace="test", stacks=list_stack, # type: ignore - ).dict(exclude_unset=True)["stacks"] + ).dict( + exclude_unset=True + )["stacks"] == list_stack ) @@ -110,8 +112,10 @@ def test_resolve_path_fields(self) -> None: cfngin_cache_dir="./cache", # type: ignore sys_path="./something", # type: ignore ) - assert obj.cfngin_cache_dir and obj.cfngin_cache_dir.is_absolute() - assert obj.sys_path and obj.sys_path.is_absolute() + assert obj.cfngin_cache_dir + assert obj.cfngin_cache_dir.is_absolute() + assert obj.sys_path + assert obj.sys_path.is_absolute() def test_required_fields(self) -> None: """Test required fields.""" @@ -136,14 +140,15 @@ def test_validate_unique_stack_names(self) -> None: def test_validate_unique_stack_names_invalid(self) -> None: """Test _validate_unique_stack_names.""" with pytest.raises(ValidationError) as excinfo: - data = { - "namespace": "test", - "stacks": [ - {"name": "stack0", "class_path": "stack0"}, - {"name": "stack0", "class_path": "stack0"}, - ], - } - CfnginConfigDefinitionModel.parse_obj(data) + CfnginConfigDefinitionModel.parse_obj( + { + "namespace": "test", + "stacks": [ + {"name": "stack0", "class_path": "stack0"}, + {"name": "stack0", "class_path": "stack0"}, + ], + } + ) errors = excinfo.value.errors() assert len(errors) == 1 assert errors[0]["loc"] == ("stacks",) @@ -264,13 +269,9 @@ def test_validate_class_and_template(self) -> None: errors = excinfo.value.errors() assert len(errors) == 1 assert errors[0]["loc"] == ("__root__",) - assert ( - errors[0]["msg"] == "only one of class_path or template_path can be defined" - ) + assert errors[0]["msg"] == "only one of class_path or template_path can be defined" - @pytest.mark.parametrize( - "enabled, locked", [(True, True), (False, True), (False, False)] - ) + @pytest.mark.parametrize("enabled, locked", [(True, True), (False, True), (False, False)]) def test_validate_class_or_template(self, enabled: bool, locked: bool) -> None: """Test _validate_class_or_template.""" assert CfnginStackDefinitionModel( diff --git a/tests/unit/config/models/cfngin/test_package_sources.py b/tests/unit/config/models/cfngin/test_package_sources.py index 21fc778de..cb22fbbe0 100644 --- a/tests/unit/config/models/cfngin/test_package_sources.py +++ b/tests/unit/config/models/cfngin/test_package_sources.py @@ -1,7 +1,6 @@ """Test runway.config.models.cfngin._package_sources.""" # pyright: basic -from typing import Dict, List import pytest from pydantic import ValidationError @@ -40,8 +39,8 @@ def test_fields(self) -> None: "local": [{"source": "something"}], "s3": [{"bucket": "bucket", "key": "something"}], } - obj: CfnginPackageSourcesDefinitionModel = ( - CfnginPackageSourcesDefinitionModel.parse_obj(data) + obj: CfnginPackageSourcesDefinitionModel = CfnginPackageSourcesDefinitionModel.parse_obj( + data ) assert isinstance(obj.git[0], GitCfnginPackageSourceDefinitionModel) assert isinstance(obj.local[0], LocalCfnginPackageSourceDefinitionModel) @@ -90,13 +89,10 @@ def test_required_fields(self) -> None: {"field": "tag", "value": "v1.0.0"}, ], ) - def test_validate_one_ref(self, ref: Dict[str, str]) -> None: + def test_validate_one_ref(self, ref: dict[str, str]) -> None: """Test _validate_one_ref.""" data = {"uri": "something", ref["field"]: ref["value"]} - assert ( - GitCfnginPackageSourceDefinitionModel.parse_obj(data)[ref["field"]] - == ref["value"] - ) + assert GitCfnginPackageSourceDefinitionModel.parse_obj(data)[ref["field"]] == ref["value"] @pytest.mark.parametrize( "refs", @@ -120,7 +116,7 @@ def test_validate_one_ref(self, ref: Dict[str, str]) -> None: ], ], ) - def test_validate_one_ref_invalid(self, refs: List[Dict[str, str]]) -> None: + def test_validate_one_ref_invalid(self, refs: list[dict[str, str]]) -> None: """Test _validate_one_ref invalid values.""" data = {"uri": "something", **{ref["field"]: ref["value"] for ref in refs}} with pytest.raises(ValidationError) as excinfo: @@ -132,7 +128,7 @@ def test_validate_one_ref_invalid(self, refs: List[Dict[str, str]]) -> None: class TestLocalCfnginPackageSourceDefinitionModel: - """Test runway.config.models.cfngin._package_sources.LocalCfnginPackageSourceDefinitionModel.""" # noqa + """Test runway.config.models.cfngin._package_sources.LocalCfnginPackageSourceDefinitionModel.""" def test_extra(self) -> None: """Test extra fields.""" diff --git a/tests/unit/config/models/runway/options/test_cdk.py b/tests/unit/config/models/runway/options/test_cdk.py index a2d9eba81..372234f50 100644 --- a/tests/unit/config/models/runway/options/test_cdk.py +++ b/tests/unit/config/models/runway/options/test_cdk.py @@ -10,7 +10,8 @@ class TestRunwayCdkModuleOptionsDataModel: def test_init_default(self) -> None: """Test init default.""" obj = RunwayCdkModuleOptionsDataModel() - assert not obj.build_steps and isinstance(obj.build_steps, list) + assert not obj.build_steps + assert isinstance(obj.build_steps, list) assert not obj.skip_npm_ci def test_init_extra(self) -> None: @@ -20,8 +21,6 @@ def test_init_extra(self) -> None: def test_init(self) -> None: """Test init.""" - obj = RunwayCdkModuleOptionsDataModel( - build_steps=["test0", "test1"], skip_npm_ci=True - ) + obj = RunwayCdkModuleOptionsDataModel(build_steps=["test0", "test1"], skip_npm_ci=True) assert obj.build_steps == ["test0", "test1"] assert obj.skip_npm_ci diff --git a/tests/unit/config/models/runway/options/test_k8s.py b/tests/unit/config/models/runway/options/test_k8s.py index 349d025b1..9aa695e29 100644 --- a/tests/unit/config/models/runway/options/test_k8s.py +++ b/tests/unit/config/models/runway/options/test_k8s.py @@ -27,8 +27,6 @@ def test_init_extra(self) -> None: def test_init(self, tmp_path: Path) -> None: """Test init.""" - obj = RunwayK8sModuleOptionsDataModel( - kubectl_version="0.13.0", overlay_path=tmp_path - ) + obj = RunwayK8sModuleOptionsDataModel(kubectl_version="0.13.0", overlay_path=tmp_path) assert obj.kubectl_version == "0.13.0" assert obj.overlay_path == tmp_path diff --git a/tests/unit/config/models/runway/options/test_serverless.py b/tests/unit/config/models/runway/options/test_serverless.py index 049b3b180..126249897 100644 --- a/tests/unit/config/models/runway/options/test_serverless.py +++ b/tests/unit/config/models/runway/options/test_serverless.py @@ -16,10 +16,10 @@ class TestRunwayServerlessModuleOptionsDataModel: def test_init_default(self) -> None: """Test init default values.""" obj = RunwayServerlessModuleOptionsDataModel() - assert not obj.args and isinstance(obj.args, list) - assert not obj.extend_serverless_yml and isinstance( - obj.extend_serverless_yml, dict - ) + assert not obj.args + assert isinstance(obj.args, list) + assert not obj.extend_serverless_yml + assert isinstance(obj.extend_serverless_yml, dict) assert obj.promotezip == RunwayServerlessPromotezipOptionDataModel() assert obj.skip_npm_ci is False diff --git a/tests/unit/config/models/runway/options/test_terraform.py b/tests/unit/config/models/runway/options/test_terraform.py index 5c392d524..28e59c25d 100644 --- a/tests/unit/config/models/runway/options/test_terraform.py +++ b/tests/unit/config/models/runway/options/test_terraform.py @@ -17,9 +17,12 @@ class TestRunwayTerraformArgsDataModel: def test_init_default(self) -> None: """Test init default.""" obj = RunwayTerraformArgsDataModel() - assert not obj.apply and isinstance(obj.apply, list) - assert not obj.init and isinstance(obj.init, list) - assert not obj.plan and isinstance(obj.plan, list) + assert not obj.apply + assert isinstance(obj.apply, list) + assert not obj.init + assert isinstance(obj.init, list) + assert not obj.plan + assert isinstance(obj.plan, list) def test_init_extra(self) -> None: """Test init extra.""" @@ -28,9 +31,7 @@ def test_init_extra(self) -> None: def test_init(self) -> None: """Test init.""" - obj = RunwayTerraformArgsDataModel( - apply=["-apply"], init=["-init"], plan=["-plan"] - ) + obj = RunwayTerraformArgsDataModel(apply=["-apply"], init=["-init"], plan=["-plan"]) assert obj.apply == ["-apply"] assert obj.init == ["-init"] assert obj.plan == ["-plan"] @@ -43,9 +44,7 @@ def test_bool(self) -> None: """Test __bool__.""" assert RunwayTerraformBackendConfigDataModel(bucket="test") assert RunwayTerraformBackendConfigDataModel(dynamodb_table="test") - assert RunwayTerraformBackendConfigDataModel( - bucket="test", dynamodb_table="test" - ) + assert RunwayTerraformBackendConfigDataModel(bucket="test", dynamodb_table="test") assert RunwayTerraformBackendConfigDataModel( bucket="test", dynamodb_table="test", workspace_key_prefix="state" ) @@ -86,8 +85,10 @@ def test_convert_args(self) -> None: """Test _convert_args.""" obj = RunwayTerraformModuleOptionsDataModel.parse_obj({"args": ["test"]}) assert obj.args.apply == ["test"] - assert not obj.args.init and isinstance(obj.args.init, list) - assert not obj.args.plan and isinstance(obj.args.plan, list) + assert not obj.args.init + assert isinstance(obj.args.init, list) + assert not obj.args.plan + assert isinstance(obj.args.plan, list) def test_init_default(self) -> None: """Test init default.""" @@ -116,8 +117,7 @@ def test_init(self) -> None: obj = RunwayTerraformModuleOptionsDataModel.parse_obj(data) assert obj.args.init == data["args"]["init"] # type: ignore assert ( - obj.backend_config.bucket - == data["terraform_backend_config"]["bucket"] # type: ignore + obj.backend_config.bucket == data["terraform_backend_config"]["bucket"] # type: ignore ) assert obj.version == data["terraform_version"] assert obj.workspace == data["terraform_workspace"] diff --git a/tests/unit/config/models/runway/test_builtin_tests.py b/tests/unit/config/models/runway/test_builtin_tests.py index 60d7798fa..b4f2f01fc 100644 --- a/tests/unit/config/models/runway/test_builtin_tests.py +++ b/tests/unit/config/models/runway/test_builtin_tests.py @@ -68,9 +68,7 @@ def test_required(self, required: Optional[bool]) -> None: def test_string_args(self) -> None: """Test args defined as a string.""" with pytest.raises(ValidationError) as excinfo: - RunwayTestDefinitionModel.parse_obj( - {"args": "something", "type": "yamllint"} - ) + RunwayTestDefinitionModel.parse_obj({"args": "something", "type": "yamllint"}) error = excinfo.value.errors()[0] assert error["loc"] == ("args",) assert error["msg"] == "field can only be a string if it's a lookup" @@ -84,9 +82,7 @@ def test_string_args_lookup(self) -> None: def test_string_required(self) -> None: """Test required defined as a string.""" with pytest.raises(ValidationError) as excinfo: - RunwayTestDefinitionModel.parse_obj( - {"required": "something", "type": "yamllint"} - ) + RunwayTestDefinitionModel.parse_obj({"required": "something", "type": "yamllint"}) error = excinfo.value.errors()[0] assert error["loc"] == ("required",) assert error["msg"] == "field can only be a string if it's a lookup" diff --git a/tests/unit/config/models/runway/test_runway.py b/tests/unit/config/models/runway/test_runway.py index 2c17f80ac..4d9d6c0f9 100644 --- a/tests/unit/config/models/runway/test_runway.py +++ b/tests/unit/config/models/runway/test_runway.py @@ -2,7 +2,7 @@ # pyright: basic from pathlib import Path -from typing import Any, Dict +from typing import Any import pytest import yaml @@ -126,10 +126,7 @@ def test_convert_runway_version_invalid(self) -> None: """Test _convert_runway_version invalid specifier set.""" with pytest.raises(ValidationError) as excinfo: RunwayConfigDefinitionModel(runway_version="=latest") # type: ignore - assert ( - excinfo.value.errors()[0]["msg"] - == "=latest is not a valid version specifier set" - ) + assert excinfo.value.errors()[0]["msg"] == "=latest is not a valid version specifier set" def test_extra(self) -> None: """Test extra fields.""" @@ -183,9 +180,7 @@ def test_convert_simple_module(self) -> None: def test_extra(self) -> None: """Test extra fields.""" with pytest.raises(ValidationError) as excinfo: - RunwayDeploymentDefinitionModel.parse_obj( - {"invalid": "val", "regions": ["us-east-1"]} - ) + RunwayDeploymentDefinitionModel.parse_obj({"invalid": "val", "regions": ["us-east-1"]}) errors = excinfo.value.errors() assert len(errors) == 1 assert errors[0]["loc"] == ("invalid",) @@ -219,7 +214,7 @@ def test_field_defaults(self) -> None: ) def test_fields_string_lookup_only(self, field: str) -> None: """Test fields that support strings only for lookups.""" - data: Dict[str, Any] = {} + data: dict[str, Any] = {} if field not in ["parallel_regions", "regions"]: data["regions"] = ["us-east-1"] data[field] = "something" @@ -259,9 +254,7 @@ def test_validate_regions(self) -> None: assert obj0.regions == ["us-east-1"] assert obj0.parallel_regions == [] - obj1 = RunwayDeploymentDefinitionModel( - modules=[], parallel_regions=["us-east-1"] - ) + obj1 = RunwayDeploymentDefinitionModel(modules=[], parallel_regions=["us-east-1"]) assert obj1.regions == [] assert obj1.parallel_regions == ["us-east-1"] @@ -279,9 +272,7 @@ class TestRunwayDeploymentRegionDefinitionModel: def test_extra(self) -> None: """Test extra fields.""" with pytest.raises(ValidationError) as excinfo: - RunwayDeploymentRegionDefinitionModel.parse_obj( - {"invalid": "val", "parallel": []} - ) + RunwayDeploymentRegionDefinitionModel.parse_obj({"invalid": "val", "parallel": []}) errors = excinfo.value.errors() assert len(errors) == 1 assert errors[0]["loc"] == ("invalid",) @@ -390,9 +381,7 @@ def test_validate_parallel(self) -> None: parallel=[{"name": "test", "path": "./"}] # type: ignore ).parallel == [RunwayModuleDefinitionModel(name="test", path="./")] - @pytest.mark.parametrize( - "field", ["env_vars", "environments", "options", "parameters"] - ) + @pytest.mark.parametrize("field", ["env_vars", "environments", "options", "parameters"]) def test_fields_string_lookup_only(self, field: str) -> None: """Test fields that support strings only for lookups.""" data = {field: "something"} diff --git a/tests/unit/config/models/test_base.py b/tests/unit/config/models/test_base.py index 8a35a00cb..78ff62582 100644 --- a/tests/unit/config/models/test_base.py +++ b/tests/unit/config/models/test_base.py @@ -1,7 +1,7 @@ """Test runway.config.models.base.""" # pyright: basic -from typing import Any, Dict, Optional +from typing import Any, Optional import pytest from pydantic import Extra, ValidationError @@ -33,7 +33,7 @@ class GoodObject(ConfigProperty): name: str bool_field: bool = True - dict_field: Dict[str, Any] = {} + dict_field: dict[str, Any] = {} optional_str_field: Optional[str] = None class Config(ConfigProperty.Config): @@ -81,8 +81,7 @@ def test_validate_all(self) -> None: def test_validate_assignment(self) -> None: """Test Config.validate_assignment.""" with pytest.raises(ValidationError) as excinfo: - obj = GoodObject(name="test") - obj.name = ("invalid",) # type: ignore + GoodObject(name="test").name = ("invalid",) # type: ignore errors = excinfo.value.errors() assert len(errors) == 1 assert errors[0]["loc"] == ("name",) diff --git a/tests/unit/config/models/test_utils.py b/tests/unit/config/models/test_utils.py index ec2ea856c..33d5b0b0f 100644 --- a/tests/unit/config/models/test_utils.py +++ b/tests/unit/config/models/test_utils.py @@ -66,6 +66,6 @@ def test_validate_string_is_lookup(provided: Any) -> None: ) def test_validate_string_is_lookup_raises(provided: str) -> None: """Test validate_string_is_lookup.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError) as excinfo: # noqa: PT011 validate_string_is_lookup(provided) assert excinfo.value == RUNWAY_LOOKUP_STRING_ERROR diff --git a/tests/unit/config/test_config.py b/tests/unit/config/test_config.py index 9f11e306e..5f5d81bc3 100644 --- a/tests/unit/config/test_config.py +++ b/tests/unit/config/test_config.py @@ -3,12 +3,11 @@ # pyright: basic from __future__ import annotations -from pathlib import Path from typing import TYPE_CHECKING +from unittest.mock import MagicMock, patch import pytest import yaml -from mock import MagicMock, patch from pydantic import BaseModel from runway.cfngin.exceptions import MissingEnvironment @@ -20,7 +19,8 @@ from runway.exceptions import ConfigNotFound if TYPE_CHECKING: - from pytest import MonkeyPatch + from pathlib import Path + MODULE = "runway.config" @@ -34,7 +34,7 @@ class ExampleModel(BaseModel): class TestBaseConfig: """Test runway.config.BaseConfig.""" - def test_dump(self, monkeypatch: MonkeyPatch) -> None: + def test_dump(self, monkeypatch: pytest.MonkeyPatch) -> None: """Test dump.""" mock_dict = MagicMock(return_value={"name": "test"}) monkeypatch.setattr(ExampleModel, "dict", mock_dict) @@ -122,7 +122,7 @@ def test_parse_file_file_path_missing(self, tmp_path: Path) -> None: assert excinfo.value.path == config_yml def test_parse_file_find_config_file( - self, monkeypatch: MonkeyPatch, tmp_path: Path + self, monkeypatch: pytest.MonkeyPatch, tmp_path: Path ) -> None: """Test parse_file with path.""" file_path = tmp_path / "test.yml" @@ -138,41 +138,35 @@ def test_parse_file_find_config_file( ) def test_parse_file_find_config_file_value_error( - self, monkeypatch: MonkeyPatch, tmp_path: Path + self, monkeypatch: pytest.MonkeyPatch, tmp_path: Path ) -> None: """Test parse_file with path raise ValueError.""" - mock_find_config_file = MagicMock( - return_value=[tmp_path / "01.yml", tmp_path / "02.yml"] - ) + mock_find_config_file = MagicMock(return_value=[tmp_path / "01.yml", tmp_path / "02.yml"]) monkeypatch.setattr(CfnginConfig, "find_config_file", mock_find_config_file) - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="more than one"): CfnginConfig.parse_file(path=tmp_path) - assert str(excinfo.value).startswith("more than one") - def test_parse_file_value_error(self): + def test_parse_file_value_error(self) -> None: """Test parse_file raise ValueError.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="must provide path or file_path"): CfnginConfig.parse_file() - assert str(excinfo.value) == "must provide path or file_path" - def test_parse_obj(self, monkeypatch: MonkeyPatch) -> None: - """Test parse_obj.""" + def test_parse_obj(self, monkeypatch: pytest.MonkeyPatch) -> None: + """Test model_validate.""" monkeypatch.setattr( MODULE + ".CfnginConfigDefinitionModel.parse_obj", - lambda x: CfnginConfigDefinitionModel(namespace="success"), # type: ignore + lambda x: CfnginConfigDefinitionModel(namespace="success"), # type: ignore # noqa: ARG005 ) assert CfnginConfig.parse_obj({}).namespace == "success" - def test_parse_raw(self, monkeypatch: MonkeyPatch, tmp_path: Path) -> None: + def test_parse_raw(self, monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None: """Test parse_raw.""" mock_resolve_raw_data = MagicMock() mock_parse_obj = MagicMock() mock_process_package_sources = MagicMock() monkeypatch.setattr(CfnginConfig, "resolve_raw_data", mock_resolve_raw_data) monkeypatch.setattr(CfnginConfig, "parse_obj", mock_parse_obj) - monkeypatch.setattr( - CfnginConfig, "process_package_sources", mock_process_package_sources - ) + monkeypatch.setattr(CfnginConfig, "process_package_sources", mock_process_package_sources) data = {"namespace": "test"} data_str = yaml.dump(data) @@ -181,20 +175,14 @@ def test_parse_raw(self, monkeypatch: MonkeyPatch, tmp_path: Path) -> None: mock_process_package_sources.return_value = data_str assert ( - CfnginConfig.parse_raw( - data_str, skip_package_sources=True, work_dir=tmp_path - ) - == data + CfnginConfig.parse_raw(data_str, skip_package_sources=True, work_dir=tmp_path) == data ) mock_resolve_raw_data.assert_called_once_with(yaml.dump(data), parameters={}) mock_parse_obj.assert_called_once_with(data) mock_process_package_sources.assert_not_called() assert ( - CfnginConfig.parse_raw( - data_str, parameters={"key": "val"}, work_dir=tmp_path - ) - == data + CfnginConfig.parse_raw(data_str, parameters={"key": "val"}, work_dir=tmp_path) == data ) mock_resolve_raw_data.assert_called_with( yaml.dump(data), @@ -207,7 +195,7 @@ def test_parse_raw(self, monkeypatch: MonkeyPatch, tmp_path: Path) -> None: @patch(MODULE + ".SourceProcessor") def test_process_package_sources( - self, mock_source_processor: MagicMock, monkeypatch: MonkeyPatch, tmp_path: Path + self, mock_source_processor: MagicMock, monkeypatch: pytest.MonkeyPatch, tmp_path: Path ) -> None: """Test process_package_sources.""" mock_resolve_raw_data = MagicMock(return_value="rendered") @@ -234,7 +222,7 @@ def test_process_package_sources( data = {"namespace": "test", "package_sources": {"git": [{"uri": "something"}]}} raw_data = yaml.dump(data) - mock_source_processor.configs_to_merge = [str(other_config.resolve())] + mock_source_processor.configs_to_merge = [other_config.resolve()] assert ( CfnginConfig.process_package_sources( raw_data, parameters={"key": "val"}, work_dir=tmp_path @@ -242,9 +230,7 @@ def test_process_package_sources( == "rendered" ) mock_source_processor.assert_called_with( - sources=CfnginPackageSourcesDefinitionModel.parse_obj( - {"git": [{"uri": "something"}]} - ), + sources=CfnginPackageSourcesDefinitionModel.parse_obj({"git": [{"uri": "something"}]}), cache_dir=tmp_path / "cache", ) assert mock_source_processor.call_count == 2 @@ -258,10 +244,7 @@ def test_resolve_raw_data(self) -> None: """Test resolve_raw_data.""" raw_data = "namespace: ${namespace}" expected = "namespace: test" - assert ( - CfnginConfig.resolve_raw_data(raw_data, parameters={"namespace": "test"}) - == expected - ) + assert CfnginConfig.resolve_raw_data(raw_data, parameters={"namespace": "test"}) == expected def test_resolve_raw_data_missing_value(self) -> None: """Test resolve_raw_data missing value.""" @@ -278,13 +261,13 @@ def test_resolve_raw_data_ignore_lookup(self) -> None: class TestRunwayConfig: """Test runway.config.RunwayConfig.""" - def test_find_config_file_yaml(self, tmp_path: Path): + def test_find_config_file_yaml(self, tmp_path: Path) -> None: """Test file_config_file runway.yaml.""" runway_yaml = tmp_path / "runway.yaml" runway_yaml.touch() assert RunwayConfig.find_config_file(tmp_path) == runway_yaml - def test_find_config_file_yml(self, tmp_path: Path): + def test_find_config_file_yml(self, tmp_path: Path) -> None: """Test file_config_file runway.yml.""" runway_yml = tmp_path / "runway.yml" runway_yml.touch() @@ -308,9 +291,8 @@ def test_find_config_file_value_error(self, tmp_path: Path) -> None: """Test file_config_file raise ValueError.""" (tmp_path / "runway.yaml").touch() (tmp_path / "runway.yml").touch() - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="more than one"): RunwayConfig.find_config_file(tmp_path) - assert str(excinfo.value).startswith("more than one") def test_parse_obj(self) -> None: """Test parse_obj.""" diff --git a/tests/unit/conftest.py b/tests/unit/conftest.py index e13e32989..6c0e32b9f 100644 --- a/tests/unit/conftest.py +++ b/tests/unit/conftest.py @@ -1,22 +1,21 @@ """Pytest fixtures and plugins.""" -# pylint: disable=redefined-outer-name from __future__ import annotations import logging import os from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, Iterator, List, Optional, cast +from typing import TYPE_CHECKING, Any, Optional, cast +from unittest.mock import MagicMock, Mock import pytest import yaml -from mock import MagicMock from runway.config import RunwayConfig from runway.core.components import DeployEnvironment from .factories import ( - MockCFNginContext, + MockCfnginContext, MockRunwayConfig, MockRunwayContext, YamlLoader, @@ -25,18 +24,18 @@ from .mock_docker.fake_api_client import make_fake_client if TYPE_CHECKING: + from collections.abc import Iterator + from _pytest.config import Config from _pytest.python import Module from docker import DockerClient - from pytest import FixtureRequest, MonkeyPatch from pytest_mock import MockerFixture -LOG = logging.getLogger(__name__) -TEST_ROOT = Path(os.path.dirname(os.path.realpath(__file__))) +LOGGER = logging.getLogger(__name__) +TEST_ROOT = Path(__file__).parent -# pylint: disable=unused-argument -def pytest_ignore_collect(path: Any, config: Config) -> bool: +def pytest_ignore_collect(path: Any, config: Config) -> bool: # noqa: ARG001 """Determine if this directory should have its tests collected.""" if config.option.functional: return True @@ -56,16 +55,16 @@ def aws_credentials() -> Iterator[None]: "AWS_SECRET_ACCESS_KEY": "testing", "AWS_DEFAULT_REGION": "us-east-1", } - saved_env: Dict[str, Optional[str]] = {} + saved_env: dict[str, Optional[str]] = {} for key, value in overrides.items(): - LOG.info("Overriding env var: %s=%s", key, value) + LOGGER.info("Overriding env var: %s=%s", key, value) saved_env[key] = os.environ.get(key, None) os.environ[key] = value yield for key, value in saved_env.items(): - LOG.info("Restoring saved env var: %s=%s", key, value) + LOGGER.info("Restoring saved env var: %s=%s", key, value) if value is None: os.environ.pop(key, None) # handle key missing else: @@ -75,9 +74,9 @@ def aws_credentials() -> Iterator[None]: @pytest.fixture(scope="package") -def fixture_dir() -> str: +def fixture_dir() -> Path: """Path to the fixture directory.""" - return os.path.join(os.path.dirname(os.path.realpath(__file__)), "fixtures") + return Path(__file__).parent / "fixtures" @pytest.fixture(scope="module") @@ -90,19 +89,19 @@ def fx_config() -> YamlLoader: ) -@pytest.fixture(scope="function") +@pytest.fixture() def fx_deployments() -> YamlLoaderDeployment: """Return YAML loader for deployment fixtures.""" return YamlLoaderDeployment(TEST_ROOT / "fixtures" / "deployments") -@pytest.fixture(scope="function") +@pytest.fixture() def mock_docker_client() -> DockerClient: """Create a docker client with mock API backend.""" return make_fake_client() -@pytest.fixture(scope="function") +@pytest.fixture() def tempfile_temporary_directory(mocker: MockerFixture, tmp_path: Path) -> MagicMock: """Mock tempfile.TemporaryDirectory.""" return mocker.patch( @@ -112,63 +111,61 @@ def tempfile_temporary_directory(mocker: MockerFixture, tmp_path: Path) -> Magic @pytest.fixture(scope="module") -def yaml_fixtures(request: FixtureRequest, fixture_dir: str) -> Dict[str, Any]: +def yaml_fixtures(request: pytest.FixtureRequest, fixture_dir: Path) -> dict[str, Any]: """Load test fixture yaml files. Uses a list of file paths within the fixture directory loaded from the `YAML_FIXTURES` variable of the module. """ - file_paths: List[str] = getattr( + file_paths: list[str] = getattr( cast("Module", request.module), "YAML_FIXTURES", [] # type: ignore ) - result: Dict[str, Any] = {} + result: dict[str, Any] = {} for file_path in file_paths: - with open(os.path.join(fixture_dir, file_path), encoding="utf-8") as _file: - data = _file.read() - result[file_path] = yaml.safe_load(data) + result[file_path] = yaml.safe_load((fixture_dir / file_path).read_bytes()) return result -@pytest.fixture(scope="function") +@pytest.fixture() def deploy_environment(tmp_path: Path) -> DeployEnvironment: """Create a deploy environment that can be used for testing.""" return DeployEnvironment(explicit_name="test", root_dir=tmp_path) -@pytest.fixture(scope="function") -def cfngin_context(runway_context: MockRunwayContext) -> MockCFNginContext: +@pytest.fixture() +def cfngin_context(runway_context: MockRunwayContext) -> MockCfnginContext: """Create a mock CFNgin context object.""" - return MockCFNginContext(deploy_environment=runway_context.env, parameters={}) + return MockCfnginContext(deploy_environment=runway_context.env, parameters={}) -@pytest.fixture -def patch_time(monkeypatch: MonkeyPatch) -> None: - """Patch built-in time object.""" - monkeypatch.setattr("time.sleep", lambda s: None) # type: ignore +@pytest.fixture() +def mock_sleep(mocker: MockerFixture) -> Mock: + """Patch built-in ``time.sleep``.""" + return mocker.patch("time.sleep", return_value=None) -@pytest.fixture +@pytest.fixture() def platform_darwin(mocker: MockerFixture) -> None: """Patch platform.system to always return "Darwin".""" mocker.patch("platform.system", return_value="Darwin") -@pytest.fixture +@pytest.fixture() def platform_linux(mocker: MockerFixture) -> None: """Patch platform.system to always return "Linux".""" mocker.patch("platform.system", return_value="Linux") -@pytest.fixture +@pytest.fixture() def platform_windows(mocker: MockerFixture) -> None: """Patch platform.system to always return "Windows".""" mocker.patch("platform.system", return_value="Windows") -@pytest.fixture(scope="function") +@pytest.fixture() def patch_runway_config( - request: FixtureRequest, monkeypatch: MonkeyPatch, runway_config: MockRunwayConfig + request: pytest.FixtureRequest, monkeypatch: pytest.MonkeyPatch, runway_config: MockRunwayConfig ) -> MockRunwayConfig: """Patch Runway config and return a mock config object.""" patch_path = getattr(cast("Module", request.module), "PATCH_RUNWAY_CONFIG", None) @@ -177,25 +174,19 @@ def patch_runway_config( return runway_config -@pytest.fixture(scope="function") +@pytest.fixture() def runway_config() -> MockRunwayConfig: """Create a mock runway config object.""" return MockRunwayConfig() -@pytest.fixture(scope="function") -def runway_context(request: FixtureRequest, tmp_path: Path) -> MockRunwayContext: +@pytest.fixture() +def runway_context(request: pytest.FixtureRequest, tmp_path: Path) -> MockRunwayContext: """Create a mock Runway context object.""" env_vars = { - "AWS_REGION": getattr( - cast("Module", request.module), "AWS_REGION", "us-east-1" - ), - "DEFAULT_AWS_REGION": getattr( - cast("Module", request.module), "AWS_REGION", "us-east-1" - ), - "DEPLOY_ENVIRONMENT": getattr( - cast("Module", request.module), "DEPLOY_ENVIRONMENT", "test" - ), + "AWS_REGION": getattr(cast("Module", request.module), "AWS_REGION", "us-east-1"), + "DEFAULT_AWS_REGION": getattr(cast("Module", request.module), "AWS_REGION", "us-east-1"), + "DEPLOY_ENVIRONMENT": getattr(cast("Module", request.module), "DEPLOY_ENVIRONMENT", "test"), } creds = { "AWS_ACCESS_KEY_ID": "test_access_key", diff --git a/tests/unit/context/test_base.py b/tests/unit/context/test_base.py index 263e36436..1123e937b 100644 --- a/tests/unit/context/test_base.py +++ b/tests/unit/context/test_base.py @@ -1,14 +1,13 @@ """Test runway.context._base.""" -# pylint: disable=redefined-outer-name # pyright: basic from __future__ import annotations from typing import TYPE_CHECKING, cast +from unittest.mock import MagicMock import boto3 import pytest -from mock import MagicMock from runway.context._base import BaseContext from runway.context.sys_info import SystemInfo @@ -31,7 +30,7 @@ } -@pytest.fixture(scope="function") +@pytest.fixture() def mock_boto3_session(mocker: MockerFixture) -> MagicMock: """Mock boto3.Session.""" mock_session = MagicMock(autospec=boto3.Session) @@ -39,7 +38,7 @@ def mock_boto3_session(mocker: MockerFixture) -> MagicMock: return mock_session -@pytest.fixture(scope="function") +@pytest.fixture() def mock_sso_botocore_session(mocker: MockerFixture) -> MagicMock: """Mock runway.aws_sso_botocore.session.Session.""" return mocker.patch(f"{MODULE}.Session") @@ -62,10 +61,7 @@ class TestBaseContext: def test_boto3_credentials(self, mocker: MockerFixture) -> None: """Test boto3_credentials.""" mocker.patch.object(self.env, "vars", TEST_ENV_CREDS) - assert ( - BaseContext(deploy_environment=self.env).boto3_credentials - == TEST_BOTO3_CREDS - ) + assert BaseContext(deploy_environment=self.env).boto3_credentials == TEST_BOTO3_CREDS def test_boto3_credentials_empty(self, mocker: MockerFixture) -> None: """Test boto3_credentials empty.""" @@ -75,9 +71,7 @@ def test_boto3_credentials_empty(self, mocker: MockerFixture) -> None: def test_current_aws_creds(self, mocker: MockerFixture) -> None: """Test current_aws_creds.""" mocker.patch.object(self.env, "vars", TEST_ENV_CREDS) - assert ( - BaseContext(deploy_environment=self.env).current_aws_creds == TEST_ENV_CREDS - ) + assert BaseContext(deploy_environment=self.env).current_aws_creds == TEST_ENV_CREDS def test_current_aws_creds_empty(self, mocker: MockerFixture) -> None: """Test current_aws_creds empty.""" diff --git a/tests/unit/context/test_cfngin.py b/tests/unit/context/test_cfngin.py index 93f669927..11c16884f 100644 --- a/tests/unit/context/test_cfngin.py +++ b/tests/unit/context/test_cfngin.py @@ -6,12 +6,12 @@ import io import json from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Union, cast +from typing import TYPE_CHECKING, Any, Optional, Union, cast +from unittest.mock import MagicMock import pytest from botocore.response import StreamingBody from botocore.stub import Stubber -from mock import MagicMock from runway.cfngin.exceptions import ( PersistentGraphCannotLock, @@ -41,12 +41,12 @@ } -def gen_tagset(tags: Dict[str, str]) -> TagSetTypeDef: +def gen_tagset(tags: dict[str, str]) -> TagSetTypeDef: """Create TagSet value from a dict.""" return [{"Key": key, "Value": value} for key, value in tags.items()] -def gen_s3_object_content(content: Union[Dict[str, Any], str]) -> StreamingBody: +def gen_s3_object_content(content: Union[dict[str, Any], str]) -> StreamingBody: """Convert a string or dict to S3 object body. Args: @@ -73,7 +73,7 @@ def test_get_fqn(delim: str, expected: str, name: Optional[str]) -> None: assert get_fqn("test", delim, name) == expected -class TestCFNginContext: # pylint: disable=too-many-public-methods +class TestCFNginContext: """Test runway.context._cfngin.CFNginContext.""" config = CfnginConfig.parse_obj( @@ -97,7 +97,7 @@ class TestCFNginContext: # pylint: disable=too-many-public-methods {"name": "stack2", "template_path": ".", "requires": ["stack1"]}, ], } - persist_graph_raw: Dict[str, Set[str]] = {"stack1": set(), "stack2": {"stack1"}} + persist_graph_raw: dict[str, set[str]] = {"stack1": set(), "stack2": {"stack1"}} persist_graph_config = CfnginConfig.parse_obj(persist_graph_raw_config) @pytest.mark.parametrize( @@ -119,9 +119,7 @@ def test_bucket_name_config(self, mocker: MockerFixture) -> None: mocker.patch.object(CfnginContext, "upload_to_s3", True) assert ( CfnginContext( - config=CfnginConfig.parse_obj( - {"namespace": "test", "cfngin_bucket": "test-bucket"} - ) + config=CfnginConfig.parse_obj({"namespace": "test", "cfngin_bucket": "test-bucket"}) ).bucket_name == "test-bucket" ) @@ -149,9 +147,7 @@ def test_get_fqn(self, mocker: MockerFixture) -> None: mock_get_fqn = mocker.patch(f"{MODULE}.get_fqn", return_value="success") obj = CfnginContext(config=self.config) assert obj.get_fqn("name") == "success" - mock_get_fqn.assert_called_once_with( - obj.base_fqn, self.config.namespace_delimiter, "name" - ) + mock_get_fqn.assert_called_once_with(obj.base_fqn, self.config.namespace_delimiter, "name") def test_get_stack(self) -> None: """Test get_stack.""" @@ -184,7 +180,8 @@ def test_init(self, tmp_path: Path) -> None: assert obj.config_path == tmp_path assert obj.env == self.env assert obj.force_stacks == ["stack-01"] - assert not obj.hook_data and isinstance(obj.hook_data, dict) + assert not obj.hook_data + assert isinstance(obj.hook_data, dict) assert obj.logger assert obj.parameters == {"key": "val"} assert obj.stack_names == ["stack-02"] @@ -198,10 +195,13 @@ def test_init_defaults(self) -> None: assert obj.config_path == Path.cwd() assert isinstance(obj.env, DeployEnvironment) assert obj.force_stacks == [] - assert not obj.hook_data and isinstance(obj.hook_data, dict) + assert not obj.hook_data + assert isinstance(obj.hook_data, dict) assert obj.logger - assert not obj.parameters and isinstance(obj.parameters, dict) - assert not obj.stack_names and isinstance(obj.stack_names, list) + assert not obj.parameters + assert isinstance(obj.parameters, dict) + assert not obj.stack_names + assert isinstance(obj.stack_names, list) def test_lock_persistent_graph_locked(self, mocker: MockerFixture) -> None: """Test lock_persistent_graph no graph.""" @@ -245,10 +245,7 @@ def test_lock_persistent_graph(self, mocker: MockerFixture) -> None: "put_object_tagging", {}, { - "Tagging": { - # pylint: disable=protected-access - "TagSet": [{"Key": obj._persistent_graph_lock_tag, "Value": "123"}] - }, + "Tagging": {"TagSet": [{"Key": obj._persistent_graph_lock_tag, "Value": "123"}]}, **obj.persistent_graph_location, }, ) @@ -269,13 +266,8 @@ def test_namespace(self) -> None: def test_namespace_delimiter(self) -> None: """Test namespace_delimiter.""" - config = CfnginConfig.parse_obj( - {"namespace": "test", "namespace_delimiter": "."} - ) - assert ( - CfnginContext(config=config).namespace_delimiter - == config.namespace_delimiter - ) + config = CfnginConfig.parse_obj({"namespace": "test", "namespace_delimiter": "."}) + assert CfnginContext(config=config).namespace_delimiter == config.namespace_delimiter def test_persistent_graph_no_location(self, mocker: MockerFixture) -> None: """Test persistent_graph no persistent_graph_location.""" @@ -313,7 +305,7 @@ def test_persistent_graph_no_such_key(self, mocker: MockerFixture) -> None: "put_object", {}, { - "Body": "{}".encode(), + "Body": b"{}", "ServerSideEncryption": "AES256", "ACL": "bucket-owner-full-control", "ContentType": "application/json", @@ -372,7 +364,7 @@ def test_persistent_graph_location_add_json(self) -> None: {"cfngin_bucket": "", "persistent_graph_key": "something"}, ], ) - def test_persistent_graph_location_empty(self, config_ext: Dict[str, str]) -> None: + def test_persistent_graph_location_empty(self, config_ext: dict[str, str]) -> None: """Test persistent_graph_location.""" config = CfnginConfig.parse_obj({"namespace": "test", **config_ext}) assert not CfnginContext(config=config).persistent_graph_location @@ -449,9 +441,7 @@ def test_persistent_graph_tags(self, mocker: MockerFixture) -> None: obj = CfnginContext() stubber = Stubber(obj.s3_client) - stubber.add_response( - "get_object_tagging", {"TagSet": []}, obj.persistent_graph_location - ) + stubber.add_response("get_object_tagging", {"TagSet": []}, obj.persistent_graph_location) stubber.add_response( "get_object_tagging", {"TagSet": [{"Key": "key", "Value": "val"}]}, @@ -476,9 +466,7 @@ def test_put_persistent_graph_empty(self, mocker: MockerFixture) -> None: with stubber: assert not obj.put_persistent_graph("123") - def test_put_persistent_graph_lock_code_mismatch( - self, mocker: MockerFixture - ) -> None: + def test_put_persistent_graph_lock_code_mismatch(self, mocker: MockerFixture) -> None: """Test put_persistent_graph lock code mismatch.""" mocker.patch.object( CfnginContext, @@ -526,9 +514,7 @@ def test_put_persistent_graph(self, mocker: MockerFixture) -> None: "put_object", {}, { - "Body": json.dumps( - self.persist_graph_raw, default=json_serial, indent=4 - ).encode(), + "Body": json.dumps(self.persist_graph_raw, default=json_serial, indent=4).encode(), "ServerSideEncryption": "AES256", "ACL": "bucket-owner-full-control", "ContentType": "application/json", @@ -610,16 +596,12 @@ def test_stacks(self) -> None: def test_tags_empty(self) -> None: """Test tags empty.""" - obj = CfnginContext( - config=CfnginConfig.parse_obj({"namespace": "test", "tags": {}}) - ) + obj = CfnginContext(config=CfnginConfig.parse_obj({"namespace": "test", "tags": {}})) assert obj.tags == {} def test_tags_none(self) -> None: """Test tags None.""" - obj = CfnginContext( - config=CfnginConfig.parse_obj({"namespace": "test", "tags": None}) - ) + obj = CfnginContext(config=CfnginConfig.parse_obj({"namespace": "test", "tags": None})) assert obj.tags == {"cfngin_namespace": obj.config.namespace} def test_tags(self) -> None: @@ -631,10 +613,7 @@ def test_tags(self) -> None: def test_template_indent(self) -> None: """Test template_indent.""" - assert ( - CfnginContext(config=self.config).template_indent - == self.config.template_indent - ) + assert CfnginContext(config=self.config).template_indent == self.config.template_indent @pytest.mark.parametrize( "config, expected", @@ -646,16 +625,11 @@ def test_template_indent(self) -> None: ({"namespace": "test", "cfngin_bucket": "something"}, True), ], ) - def test_upload_to_s3(self, config: Dict[str, Any], expected: bool) -> None: + def test_upload_to_s3(self, config: dict[str, Any], expected: bool) -> None: """Test upload_to_s3.""" - assert ( - CfnginContext(config=CfnginConfig.parse_obj(config)).upload_to_s3 - is expected - ) + assert CfnginContext(config=CfnginConfig.parse_obj(config)).upload_to_s3 is expected - def test_unlock_persistent_graph_empty_no_such_key( - self, mocker: MockerFixture - ) -> None: + def test_unlock_persistent_graph_empty_no_such_key(self, mocker: MockerFixture) -> None: """Test unlock_persistent_graph empty graph NoSuchKey.""" mocker.patch.object( CfnginContext, @@ -669,9 +643,7 @@ def test_unlock_persistent_graph_empty_no_such_key( with stubber: assert obj.unlock_persistent_graph("123") - def test_unlock_persistent_graph_lock_code_mismatch( - self, mocker: MockerFixture - ) -> None: + def test_unlock_persistent_graph_lock_code_mismatch(self, mocker: MockerFixture) -> None: """Test unlock_persistent_graph lock code mismatch.""" mocker.patch.object( CfnginContext, @@ -718,7 +690,7 @@ def test_unlock_persistent_graph_no_such_key(self, mocker: MockerFixture) -> Non stubber = Stubber(obj.s3_client) stubber.add_response( "get_object", - {"Body": "{}".encode()}, + {"Body": b"{}"}, { "ResponseContentType": "application/json", **obj.persistent_graph_location, @@ -728,11 +700,9 @@ def test_unlock_persistent_graph_no_such_key(self, mocker: MockerFixture) -> Non with stubber: assert obj.unlock_persistent_graph("123") - @pytest.mark.parametrize( - "graph_dict", cast(List[Dict[str, List[str]]], [{"stack0": []}, {}]) - ) + @pytest.mark.parametrize("graph_dict", cast(list[dict[str, list[str]]], [{"stack0": []}, {}])) def test_unlock_persistent_graph( - self, graph_dict: Dict[str, List[str]], mocker: MockerFixture + self, graph_dict: dict[str, list[str]], mocker: MockerFixture ) -> None: """Test unlock_persistent_graph.""" mocker.patch.object( @@ -748,7 +718,7 @@ def test_unlock_persistent_graph( if not graph_dict: stubber.add_response( "get_object", - {"Body": "{}".encode()}, + {"Body": b"{}"}, { "ResponseContentType": "application/json", **obj.persistent_graph_location, diff --git a/tests/unit/context/test_runway.py b/tests/unit/context/test_runway.py index cbef68e81..4a37815ba 100644 --- a/tests/unit/context/test_runway.py +++ b/tests/unit/context/test_runway.py @@ -4,9 +4,9 @@ from __future__ import annotations from typing import TYPE_CHECKING, Any +from unittest.mock import MagicMock import pytest -from mock import MagicMock from runway.context._runway import RunwayContext from runway.context.sys_info import OsInfo diff --git a/tests/unit/context/test_sys_info.py b/tests/unit/context/test_sys_info.py index 0e831550c..e6d03143f 100644 --- a/tests/unit/context/test_sys_info.py +++ b/tests/unit/context/test_sys_info.py @@ -1,7 +1,5 @@ """Test runway.context.sys_info.""" -# pylint: disable=invalid-name,unused-argument -# pyright: basic from __future__ import annotations from typing import TYPE_CHECKING @@ -16,43 +14,43 @@ MODULE = "runway.context.sys_info" -@pytest.fixture(scope="function") -def clear_OsInfo() -> None: # noqa +@pytest.fixture() +def clear_os_info() -> None: """Clear OsInfo singleton.""" OsInfo.clear_singleton() -@pytest.fixture(scope="function") -def clear_SystemInfo() -> None: # noqa +@pytest.fixture() +def clear_system_info() -> None: """Clear OsInfo singleton.""" SystemInfo.clear_singleton() -@pytest.mark.usefixtures("clear_OsInfo") +@pytest.mark.usefixtures("clear_os_info") class TestOsInfo: """Test OsInfo.""" - def test_is_darwin_false(self, platform_linux: None) -> None: + def test_is_darwin_false(self, platform_linux: None) -> None: # noqa: ARG002 """Test is_darwin False.""" assert not OsInfo().is_darwin - def test_is_darwin(self, platform_darwin: None) -> None: + def test_is_darwin(self, platform_darwin: None) -> None: # noqa: ARG002 """Test is_darwin.""" assert OsInfo().is_darwin - def test_is_linux_false(self, platform_darwin: None) -> None: + def test_is_linux_false(self, platform_darwin: None) -> None: # noqa: ARG002 """Test is_linux False.""" assert not OsInfo().is_linux - def test_is_linux(self, platform_linux: None) -> None: + def test_is_linux(self, platform_linux: None) -> None: # noqa: ARG002 """Test is_linux.""" assert OsInfo().is_linux - def test_is_macos_false(self, platform_linux: None) -> None: + def test_is_macos_false(self, platform_linux: None) -> None: # noqa: ARG002 """Test is_macos False.""" assert not OsInfo().is_macos - def test_is_macos(self, platform_darwin: None) -> None: + def test_is_macos(self, platform_darwin: None) -> None: # noqa: ARG002 """Test is_macos.""" assert OsInfo().is_macos @@ -68,23 +66,23 @@ def test_is_posix(self, mocker: MockerFixture) -> None: mock_os.name = "posix" assert OsInfo().is_posix - def test_is_windows_false(self, platform_linux: None) -> None: + def test_is_windows_false(self, platform_linux: None) -> None: # noqa: ARG002 """Test is_windows False.""" assert not OsInfo().is_windows - def test_is_windows(self, platform_windows: None) -> None: + def test_is_windows(self, platform_windows: None) -> None: # noqa: ARG002 """Test is_windows.""" assert OsInfo().is_windows - def test_name_darwin(self, platform_darwin: None) -> None: + def test_name_darwin(self, platform_darwin: None) -> None: # noqa: ARG002 """Test name darwin.""" assert OsInfo().name == "darwin" - def test_name_linux(self, platform_linux: None) -> None: + def test_name_linux(self, platform_linux: None) -> None: # noqa: ARG002 """Test name linux.""" assert OsInfo().name == "linux" - def test_name_windows(self, platform_windows: None) -> None: + def test_name_windows(self, platform_windows: None) -> None: # noqa: ARG002 """Test name windows.""" assert OsInfo().name == "windows" @@ -93,7 +91,7 @@ def test_singleton(self) -> None: assert id(OsInfo()) == id(OsInfo()) -@pytest.mark.usefixtures("clear_SystemInfo") +@pytest.mark.usefixtures("clear_system_info") class TestSystemInfo: """Test SystemInfo.""" diff --git a/tests/unit/core/components/test_deploy_environment.py b/tests/unit/core/components/test_deploy_environment.py index 35219b917..d57207bac 100644 --- a/tests/unit/core/components/test_deploy_environment.py +++ b/tests/unit/core/components/test_deploy_environment.py @@ -1,22 +1,20 @@ -"""Test runway.core.components.deploy_environment.""" +"""Test runway.core.components._deploy_environment.""" -# pylint: disable=protected-access -# pyright: basic +# ruff: noqa: SLF001 from __future__ import annotations import logging import os from pathlib import Path -from typing import TYPE_CHECKING, Dict, List +from typing import TYPE_CHECKING +from unittest.mock import MagicMock import pytest from git.exc import InvalidGitRepositoryError -from mock import MagicMock -from runway.core.components import DeployEnvironment +from runway.core.components._deploy_environment import DeployEnvironment if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture MODULE = "runway.core.components._deploy_environment" @@ -31,7 +29,7 @@ class TestDeployEnvironment: """Test runway.core.components.DeployEnvironment.""" - def test_init(self, cd_tmp_path: Path) -> None: + def test___init__(self, cd_tmp_path: Path) -> None: """Test attributes set by init.""" new_dir = cd_tmp_path / "new_dir" obj = DeployEnvironment( @@ -45,7 +43,7 @@ def test_init(self, cd_tmp_path: Path) -> None: assert obj.root_dir == new_dir assert obj.vars == {"key": "val"} - def test_init_defaults(self, cd_tmp_path: Path) -> None: + def test___init___defaults(self, cd_tmp_path: Path) -> None: """Test attributes set by init default values.""" obj = DeployEnvironment() @@ -54,6 +52,11 @@ def test_init_defaults(self, cd_tmp_path: Path) -> None: assert obj.root_dir == cd_tmp_path assert obj.vars == os.environ + def test___init___empty_environ(self) -> None: + """Test attributes set by init.""" + obj = DeployEnvironment(environ={}) + assert obj.vars == os.environ + def test_boto3_credentials(self) -> None: """Test boto3_credentials.""" obj = DeployEnvironment(environ=TEST_CREDENTIALS) @@ -99,9 +102,7 @@ def test_branch_name(self, mocker: MockerFixture) -> None: obj = DeployEnvironment() assert obj.branch_name == branch_name - mock_git.Repo.assert_called_once_with( - os.getcwd(), search_parent_directories=True - ) + mock_git.Repo.assert_called_once_with(str(Path.cwd()), search_parent_directories=True) def test_branch_name_invalid_repo(self, mocker: MockerFixture) -> None: """Test branch_name handle InvalidGitRepositoryError.""" @@ -110,12 +111,10 @@ def test_branch_name_invalid_repo(self, mocker: MockerFixture) -> None: obj = DeployEnvironment() assert obj.branch_name is None - mock_git.Repo.assert_called_once_with( - os.getcwd(), search_parent_directories=True - ) + mock_git.Repo.assert_called_once_with(str(Path.cwd()), search_parent_directories=True) def test_branch_name_no_git( - self, mocker: MockerFixture, caplog: LogCaptureFixture + self, mocker: MockerFixture, caplog: pytest.LogCaptureFixture ) -> None: """Test branch_name git ImportError.""" caplog.set_level(logging.DEBUG, logger="runway.core.components") @@ -129,7 +128,7 @@ def test_branch_name_no_git( ) in caplog.messages def test_branch_name_type_error( - self, mocker: MockerFixture, caplog: LogCaptureFixture + self, mocker: MockerFixture, caplog: pytest.LogCaptureFixture ) -> None: """Test branch_name handle TypeError.""" caplog.set_level(logging.WARNING, logger="runway") @@ -137,8 +136,7 @@ def test_branch_name_type_error( mock_git.Repo.side_effect = TypeError with pytest.raises(SystemExit) as excinfo: - obj = DeployEnvironment() - assert not obj.branch_name + assert not DeployEnvironment().branch_name assert excinfo.value.code == 1 assert "Unable to retrieve the current git branch name!" in caplog.messages @@ -255,7 +253,7 @@ def test_name(self) -> None: ], ) def test_name_from_branch( - self, branch: str, environ: Dict[str, str], expected: str, mocker: MockerFixture + self, branch: str, environ: dict[str, str], expected: str, mocker: MockerFixture ) -> None: """Test name from branch.""" mock_prompt = MagicMock(return_value="user_value") @@ -317,8 +315,7 @@ def test_copy(self, mocker: MockerFixture, tmp_path: Path) -> None: ( "explicit", [ - 'deploy environment "test" is explicitly defined ' - "in the environment", + 'deploy environment "test" is explicitly defined in the environment', "if not correct, update the value or unset it to " "fall back to the name of the current git branch " "or parent directory", @@ -327,8 +324,7 @@ def test_copy(self, mocker: MockerFixture, tmp_path: Path) -> None: ( "branch", [ - 'deploy environment "test" was determined from the ' - "current git branch", + 'deploy environment "test" was determined from the current git branch', "if not correct, update the branch name or set an " "override via the DEPLOY_ENVIRONMENT environment " "variable", @@ -337,8 +333,7 @@ def test_copy(self, mocker: MockerFixture, tmp_path: Path) -> None: ( "directory", [ - 'deploy environment "test" was determined from ' - "the current directory", + 'deploy environment "test" was determined from the current directory', "if not correct, update the directory name or " "set an override via the DEPLOY_ENVIRONMENT " "environment variable", @@ -349,8 +344,8 @@ def test_copy(self, mocker: MockerFixture, tmp_path: Path) -> None: def test_log_name( self, derived_from: str, - expected: List[str], - caplog: LogCaptureFixture, + expected: list[str], + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, ) -> None: """Test log_name.""" diff --git a/tests/unit/core/components/test_deployment.py b/tests/unit/core/components/test_deployment.py index 5326d831f..17104d70b 100644 --- a/tests/unit/core/components/test_deployment.py +++ b/tests/unit/core/components/test_deployment.py @@ -1,26 +1,24 @@ -"""Test runway.core.components.deployment.""" +"""Test runway.core.components._deployment.""" -# pylint: disable=protected-access -# pyright: basic +# ruff: noqa: SLF001 from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict, List, cast +from typing import TYPE_CHECKING, Any, cast +from unittest.mock import ANY, MagicMock, Mock, PropertyMock, call import pytest -from mock import ANY, MagicMock, Mock, PropertyMock, call from runway.config.components.runway import ( RunwayDeploymentDefinition, RunwayVariablesDefinition, ) from runway.config.models.runway import RunwayFutureDefinitionModel -from runway.core.components import Deployment +from runway.core.components._deployment import Deployment from runway.exceptions import UnresolvedVariable from runway.variables import Variable if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from runway.core.type_defs import RunwayActionTypeDef @@ -102,7 +100,7 @@ def test___init___args( def test_assume_role_config( self, config: str, - expected: Dict[str, Any], + expected: dict[str, Any], fx_deployments: YamlLoaderDeployment, runway_context: MockRunwayContext, ) -> None: @@ -117,9 +115,7 @@ def test_env_vars_config_raise_unresolved_variable( runway_context: MockRunwayContext, ) -> None: """Test env_vars_config raise UnresolvedVariable.""" - mocker.patch.object( - Deployment, "_Deployment__merge_env_vars", Mock(return_value=None) - ) + mocker.patch.object(Deployment, "_Deployment__merge_env_vars", Mock(return_value=None)) mocker.patch.object( RunwayDeploymentDefinition, "env_vars", @@ -133,13 +129,12 @@ def test_env_vars_config_raise_unresolved_variable( ) with pytest.raises(UnresolvedVariable): - obj = Deployment( + assert not Deployment( context=runway_context, definition=RunwayDeploymentDefinition.parse_obj( - cast(Dict[str, Any], fx_deployments.get("min_required")) + cast(dict[str, Any], fx_deployments.get("min_required")) ), - ) - assert not obj.env_vars_config + ).env_vars_config def test_env_vars_config_unresolved( self, @@ -149,9 +144,7 @@ def test_env_vars_config_unresolved( ) -> None: """Test env_vars_config unresolved.""" expected = {"key": "val"} - mocker.patch.object( - Deployment, "_Deployment__merge_env_vars", Mock(return_value=None) - ) + mocker.patch.object(Deployment, "_Deployment__merge_env_vars", Mock(return_value=None)) mocker.patch.object( RunwayDeploymentDefinition, "env_vars", @@ -168,9 +161,7 @@ def test_env_vars_config_unresolved( ) variable = Mock(value=expected) - raw_deployment: Dict[str, Any] = cast( - Dict[str, Any], fx_deployments.get("min_required") - ) + raw_deployment: dict[str, Any] = cast(dict[str, Any], fx_deployments.get("min_required")) deployment = RunwayDeploymentDefinition.parse_obj(raw_deployment) obj = Deployment(context=runway_context, definition=deployment) obj.definition._vars.update({"env_vars": variable}) @@ -191,7 +182,7 @@ def test_env_vars_config_unresolved( def test_regions( self, config: str, - expected: List[str], + expected: list[str], fx_deployments: YamlLoaderDeployment, runway_context: MockRunwayContext, ) -> None: @@ -230,15 +221,13 @@ def test_deploy( """Test deploy.""" mock_run = MagicMock() mocker.patch.object(Deployment, "run", mock_run) - obj = Deployment( - context=runway_context, definition=fx_deployments.load("min_required") - ) + obj = Deployment(context=runway_context, definition=fx_deployments.load("min_required")) assert not obj.deploy() mock_run.assert_called_once_with("deploy", "us-east-1") def test_deploy_async( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fx_deployments: YamlLoaderDeployment, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -273,7 +262,7 @@ def test_deploy_async( def test_deploy_sync( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fx_deployments: YamlLoaderDeployment, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -289,12 +278,8 @@ def test_deploy_sync( definition=fx_deployments.load("simple_parallel_regions"), ) assert not obj.deploy() - assert ( - "unnamed_deployment:processing regions sequentially..." in caplog.messages - ) - mock_run.assert_has_calls( - [call("deploy", "us-east-1"), call("deploy", "us-west-2")] - ) + assert "unnamed_deployment:processing regions sequentially..." in caplog.messages + mock_run.assert_has_calls([call("deploy", "us-east-1"), call("deploy", "us-west-2")]) @pytest.mark.parametrize("async_used", [(True), (False)]) def test_destroy( @@ -327,7 +312,7 @@ def test_destroy( def test_init( self, async_used: bool, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fx_deployments: YamlLoaderDeployment, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -356,7 +341,7 @@ def test_init( def test_plan( self, async_used: bool, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fx_deployments: YamlLoaderDeployment, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -421,11 +406,9 @@ def test_run_async( ) -> None: """Test run async.""" mocker.patch(f"{MODULE}.aws") - # ensure that mock.MagicMock is used for backported features mock_module = mocker.patch(f"{MODULE}.Module", MagicMock()) definition = fx_deployments.load("simple_parallel_regions") runway_context._use_concurrent = True - # ensure that mock.MagicMock is used for backported features mock_resolve = mocker.patch.object(definition, "resolve", MagicMock()) mocker.patch.object(Deployment, "validate_account_credentials") obj = Deployment(context=runway_context, definition=definition) @@ -434,16 +417,15 @@ def test_run_async( new_ctx = mock_resolve.call_args.args[0] assert new_ctx != runway_context - assert new_ctx.command == "destroy" and runway_context.command != "destroy" - assert ( - new_ctx.env.aws_region == "us-west-2" - and runway_context.env.aws_region != "us-west-2" - ) + assert new_ctx.command == "destroy" + assert runway_context.command != "destroy" + assert new_ctx.env.aws_region == "us-west-2" + assert runway_context.env.aws_region != "us-west-2" assert mock_module.run_list.call_args.kwargs["context"] == new_ctx def test_validate_account_credentials( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, fx_deployments: YamlLoaderDeployment, runway_context: MockRunwayContext, @@ -451,9 +433,7 @@ def test_validate_account_credentials( """Test validate_account_credentials.""" caplog.set_level(logging.INFO, logger="runway") mock_aws = mocker.patch(f"{MODULE}.aws") - obj = Deployment( - context=runway_context, definition=fx_deployments.load("validate_account") - ) + obj = Deployment(context=runway_context, definition=fx_deployments.load("validate_account")) account = MagicMock() account.aliases = ["no-match"] @@ -462,9 +442,7 @@ def test_validate_account_credentials( with pytest.raises(SystemExit) as excinfo: assert obj.validate_account_credentials() assert excinfo.value.code == 1 - assert 'does not match required account "123456789012"' in "\n".join( - caplog.messages - ) + assert 'does not match required account "123456789012"' in "\n".join(caplog.messages) caplog.clear() del excinfo @@ -510,10 +488,6 @@ def test_run_list( future=None, # type: ignore variables=mock_vars, ) - dep0.resolve.assert_called_once_with( - runway_context, variables=mock_vars, pre_process=True - ) - dep1.resolve.assert_called_once_with( - runway_context, variables=mock_vars, pre_process=True - ) + dep0.resolve.assert_called_once_with(runway_context, variables=mock_vars, pre_process=True) + dep1.resolve.assert_called_once_with(runway_context, variables=mock_vars, pre_process=True) mock_action.assert_called_once_with() diff --git a/tests/unit/core/components/test_module.py b/tests/unit/core/components/test_module.py index 3f6fe9cff..4e71370ac 100644 --- a/tests/unit/core/components/test_module.py +++ b/tests/unit/core/components/test_module.py @@ -1,15 +1,13 @@ """Test runway.core.components._module.""" -# pylint: disable=protected-access,redefined-outer-name,unused-argument -# pyright: basic from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, List, Optional, cast +from typing import TYPE_CHECKING, Any, Optional, cast +from unittest.mock import MagicMock, call import pytest import yaml -from mock import MagicMock, call from runway.core.components import Deployment, Module from runway.core.components._module import validate_environment @@ -17,7 +15,6 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from ...factories import MockRunwayContext, YamlLoaderDeployment @@ -25,7 +22,7 @@ MODULE = "runway.core.components._module" -@pytest.fixture(scope="function") +@pytest.fixture() def empty_opts_from_file(mocker: MockerFixture) -> None: """Empty Module.opts_from_file.""" mocker.patch.object(Module, "opts_from_file", {}) @@ -78,7 +75,7 @@ def test_child_modules( def test_environment_matches_defined( self, - cd_tmp_path: Path, + cd_tmp_path: Path, # noqa: ARG002 fx_deployments: YamlLoaderDeployment, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -100,7 +97,7 @@ def test_environment_matches_defined( def test_environments_deployment( self, cd_tmp_path: Path, - empty_opts_from_file: None, + empty_opts_from_file: None, # noqa: ARG002 fx_deployments: YamlLoaderDeployment, runway_context: MockRunwayContext, ) -> None: @@ -125,9 +122,7 @@ def test_environments_opts_from_file( ) -> None: """Test environments with opts_from_file.""" runway_context.env.root_dir = cd_tmp_path - mocker.patch.object( - Module, "opts_from_file", {"environments": {"test": ["us-east-1"]}} - ) + mocker.patch.object(Module, "opts_from_file", {"environments": {"test": ["us-east-1"]}}) deployment = fx_deployments.load("environments_map_str") mod = Module( context=runway_context, @@ -182,7 +177,7 @@ def test_path( def test_payload_with_deployment( self, cd_tmp_path: Path, - empty_opts_from_file: None, + empty_opts_from_file: None, # noqa: ARG002 fx_deployments: YamlLoaderDeployment, runway_context: MockRunwayContext, ) -> None: @@ -258,9 +253,7 @@ def test_type( runway_context: MockRunwayContext, ) -> None: """Test type.""" - mock_path = mocker.patch( - f"{MODULE}.ModulePath", module_root=runway_context.env.root_dir - ) + mock_path = mocker.patch(f"{MODULE}.ModulePath", module_root=runway_context.env.root_dir) mock_type = mocker.patch(f"{MODULE}.RunwayModuleType") mock_type.return_value = mock_type mocker.patch.object(Module, "path", mock_path) @@ -313,9 +306,7 @@ def test_use_async( use_concurrent: bool, ) -> None: """Test use_async.""" - obj = Module( - context=runway_context, definition=fx_deployments.load(config).modules[0] - ) + obj = Module(context=runway_context, definition=fx_deployments.load(config).modules[0]) obj.ctx._use_concurrent = use_concurrent # type: ignore assert obj.use_async == expected @@ -336,7 +327,7 @@ def test_deploy( def test_deploy_async( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fx_deployments: YamlLoaderDeployment, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -374,7 +365,7 @@ def test_deploy_async( def test_deploy_sync( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fx_deployments: YamlLoaderDeployment, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -484,7 +475,7 @@ def test_init_no_children( def test_plan( self, async_used: bool, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fx_deployments: YamlLoaderDeployment, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -512,7 +503,7 @@ def test_plan( def test_plan_no_children( self, async_used: bool, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fx_deployments: YamlLoaderDeployment, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -534,7 +525,7 @@ def test_plan_no_children( def test_run( self, - empty_opts_from_file: None, + empty_opts_from_file: None, # noqa: ARG002 fx_deployments: YamlLoaderDeployment, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -560,9 +551,7 @@ def test_run( mocker.patch.object(Module, "should_skip", False) assert not mod.run("deploy") mock_change_dir.assert_called_once_with(tmp_path) - mock_type.module_class.assert_called_once_with( - mod.ctx, module_root=tmp_path, **mod.payload - ) + mock_type.module_class.assert_called_once_with(mod.ctx, module_root=tmp_path, **mod.payload) mock_inst["deploy"].assert_called_once_with() del mock_inst.deploy @@ -642,9 +631,9 @@ def test_run_list( ], ) def test_validate_environment( - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, env_def: Any, - expected_logs: List[str], + expected_logs: list[str], expected: Optional[bool], mocker: MockerFixture, runway_context: MockRunwayContext, diff --git a/tests/unit/core/components/test_module_path.py b/tests/unit/core/components/test_module_path.py index a005666a2..c044fd5b0 100644 --- a/tests/unit/core/components/test_module_path.py +++ b/tests/unit/core/components/test_module_path.py @@ -5,10 +5,10 @@ from copy import deepcopy from pathlib import Path -from typing import TYPE_CHECKING, Dict, List, Optional, Union +from typing import TYPE_CHECKING, Optional, Union +from unittest.mock import MagicMock import pytest -from mock import MagicMock from typing_extensions import TypedDict from runway.config.components.runway import RunwayModuleDefinition @@ -23,20 +23,19 @@ MODULE = "runway.core.components._module_path" -TypeDefTestDefinitionExpected = TypedDict( - "TypeDefTestDefinitionExpected", - arguments=Dict[str, str], - location=str, - source=str, - uri=str, -) -TypeDefTestDefinition = TypedDict( - "TypeDefTestDefinition", - definition=Optional[Union[Path, str]], - expected=TypeDefTestDefinitionExpected, -) +class TypeDefTestDefinitionExpected(TypedDict): # noqa: D101 + arguments: dict[str, str] + location: str + source: str + uri: str -TESTS: List[TypeDefTestDefinition] = [ + +class TypeDefTestDefinition(TypedDict): # noqa: D101 + definition: Optional[Union[Path, str]] + expected: TypeDefTestDefinitionExpected + + +TESTS: list[TypeDefTestDefinition] = [ { "definition": "git::git://github.com/onicagroup/foo/foo-bar.git", "expected": { @@ -92,7 +91,7 @@ }, }, { - "definition": "git::git://github.com/onicagroup/foo/bar.git//src/foo/bar?branch=foo&bar=baz", # noqa + "definition": "git::git://github.com/onicagroup/foo/bar.git//src/foo/bar?branch=foo&bar=baz", "expected": { "location": "src/foo/bar", "arguments": {"branch": "foo", "bar": "baz"}, @@ -245,10 +244,7 @@ def test_module_root( if isinstance(test["definition"], (type(None), Path)): assert obj.module_root == test["definition"] or Path.cwd() elif test["expected"]["source"] == "local": - assert ( - obj.module_root - == deploy_environment.root_dir / test["expected"]["location"] - ) + assert obj.module_root == deploy_environment.root_dir / test["expected"]["location"] else: assert ( obj.module_root @@ -297,19 +293,13 @@ def test_uri( == test["expected"]["uri"] ) - def test_parse_obj_none( - self, deploy_environment: DeployEnvironment, tmp_path: Path - ) -> None: + def test_parse_obj_none(self, deploy_environment: DeployEnvironment, tmp_path: Path) -> None: """Test parse_obj None.""" - obj = ModulePath.parse_obj( - None, cache_dir=tmp_path, deploy_environment=deploy_environment - ) + obj = ModulePath.parse_obj(None, cache_dir=tmp_path, deploy_environment=deploy_environment) assert obj.definition == Path.cwd() assert obj.env == deploy_environment - def test_parse_obj_path( - self, deploy_environment: DeployEnvironment, tmp_path: Path - ) -> None: + def test_parse_obj_path(self, deploy_environment: DeployEnvironment, tmp_path: Path) -> None: """Test parse_obj Path.""" obj = ModulePath.parse_obj( tmp_path, cache_dir=tmp_path, deploy_environment=deploy_environment @@ -334,9 +324,7 @@ def test_parse_obj_runway_config( assert obj1.definition == model.path assert obj1.env == deploy_environment - def test_parse_obj_str( - self, deploy_environment: DeployEnvironment, tmp_path: Path - ) -> None: + def test_parse_obj_str(self, deploy_environment: DeployEnvironment, tmp_path: Path) -> None: """Test parse_obj str.""" obj = ModulePath.parse_obj( "./test", cache_dir=tmp_path, deploy_environment=deploy_environment diff --git a/tests/unit/core/components/test_module_type.py b/tests/unit/core/components/test_module_type.py index bc6432678..11cdd27e4 100644 --- a/tests/unit/core/components/test_module_type.py +++ b/tests/unit/core/components/test_module_type.py @@ -4,7 +4,7 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, List, Type +from typing import TYPE_CHECKING import pytest @@ -19,8 +19,6 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture - from runway.config.models.runway import RunwayModuleTypeTypeDef from runway.module.base import RunwayModule @@ -43,7 +41,7 @@ class TestRunwayModuleType: ], ) def test_autodetection( - self, files: List[str], expected: Type[RunwayModule], cd_tmp_path: Path + self, files: list[str], expected: type[RunwayModule], cd_tmp_path: Path ) -> None: """Test from autodetection.""" for file_path in files: @@ -57,9 +55,7 @@ def test_autodetection( assert not result.type_str assert result.module_class.__name__ == expected.__name__ - def test_autodetection_fail( - self, caplog: LogCaptureFixture, cd_tmp_path: Path - ) -> None: + def test_autodetection_fail(self, caplog: pytest.LogCaptureFixture, cd_tmp_path: Path) -> None: """Test autodetection fail.""" caplog.set_level(logging.ERROR, logger="runway") with pytest.raises(SystemExit) as excinfo: @@ -90,7 +86,7 @@ def test_from_class_path(self, cd_tmp_path: Path) -> None: ], ) def test_from_extension( - self, ext: str, expected: Type[RunwayModule], cd_tmp_path: Path + self, ext: str, expected: type[RunwayModule], cd_tmp_path: Path ) -> None: """Test from path extension.""" filename = "filename." + ext @@ -111,7 +107,7 @@ def test_from_extension( def test_from_type_str( self, type_str: RunwayModuleTypeTypeDef, - expected: Type[RunwayModule], + expected: type[RunwayModule], cd_tmp_path: Path, ) -> None: """Test from type_str.""" diff --git a/tests/unit/core/providers/aws/s3/_helpers/conftest.py b/tests/unit/core/providers/aws/s3/_helpers/conftest.py index fa104748e..d9daae69e 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/conftest.py +++ b/tests/unit/core/providers/aws/s3/_helpers/conftest.py @@ -2,18 +2,23 @@ from __future__ import annotations -from pathlib import Path -from typing import List +from typing import TYPE_CHECKING import pytest from typing_extensions import TypedDict -LocalFiles = TypedDict( - "LocalFiles", files=List[Path], local_dir=Path, local_file=Path, tmp_path=Path -) +if TYPE_CHECKING: + from pathlib import Path -@pytest.fixture(scope="function") +class LocalFiles(TypedDict): + files: list[Path] + local_dir: Path + local_file: Path + tmp_path: Path + + +@pytest.fixture() def loc_files(tmp_path: Path) -> LocalFiles: """Fixture for creating local files.""" file0 = tmp_path / "some_directory" / "text0.txt" diff --git a/tests/unit/core/providers/aws/s3/_helpers/factories.py b/tests/unit/core/providers/aws/s3/_helpers/factories.py index 50ceb715b..401aa748a 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/factories.py +++ b/tests/unit/core/providers/aws/s3/_helpers/factories.py @@ -2,13 +2,13 @@ from __future__ import annotations -from typing import Any, Dict, Optional +from typing import Any, Optional class FakeTransferFutureCallArgs: """Fake TransferFutureCallArgs.""" - def __init__(self, *, extra_args: Optional[Dict[str, Any]] = None, **kwargs: Any): + def __init__(self, *, extra_args: Optional[dict[str, Any]] = None, **kwargs: Any) -> None: """Instantiate class.""" self.extra_args = extra_args or {} for kwarg, val in kwargs.items(): @@ -23,7 +23,7 @@ def __init__( size: Optional[int] = None, call_args: Optional[FakeTransferFutureCallArgs] = None, transfer_id: Optional[str] = None, - ): + ) -> None: """Instantiate class.""" self.size = size self.call_args = call_args or FakeTransferFutureCallArgs() @@ -36,9 +36,9 @@ class FakeTransferFuture: def __init__( self, result: Optional[str] = None, - exception: Exception = None, + exception: Optional[Exception] = None, meta: FakeTransferFutureMeta = None, - ): + ) -> None: """Instantiate class.""" self._result = result self._exception = exception diff --git a/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_base.py b/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_base.py index 446e27fbd..b889e5829 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_base.py +++ b/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_base.py @@ -3,10 +3,10 @@ from __future__ import annotations import datetime -from typing import TYPE_CHECKING, List, Optional, cast +from typing import TYPE_CHECKING, Any, cast +from unittest.mock import Mock import pytest -from mock import Mock from runway.core.providers.aws.s3._helpers.file_generator import FileStats from runway.core.providers.aws.s3._helpers.sync_strategy.base import ( @@ -37,23 +37,20 @@ def test_compare_size(self, dest_size: int, expected: bool, src_size: int) -> No dest_file = FileStats(src="", size=dest_size) assert BaseSync.compare_size(src_file, dest_file) is expected - @pytest.mark.parametrize( - "src, dest", [(None, None), (Mock(), None), (None, Mock())] - ) + @pytest.mark.parametrize("src, dest", [(None, None), (Mock(), None), (None, Mock())]) def test_compare_size_raise_value_error( - self, dest: Optional[FileStats], src: Optional[FileStats] + self, dest: FileStats | None, src: FileStats | None ) -> None: """Test compare_time.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="src_file and dest_file must not be None"): BaseSync().compare_size(src, dest) - assert str(excinfo.value) == "src_file and dest_file must not be None" def test_compare_time(self) -> None: """Test compare_time.""" - obj = BaseSync() + obj: BaseSync[Any] = BaseSync() now = datetime.datetime.now() future = now + datetime.timedelta(0, 15) - kwargs = {"src": "", "operation_name": "invalid"} + kwargs: dict[str, Any] = {"src": "", "operation_name": "invalid"} assert ( obj.compare_time( FileStats(last_update=now, **kwargs), @@ -79,10 +76,10 @@ def test_compare_time(self) -> None: @pytest.mark.parametrize("operation_name", ["copy", "upload"]) def test_compare_time_copy_or_upload(self, operation_name: str) -> None: """Test compare_time.""" - obj = BaseSync() + obj: BaseSync[Any] = BaseSync() now = datetime.datetime.now() future = now + datetime.timedelta(0, 15) - kwargs = {"src": "", "operation_name": operation_name} + kwargs: dict[str, Any] = {"src": "", "operation_name": operation_name} assert ( obj.compare_time( FileStats(last_update=now, **kwargs), @@ -107,10 +104,10 @@ def test_compare_time_copy_or_upload(self, operation_name: str) -> None: def test_compare_time_download(self) -> None: """Test compare_time.""" - obj = BaseSync() + obj: BaseSync[Any] = BaseSync() now = datetime.datetime.now() future = now + datetime.timedelta(0, 15) - kwargs = {"src": "", "operation_name": "download"} + kwargs: dict[str, Any] = {"src": "", "operation_name": "download"} assert ( obj.compare_time( FileStats(last_update=now, **kwargs), @@ -133,16 +130,13 @@ def test_compare_time_download(self) -> None: is True ) - @pytest.mark.parametrize( - "src, dest", [(None, None), (Mock(), None), (None, Mock())] - ) + @pytest.mark.parametrize("src, dest", [(None, None), (Mock(), None), (None, Mock())]) def test_compare_time_raise_value_error( - self, dest: Optional[FileStats], src: Optional[FileStats] + self, dest: FileStats | None, src: FileStats | None ) -> None: """Test compare_time.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="src_file and dest_file must not be None"): BaseSync().compare_time(src, dest) - assert str(excinfo.value) == "src_file and dest_file must not be None" def test_determine_should_sync(self) -> None: """Test determine_should_sync.""" @@ -151,16 +145,16 @@ def test_determine_should_sync(self) -> None: def test_init(self) -> None: """Test __init__.""" - valid_sync_types: List[ValidSyncType] = [ + valid_sync_types: list[ValidSyncType] = [ "file_at_src_and_dest", "file_not_at_dest", "file_not_at_src", ] for sync_type in valid_sync_types: - strategy = BaseSync(sync_type) + strategy: BaseSync[Any] = BaseSync(sync_type) assert strategy.sync_type == sync_type - with pytest.raises(ValueError): + with pytest.raises(ValueError, match="Unknown sync_type"): BaseSync("invalid_sync_type") # type: ignore def test_name(self) -> None: @@ -170,23 +164,17 @@ def test_name(self) -> None: def test_register_strategy(self) -> None: """Test register_strategy.""" session = Mock() - obj = BaseSync() + obj: BaseSync[Any] = BaseSync() obj.register_strategy(session) register_args = cast(Mock, session.register).call_args_list assert register_args[0][0][0] == "choosing-s3-sync-strategy" - # pylint: disable=comparison-with-callable assert register_args[0][0][1] == obj.use_sync_strategy def test_use_sync_strategy(self, mocker: MockerFixture) -> None: """Test use_sync_strategy.""" - assert ( - BaseSync().use_sync_strategy( - {"invalid_sync_strategy": True} # type: ignore - ) - is None - ) + assert BaseSync().use_sync_strategy({"invalid_sync_strategy": True}) is None # type: ignore mocker.patch.object(BaseSync, "name", "something") - obj = BaseSync() + obj: BaseSync[Any] = BaseSync() assert obj.use_sync_strategy({"something": True}) == obj # type: ignore @@ -213,9 +201,7 @@ def test_determine_should_sync( MissingFileSync, "compare_time", return_value=is_time ) assert ( - MissingFileSync().determine_should_sync( - FileStats(src=""), FileStats(src="") - ) + MissingFileSync().determine_should_sync(FileStats(src=""), FileStats(src="")) is expected ) mock_compare_size.assert_not_called() @@ -246,16 +232,9 @@ def test_determine_should_sync( self, expected: bool, is_size: bool, is_time: bool, mocker: MockerFixture ) -> None: """Test determine_should_sync.""" - mock_compare_size = mocker.patch.object( - NeverSync, "compare_size", return_value=is_size - ) - mock_compare_time = mocker.patch.object( - NeverSync, "compare_time", return_value=is_time - ) - assert ( - NeverSync().determine_should_sync(FileStats(src=""), FileStats(src="")) - is expected - ) + mock_compare_size = mocker.patch.object(NeverSync, "compare_size", return_value=is_size) + mock_compare_time = mocker.patch.object(NeverSync, "compare_time", return_value=is_time) + assert NeverSync().determine_should_sync(FileStats(src=""), FileStats(src="")) is expected mock_compare_size.assert_not_called() mock_compare_time.assert_not_called() @@ -292,10 +271,7 @@ def test_determine_should_sync( mock_compare_time = mocker.patch.object( SizeAndLastModifiedSync, "compare_time", return_value=is_time ) - assert ( - SizeAndLastModifiedSync().determine_should_sync(src_file, dest_file) - is expected - ) + assert SizeAndLastModifiedSync().determine_should_sync(src_file, dest_file) is expected mock_compare_size.assert_called_once_with(src_file, dest_file) mock_compare_time.assert_called_once_with(src_file, dest_file) diff --git a/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_delete.py b/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_delete.py index f1c273f19..0aa511249 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_delete.py +++ b/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_delete.py @@ -31,16 +31,9 @@ def test_determine_should_sync( self, expected: bool, is_size: bool, is_time: bool, mocker: MockerFixture ) -> None: """Test determine_should_sync.""" - mock_compare_size = mocker.patch.object( - DeleteSync, "compare_size", return_value=is_size - ) - mock_compare_time = mocker.patch.object( - DeleteSync, "compare_time", return_value=is_time - ) - assert ( - DeleteSync().determine_should_sync(FileStats(src=""), FileStats(src="")) - is expected - ) + mock_compare_size = mocker.patch.object(DeleteSync, "compare_size", return_value=is_size) + mock_compare_time = mocker.patch.object(DeleteSync, "compare_time", return_value=is_time) + assert DeleteSync().determine_should_sync(FileStats(src=""), FileStats(src="")) is expected mock_compare_size.assert_not_called() mock_compare_time.assert_not_called() diff --git a/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_exact_timestamps.py b/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_exact_timestamps.py index 92ac0e66e..a7d3590ff 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_exact_timestamps.py +++ b/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_exact_timestamps.py @@ -3,10 +3,9 @@ from __future__ import annotations import datetime -from typing import Optional +from unittest.mock import Mock import pytest -from mock import Mock from runway.core.providers.aws.s3._helpers.file_generator import FileStats from runway.core.providers.aws.s3._helpers.sync_strategy.exact_timestamps import ( @@ -43,16 +42,13 @@ def test_compare_time_dest_older_not_download(self) -> None: is False ) - @pytest.mark.parametrize( - "src, dest", [(None, None), (Mock(), None), (None, Mock())] - ) + @pytest.mark.parametrize("src, dest", [(None, None), (Mock(), None), (None, Mock())]) def test_compare_time_raise_value_error( - self, dest: Optional[FileStats], src: Optional[FileStats] + self, dest: FileStats | None, src: FileStats | None ) -> None: """Test compare_time.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="src_file and dest_file must not be None"): ExactTimestampsSync().compare_time(src, dest) - assert str(excinfo.value) == "src_file and dest_file must not be None" def test_compare_time_same(self) -> None: """Test compare_time.""" diff --git a/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_register.py b/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_register.py index c761a4660..429de4b7d 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_register.py +++ b/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_register.py @@ -3,8 +3,7 @@ from __future__ import annotations from typing import TYPE_CHECKING - -from mock import Mock, call +from unittest.mock import Mock, call from runway.core.providers.aws.s3._helpers.sync_strategy import ( DeleteSync, diff --git a/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_size_only.py b/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_size_only.py index 67791867c..af7d7c25a 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_size_only.py +++ b/tests/unit/core/providers/aws/s3/_helpers/sync_strategy/test_size_only.py @@ -33,12 +33,8 @@ def test_determine_should_sync( """Test determine_should_sync.""" src_file = FileStats(src="") dest_file = FileStats(src="") - mock_compare_size = mocker.patch.object( - SizeOnlySync, "compare_size", return_value=is_size - ) - mock_compare_time = mocker.patch.object( - SizeOnlySync, "compare_time", return_value=is_time - ) + mock_compare_size = mocker.patch.object(SizeOnlySync, "compare_size", return_value=is_size) + mock_compare_time = mocker.patch.object(SizeOnlySync, "compare_time", return_value=is_time) assert SizeOnlySync().determine_should_sync(src_file, dest_file) is expected mock_compare_size.assert_called_once_with(src_file, dest_file) mock_compare_time.assert_not_called() diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_action_architecture.py b/tests/unit/core/providers/aws/s3/_helpers/test_action_architecture.py index 67b129cf2..5d5001276 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_action_architecture.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_action_architecture.py @@ -4,9 +4,9 @@ import os from typing import TYPE_CHECKING +from unittest.mock import Mock, call import pytest -from mock import Mock, call from runway.core.providers.aws.s3._helpers.action_architecture import ActionArchitecture from runway.core.providers.aws.s3._helpers.parameters import ParametersDataModel @@ -145,16 +145,10 @@ def test_run_sync( "choose_sync_strategies", return_value={"sync_strategy": "test"}, ) - mocker.patch( - f"{MODULE}.FormatPath", format=Mock(side_effect=[files, rev_files]) - ) + mocker.patch(f"{MODULE}.FormatPath", format=Mock(side_effect=[files, rev_files])) mock_file_generator = Mock(call=Mock(return_value="FileGenerator().call()")) - mock_file_generator_rev = Mock( - call=Mock(return_value="rev:FileGenerator().call()") - ) - mock_file_info_builder = Mock( - call=Mock(return_value="FileInfoBuilder().call()") - ) + mock_file_generator_rev = Mock(call=Mock(return_value="rev:FileGenerator().call()")) + mock_file_info_builder = Mock(call=Mock(return_value="FileInfoBuilder().call()")) mock_comparator = Mock(call=Mock(return_value="Comparator().call()")) mocker.patch(f"{MODULE}.Comparator", return_value=mock_comparator) mocker.patch( @@ -195,9 +189,7 @@ def test_run_sync( mock_comparator.call.assert_called_once_with( mock_filter_inst.call.return_value, mock_filter_inst.call.return_value ) - mock_file_info_builder.call.assert_called_once_with( - mock_comparator.call.return_value - ) + mock_file_info_builder.call.assert_called_once_with(mock_comparator.call.return_value) mock_s3_transfer_handler.call.assert_called_once_with( mock_file_info_builder.call.return_value ) diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_comparator.py b/tests/unit/core/providers/aws/s3/_helpers/test_comparator.py index a12f172ae..fed60411c 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_comparator.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_comparator.py @@ -3,10 +3,9 @@ from __future__ import annotations import datetime -from typing import List, Optional +from unittest.mock import Mock import pytest -from mock import Mock from runway.core.providers.aws.s3._helpers.comparator import Comparator from runway.core.providers.aws.s3._helpers.file_generator import FileStats @@ -38,8 +37,7 @@ def setup_method(self) -> None: def test_call_compare_key_equal_should_not_sync(self) -> None: """Test call compare key equal should not sync.""" self.sync_strategy.determine_should_sync.return_value = False - ref_list: List[FileStats] = [] - result_list: List[FileStats] = [] + ref_list: list[FileStats] = [] src_files = [ FileStats( src="", @@ -64,30 +62,22 @@ def test_call_compare_key_equal_should_not_sync(self) -> None: operation_name="", ) ] - files = self.comparator.call(iter(src_files), iter(dest_files)) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list # Try when the sync strategy says to sync the file. self.sync_strategy.determine_should_sync.return_value = True ref_list = [] - result_list = [] - files = self.comparator.call(iter(src_files), iter(dest_files)) ref_list.append(src_files[0]) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list - def test_call_compare_key_greater(self): + def test_call_compare_key_greater(self) -> None: """Test call compare key greater.""" self.not_at_dest_sync_strategy.determine_should_sync.return_value = False self.not_at_src_sync_strategy.determine_should_sync.return_value = True - src_files: List[FileStats] = [] - dest_files: List[FileStats] = [] - ref_list: List[FileStats] = [] - result_list: List[FileStats] = [] + src_files: list[FileStats] = [] + dest_files: list[FileStats] = [] + ref_list: list[FileStats] = [] src_file = FileStats( src="", dest="", @@ -111,32 +101,24 @@ def test_call_compare_key_greater(self): src_files.append(src_file) dest_files.append(dest_file) ref_list.append(dest_file) - files = self.comparator.call(iter(src_files), iter(dest_files)) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list # Now try when the sync strategy says not to sync the file. self.not_at_src_sync_strategy.determine_should_sync.return_value = False - result_list = [] ref_list = [] - files = self.comparator.call(iter(src_files), iter(dest_files)) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list def test_call_compare_key_less(self) -> None: """Test call compare key less.""" self.not_at_src_sync_strategy.determine_should_sync.return_value = False self.not_at_dest_sync_strategy.determine_should_sync.return_value = True - ref_list: List[FileStats] = [] - result_list: List[FileStats] = [] - src_files: List[FileStats] = [] - dest_files: List[FileStats] = [] + ref_list: list[FileStats] = [] + src_files: list[FileStats] = [] + dest_files: list[FileStats] = [] src_file = FileStats( src="", dest="", - compare_key="bomparator_test.py", + compare_key="bomparator_test.py", # cspell: disable-line size=10, last_update=NOW, src_type="local", @@ -156,27 +138,19 @@ def test_call_compare_key_less(self) -> None: src_files.append(src_file) dest_files.append(dest_file) ref_list.append(src_file) - files = self.comparator.call(iter(src_files), iter(dest_files)) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list # Now try when the sync strategy says not to sync the file. self.not_at_dest_sync_strategy.determine_should_sync.return_value = False - result_list = [] ref_list = [] - files = self.comparator.call(iter(src_files), iter(dest_files)) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list def test_call_empty_dest(self) -> None: """Test call empty dest.""" self.not_at_dest_sync_strategy.determine_should_sync.return_value = True - src_files: List[FileStats] = [] - dest_files: List[FileStats] = [] - ref_list: List[FileStats] = [] - result_list: List[FileStats] = [] + src_files: list[FileStats] = [] + dest_files: list[FileStats] = [] + ref_list: list[FileStats] = [] src_file = FileStats( src="", dest="", @@ -189,27 +163,19 @@ def test_call_empty_dest(self) -> None: ) src_files.append(src_file) ref_list.append(src_file) - files = self.comparator.call(iter(src_files), iter(dest_files)) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list # Now try when the sync strategy says not to sync the file. self.not_at_dest_sync_strategy.determine_should_sync.return_value = False - result_list = [] ref_list = [] - files = self.comparator.call(iter(src_files), iter(dest_files)) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list def test_call_empty_src(self) -> None: """Test call empty src.""" self.not_at_src_sync_strategy.determine_should_sync.return_value = True - src_files: List[FileStats] = [] - dest_files: List[FileStats] = [] - ref_list: List[FileStats] = [] - result_list: List[FileStats] = [] + src_files: list[FileStats] = [] + dest_files: list[FileStats] = [] + ref_list: list[FileStats] = [] dest_file = FileStats( src="", dest="", @@ -222,30 +188,19 @@ def test_call_empty_src(self) -> None: ) dest_files.append(dest_file) ref_list.append(dest_file) - files = self.comparator.call(iter(src_files), iter(dest_files)) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list # Now try when the sync strategy says not to sync the file. self.not_at_src_sync_strategy.determine_should_sync.return_value = False - result_list = [] ref_list = [] - files = self.comparator.call(iter(src_files), iter(dest_files)) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list def test_call_empty_src_dest(self) -> None: """Test call.""" - src_files: List[FileStats] = [] - dest_files: List[FileStats] = [] - ref_list: List[FileStats] = [] - result_list: List[FileStats] = [] - files = self.comparator.call(iter(src_files), iter(dest_files)) - for filename in files: - result_list.append(filename) - assert result_list == ref_list + src_files: list[FileStats] = [] + dest_files: list[FileStats] = [] + ref_list: list[FileStats] = [] + assert list(self.comparator.call(iter(src_files), iter(dest_files))) == ref_list @pytest.mark.parametrize( "src_file, dest_file, expected", @@ -260,9 +215,9 @@ def test_call_empty_src_dest(self) -> None: ) def test_compare_comp_key( self, - dest_file: Optional[FileStats], + dest_file: FileStats | None, expected: str, - src_file: Optional[FileStats], + src_file: FileStats | None, ) -> None: """Test compare_comp_key.""" assert Comparator.compare_comp_key(src_file, dest_file) == expected diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_file_generator.py b/tests/unit/core/providers/aws/s3/_helpers/test_file_generator.py index d3566d788..0fdd79559 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_file_generator.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_file_generator.py @@ -6,13 +6,12 @@ import os import platform import stat -from pathlib import Path from typing import TYPE_CHECKING +from unittest.mock import Mock import pytest from botocore.exceptions import ClientError from dateutil.tz import tzlocal -from mock import Mock from runway.core.providers.aws.s3._helpers.file_generator import ( FileGenerator, @@ -24,6 +23,8 @@ from runway.core.providers.aws.s3._helpers.utils import EPOCH_TIME if TYPE_CHECKING: + from pathlib import Path + from pytest_mock import MockerFixture from runway.core.providers.aws.s3._helpers.file_generator import ( @@ -47,9 +48,7 @@ def test_is_readable(tmp_path: Path) -> None: assert is_readable(tmp_file) -def test_is_readable_unreadable_directory( - mocker: MockerFixture, tmp_path: Path -) -> None: +def test_is_readable_unreadable_directory(mocker: MockerFixture, tmp_path: Path) -> None: """Test is_readable.""" mocker.patch("os.listdir", side_effect=OSError) assert not is_readable(tmp_path) @@ -78,9 +77,7 @@ def test_is_special_file_block_device(mocker: MockerFixture, tmp_path: Path) -> assert is_special_file(tmp_file) -def test_is_special_file_character_device( - mocker: MockerFixture, tmp_path: Path -) -> None: +def test_is_special_file_character_device(mocker: MockerFixture, tmp_path: Path) -> None: """Test is_special_file.""" mocker.patch("stat.S_ISCHR", return_value=True) tmp_file = tmp_path / "foo" @@ -93,7 +90,6 @@ def test_is_special_file_fifo(tmp_path: Path) -> None: """Test is_special_file.""" tmp_file = tmp_path / "foo" # method only exists on linux systems - # pylint: disable=no-member os.mknod(tmp_file, 0o600 | stat.S_IFIFO) # type: ignore assert is_special_file(tmp_file) @@ -150,9 +146,7 @@ def test_call_locals3(self, mocker: MockerFixture, tmp_path: Path) -> None: formatted_path["src"]["path"], formatted_path["dir_op"] ) mock_list_objects.assert_not_called() - mock_find_dest_path_comp_key.assert_called_once_with( - formatted_path, f"{src}test.txt" - ) + mock_find_dest_path_comp_key.assert_called_once_with(formatted_path, f"{src}test.txt") def test_call_s3local(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test call.""" @@ -185,13 +179,9 @@ def test_call_s3local(self, mocker: MockerFixture, tmp_path: Path) -> None: formatted_path["src"]["path"], formatted_path["dir_op"] ) mock_list_files.assert_not_called() - mock_find_dest_path_comp_key.assert_called_once_with( - formatted_path, f"{src}test.txt" - ) + mock_find_dest_path_comp_key.assert_called_once_with(formatted_path, f"{src}test.txt") - def test_list_files_directory( - self, loc_files: LocalFiles, mocker: MockerFixture - ) -> None: + def test_list_files_directory(self, loc_files: LocalFiles, mocker: MockerFixture) -> None: """Test list_files.""" mocker.patch(f"{MODULE}.get_file_stat", return_value=(15, NOW)) mocker.patch.object(FileGenerator, "should_ignore_file", return_value=False) @@ -201,9 +191,7 @@ def test_list_files_directory( assert (loc_files["files"][0], {"Size": 15, "LastModified": NOW}) in result assert (loc_files["files"][1], {"Size": 15, "LastModified": NOW}) in result - def test_list_files_file( - self, loc_files: LocalFiles, mocker: MockerFixture - ) -> None: + def test_list_files_file(self, loc_files: LocalFiles, mocker: MockerFixture) -> None: """Test list_files.""" mocker.patch(f"{MODULE}.get_file_stat", return_value=(15, NOW)) mocker.patch.object(FileGenerator, "should_ignore_file", return_value=False) @@ -223,9 +211,7 @@ def test_list_objects(self, mocker: MockerFixture) -> None: mock_inst = Mock(list_objects=mock_list_objects) mock_class = mocker.patch(f"{MODULE}.BucketLister", return_value=mock_inst) params = {"key": "val"} - obj = FileGenerator( - self.client, "", request_parameters={"ListObjectsV2": params} - ) + obj = FileGenerator(self.client, "", request_parameters={"ListObjectsV2": params}) result = list(obj.list_objects("bucket/", dir_op=True)) mock_class.assert_called_once_with(self.client) mock_list_objects.assert_called_once_with( @@ -244,9 +230,7 @@ def test_list_objects_delete(self, mocker: MockerFixture) -> None: mock_inst = Mock(list_objects=mock_list_objects) mock_class = mocker.patch(f"{MODULE}.BucketLister", return_value=mock_inst) params = {"key": "val"} - obj = FileGenerator( - self.client, "delete", request_parameters={"ListObjectsV2": params} - ) + obj = FileGenerator(self.client, "delete", request_parameters={"ListObjectsV2": params}) result = list(obj.list_objects("bucket/prefix", dir_op=True)) mock_class.assert_called_once_with(self.client) mock_list_objects.assert_called_once_with( @@ -274,9 +258,7 @@ def test_list_objects_incorrect_dir_opt(self, mocker: MockerFixture) -> None: def test_list_objects_single(self) -> None: """Test list_objects.""" - head_object = Mock( - return_value={"ContentLength": "13", "LastModified": NOW.isoformat()} - ) + head_object = Mock(return_value={"ContentLength": "13", "LastModified": NOW.isoformat()}) self.client.head_object = head_object obj = FileGenerator(self.client, "") result = list(obj.list_objects("bucket/key.txt", False)) @@ -295,17 +277,13 @@ def test_list_objects_single_client_error_403(self) -> None: def test_list_objects_single_client_error_404(self) -> None: """Test list_objects.""" - exc = ClientError( - {"Error": {"Code": "404", "Message": "something"}}, "HeadObject" - ) + exc = ClientError({"Error": {"Code": "404", "Message": "something"}}, "HeadObject") head_object = Mock(side_effect=exc) self.client.head_object = head_object with pytest.raises(ClientError) as excinfo: list(FileGenerator(self.client, "").list_objects("bucket/key.txt", False)) assert excinfo.value != exc - assert ( - excinfo.value.response["Error"]["Message"] == 'Key "key.txt" does not exist' - ) + assert excinfo.value.response["Error"]["Message"] == 'Key "key.txt" does not exist' def test_list_objects_single_delete(self) -> None: """Test list_objects.""" @@ -334,9 +312,7 @@ def test_normalize_sort_backslash(self) -> None: def test_safely_get_file_stats(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test safely_get_file_stats.""" - mock_get_file_stat = mocker.patch( - f"{MODULE}.get_file_stat", return_value=(15, NOW) - ) + mock_get_file_stat = mocker.patch(f"{MODULE}.get_file_stat", return_value=(15, NOW)) obj = FileGenerator(self.client, "") assert obj.safely_get_file_stats(tmp_path) == ( tmp_path, @@ -358,9 +334,7 @@ def test_safely_get_file_stats_no_last_update( self, mocker: MockerFixture, tmp_path: Path ) -> None: """Test safely_get_file_stats.""" - mock_create_warning = mocker.patch( - f"{MODULE}.create_warning", return_value="warning" - ) + mock_create_warning = mocker.patch(f"{MODULE}.create_warning", return_value="warning") mocker.patch(f"{MODULE}.get_file_stat", return_value=(15, None)) obj = FileGenerator(self.client, "") assert obj.safely_get_file_stats(tmp_path) == ( @@ -369,8 +343,7 @@ def test_safely_get_file_stats_no_last_update( ) mock_create_warning.assert_called_once_with( path=tmp_path, - error_message="File has an invalid timestamp. Passing epoch " - "time as timestamp.", + error_message="File has an invalid timestamp. Passing epoch time as timestamp.", skip_file=False, ) assert obj.result_queue.get() == "warning" @@ -380,9 +353,7 @@ def test_should_ignore_file(self, mocker: MockerFixture, tmp_path: Path) -> None mock_triggers_warning = mocker.patch.object( FileGenerator, "triggers_warning", return_value=False ) - assert not FileGenerator( - self.client, "", follow_symlinks=True - ).should_ignore_file(tmp_path) + assert not FileGenerator(self.client, "", follow_symlinks=True).should_ignore_file(tmp_path) mock_triggers_warning.assert_called_once_with(tmp_path) def test_should_ignore_file_symlink(self, tmp_path: Path) -> None: @@ -391,64 +362,42 @@ def test_should_ignore_file_symlink(self, tmp_path: Path) -> None: real_path = tmp_path / "real_path" real_path.mkdir() tmp_symlink.symlink_to(real_path) - assert FileGenerator(self.client, "", follow_symlinks=False).should_ignore_file( - tmp_symlink - ) + assert FileGenerator(self.client, "", follow_symlinks=False).should_ignore_file(tmp_symlink) def test_should_ignore_file_triggers_warning( self, mocker: MockerFixture, tmp_path: Path ) -> None: """Test should_ignore_file.""" mocker.patch.object(FileGenerator, "triggers_warning", return_value=True) - assert FileGenerator(self.client, "", follow_symlinks=True).should_ignore_file( - tmp_path - ) + assert FileGenerator(self.client, "", follow_symlinks=True).should_ignore_file(tmp_path) def test_triggers_warning(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test triggers_warning.""" mock_create_warning = mocker.patch(f"{MODULE}.create_warning") - mock_is_special_file = mocker.patch( - f"{MODULE}.is_special_file", return_value=False - ) + mock_is_special_file = mocker.patch(f"{MODULE}.is_special_file", return_value=False) mock_is_readable = mocker.patch(f"{MODULE}.is_readable", return_value=True) - assert not FileGenerator( - self.client, "", follow_symlinks=True - ).triggers_warning(tmp_path) + assert not FileGenerator(self.client, "", follow_symlinks=True).triggers_warning(tmp_path) mock_is_special_file.assert_called_once_with(tmp_path) mock_is_readable.assert_called_once_with(tmp_path) mock_create_warning.assert_not_called() - def test_triggers_warning_does_not_exist( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test_triggers_warning_does_not_exist(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test triggers_warning.""" missing_path = tmp_path / "missing" - mock_create_warning = mocker.patch( - f"{MODULE}.create_warning", return_value="warning" - ) - mock_is_special_file = mocker.patch( - f"{MODULE}.is_special_file", return_value=False - ) + mock_create_warning = mocker.patch(f"{MODULE}.create_warning", return_value="warning") + mock_is_special_file = mocker.patch(f"{MODULE}.is_special_file", return_value=False) mock_is_readable = mocker.patch(f"{MODULE}.is_readable", return_value=True) obj = FileGenerator(self.client, "", follow_symlinks=True) assert obj.triggers_warning(missing_path) mock_is_special_file.assert_not_called() mock_is_readable.assert_not_called() - mock_create_warning.assert_called_once_with( - missing_path, "File does not exist." - ) + mock_create_warning.assert_called_once_with(missing_path, "File does not exist.") assert obj.result_queue.get() == "warning" - def test_triggers_warning_is_special_file( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test_triggers_warning_is_special_file(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test triggers_warning.""" - mock_create_warning = mocker.patch( - f"{MODULE}.create_warning", return_value="warning" - ) - mock_is_special_file = mocker.patch( - f"{MODULE}.is_special_file", return_value=True - ) + mock_create_warning = mocker.patch(f"{MODULE}.create_warning", return_value="warning") + mock_is_special_file = mocker.patch(f"{MODULE}.is_special_file", return_value=True) mock_is_readable = mocker.patch(f"{MODULE}.is_readable", return_value=True) obj = FileGenerator(self.client, "", follow_symlinks=True) assert obj.triggers_warning(tmp_path) @@ -460,24 +409,16 @@ def test_triggers_warning_is_special_file( ) assert obj.result_queue.get() == "warning" - def test_triggers_warning_is_unreadable( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test_triggers_warning_is_unreadable(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test triggers_warning.""" - mock_create_warning = mocker.patch( - f"{MODULE}.create_warning", return_value="warning" - ) - mock_is_special_file = mocker.patch( - f"{MODULE}.is_special_file", return_value=False - ) + mock_create_warning = mocker.patch(f"{MODULE}.create_warning", return_value="warning") + mock_is_special_file = mocker.patch(f"{MODULE}.is_special_file", return_value=False) mock_is_readable = mocker.patch(f"{MODULE}.is_readable", return_value=False) obj = FileGenerator(self.client, "", follow_symlinks=True) assert obj.triggers_warning(tmp_path) mock_is_special_file.assert_called_once_with(tmp_path) mock_is_readable.assert_called_once_with(tmp_path) - mock_create_warning.assert_called_once_with( - tmp_path, "File/Directory is not readable." - ) + mock_create_warning.assert_called_once_with(tmp_path, "File/Directory is not readable.") assert obj.result_queue.get() == "warning" diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_file_info.py b/tests/unit/core/providers/aws/s3/_helpers/test_file_info.py index 4b4297e2f..d684b12a6 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_file_info.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_file_info.py @@ -6,7 +6,6 @@ from typing import TYPE_CHECKING import pytest -from typing_extensions import Literal from runway.core.providers.aws.s3._helpers.file_info import FileInfo from runway.core.providers.aws.s3._helpers.utils import EPOCH_TIME @@ -15,6 +14,7 @@ from pathlib import Path from mypy_boto3_s3.type_defs import ObjectTypeDef + from typing_extensions import Literal NOW = datetime.datetime.now() diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_file_info_builder.py b/tests/unit/core/providers/aws/s3/_helpers/test_file_info_builder.py index 3b61056f7..7c45e02ed 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_file_info_builder.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_file_info_builder.py @@ -2,7 +2,7 @@ from __future__ import annotations -from mock import Mock +from unittest.mock import Mock from runway.core.providers.aws.s3._helpers.file_generator import FileStats from runway.core.providers.aws.s3._helpers.file_info import FileInfo diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_filters.py b/tests/unit/core/providers/aws/s3/_helpers/test_filters.py index 5dc0e0331..b1da765b8 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_filters.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_filters.py @@ -20,12 +20,8 @@ class TestFilter: def test_call_local(self, tmp_path: Path) -> None: """Test call.""" - exclude_md = FileStats( - src=tmp_path / "exclude/README.md", src_type="local", dest="" - ) - include_md = FileStats( - src=tmp_path / "include/README.md", src_type="local", dest="" - ) + exclude_md = FileStats(src=tmp_path / "exclude/README.md", src_type="local", dest="") + include_md = FileStats(src=tmp_path / "include/README.md", src_type="local", dest="") other_file = FileStats(src=tmp_path / "/test.txt", src_type="local", dest="") params = ParametersDataModel( src=str(tmp_path), diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_format_path.py b/tests/unit/core/providers/aws/s3/_helpers/test_format_path.py index 25afa29ba..698ab0487 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_format_path.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_format_path.py @@ -3,10 +3,10 @@ from __future__ import annotations import os -from typing import TYPE_CHECKING, Tuple +from typing import TYPE_CHECKING +from unittest.mock import call import pytest -from mock import call from runway.core.providers.aws.s3._helpers.format_path import FormatPath @@ -82,9 +82,7 @@ def test_format_local_path(self, tmp_path: Path) -> None: ("s3://bucket/key.txt", False, ("s3://bucket/key.txt", False)), ], ) - def test_format_s3_path( - self, dir_op: bool, expected: Tuple[str, bool], path: str - ) -> None: + def test_format_s3_path(self, dir_op: bool, expected: tuple[str, bool], path: str) -> None: """Test format_s3_path.""" assert FormatPath.format_s3_path(path, dir_op) == expected @@ -99,8 +97,6 @@ def test_format_s3_path( ("s3://test", ("s3", "test")), ], ) - def test_identify_path_type( - self, expected: Tuple[SupportedPathType, str], path: str - ) -> None: + def test_identify_path_type(self, expected: tuple[SupportedPathType, str], path: str) -> None: """Test identify_path_type.""" assert FormatPath.identify_path_type(path) == expected diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_parameters.py b/tests/unit/core/providers/aws/s3/_helpers/test_parameters.py index 8c3a7dd3c..535a6c7b0 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_parameters.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_parameters.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any, Dict, List +from typing import TYPE_CHECKING, Any import pytest from pydantic import ValidationError @@ -45,9 +45,7 @@ def test_init(self, mocker: MockerFixture) -> None: "cmd, expected", [("sync", True), ("mb", True), ("rb", True), ("cp", False), ("mv", False)], ) - def test_init_set_dir_op( - self, cmd: str, expected: bool, mocker: MockerFixture - ) -> None: + def test_init_set_dir_op(self, cmd: str, expected: bool, mocker: MockerFixture) -> None: """Test __init__.""" mocker.patch.object(Parameters, "_validate_path_args") assert Parameters(cmd, self.data_locallocal).data.dir_op == expected @@ -56,9 +54,7 @@ def test_init_set_dir_op( "cmd, expected", [("sync", False), ("mb", False), ("rb", False), ("cp", False), ("mv", True)], ) - def test_init_set_is_move( - self, cmd: str, expected: bool, mocker: MockerFixture - ) -> None: + def test_init_set_is_move(self, cmd: str, expected: bool, mocker: MockerFixture) -> None: """Test __init__.""" mocker.patch.object(Parameters, "_validate_path_args") assert Parameters(cmd, self.data_locallocal).data.is_move == expected @@ -71,9 +67,8 @@ def test_same_path_mv_locallocal(self) -> None: def test_same_path_mv_s3s3(self) -> None: """Test _same_path.""" self.data_s3s3.dest = self.data_s3s3.src - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="Cannot mv a file onto itself"): Parameters("mv", self.data_s3s3) - assert "Cannot mv a file onto itself" in str(excinfo.value) def test_same_path_mv_s3s3_not_same(self) -> None: """Test _same_path.""" @@ -126,9 +121,7 @@ class TestParametersDataModel: ("s3://test-dest", "s3://test-src", "s3s3"), ], ) - def test_determine_paths_type( - self, dest: str, expected: PathsType, src: str - ) -> None: + def test_determine_paths_type(self, dest: str, expected: PathsType, src: str) -> None: """Test _determine_paths_type.""" assert ParametersDataModel(dest=dest, src=src).paths_type == expected @@ -168,9 +161,7 @@ def test_normalize_s3_trailing_slash(self, provided: str, expected: str) -> None "kwargs, error_locs", [({"dest": "test-dest"}, ["src"]), ({"src": "test-src"}, ["dest"])], ) - def test_required_fields( - self, error_locs: List[str], kwargs: Dict[str, Any] - ) -> None: + def test_required_fields(self, error_locs: list[str], kwargs: dict[str, Any]) -> None: """Test required fields.""" with pytest.raises(ValidationError) as excinfo: ParametersDataModel(**kwargs) diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_results.py b/tests/unit/core/providers/aws/s3/_helpers/test_results.py index 429dca6da..2ff84fbf8 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_results.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_results.py @@ -1,16 +1,15 @@ """Test runway.core.providers.aws.s3._helpers.results.""" -# pylint: disable=too-many-lines from __future__ import annotations import time from concurrent.futures import CancelledError from io import StringIO from queue import Queue -from typing import TYPE_CHECKING, Any, ClassVar, Dict, Optional +from typing import TYPE_CHECKING, Any, ClassVar, Optional +from unittest.mock import Mock import pytest -from mock import Mock from s3transfer.exceptions import FatalError from runway._logging import LogLevels @@ -54,7 +53,6 @@ ) if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from s3transfer.futures import TransferFuture @@ -100,7 +98,7 @@ class BaseResultSubscriberTest: future: TransferFuture key: ClassVar[str] = "test.txt" ref_exception: ClassVar[Exception] = Exception() - result_queue: "Queue[Any]" + result_queue: Queue[Any] size: ClassVar[int] = 20 * (1024 * 1024) # 20 MB src: str transfer_type: str @@ -131,9 +129,7 @@ def _get_transfer_future( return FakeTransferFuture(result=result, exception=exception, meta=meta) def _get_transfer_future_call_args(self) -> FakeTransferFutureCallArgs: - return FakeTransferFutureCallArgs( - fileobj=self.filename, key=self.key, bucket=self.bucket - ) + return FakeTransferFutureCallArgs(fileobj=self.filename, key=self.key, bucket=self.bucket) def get_queued_result(self) -> AnyResult: """Get queued result.""" @@ -271,9 +267,7 @@ def setup_method(self) -> None: def test_on_progress(self, mocker: MockerFixture) -> None: """Test on_progress.""" - mocker.patch.object( - BaseResultSubscriber, "_get_src_dest", return_value=(None, None) - ) + mocker.patch.object(BaseResultSubscriber, "_get_src_dest", return_value=(None, None)) assert not self.result_subscriber.on_queued(self.future) assert isinstance(self.get_queued_result(), QueuedResult) assert not self.result_subscriber.on_progress(self.future, 13) @@ -298,7 +292,7 @@ class TestCommandResultRecorder: command_result_recorder: CommandResultRecorder dest: ClassVar[str] = "s3://mybucket/test-key" result_processor: ResultProcessor - result_queue: "Queue[Any]" + result_queue: Queue[Any] result_recorder: ResultRecorder src: ClassVar[str] = "file" total_transfer_size: ClassVar[int] = 20 * (1024 * 1024) # 20 MB @@ -308,9 +302,7 @@ def setup_method(self) -> None: """Run before each test method if run to return the class instance attrs to default.""" self.result_queue = Queue() self.result_recorder = ResultRecorder() - self.result_processor = ResultProcessor( - self.result_queue, [self.result_recorder] - ) + self.result_processor = ResultProcessor(self.result_queue, [self.result_recorder]) self.command_result_recorder = CommandResultRecorder( self.result_queue, self.result_recorder, self.result_processor ) @@ -358,9 +350,7 @@ def test_get_command_result_success(self) -> None: ) ) self.result_queue.put( - SuccessResult( - transfer_type=self.transfer_type, src=self.src, dest=self.dest - ) + SuccessResult(transfer_type=self.transfer_type, src=self.src, dest=self.dest) ) result = self.command_result_recorder.get_command_result() assert result.num_tasks_failed == 0 @@ -384,7 +374,7 @@ def test_notify_total_submissions(self) -> None: class TestCopyResultSubscriber(TestUploadResultSubscriber): """Test CopyResultSubscriber.""" - copy_source: Dict[str, str] + copy_source: dict[str, str] source_bucket: str source_key: str @@ -410,9 +400,7 @@ def _get_transfer_future_call_args(self) -> FakeTransferFutureCallArgs: def test_on_queued_transfer_type_override(self) -> None: """Test on_queued.""" new_transfer_type = "move" - self.result_subscriber = CopyResultSubscriber( - self.result_queue, new_transfer_type - ) + self.result_subscriber = CopyResultSubscriber(self.result_queue, new_transfer_type) self.result_subscriber.on_queued(self.future) result = self.get_queued_result() self.assert_result_queue_is_empty() @@ -480,7 +468,7 @@ def test_does_not_print_progress_result(self) -> None: self.result_printer(progress_result) assert self.out_file.getvalue() == "" - def test_does_print_success_result(self, caplog: LogCaptureFixture) -> None: + def test_does_print_success_result(self, caplog: pytest.LogCaptureFixture) -> None: """Test does print success result.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") transfer_type = "upload" @@ -492,7 +480,7 @@ def test_does_print_success_result(self, caplog: LogCaptureFixture) -> None: assert self.out_file.getvalue() == "" def test_final_total_does_not_try_to_clear_empty_progress( - self, caplog: LogCaptureFixture + self, caplog: pytest.LogCaptureFixture ) -> None: """Test final total does not try to clear empty progress.""" caplog.set_level(LogLevels.INFO, "runway.core.providers.aws.s3") @@ -513,7 +501,7 @@ def test_final_total_does_not_try_to_clear_empty_progress( assert caplog.messages == ["upload: file to s3://mybucket/test-key"] assert self.out_file.getvalue() == "" - def test_print_failure_result(self, caplog: LogCaptureFixture) -> None: + def test_print_failure_result(self, caplog: pytest.LogCaptureFixture) -> None: """Test print failure result.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") transfer_type = "upload" @@ -526,12 +514,10 @@ def test_print_failure_result(self, caplog: LogCaptureFixture) -> None: exception=Exception("my exception"), ) self.result_printer(failure_result) - assert caplog.messages == [ - "upload failed: file to s3://mybucket/test-key my exception" - ] + assert caplog.messages == ["upload failed: file to s3://mybucket/test-key my exception"] assert self.error_file.getvalue() == "" - def test_print_warning_result(self, caplog: LogCaptureFixture) -> None: + def test_print_warning_result(self, caplog: pytest.LogCaptureFixture) -> None: """Test print warning.""" caplog.set_level(LogLevels.WARNING, "runway.core.providers.aws.s3") self.result_printer(PrintTask("warning: my warning")) @@ -557,7 +543,7 @@ def test_does_not_print_progress_result(self) -> None: self.result_printer(progress_result) assert self.out_file.getvalue() == "" - def test_does_not_print_success_result(self, caplog: LogCaptureFixture) -> None: + def test_does_not_print_success_result(self, caplog: pytest.LogCaptureFixture) -> None: """Test does not print success result.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") transfer_type = "upload" @@ -568,7 +554,7 @@ def test_does_not_print_success_result(self, caplog: LogCaptureFixture) -> None: assert not caplog.messages assert not self.out_file.getvalue() - def test_does_print_failure_result(self, caplog: LogCaptureFixture) -> None: + def test_does_print_failure_result(self, caplog: pytest.LogCaptureFixture) -> None: """Test print failure result.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") transfer_type = "upload" @@ -581,12 +567,10 @@ def test_does_print_failure_result(self, caplog: LogCaptureFixture) -> None: exception=Exception("my exception"), ) self.result_printer(failure_result) - assert caplog.messages == [ - "upload failed: file to s3://mybucket/test-key my exception" - ] + assert caplog.messages == ["upload failed: file to s3://mybucket/test-key my exception"] assert not self.error_file.getvalue() - def test_does_print_warning_result(self, caplog: LogCaptureFixture) -> None: + def test_does_print_warning_result(self, caplog: pytest.LogCaptureFixture) -> None: """Test print warning.""" caplog.set_level(LogLevels.WARNING, "runway.core.providers.aws.s3") self.result_printer(PrintTask("warning: my warning")) @@ -594,7 +578,7 @@ def test_does_print_warning_result(self, caplog: LogCaptureFixture) -> None: assert not self.error_file.getvalue() def test_final_total_does_not_try_to_clear_empty_progress( - self, caplog: LogCaptureFixture + self, caplog: pytest.LogCaptureFixture ) -> None: """Test final total does not try to clear empty progress.""" caplog.set_level(LogLevels.INFO, "runway.core.providers.aws.s3") @@ -616,26 +600,23 @@ def test_final_total_does_not_try_to_clear_empty_progress( assert not self.out_file.getvalue() -# pylint: disable=too-many-public-methods class TestResultPrinter(BaseResultPrinterTest): """Test ResultPrinter.""" - def test_ctrl_c_error(self, caplog: LogCaptureFixture) -> None: + def test_ctrl_c_error(self, caplog: pytest.LogCaptureFixture) -> None: """Test Ctrl+C error.""" caplog.set_level(LogLevels.WARNING, "runway.core.providers.aws.s3") self.result_printer(CtrlCResult(Exception())) assert caplog.messages == ["cancelled: ctrl-c received"] - def test_dry_run(self, caplog: LogCaptureFixture) -> None: + def test_dry_run(self, caplog: pytest.LogCaptureFixture) -> None: """Test dry run.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") - result = DryRunResult( - transfer_type="upload", src="s3://mybucket/key", dest="./local/file" - ) + result = DryRunResult(transfer_type="upload", src="s3://mybucket/key", dest="./local/file") self.result_printer(result) assert caplog.messages == [f"(dryrun) upload: {result.src} to {result.dest}"] - def test_dry_run_unicode(self, caplog: LogCaptureFixture) -> None: + def test_dry_run_unicode(self, caplog: pytest.LogCaptureFixture) -> None: """Test dry run.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") result = DryRunResult( @@ -644,19 +625,19 @@ def test_dry_run_unicode(self, caplog: LogCaptureFixture) -> None: self.result_printer(result) assert caplog.messages == [f"(dryrun) upload: {result.src} to {result.dest}"] - def test_error(self, caplog: LogCaptureFixture) -> None: + def test_error(self, caplog: pytest.LogCaptureFixture) -> None: """Test error.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") self.result_printer(ErrorResult(Exception("my exception"))) assert caplog.messages == ["fatal error: my exception"] - def test_error_unicode(self, caplog: LogCaptureFixture) -> None: + def test_error_unicode(self, caplog: pytest.LogCaptureFixture) -> None: """Test error.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") self.result_printer(ErrorResult(Exception("unicode exists \u2713"))) assert caplog.messages == ["fatal error: unicode exists \u2713"] - def test_error_while_progress(self, caplog: LogCaptureFixture) -> None: + def test_error_while_progress(self, caplog: pytest.LogCaptureFixture) -> None: """Test error.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") mb = 1024**2 @@ -669,7 +650,7 @@ def test_error_while_progress(self, caplog: LogCaptureFixture) -> None: assert caplog.messages == ["fatal error: my exception"] assert not self.out_file.getvalue() - def test_failure(self, caplog: LogCaptureFixture) -> None: + def test_failure(self, caplog: pytest.LogCaptureFixture) -> None: """Test failure.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") transfer_type = "upload" @@ -688,7 +669,7 @@ def test_failure(self, caplog: LogCaptureFixture) -> None: assert caplog.messages == [f"upload failed: file to {dest} my exception"] def test_failure_but_no_expected_files_transferred_provided( - self, caplog: LogCaptureFixture + self, caplog: pytest.LogCaptureFixture ) -> None: """Test failure.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") @@ -714,12 +695,11 @@ def test_failure_but_no_expected_files_transferred_provided( ) self.result_printer(failure_result) assert self.out_file.getvalue() == ( - "Completed 1.0 MiB/~1.0 MiB (0 Bytes/s) with ~0 file(s) " - "remaining (calculating...)\r" + "Completed 1.0 MiB/~1.0 MiB (0 Bytes/s) with ~0 file(s) remaining (calculating...)\r" ) assert caplog.messages == [f"upload failed: file to {dest} my exception"] - def test_failure_for_delete(self, caplog: LogCaptureFixture) -> None: + def test_failure_for_delete(self, caplog: pytest.LogCaptureFixture) -> None: """Test failure.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") transfer_type = "delete" @@ -738,7 +718,7 @@ def test_failure_for_delete(self, caplog: LogCaptureFixture) -> None: assert caplog.messages == [f"delete failed: {src} my exception"] def test_failure_for_delete_but_no_expected_files_transferred_provided( - self, caplog: LogCaptureFixture + self, caplog: pytest.LogCaptureFixture ) -> None: """Test failure.""" shared_file = self.out_file @@ -764,7 +744,7 @@ def test_failure_for_delete_but_no_expected_files_transferred_provided( assert caplog.messages == [f"delete failed: {src} my exception"] def test_failure_for_delete_with_files_remaining( - self, caplog: LogCaptureFixture + self, caplog: pytest.LogCaptureFixture ) -> None: """Test failure.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") @@ -791,7 +771,7 @@ def test_failure_for_delete_with_files_remaining( ) assert caplog.messages == [f"delete failed: {src} my exception"] - def test_failure_unicode(self, caplog: LogCaptureFixture) -> None: + def test_failure_unicode(self, caplog: pytest.LogCaptureFixture) -> None: """Test failure.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") transfer_type = "upload" @@ -809,7 +789,7 @@ def test_failure_unicode(self, caplog: LogCaptureFixture) -> None: self.result_printer(failure_result) assert caplog.messages == [f"upload failed: {src} to {dest} my exception"] - def test_failure_with_files_remaining(self, caplog: LogCaptureFixture) -> None: + def test_failure_with_files_remaining(self, caplog: pytest.LogCaptureFixture) -> None: """Test failure.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") shared_file = self.out_file @@ -834,12 +814,11 @@ def test_failure_with_files_remaining(self, caplog: LogCaptureFixture) -> None: ) self.result_printer(failure_result) assert self.out_file.getvalue() == ( - "Completed 1.0 MiB/~4.0 MiB (0 Bytes/s) with ~3 file(s) " - "remaining (calculating...)\r" + "Completed 1.0 MiB/~4.0 MiB (0 Bytes/s) with ~3 file(s) remaining (calculating...)\r" ) assert caplog.messages == [f"upload failed: file to {dest} my exception"] - def test_failure_with_progress(self, caplog: LogCaptureFixture) -> None: + def test_failure_with_progress(self, caplog: pytest.LogCaptureFixture) -> None: """Test failure.""" caplog.set_level(LogLevels.ERROR, "runway.core.providers.aws.s3") shared_file = self.out_file @@ -875,7 +854,7 @@ def test_failure_with_progress(self, caplog: LogCaptureFixture) -> None: assert caplog.messages == [f"upload failed: file to {dest} my exception"] def test_final_total_does_not_print_out_newline_for_no_transfers( - self, caplog: LogCaptureFixture + self, caplog: pytest.LogCaptureFixture ) -> None: """Test final total.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") @@ -884,7 +863,7 @@ def test_final_total_does_not_print_out_newline_for_no_transfers( assert not self.out_file.getvalue() def test_final_total_notification_with_no_more_expected_progress( - self, caplog: LogCaptureFixture + self, caplog: pytest.LogCaptureFixture ) -> None: """Test final total.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") @@ -899,8 +878,7 @@ def test_final_total_notification_with_no_more_expected_progress( success_result = SuccessResult(transfer_type=transfer_type, src=src, dest=dest) self.result_printer(success_result) assert self.out_file.getvalue() == ( - "Completed 1.0 MiB/~1.0 MiB (0 Bytes/s) with ~0 file(s) " - "remaining (calculating...)\r" + "Completed 1.0 MiB/~1.0 MiB (0 Bytes/s) with ~0 file(s) remaining (calculating...)\r" ) assert caplog.messages == [f"upload: file to {dest}"] @@ -943,9 +921,7 @@ def test_get_progress_result_no_expected_transfer_bytes(self) -> None: self.result_recorder.expected_bytes_transferred = 0 progress_result = self.get_progress_result() self.result_printer(progress_result) - assert ( - self.out_file.getvalue() == "Completed 1 file(s) with 3 file(s) remaining\r" - ) + assert self.out_file.getvalue() == "Completed 1 file(s) with 3 file(s) remaining\r" def test_get_progress_result_still_calculating_totals_no_bytes(self) -> None: """Test get_progress_result.""" @@ -970,8 +946,7 @@ def test_get_progress_result_still_calculating_totals(self) -> None: progress_result = self.get_progress_result() self.result_printer(progress_result) assert ( - self.out_file.getvalue() - == "Completed 1.0 MiB/~20.0 MiB (0 Bytes/s) with ~3 file(s) " + self.out_file.getvalue() == "Completed 1.0 MiB/~20.0 MiB (0 Bytes/s) with ~3 file(s) " "remaining (calculating...)\r" ) @@ -1016,15 +991,15 @@ def test_init_no_error_file(self, mocker: MockerFixture) -> None: """Test __init__ no error_file.""" mock_stderr = mocker.patch("sys.stderr", Mock()) result = ResultPrinter(self.result_recorder, out_file=self.out_file) - assert result._error_file == mock_stderr # pylint: disable=protected-access + assert result._error_file == mock_stderr def test_init_no_out_file(self, mocker: MockerFixture) -> None: """Test __init__ no out_file.""" mock_stdout = mocker.patch("sys.stdout", Mock()) result = ResultPrinter(self.result_recorder, error_file=self.error_file) - assert result._out_file == mock_stdout # pylint: disable=protected-access + assert result._out_file == mock_stdout - def test_success(self, caplog: LogCaptureFixture) -> None: + def test_success(self, caplog: pytest.LogCaptureFixture) -> None: """Test success.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") transfer_type = "upload" @@ -1038,7 +1013,7 @@ def test_success(self, caplog: LogCaptureFixture) -> None: assert caplog.messages == [f"upload: file to {dest}"] def test_success_but_no_expected_files_transferred_provided( - self, caplog: LogCaptureFixture + self, caplog: pytest.LogCaptureFixture ) -> None: """Test success but no expected files transferred provided.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") @@ -1054,12 +1029,11 @@ def test_success_but_no_expected_files_transferred_provided( success_result = SuccessResult(transfer_type=transfer_type, src=src, dest=dest) self.result_printer(success_result) assert self.out_file.getvalue() == ( - "Completed 1.0 MiB/~1.0 MiB (0 Bytes/s) with ~0 file(s) " - "remaining (calculating...)\r" + "Completed 1.0 MiB/~1.0 MiB (0 Bytes/s) with ~0 file(s) remaining (calculating...)\r" ) assert caplog.messages == [f"upload: file to {dest}"] - def test_success_delete(self, caplog: LogCaptureFixture) -> None: + def test_success_delete(self, caplog: pytest.LogCaptureFixture) -> None: """Test success for delete.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") transfer_type = "delete" @@ -1072,7 +1046,7 @@ def test_success_delete(self, caplog: LogCaptureFixture) -> None: assert caplog.messages == [f"delete: {src}"] def test_success_delete_but_no_expected_files_transferred_provided( - self, caplog: LogCaptureFixture + self, caplog: pytest.LogCaptureFixture ) -> None: """Test success delete but no expected files transferred provided.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") @@ -1088,9 +1062,7 @@ def test_success_delete_but_no_expected_files_transferred_provided( ) assert caplog.messages == [f"delete: {src}"] - def test_success_delete_with_files_remaining( - self, caplog: LogCaptureFixture - ) -> None: + def test_success_delete_with_files_remaining(self, caplog: pytest.LogCaptureFixture) -> None: """Test success delete with files remaining.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") transfer_type = "delete" @@ -1105,19 +1077,17 @@ def test_success_delete_with_files_remaining( ) assert caplog.messages == [f"delete: {src}"] - def test_success_unicode_src(self, caplog: LogCaptureFixture) -> None: + def test_success_unicode_src(self, caplog: pytest.LogCaptureFixture) -> None: """Test success.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") self.result_recorder.final_expected_files_transferred = 1 self.result_recorder.expected_files_transferred = 1 self.result_recorder.files_transferred = 1 - result = SuccessResult( - transfer_type="delete", src="s3://mybucket/tmp/\u2713", dest=None - ) + result = SuccessResult(transfer_type="delete", src="s3://mybucket/tmp/\u2713", dest=None) self.result_printer(result) assert caplog.messages == [f"delete: {result.src}"] - def test_success_unicode_src_and_dest(self, caplog: LogCaptureFixture) -> None: + def test_success_unicode_src_and_dest(self, caplog: pytest.LogCaptureFixture) -> None: """Test success.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") self.result_recorder.final_expected_files_transferred = 1 @@ -1129,7 +1099,7 @@ def test_success_unicode_src_and_dest(self, caplog: LogCaptureFixture) -> None: self.result_printer(result) assert caplog.messages == [f"upload: {result.src} to {result.dest}"] - def test_success_with_files_remaining(self, caplog: LogCaptureFixture) -> None: + def test_success_with_files_remaining(self, caplog: pytest.LogCaptureFixture) -> None: """Test success with files remaining.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") transfer_type = "upload" @@ -1143,12 +1113,11 @@ def test_success_with_files_remaining(self, caplog: LogCaptureFixture) -> None: success_result = SuccessResult(transfer_type=transfer_type, src=src, dest=dest) self.result_printer(success_result) assert self.out_file.getvalue() == ( - "Completed 1.0 MiB/~4.0 MiB (0 Bytes/s) with ~3 file(s) " - "remaining (calculating...)\r" + "Completed 1.0 MiB/~4.0 MiB (0 Bytes/s) with ~3 file(s) remaining (calculating...)\r" ) assert caplog.messages == [f"upload: file to {dest}"] - def test_success_with_progress(self, caplog: LogCaptureFixture) -> None: + def test_success_with_progress(self, caplog: pytest.LogCaptureFixture) -> None: """Test success with progress.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") mb = 1024**2 @@ -1177,7 +1146,7 @@ def test_unknown_result_object(self) -> None: assert self.out_file.getvalue() == "" assert self.error_file.getvalue() == "" - def test_warning(self, caplog: LogCaptureFixture) -> None: + def test_warning(self, caplog: pytest.LogCaptureFixture) -> None: """Test warning.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") self.result_recorder.final_expected_files_transferred = 1 @@ -1186,7 +1155,7 @@ def test_warning(self, caplog: LogCaptureFixture) -> None: self.result_printer(PrintTask("warning: my warning")) assert caplog.messages == ["warning: my warning"] - def test_warning_unicode(self, caplog: LogCaptureFixture) -> None: + def test_warning_unicode(self, caplog: pytest.LogCaptureFixture) -> None: """Test warning.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") self.result_recorder.final_expected_files_transferred = 1 @@ -1195,7 +1164,7 @@ def test_warning_unicode(self, caplog: LogCaptureFixture) -> None: self.result_printer(PrintTask("warning: unicode exists \u2713")) assert caplog.messages == ["warning: unicode exists \u2713"] - def test_warning_with_progress(self, caplog: LogCaptureFixture) -> None: + def test_warning_with_progress(self, caplog: pytest.LogCaptureFixture) -> None: """Test warning.""" caplog.set_level(LogLevels.NOTICE, "runway.core.providers.aws.s3") shared_file = self.out_file @@ -1224,7 +1193,7 @@ class TestResultProcessor: """Test ResultProcessor.""" result_processor: ResultProcessor - result_queue: "Queue[Any]" + result_queue: Queue[Any] def setup_method(self) -> None: """Run before each test method if run to return the class instance attrs to default.""" @@ -1239,7 +1208,6 @@ def test_run_error(self, mocker: MockerFixture) -> None: self.result_queue.put(ShutdownThreadRequest()) assert not self.result_processor.run() mock_process_result.assert_called_once_with(error_result) - # pylint: disable=protected-access assert not self.result_processor._result_handlers_enabled def test_process_result_handle_error(self) -> None: @@ -1265,7 +1233,6 @@ def setup_method(self) -> None: def test_get_ongoing_dict_key(self) -> None: """Test _get_ongoing_dict_key.""" with pytest.raises(TypeError): - # pylint: disable=protected-access self.result_recorder._get_ongoing_dict_key(Mock()) # type: ignore def test_record_error_result(self) -> None: @@ -1277,9 +1244,7 @@ def test_record_error_result(self) -> None: def test_record_final_expected_files(self) -> None: """Test _record_final_expected_files.""" assert not self.result_recorder.final_expected_files_transferred - assert not self.result_recorder( - FinalTotalSubmissionsResult(total_submissions=13) - ) + assert not self.result_recorder(FinalTotalSubmissionsResult(total_submissions=13)) assert self.result_recorder.final_expected_files_transferred == 13 def test_record_progress_result_start_time(self, mocker: MockerFixture) -> None: @@ -1287,9 +1252,7 @@ def test_record_progress_result_start_time(self, mocker: MockerFixture) -> None: mock_time = mocker.patch("time.time", return_value=time.time()) assert not self.result_recorder.start_time assert not self.result_recorder( - ProgressResult( - total_transfer_size=13, timestamp=time.time(), bytes_transferred=0 - ) + ProgressResult(total_transfer_size=13, timestamp=time.time(), bytes_transferred=0) ) assert self.result_recorder.start_time == mock_time.return_value diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_s3handler.py b/tests/unit/core/providers/aws/s3/_helpers/test_s3handler.py index 1f4a8cbe8..0add05f28 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_s3handler.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_s3handler.py @@ -1,14 +1,13 @@ """Test runway.core.providers.aws.s3._helpers.s3handler.""" -# pylint: disable=redefined-outer-name,too-many-lines from __future__ import annotations from pathlib import Path from queue import Queue -from typing import TYPE_CHECKING, Any, ClassVar, Dict, NamedTuple, Optional, cast +from typing import TYPE_CHECKING, Any, ClassVar, NamedTuple, Optional, cast +from unittest.mock import MagicMock, Mock import pytest -from mock import MagicMock, Mock from s3transfer.manager import TransferManager from runway.core.providers.aws.s3._helpers.file_info import FileInfo @@ -70,25 +69,23 @@ class MockSubmitters(NamedTuple): """Named tuple return value of mock_submitters.""" - classes: Dict[str, Mock] - instances: Dict[str, Mock] + classes: dict[str, Mock] + instances: dict[str, Mock] -@pytest.fixture(scope="function") +@pytest.fixture() def mock_submitters(mocker: MockerFixture) -> MockSubmitters: """Mock handler submitters.""" classes = { "copy": mocker.patch(f"{MODULE}.CopyRequestSubmitter", Mock()), "delete": mocker.patch(f"{MODULE}.DeleteRequestSubmitter", Mock()), "download": mocker.patch(f"{MODULE}.DownloadRequestSubmitter", Mock()), - "download_stream": mocker.patch( - f"{MODULE}.DownloadStreamRequestSubmitter", Mock() - ), + "download_stream": mocker.patch(f"{MODULE}.DownloadStreamRequestSubmitter", Mock()), "local_delete": mocker.patch(f"{MODULE}.LocalDeleteRequestSubmitter", Mock()), "upload": mocker.patch(f"{MODULE}.UploadRequestSubmitter", Mock()), "upload_stream": mocker.patch(f"{MODULE}.UploadStreamRequestSubmitter", Mock()), } - instances: Dict[str, Mock] = {} + instances: dict[str, Mock] = {} for name, mock_class in classes.items(): inst = Mock(can_submit=Mock(return_value=False), submit=Mock(return_value=True)) mock_class.return_value = inst @@ -103,7 +100,7 @@ class BaseTransferRequestSubmitterTest: config_params: ParametersDataModel filename: ClassVar[str] = "test-file.txt" key: ClassVar[str] = "test-key.txt" - result_queue: "Queue[Any]" + result_queue: Queue[Any] transfer_manager: Mock def setup_method(self) -> None: @@ -135,12 +132,9 @@ def test_can_submit(self) -> None: ("s3://test", "s3://test"), ], ) - def test_format_s3_path( - self, expected: Optional[str], path: Optional[AnyPath] - ) -> None: + def test_format_s3_path(self, expected: Optional[str], path: Optional[AnyPath]) -> None: """Test _format_s3_path.""" assert ( - # pylint: disable=protected-access BaseTransferRequestSubmitter( Mock(), Mock(), ParametersDataModel(dest="", src="") )._format_s3_path(path) @@ -202,7 +196,7 @@ def test_submit(self) -> None: self.config_params["guess_mime_type"] = True future = self.transfer_request_submitter.submit(fileinfo) assert self.transfer_manager.copy.return_value is future - call_kwargs = cast(Dict[str, Any], self.transfer_manager.copy.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.copy.call_args[1]) assert call_kwargs["copy_source"] == { "Bucket": self.source_bucket, "Key": self.source_key, @@ -230,7 +224,7 @@ def test_submit_content_type_specified(self) -> None: self.config_params["content_type"] = "text/plain" self.transfer_request_submitter.submit(fileinfo) - copy_call_kwargs = cast(Dict[str, Any], self.transfer_manager.copy.call_args[1]) + copy_call_kwargs = cast(dict[str, Any], self.transfer_manager.copy.call_args[1]) assert copy_call_kwargs["extra_args"] == {"ContentType": "text/plain"} ref_subscribers = [ProvideSizeSubscriber, CopyResultSubscriber] actual_subscribers = copy_call_kwargs["subscribers"] @@ -269,7 +263,7 @@ def test_submit_extra_args(self) -> None: self.config_params["storage_class"] = "STANDARD_IA" self.transfer_request_submitter.submit(fileinfo) - call_kwargs = cast(Dict[str, Any], self.transfer_manager.copy.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.copy.call_args[1]) assert call_kwargs["extra_args"] == {"StorageClass": "STANDARD_IA"} def test_submit_move_adds_delete_source_subscriber(self) -> None: @@ -287,7 +281,7 @@ def test_submit_move_adds_delete_source_subscriber(self) -> None: DeleteSourceObjectSubscriber, CopyResultSubscriber, ] - call_kwargs = cast(Dict[str, Any], self.transfer_manager.copy.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.copy.call_args[1]) actual_subscribers = call_kwargs["subscribers"] assert len(ref_subscribers) == len(actual_subscribers) for i, actual_subscriber in enumerate(actual_subscribers): @@ -301,7 +295,7 @@ def test_submit_no_guess_content_mime_type(self) -> None: ) self.config_params["guess_mime_type"] = False self.transfer_request_submitter.submit(fileinfo) - call_kwargs = cast(Dict[str, Any], self.transfer_manager.copy.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.copy.call_args[1]) ref_subscribers = [ProvideSizeSubscriber, CopyResultSubscriber] actual_subscribers = call_kwargs["subscribers"] assert len(ref_subscribers) == len(actual_subscribers) @@ -348,10 +342,7 @@ def test_submit_warn_glacier_incompatible(self) -> None: warning_result = self.result_queue.get() assert isinstance(warning_result, PrintTask) - assert ( - "Unable to perform copy operations on GLACIER objects" - in warning_result.message - ) + assert "Unable to perform copy operations on GLACIER objects" in warning_result.message assert future is None assert len(self.transfer_manager.copy.call_args_list) == 0 # type: ignore @@ -392,13 +383,11 @@ def test_can_submit_local_delete(self) -> None: def test_submit(self) -> None: """Test submit.""" - fileinfo = FileInfo( - src=self.bucket + "/" + self.key, dest=None, operation_name="delete" - ) + fileinfo = FileInfo(src=self.bucket + "/" + self.key, dest=None, operation_name="delete") future = self.transfer_request_submitter.submit(fileinfo) assert self.transfer_manager.delete.return_value is future - call_kwargs = cast(Dict[str, Any], self.transfer_manager.delete.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.delete.call_args[1]) assert call_kwargs["bucket"] == self.bucket assert call_kwargs["key"] == self.key assert call_kwargs["extra_args"] == {} @@ -448,10 +437,10 @@ def assert_no_downloads_happened(self) -> None: assert len(self.transfer_manager.download.call_args_list) == 0 # type: ignore def create_file_info( - self, key: str, response_data: Optional[Dict[str, Any]] = None + self, key: str, response_data: Optional[dict[str, Any]] = None ) -> FileInfo: """Create FileInfo.""" - kwargs: Dict[str, Any] = { + kwargs: dict[str, Any] = { "src": self.bucket + "/" + key, "src_type": "s3", "dest": self.filename, @@ -479,7 +468,7 @@ def test_submit(self) -> None: fileinfo = self.create_file_info(self.key) future = self.transfer_request_submitter.submit(fileinfo) assert self.transfer_manager.download.return_value is future - call_kwargs = cast(Dict[str, Any], self.transfer_manager.download.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.download.call_args[1]) assert call_kwargs["fileobj"] == self.filename assert call_kwargs["bucket"] == self.bucket assert call_kwargs["key"] == self.key @@ -523,7 +512,7 @@ def test_submit_extra_args(self) -> None: self.config_params["sse_c"] = "AES256" self.config_params["sse_c_key"] = "test-key" self.transfer_request_submitter.submit(fileinfo) - call_kwargs = cast(Dict[str, Any], self.transfer_manager.download.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.download.call_args[1]) assert call_kwargs["extra_args"] == { "SSECustomerAlgorithm": "AES256", "SSECustomerKey": "test-key", @@ -542,7 +531,7 @@ def test_submit_move_adds_delete_source_subscriber(self) -> None: DeleteSourceObjectSubscriber, DownloadResultSubscriber, ] - call_kwargs = cast(Dict[str, Any], self.transfer_manager.download.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.download.call_args[1]) actual_subscribers = call_kwargs["subscribers"] assert len(ref_subscribers) == len(actual_subscribers) for i, actual_subscriber in enumerate(actual_subscribers): @@ -581,9 +570,7 @@ def test_warn_and_ignore_with_leading_chars(self) -> None: def test_submit_warn_glacier_force(self) -> None: """Test submit.""" self.config_params["force_glacier_transfer"] = True - fileinfo = self.create_file_info( - self.key, response_data={"StorageClass": "GLACIER"} - ) + fileinfo = self.create_file_info(self.key, response_data={"StorageClass": "GLACIER"}) future = self.transfer_request_submitter.submit(fileinfo) assert self.result_queue.empty() assert self.transfer_manager.download.return_value is future @@ -614,10 +601,7 @@ def test_submit_warn_glacier_incompatible(self) -> None: future = self.transfer_request_submitter.submit(fileinfo) warning_result = self.result_queue.get() assert isinstance(warning_result, PrintTask) - assert ( - "Unable to perform download operations on GLACIER objects" - in warning_result.message - ) + assert "Unable to perform download operations on GLACIER objects" in warning_result.message assert not future self.assert_no_downloads_happened() @@ -655,7 +639,7 @@ def test_submit(self) -> None: future = self.transfer_request_submitter.submit(fileinfo) assert self.transfer_manager.download.return_value is future - call_kwargs = cast(Dict[str, Any], self.transfer_manager.download.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.download.call_args[1]) assert isinstance(call_kwargs["fileobj"], StdoutBytesWriter) assert call_kwargs["bucket"] == self.bucket assert call_kwargs["key"] == self.key @@ -701,27 +685,21 @@ def setup_method(self) -> None: def test_can_submit(self) -> None: """Test can_submit.""" - fileinfo = FileInfo( - src=self.filename, dest=None, operation_name="delete", src_type="local" - ) + fileinfo = FileInfo(src=self.filename, dest=None, operation_name="delete", src_type="local") assert self.transfer_request_submitter.can_submit(fileinfo) fileinfo.operation_name = "foo" assert not self.transfer_request_submitter.can_submit(fileinfo) def test_can_submit_remote_deletes(self) -> None: """Test can_submit.""" - fileinfo = FileInfo( - src=self.filename, dest=None, operation_name="delete", src_type="s3" - ) + fileinfo = FileInfo(src=self.filename, dest=None, operation_name="delete", src_type="s3") assert not self.transfer_request_submitter.can_submit(fileinfo) def test_submit(self, tmp_path: Path) -> None: """Test submit.""" full_filename = tmp_path / self.filename full_filename.write_text("content") - fileinfo = FileInfo( - src=full_filename, dest=None, operation_name="delete", src_type="local" - ) + fileinfo = FileInfo(src=full_filename, dest=None, operation_name="delete", src_type="local") result = self.transfer_request_submitter.submit(fileinfo) assert result queued_result = self.result_queue.get() @@ -758,9 +736,7 @@ def test_dry_run(self) -> None: def test_submit_with_exception(self) -> None: """Test submit.""" - fileinfo = FileInfo( - src=self.filename, dest=None, operation_name="delete", src_type="local" - ) + fileinfo = FileInfo(src=self.filename, dest=None, operation_name="delete", src_type="local") result = self.transfer_request_submitter.submit(fileinfo) assert result @@ -783,7 +759,7 @@ class TestS3TransferHandler: config_params: ClassVar[ParametersDataModel] = ParametersDataModel(dest="", src="") result_command_recorder: CommandResultRecorder - result_queue: "Queue[Any]" + result_queue: Queue[Any] transfer_manager: TransferManager def setup_method(self) -> None: @@ -804,11 +780,9 @@ def test_call(self, mock_submitters: MockSubmitters, tmp_path: Path) -> None: ) fileinfos = [FileInfo(src=tmp_path)] assert handler.call(fileinfos) == "success" # type: ignore - mock_submitters.instances["copy"].can_submit.assert_called_once_with( - fileinfos[0] - ) + mock_submitters.instances["copy"].can_submit.assert_called_once_with(fileinfos[0]) mock_submitters.instances["copy"].submit.assert_called_once_with(fileinfos[0]) - self.result_command_recorder.notify_total_submissions.assert_called_once_with(1) # type: ignore # noqa + self.result_command_recorder.notify_total_submissions.assert_called_once_with(1) # type: ignore self.result_command_recorder.get_command_result.assert_called_once_with() # type: ignore @@ -817,7 +791,7 @@ class TestS3TransferHandlerFactory: config_params: ParametersDataModel client: S3Client - result_queue: "Queue[Any]" + result_queue: Queue[Any] runtime_config: TransferConfigDict def setup_method(self) -> None: @@ -839,12 +813,10 @@ def test_call_is_stream(self, mocker: MockerFixture) -> None: assert S3TransferHandlerFactory(self.config_params, self.runtime_config)( self.client, self.result_queue ) - call_kwargs = cast(Dict[str, Any], mock_processor.call_args[1]) + call_kwargs = cast(dict[str, Any], mock_processor.call_args[1]) assert len(call_kwargs["result_handlers"]) == 2 assert isinstance(call_kwargs["result_handlers"][0], ResultRecorder) - assert isinstance( - call_kwargs["result_handlers"][1], OnlyShowErrorsResultPrinter - ) + assert isinstance(call_kwargs["result_handlers"][1], OnlyShowErrorsResultPrinter) def test_call_no_progress(self, mocker: MockerFixture) -> None: """Test __call__.""" @@ -853,7 +825,7 @@ def test_call_no_progress(self, mocker: MockerFixture) -> None: assert S3TransferHandlerFactory(self.config_params, self.runtime_config)( self.client, self.result_queue ) - call_kwargs = cast(Dict[str, Any], mock_processor.call_args[1]) + call_kwargs = cast(dict[str, Any], mock_processor.call_args[1]) assert len(call_kwargs["result_handlers"]) == 2 assert isinstance(call_kwargs["result_handlers"][0], ResultRecorder) assert isinstance(call_kwargs["result_handlers"][1], NoProgressResultPrinter) @@ -865,12 +837,10 @@ def test_call_only_show_errors(self, mocker: MockerFixture) -> None: assert S3TransferHandlerFactory(self.config_params, self.runtime_config)( self.client, self.result_queue ) - call_kwargs = cast(Dict[str, Any], mock_processor.call_args[1]) + call_kwargs = cast(dict[str, Any], mock_processor.call_args[1]) assert len(call_kwargs["result_handlers"]) == 2 assert isinstance(call_kwargs["result_handlers"][0], ResultRecorder) - assert isinstance( - call_kwargs["result_handlers"][1], OnlyShowErrorsResultPrinter - ) + assert isinstance(call_kwargs["result_handlers"][1], OnlyShowErrorsResultPrinter) def test_call_quiet(self, mocker: MockerFixture) -> None: """Test __call__.""" @@ -879,7 +849,7 @@ def test_call_quiet(self, mocker: MockerFixture) -> None: assert S3TransferHandlerFactory(self.config_params, self.runtime_config)( self.client, self.result_queue ) - call_kwargs = cast(Dict[str, Any], mock_processor.call_args[1]) + call_kwargs = cast(dict[str, Any], mock_processor.call_args[1]) assert len(call_kwargs["result_handlers"]) == 1 assert isinstance(call_kwargs["result_handlers"][0], ResultRecorder) @@ -914,7 +884,7 @@ def test_submit(self) -> None: future = self.transfer_request_submitter.submit(fileinfo) assert self.transfer_manager.upload.return_value is future - call_kwargs = cast(Dict[str, Any], self.transfer_manager.upload.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.upload.call_args[1]) assert call_kwargs["fileobj"] == self.filename assert call_kwargs["bucket"] == self.bucket assert call_kwargs["key"] == self.key @@ -936,7 +906,7 @@ def test_submit_content_type_specified(self) -> None: self.config_params["content_type"] = "text/plain" self.transfer_request_submitter.submit(fileinfo) - call_kwargs = cast(Dict[str, Any], self.transfer_manager.upload.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.upload.call_args[1]) assert call_kwargs["extra_args"] == {"ContentType": "text/plain"} ref_subscribers = [ProvideSizeSubscriber, UploadResultSubscriber] actual_subscribers = call_kwargs["subscribers"] @@ -991,7 +961,7 @@ def test_submit_extra_args(self) -> None: self.config_params["storage_class"] = "STANDARD_IA" self.transfer_request_submitter.submit(fileinfo) - call_kwargs = cast(Dict[str, Any], self.transfer_manager.upload.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.upload.call_args[1]) assert call_kwargs["extra_args"] == {"StorageClass": "STANDARD_IA"} def test_submit_move_adds_delete_source_subscriber(self) -> None: @@ -1006,7 +976,7 @@ def test_submit_move_adds_delete_source_subscriber(self) -> None: DeleteSourceFileSubscriber, UploadResultSubscriber, ] - call_kwargs = cast(Dict[str, Any], self.transfer_manager.upload.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.upload.call_args[1]) actual_subscribers = call_kwargs["subscribers"] assert len(ref_subscribers) == len(actual_subscribers) for i, actual_subscriber in enumerate(actual_subscribers): @@ -1018,7 +988,7 @@ def test_submit_no_guess_content_mime_type(self) -> None: self.config_params["guess_mime_type"] = False self.transfer_request_submitter.submit(fileinfo) - call_kwargs = cast(Dict[str, Any], self.transfer_manager.upload.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.upload.call_args[1]) ref_subscribers = [ProvideSizeSubscriber, UploadResultSubscriber] actual_subscribers = call_kwargs["subscribers"] assert len(ref_subscribers) == len(actual_subscribers) @@ -1072,7 +1042,7 @@ def test_submit(self) -> None: future = self.transfer_request_submitter.submit(fileinfo) assert self.transfer_manager.upload.return_value is future - call_kwargs = cast(Dict[str, Any], self.transfer_manager.upload.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.upload.call_args[1]) assert isinstance(call_kwargs["fileobj"], NonSeekableStream) assert call_kwargs["bucket"] == self.bucket assert call_kwargs["key"] == self.key @@ -1108,7 +1078,7 @@ def test_submit_expected_size_provided(self) -> None: self.config_params["expected_size"] = provided_size fileinfo = FileInfo(src=self.filename, dest=self.bucket + "/" + self.key) self.transfer_request_submitter.submit(fileinfo) - call_kwargs = cast(Dict[str, Any], self.transfer_manager.upload.call_args[1]) + call_kwargs = cast(dict[str, Any], self.transfer_manager.upload.call_args[1]) ref_subscribers = [ProvideSizeSubscriber, UploadStreamResultSubscriber] actual_subscribers = call_kwargs["subscribers"] @@ -1129,7 +1099,4 @@ def test_submit_raise_stdin_missing(self, mocker: MockerFixture) -> None: ) with pytest.raises(StdinMissingError) as excinfo: self.transfer_request_submitter.submit(fileinfo) - assert ( - excinfo.value.message - == "stdin is required for this operation, but is not available" - ) + assert excinfo.value.message == "stdin is required for this operation, but is not available" diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_transfer_config.py b/tests/unit/core/providers/aws/s3/_helpers/test_transfer_config.py index fee3606f9..9b8c7dd50 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_transfer_config.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_transfer_config.py @@ -2,8 +2,6 @@ from __future__ import annotations -from typing import Dict - import pytest from s3transfer.manager import TransferConfig @@ -26,17 +24,12 @@ def test_build_config(self) -> None: def test_build_config_human_readable_rates_converted_to_bytes(self) -> None: """Test build_config.""" - assert ( - RuntimeConfig.build_config(max_bandwidth="1MB/s")["max_bandwidth"] - == 1024**2 - ) + assert RuntimeConfig.build_config(max_bandwidth="1MB/s")["max_bandwidth"] == 1024**2 def test_build_config_human_readable_sizes_converted_to_bytes(self) -> None: """Test build_config.""" assert ( - RuntimeConfig.build_config(multipart_threshold="10MB")[ - "multipart_threshold" - ] + RuntimeConfig.build_config(multipart_threshold="10MB")["multipart_threshold"] == 10 * 1024 * 1024 ) @@ -69,7 +62,7 @@ def test_build_config_partial_override(self) -> None: {"max_queue_size": "not an int"}, ], ) - def test_build_config_validates_integer_types(self, kwargs: Dict[str, str]) -> None: + def test_build_config_validates_integer_types(self, kwargs: dict[str, str]) -> None: """Test build_config.""" with pytest.raises(InvalidConfigError): RuntimeConfig.build_config(**kwargs) @@ -84,9 +77,7 @@ def test_build_config_validates_integer_types(self, kwargs: Dict[str, str]) -> N {"multipart_threshold": -15}, ], ) - def test_build_config_validates_positive_integers( - self, kwargs: Dict[str, str] - ) -> None: + def test_build_config_validates_positive_integers(self, kwargs: dict[str, str]) -> None: """Test build_config.""" with pytest.raises(InvalidConfigError): RuntimeConfig.build_config(**kwargs) diff --git a/tests/unit/core/providers/aws/s3/_helpers/test_utils.py b/tests/unit/core/providers/aws/s3/_helpers/test_utils.py index 799b89b88..38feb9090 100644 --- a/tests/unit/core/providers/aws/s3/_helpers/test_utils.py +++ b/tests/unit/core/providers/aws/s3/_helpers/test_utils.py @@ -1,6 +1,5 @@ """Test runway.core.providers.aws.s3._helpers.utils.""" -# pylint: disable=too-many-lines from __future__ import annotations import datetime @@ -13,7 +12,8 @@ from io import BytesIO from pathlib import Path from queue import Queue -from typing import TYPE_CHECKING, Any, ClassVar, Dict, List, Optional +from typing import TYPE_CHECKING, Any, ClassVar, Optional +from unittest.mock import Mock, PropertyMock, sentinel import boto3 import pytest @@ -21,7 +21,6 @@ from botocore.hooks import HierarchicalEmitter from botocore.stub import Stubber from dateutil.tz import tzlocal -from mock import Mock, PropertyMock, sentinel from s3transfer.compat import seekable from s3transfer.futures import TransferFuture @@ -90,9 +89,9 @@ class TestBucketLister: date_parser: ClassVar[Mock] = Mock(return_value=sentinel.now) emitter: ClassVar[HierarchicalEmitter] = HierarchicalEmitter() client: ClassVar[Mock] = Mock(meta=Mock(events=emitter)) - responses: List[Any] = [] + responses: list[Any] = [] - def fake_paginate(self, *_args: Any, **_kwargs: Any) -> List[Any]: + def fake_paginate(self, *_args: Any, **_kwargs: Any) -> list[Any]: """Fake paginate.""" for response in self.responses: self.emitter.emit("after-call.s3.ListObjectsV2", parsed=response) @@ -121,7 +120,7 @@ def test_list_objects(self) -> None: for individual_response in individual_response_elements: assert individual_response["LastModified"] == now - def test_list_objects_pass_extra_args(self): + def test_list_objects_pass_extra_args(self) -> None: """Test list_objects.""" self.client.get_paginator.return_value.paginate = Mock( return_value=[ @@ -137,18 +136,14 @@ def test_list_objects_pass_extra_args(self): ] ) lister = BucketLister(self.client, self.date_parser) - list( - lister.list_objects( - bucket="mybucket", extra_args={"RequestPayer": "requester"} - ) - ) + list(lister.list_objects(bucket="mybucket", extra_args={"RequestPayer": "requester"})) self.client.get_paginator.return_value.paginate.assert_called_with( Bucket="mybucket", PaginationConfig={"PageSize": None}, RequestPayer="requester", ) - def test_list_objects_pass_prefix(self): + def test_list_objects_pass_prefix(self) -> None: """Test list_objects.""" self.client.get_paginator.return_value.paginate = Mock( return_value=[ @@ -183,9 +178,7 @@ def test_on_done_delete(self) -> None: """Test on_done.""" client = boto3.client("s3") stubber = Stubber(client) - stubber.add_response( - "delete_object", {}, {"Bucket": self.bucket, "Key": self.key} - ) + stubber.add_response("delete_object", {}, {"Bucket": self.bucket, "Key": self.key}) future = Mock(meta=self.meta) with stubber: assert not DeleteCopySourceObjectSubscriber(client).on_done(future) @@ -232,9 +225,7 @@ def test_on_done_delete(self, tmp_path: Path) -> None: tmp_file = tmp_path / "test.txt" tmp_file.write_text("data") future = Mock( - meta=FakeTransferFutureMeta( - call_args=FakeTransferFutureCallArgs(fileobj=str(tmp_file)) - ) + meta=FakeTransferFutureMeta(call_args=FakeTransferFutureCallArgs(fileobj=str(tmp_file))) ) DeleteSourceFileSubscriber().on_done(future) assert not tmp_file.exists() @@ -244,9 +235,7 @@ def test_on_done_exception(self, tmp_path: Path) -> None: """Test on_done.""" tmp_file = tmp_path / "test.txt" future = Mock( - meta=FakeTransferFutureMeta( - call_args=FakeTransferFutureCallArgs(fileobj=str(tmp_file)) - ) + meta=FakeTransferFutureMeta(call_args=FakeTransferFutureCallArgs(fileobj=str(tmp_file))) ) DeleteSourceFileSubscriber().on_done(future) assert not tmp_file.exists() @@ -267,9 +256,7 @@ def test_on_done_delete(self) -> None: """Test on_done.""" client = boto3.client("s3") stubber = Stubber(client) - stubber.add_response( - "delete_object", {}, {"Bucket": self.bucket, "Key": self.key} - ) + stubber.add_response("delete_object", {}, {"Bucket": self.bucket, "Key": self.key}) future = Mock(meta=self.meta) with stubber: assert not DeleteSourceObjectSubscriber(client).on_done(future) @@ -348,7 +335,7 @@ def test_on_queued_exists(self, tmp_path: Path) -> None: assert tmp_dir.is_dir() future.set_exception.assert_not_called() - def test_on_queued_handle_eexist( + def test_on_queued_handle_eexist( # cspell: disable-line self, mocker: MockerFixture, tmp_path: Path ) -> None: """Test on_queued.""" @@ -359,8 +346,8 @@ def test_on_queued_handle_eexist( ) ) exc = OSError() - exc.errno = errno.EEXIST - mocker.patch("os.makedirs", side_effect=exc) + exc.errno = errno.EEXIST # cspell: disable-line + mocker.patch("pathlib.Path.mkdir", side_effect=exc) assert not DirectoryCreatorSubscriber().on_queued(future) assert not tmp_dir.exists() @@ -372,7 +359,7 @@ def test_on_queued_os_error(self, mocker: MockerFixture, tmp_path: Path) -> None call_args=FakeTransferFutureCallArgs(fileobj=tmp_dir / "test.txt") ) ) - mocker.patch("os.makedirs", side_effect=OSError()) + mocker.patch("pathlib.Path.mkdir", side_effect=OSError()) with pytest.raises(CreateDirectoryError): DirectoryCreatorSubscriber().on_queued(future) assert not tmp_dir.exists() @@ -400,10 +387,10 @@ class TestOnDoneFilteredSubscriber: class Subscriber(OnDoneFilteredSubscriber): """Subscriber subclass to test.""" - def __init__(self): + def __init__(self) -> None: """Instantiate class.""" - self.on_success_calls: List[Any] = [] - self.on_failure_calls: List[Any] = [] + self.on_success_calls: list[Any] = [] + self.on_failure_calls: list[Any] = [] def _on_success(self, future: Any) -> None: self.on_success_calls.append(future) @@ -411,26 +398,24 @@ def _on_success(self, future: Any) -> None: def _on_failure(self, future: Any, exception: Exception) -> None: self.on_failure_calls.append((future, exception)) - def test_on_done_failure(self): + def test_on_done_failure(self) -> None: """Test on_done.""" subscriber = self.Subscriber() exception = Exception("my exception") future = FakeTransferFuture(exception=exception) subscriber.on_done(future) # type: ignore assert subscriber.on_failure_calls == [(future, exception)] - assert not subscriber.on_success_calls and isinstance( - subscriber.on_success_calls, list - ) + assert not subscriber.on_success_calls + assert isinstance(subscriber.on_success_calls, list) - def test_on_done_success(self): + def test_on_done_success(self) -> None: """Test on_done.""" subscriber = self.Subscriber() future = FakeTransferFuture("return-value") subscriber.on_done(future) # type: ignore assert subscriber.on_success_calls == [future] - assert not subscriber.on_failure_calls and isinstance( - subscriber.on_failure_calls, list - ) + assert not subscriber.on_failure_calls + assert isinstance(subscriber.on_failure_calls, list) class TestProvideCopyContentTypeSubscriber: @@ -459,25 +444,19 @@ class TestProvideLastModifiedTimeSubscriber: desired_utime: ClassVar[datetime.datetime] = datetime.datetime( 2016, 1, 18, 7, 0, 0, tzinfo=tzlocal() ) - result_queue: ClassVar["Queue[Any]"] = Queue() - subscriber: ClassVar[ProvideLastModifiedTimeSubscriber] = ( - ProvideLastModifiedTimeSubscriber(desired_utime, result_queue) + result_queue: ClassVar[Queue[Any]] = Queue() + subscriber: ClassVar[ProvideLastModifiedTimeSubscriber] = ProvideLastModifiedTimeSubscriber( + desired_utime, result_queue ) - def test_on_done_handle_exception( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test_on_done_handle_exception(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test on_done.""" tmp_file = tmp_path / "test.txt" tmp_file.touch() future = FakeTransferFuture( - meta=FakeTransferFutureMeta( - call_args=FakeTransferFutureCallArgs(fileobj=tmp_file) - ) - ) - mock_create_warning = mocker.patch( - f"{MODULE}.create_warning", return_value="warning" + meta=FakeTransferFutureMeta(call_args=FakeTransferFutureCallArgs(fileobj=tmp_file)) ) + mock_create_warning = mocker.patch(f"{MODULE}.create_warning", return_value="warning") assert not ProvideLastModifiedTimeSubscriber( None, self.result_queue # type: ignore ).on_done( @@ -485,10 +464,7 @@ def test_on_done_handle_exception( ) mock_create_warning.assert_called_once() assert mock_create_warning.call_args[0][0] == tmp_file - assert ( - "was unable to update the last modified time." - in mock_create_warning.call_args[0][1] - ) + assert "was unable to update the last modified time." in mock_create_warning.call_args[0][1] assert self.result_queue.get() == "warning" def test_on_done_modifies_utime(self, tmp_path: Path) -> None: @@ -496,9 +472,7 @@ def test_on_done_modifies_utime(self, tmp_path: Path) -> None: tmp_file = tmp_path / "test.txt" tmp_file.touch() future = FakeTransferFuture( - meta=FakeTransferFutureMeta( - call_args=FakeTransferFutureCallArgs(fileobj=tmp_file) - ) + meta=FakeTransferFutureMeta(call_args=FakeTransferFutureCallArgs(fileobj=tmp_file)) ) assert not self.subscriber.on_done(future) # type: ignore _, utime = get_file_stat(tmp_file) @@ -523,9 +497,7 @@ class TestProvideUploadContentTypeSubscriber: def test_on_queued(self) -> None: """Test on_queued.""" future = FakeTransferFuture( - meta=FakeTransferFutureMeta( - call_args=FakeTransferFutureCallArgs(fileobj="test.txt") - ) + meta=FakeTransferFutureMeta(call_args=FakeTransferFutureCallArgs(fileobj="test.txt")) ) assert not ProvideUploadContentTypeSubscriber().on_queued(future) # type: ignore assert future.meta.call_args.extra_args.get("ContentType") == "text/plain" @@ -534,7 +506,7 @@ def test_on_queued(self) -> None: class TestRequestParamsMapper: """Test RequestParamsMapper.""" - params: ClassVar[Dict[str, str]] = { + params: ClassVar[dict[str, str]] = { "sse": "AES256", "sse_kms_key_id": "my-kms-key", "sse_c": "AES256", @@ -545,7 +517,7 @@ class TestRequestParamsMapper: def test_map_copy_object_params(self) -> None: """Test map_copy_object_params.""" - params: Dict[str, str] = {} + params: dict[str, str] = {} assert not RequestParamsMapper.map_copy_object_params( params, {"metadata": "something", **self.params} ) @@ -562,7 +534,7 @@ def test_map_copy_object_params(self) -> None: def test_map_copy_object_params_metadata_directive(self) -> None: """Test map_copy_object_params.""" - params: Dict[str, str] = {} + params: dict[str, str] = {} assert not RequestParamsMapper.map_copy_object_params( params, {"metadata_directive": "something", **self.params} ) @@ -578,10 +550,8 @@ def test_map_copy_object_params_metadata_directive(self) -> None: def test_map_create_multipart_upload_params(self) -> None: """Test map_create_multipart_upload_params.""" - params: Dict[str, str] = {} - assert not RequestParamsMapper.map_create_multipart_upload_params( - params, self.params - ) + params: dict[str, str] = {} + assert not RequestParamsMapper.map_create_multipart_upload_params(params, self.params) assert params == { "SSECustomerAlgorithm": "AES256", "SSECustomerKey": "my-sse-c-key", @@ -591,7 +561,7 @@ def test_map_create_multipart_upload_params(self) -> None: def test_map_delete_object_params(self) -> None: """Test map_delete_object_params.""" - params: Dict[str, Any] = {} + params: dict[str, Any] = {} assert not RequestParamsMapper.map_delete_object_params( params, {"request_payer": "requester", **self.params} ) @@ -599,7 +569,7 @@ def test_map_delete_object_params(self) -> None: def test_map_get_object_params(self) -> None: """Test map_get_object_params.""" - params: Dict[str, str] = {} + params: dict[str, str] = {} assert not RequestParamsMapper.map_get_object_params(params, self.params) assert params == { "SSECustomerAlgorithm": "AES256", @@ -608,7 +578,7 @@ def test_map_get_object_params(self) -> None: def test_map_head_object_params(self) -> None: """Test map_head_object_params.""" - params: Dict[str, str] = {} + params: dict[str, str] = {} assert not RequestParamsMapper.map_head_object_params(params, self.params) assert params == { "SSECustomerAlgorithm": "AES256", @@ -617,7 +587,7 @@ def test_map_head_object_params(self) -> None: def test_map_list_objects_v2_params(self) -> None: """Test map_list_objects_v2_params.""" - params: Dict[str, Any] = {} + params: dict[str, Any] = {} assert not RequestParamsMapper.map_list_objects_v2_params( params, {"request_payer": "requester", **self.params} ) @@ -625,7 +595,7 @@ def test_map_list_objects_v2_params(self) -> None: def test_map_put_object_params(self) -> None: """Test map_put_object_params.""" - params: Dict[str, str] = {} + params: dict[str, str] = {} assert not RequestParamsMapper.map_put_object_params( params, { @@ -653,28 +623,25 @@ def test_map_put_object_params(self) -> None: def test_map_put_object_params_raise_value_error_format(self) -> None: """Test map_put_object_params.""" - params: Dict[str, str] = {} - with pytest.raises(ValueError) as excinfo: + params: dict[str, str] = {} + with pytest.raises(ValueError, match="grants should be of the form permission=principal"): RequestParamsMapper.map_put_object_params( params, {"grants": ["invalid"], **self.params} ) - assert str(excinfo.value) == "grants should be of the form permission=principal" def test_map_put_object_params_raise_value_error_permission(self) -> None: """Test map_put_object_params.""" - params: Dict[str, str] = {} - with pytest.raises(ValueError) as excinfo: + params: dict[str, str] = {} + with pytest.raises( + ValueError, match="permission must be one of: read|readacl|writeacl|full" + ): RequestParamsMapper.map_put_object_params( params, {"grants": ["invalid=test-read"], **self.params} ) - assert ( - str(excinfo.value) - == "permission must be one of: read|readacl|writeacl|full" - ) def test_map_upload_part_params(self) -> None: """Test map_upload_part_params.""" - params: Dict[str, str] = {} + params: dict[str, str] = {} assert not RequestParamsMapper.map_upload_part_params(params, self.params) assert params == { "SSECustomerAlgorithm": "AES256", @@ -683,7 +650,7 @@ def test_map_upload_part_params(self) -> None: def test_map_upload_part_copy_params(self) -> None: """Test map_upload_part_copy_params.""" - params: Dict[str, str] = {} + params: dict[str, str] = {} assert not RequestParamsMapper.map_upload_part_copy_params(params, self.params) assert params == { "CopySourceSSECustomerAlgorithm": "AES256", @@ -725,22 +692,18 @@ def test_write_no_stdout(self, mocker: MockerFixture) -> None: def test_block_s3_object_lambda_raise_colon() -> None: """Test block_s3_object_lambda.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="S3 action does not support S3 Object Lambda resources"): block_s3_object_lambda( - "arn:aws:s3-object-lambda:us-west-2:123456789012:" - "accesspoint:my-accesspoint" + "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:my-accesspoint" ) - assert "does not support S3 Object Lambda resources" in str(excinfo.value) def test_block_s3_object_lambda_raise_slash() -> None: """Test block_s3_object_lambda.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="S3 action does not support S3 Object Lambda resources"): block_s3_object_lambda( - "arn:aws:s3-object-lambda:us-west-2:123456789012:" - "accesspoint/my-accesspoint" + "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/my-accesspoint" ) - assert "does not support S3 Object Lambda resources" in str(excinfo.value) def test_create_warning() -> None: @@ -806,28 +769,28 @@ def test_date_parser_datetime() -> None: "pre/key", ), ( - "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", # noqa - "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", # noqa + "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", + "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", "", ), ( - "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint/key", # noqa - "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", # noqa + "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint/key", + "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", "key", ), ( - "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint/key:name", # noqa - "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", # noqa + "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint/key:name", + "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", "key:name", ), ( - "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint/key/name", # noqa - "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", # noqa + "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint/key/name", + "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", "key/name", ), ( - "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint/prefix/key:name", # noqa - "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", # noqa + "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint/prefix/key:name", + "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-12334:accesspoint:my-accesspoint", "prefix/key:name", ), ], @@ -909,11 +872,10 @@ def test_get_file_stat_handle_timestamp_error( def test_get_file_stat_raise_value_error(mocker: MockerFixture, tmp_path: Path) -> None: """Test get_file_stat.""" - mocker.patch.object(Path, "stat", PropertyMock(side_effect=IOError("msg"))) + mocker.patch.object(Path, "stat", PropertyMock(side_effect=OSError("msg"))) tmp_file = tmp_path / "test.txt" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="Could not retrieve file stat"): get_file_stat(tmp_file) - assert str(excinfo.value) == f"Could not retrieve file stat of {tmp_file}: msg" def test_guess_content_type(mocker: MockerFixture, tmp_path: Path) -> None: @@ -984,23 +946,18 @@ def test_human_readable_to_bytes(expected: int, value: str) -> None: def test_human_readable_to_bytes_raise_value_error() -> None: """Test human_readable_to_bytes.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="Invalid size value"): human_readable_to_bytes("test") - assert str(excinfo.value) == "Invalid size value: test" -@pytest.mark.skipif( - platform.system() == "Windows", reason="crashes xdist worker on Windows" -) -def test_relative_path_handle_value_error( - mocker: MockerFixture, tmp_path: Path -) -> None: +@pytest.mark.skipif(platform.system() == "Windows", reason="crashes xdist worker on Windows") +def test_relative_path_handle_value_error(mocker: MockerFixture, tmp_path: Path) -> None: """Test relative_path.""" tmp_file = tmp_path / "test.txt" mocker.patch("os.path.split", side_effect=ValueError()) result = relative_path(tmp_file, tmp_path) assert isinstance(result, str) - assert os.path.isabs(result) + assert Path(result).is_absolute() @pytest.mark.parametrize( @@ -1057,7 +1014,7 @@ def test_set_file_utime_raise_os_error(mocker: MockerFixture, tmp_path: Path) -> mocker.patch("os.utime", side_effect=OSError(2, "")) now = datetime.datetime.now(tzlocal()) epoch_now = time.mktime(now.timetuple()) - with pytest.raises(OSError): + with pytest.raises(OSError): # noqa: PT011 set_file_utime(tmp_file, epoch_now) @@ -1073,9 +1030,7 @@ def test_uni_print_handle_unicode_encoding_error() -> None: """Test uni_print.""" out_file = Mock( encoding=None, - write=Mock( - side_effect=[UnicodeEncodeError("test", "test", 0, 0, "test"), None] - ), + write=Mock(side_effect=[UnicodeEncodeError("test", "test", 0, 0, "test"), None]), ) assert not uni_print("test", out_file) assert out_file.write.call_count == 2 diff --git a/tests/unit/core/providers/aws/s3/test_bucket.py b/tests/unit/core/providers/aws/s3/test_bucket.py index e603fe8ff..8ddc70828 100644 --- a/tests/unit/core/providers/aws/s3/test_bucket.py +++ b/tests/unit/core/providers/aws/s3/test_bucket.py @@ -6,15 +6,14 @@ import logging from http import HTTPStatus from typing import TYPE_CHECKING +from unittest.mock import MagicMock import pytest -from mock import MagicMock from runway.core.providers.aws import BaseResponse from runway.core.providers.aws.s3 import Bucket if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from .....factories import MockRunwayContext @@ -87,7 +86,7 @@ def test_create(self, runway_context: MockRunwayContext) -> None: stubber.assert_no_pending_responses() def test_create_exists( - self, caplog: LogCaptureFixture, runway_context: MockRunwayContext + self, caplog: pytest.LogCaptureFixture, runway_context: MockRunwayContext ) -> None: """Test create with exists=True.""" caplog.set_level(logging.DEBUG, logger="runway.core.providers.aws.s3.bucket") @@ -106,7 +105,7 @@ def test_create_exists( assert "bucket already exists" in "\n".join(caplog.messages) def test_create_forbidden( - self, caplog: LogCaptureFixture, runway_context: MockRunwayContext + self, caplog: pytest.LogCaptureFixture, runway_context: MockRunwayContext ) -> None: """Test create with forbidden=True.""" caplog.set_level(logging.DEBUG, logger="runway.core.providers.aws.s3.bucket") @@ -178,7 +177,7 @@ def test_enable_versioning(self, runway_context: MockRunwayContext) -> None: stubber.assert_no_pending_responses() def test_enable_versioning_skipped( - self, caplog: LogCaptureFixture, runway_context: MockRunwayContext + self, caplog: pytest.LogCaptureFixture, runway_context: MockRunwayContext ) -> None: """Test enable_versioning with Status=Enabled.""" caplog.set_level(logging.DEBUG, logger="runway.core.providers.aws.s3.bucket") @@ -231,9 +230,7 @@ def test_forbidden( ) -> None: """Test forbidden.""" response = BaseResponse() - response.metadata.http_status_code = ( - HTTPStatus.FORBIDDEN if forbidden else HTTPStatus.OK - ) + response.metadata.http_status_code = HTTPStatus.FORBIDDEN if forbidden else HTTPStatus.OK mocker.patch.object(Bucket, "head", response) assert Bucket(runway_context, "test-bucket").forbidden is expected @@ -256,9 +253,7 @@ def test_get_versioning(self, runway_context: MockRunwayContext) -> None: response = {"Status": "Enabled", "MFADelete": "Enabled"} - stubber.add_response( - "get_bucket_versioning", response, {"Bucket": "test-bucket"} - ) + stubber.add_response("get_bucket_versioning", response, {"Bucket": "test-bucket"}) with stubber: assert bucket.get_versioning() == response @@ -281,7 +276,7 @@ def test_head(self, runway_context: MockRunwayContext) -> None: stubber.assert_no_pending_responses() def test_head_clienterror( - self, caplog: LogCaptureFixture, runway_context: MockRunwayContext + self, caplog: pytest.LogCaptureFixture, runway_context: MockRunwayContext ) -> None: """Test head with ClientError.""" caplog.set_level(logging.DEBUG, logger="runway.core.providers.aws.s3.bucket") @@ -311,9 +306,7 @@ def test_not_found( ) -> None: """Test not_found.""" response = BaseResponse() - response.metadata.http_status_code = ( - HTTPStatus.NOT_FOUND if not_found else HTTPStatus.OK - ) + response.metadata.http_status_code = HTTPStatus.NOT_FOUND if not_found else HTTPStatus.OK mocker.patch.object(Bucket, "head", response) assert Bucket(runway_context, "test-bucket").not_found is expected @@ -322,9 +315,7 @@ def test_sync_from_local( ) -> None: """Test sync_from_local.""" mock_handler = MagicMock() - mock_handler_class = mocker.patch( - f"{MODULE}.S3SyncHandler", return_value=mock_handler - ) + mock_handler_class = mocker.patch(f"{MODULE}.S3SyncHandler", return_value=mock_handler) runway_context.add_stubber("s3") src_directory = "/test/" obj = Bucket(runway_context, "test-bucket") @@ -343,20 +334,14 @@ def test_sync_from_local( ) mock_handler.run.assert_called_once_with() - def test_sync_to_local( - self, mocker: MockerFixture, runway_context: MockRunwayContext - ) -> None: + def test_sync_to_local(self, mocker: MockerFixture, runway_context: MockRunwayContext) -> None: """Test sync_to_local.""" mock_handler = MagicMock() - mock_handler_class = mocker.patch( - f"{MODULE}.S3SyncHandler", return_value=mock_handler - ) + mock_handler_class = mocker.patch(f"{MODULE}.S3SyncHandler", return_value=mock_handler) runway_context.add_stubber("s3") dest_directory = "/test/" obj = Bucket(runway_context, "test-bucket") - assert not obj.sync_to_local( - dest_directory, follow_symlinks=True, include=["something"] - ) + assert not obj.sync_to_local(dest_directory, follow_symlinks=True, include=["something"]) mock_handler_class.assert_called_once_with( context=runway_context, delete=False, diff --git a/tests/unit/core/providers/aws/s3/test_sync_handler.py b/tests/unit/core/providers/aws/s3/test_sync_handler.py index 6909e8154..d4188e069 100644 --- a/tests/unit/core/providers/aws/s3/test_sync_handler.py +++ b/tests/unit/core/providers/aws/s3/test_sync_handler.py @@ -1,11 +1,9 @@ """Test runway.core.providers.aws.s3._sync_handler.""" -# pylint: disable=protected-access from __future__ import annotations from typing import TYPE_CHECKING - -from mock import Mock +from unittest.mock import Mock from runway.core.providers.aws.s3._sync_handler import S3SyncHandler @@ -27,17 +25,11 @@ def test_client(self, runway_context: MockRunwayContext) -> None: runway_context, dest="", src="" ).client == runway_context.get_session().client("s3") - def test_run( - self, mocker: MockerFixture, runway_context: MockRunwayContext - ) -> None: + def test_run(self, mocker: MockerFixture, runway_context: MockRunwayContext) -> None: """Test run.""" - mock_register_sync_strategies = mocker.patch( - f"{MODULE}.register_sync_strategies" - ) + mock_register_sync_strategies = mocker.patch(f"{MODULE}.register_sync_strategies") mock_action = mocker.patch(f"{MODULE}.ActionArchitecture") - transfer_config = mocker.patch.object( - S3SyncHandler, "transfer_config", {"key": "val"} - ) + transfer_config = mocker.patch.object(S3SyncHandler, "transfer_config", {"key": "val"}) obj = S3SyncHandler(runway_context, dest="", src="") assert not obj.run() mock_register_sync_strategies.assert_called_once_with(obj._botocore_session) diff --git a/tests/unit/core/providers/aws/test_account.py b/tests/unit/core/providers/aws/test_account.py index f55299a05..06ba2516f 100644 --- a/tests/unit/core/providers/aws/test_account.py +++ b/tests/unit/core/providers/aws/test_account.py @@ -50,7 +50,5 @@ def test_id_raise_value_error(self, runway_context: MockRunwayContext) -> None: {"UserId": "test-user", "Arn": arn}, ) account = AccountDetails(runway_context) - with stubber, pytest.raises( - ValueError, match="get_caller_identity did not return Account" - ): + with stubber, pytest.raises(ValueError, match="get_caller_identity did not return Account"): assert not account.id diff --git a/tests/unit/core/providers/aws/test_assume_role.py b/tests/unit/core/providers/aws/test_assume_role.py index 9b31693ff..75ab2e872 100644 --- a/tests/unit/core/providers/aws/test_assume_role.py +++ b/tests/unit/core/providers/aws/test_assume_role.py @@ -12,7 +12,6 @@ from runway.core.providers.aws import AssumeRole if TYPE_CHECKING: - from pytest import LogCaptureFixture from ....factories import MockRunwayContext @@ -82,13 +81,16 @@ def test_assume_role_no_revert_on_exit(runway_context: MockRunwayContext) -> Non assert runway_context.env.aws_credentials != NEW_CREDENTIALS - with stubber, AssumeRole( - runway_context, - role_arn=ROLE_ARN, - duration_seconds=900, - revert_on_exit=False, - session_name="runway-test", - ) as result: + with ( + stubber, + AssumeRole( + runway_context, + role_arn=ROLE_ARN, + duration_seconds=900, + revert_on_exit=False, + session_name="runway-test", + ) as result, + ): assert runway_context.env.aws_credentials == NEW_CREDENTIALS assert result.role_arn == ROLE_ARN assert result.duration_seconds == 900 @@ -100,7 +102,7 @@ def test_assume_role_no_revert_on_exit(runway_context: MockRunwayContext) -> Non def test_assume_role_no_role( - caplog: LogCaptureFixture, runway_context: MockRunwayContext + caplog: pytest.LogCaptureFixture, runway_context: MockRunwayContext ) -> None: """Test AssumeRole with no role_arn.""" caplog.set_level(logging.DEBUG, logger="runway") @@ -123,8 +125,9 @@ def test_assume_role_raise_value_error(runway_context: MockRunwayContext) -> Non {"RoleArn": ROLE_ARN, "RoleSessionName": "runway", "DurationSeconds": 3600}, ) - with stubber, pytest.raises( - ValueError, match="assume_role did not return Credentials" + with ( + stubber, + pytest.raises(ValueError, match="assume_role did not return Credentials"), + AssumeRole(runway_context, role_arn=ROLE_ARN), ): - with AssumeRole(runway_context, role_arn=ROLE_ARN): - raise AssertionError + raise AssertionError diff --git a/tests/unit/core/test_core.py b/tests/unit/core/test_core.py index c0c99be95..8b53e49cd 100644 --- a/tests/unit/core/test_core.py +++ b/tests/unit/core/test_core.py @@ -4,15 +4,14 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any +from unittest.mock import MagicMock, call import pytest -from mock import MagicMock, call from runway.core import Runway if TYPE_CHECKING: - from pytest import LogCaptureFixture, MonkeyPatch from pytest_mock import MockerFixture from ..factories import MockRunwayConfig, MockRunwayContext @@ -38,8 +37,8 @@ def test___init___( def test___init___undetermined_version( self, - caplog: LogCaptureFixture, - monkeypatch: MonkeyPatch, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, runway_config: MockRunwayConfig, runway_context: MockRunwayContext, ) -> None: @@ -51,7 +50,7 @@ def test___init___undetermined_version( def test___init___unsupported_version( self, - monkeypatch: MonkeyPatch, + monkeypatch: pytest.MonkeyPatch, runway_config: MockRunwayConfig, runway_context: MockRunwayContext, ) -> None: @@ -220,8 +219,8 @@ def test_reverse_deployments(self) -> None: def test_test( self, - caplog: LogCaptureFixture, - monkeypatch: MonkeyPatch, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, runway_config: MockRunwayConfig, runway_context: MockRunwayContext, ) -> None: @@ -229,12 +228,8 @@ def test_test( caplog.set_level(logging.ERROR, logger="runway") test_handlers = { "exception": MagicMock(handle=MagicMock(side_effect=Exception())), - "fail_system_exit_0": MagicMock( - handle=MagicMock(side_effect=SystemExit(0)) - ), - "fail_system_exit_1": MagicMock( - handle=MagicMock(side_effect=SystemExit(1)) - ), + "fail_system_exit_0": MagicMock(handle=MagicMock(side_effect=SystemExit(0))), + "fail_system_exit_1": MagicMock(handle=MagicMock(side_effect=SystemExit(1))), "success": MagicMock(), } monkeypatch.setattr(MODULE + "._TEST_HANDLERS", test_handlers) @@ -246,9 +241,7 @@ def test_test( ] assert not obj.test() assert "the following tests failed" not in "\n".join(caplog.messages) - test_handlers["success"].handle.assert_called_with( - obj.tests[0].name, obj.tests[0].args - ) + test_handlers["success"].handle.assert_called_with(obj.tests[0].name, obj.tests[0].args) test_handlers["fail_system_exit_0"].handle.assert_called_with( obj.tests[1].name, obj.tests[1].args ) @@ -281,25 +274,20 @@ def test_test( assert not obj.test() assert excinfo.value.code == 1 assert "exception:running test (fail)" in caplog.messages - assert ( - "exception:test required; the remaining tests have been skipped" - in caplog.messages - ) - test_handlers["exception"].handle.assert_called_with( - obj.tests[0].name, obj.tests[0].args - ) + assert "exception:test required; the remaining tests have been skipped" in caplog.messages + test_handlers["exception"].handle.assert_called_with(obj.tests[0].name, obj.tests[0].args) assert test_handlers["success"].handle.call_count == 1 def test_test_keyerror( self, - caplog: LogCaptureFixture, - monkeypatch: MonkeyPatch, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, runway_config: MockRunwayConfig, runway_context: MockRunwayContext, ) -> None: """Test test with handler not found.""" caplog.set_level(logging.ERROR, logger="runway") - test_handlers: Dict[str, Any] = {} + test_handlers: dict[str, Any] = {} monkeypatch.setattr(MODULE + "._TEST_HANDLERS", test_handlers) obj = Runway(runway_config, runway_context) # type: ignore @@ -319,7 +307,7 @@ def test_test_keyerror( def test_test_no_tests( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, runway_config: MockRunwayConfig, runway_context: MockRunwayContext, ) -> None: diff --git a/tests/unit/dependency_managers/test__pip.py b/tests/unit/dependency_managers/test__pip.py index a922ef3fa..cd41e8ae6 100644 --- a/tests/unit/dependency_managers/test__pip.py +++ b/tests/unit/dependency_managers/test__pip.py @@ -5,16 +5,15 @@ import logging import subprocess from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Union +from typing import TYPE_CHECKING, Any, Union +from unittest.mock import Mock import pytest -from mock import Mock from runway.compat import shlex_join from runway.dependency_managers import Pip, PipInstallFailedError if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture MODULE = "runway.dependency_managers._pip" @@ -36,9 +35,7 @@ def test_config_files(self) -> None: ({"file_name": "foo.txt"}, True), ], ) - def test_dir_is_project( - self, expected: bool, kwargs: Dict[str, str], tmp_path: Path - ) -> None: + def test_dir_is_project(self, expected: bool, kwargs: dict[str, str], tmp_path: Path) -> None: """Test dir_is_project.""" requirements_txt = tmp_path / kwargs.get("file_name", "requirements.txt") if expected: @@ -50,8 +47,8 @@ def test_dir_is_project( @pytest.mark.parametrize("command", ["test", ["test"]]) def test_generate_command( self, - caplog: LogCaptureFixture, - command: Union[List[str], str], + caplog: pytest.LogCaptureFixture, + command: Union[list[str], str], mocker: MockerFixture, ) -> None: """Test generate_command.""" @@ -89,7 +86,7 @@ def test_generate_command( ], ) def test_generate_install_command( - self, call_args: Dict[str, Any], expected: Dict[str, Any], mocker: MockerFixture + self, call_args: dict[str, Any], expected: dict[str, Any], mocker: MockerFixture ) -> None: """Test generate_install_command.""" expected.setdefault("cache_dir", None) @@ -117,9 +114,7 @@ def test_install( mock_generate_install_command = mocker.patch.object( Pip, "generate_install_command", return_value=["generate_install_command"] ) - mock_run_command = mocker.patch.object( - Pip, "_run_command", return_value="_run_command" - ) + mock_run_command = mocker.patch.object(Pip, "_run_command", return_value="_run_command") assert ( Pip(Mock(), tmp_path).install( @@ -138,7 +133,7 @@ def test_install( target=target, ) mock_run_command.assert_called_once_with( - mock_generate_install_command.return_value + ["--foo", "bar"], + [*mock_generate_install_command.return_value, "--foo", "bar"], suppress_output=False, ) @@ -158,9 +153,7 @@ def test_install_raise_from_called_process_error( ) with pytest.raises(PipInstallFailedError) as excinfo: - assert Pip(Mock(), tmp_path).install( - requirements=requirements_txt, target=target - ) + assert Pip(Mock(), tmp_path).install(requirements=requirements_txt, target=target) assert ( excinfo.value.message == "pip failed to install dependencies; " "review pip's output above to troubleshoot" @@ -180,9 +173,7 @@ def test_python_version( self, cmd_output: str, expected: str, mocker: MockerFixture, tmp_path: Path ) -> None: """Test python_version.""" - mock_run_command = mocker.patch.object( - Pip, "_run_command", return_value=cmd_output - ) + mock_run_command = mocker.patch.object(Pip, "_run_command", return_value=cmd_output) version_cls = mocker.patch(f"{MODULE}.Version", return_value="success") assert Pip(Mock(), tmp_path).python_version == version_cls.return_value mock_run_command.assert_called_once_with([Pip.EXECUTABLE, "--version"]) @@ -202,9 +193,7 @@ def test_version( self, cmd_output: str, expected: str, mocker: MockerFixture, tmp_path: Path ) -> None: """Test version.""" - mock_run_command = mocker.patch.object( - Pip, "_run_command", return_value=cmd_output - ) + mock_run_command = mocker.patch.object(Pip, "_run_command", return_value=cmd_output) version_cls = mocker.patch(f"{MODULE}.Version", return_value="success") assert Pip(Mock(), tmp_path).version == version_cls.return_value mock_run_command.assert_called_once_with([Pip.EXECUTABLE, "--version"]) diff --git a/tests/unit/dependency_managers/test__pipenv.py b/tests/unit/dependency_managers/test__pipenv.py index 081414b0e..8ac918da2 100644 --- a/tests/unit/dependency_managers/test__pipenv.py +++ b/tests/unit/dependency_managers/test__pipenv.py @@ -4,17 +4,16 @@ import logging import subprocess -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any +from unittest.mock import Mock import pytest -from mock import Mock from runway.dependency_managers import Pipenv, PipenvExportFailedError if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture from pytest_mock import MockerFixture MODULE = "runway.dependency_managers._pipenv" @@ -33,7 +32,7 @@ def test_config_files(self) -> None: ) def test_dir_is_project( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, lock_exists: bool, pipfile_exists: bool, tmp_path: Path, @@ -61,7 +60,7 @@ def test_dir_is_project( ) def test_export( self, - export_kwargs: Dict[str, Any], + export_kwargs: dict[str, Any], mocker: MockerFixture, tmp_path: Path, ) -> None: @@ -70,9 +69,7 @@ def test_export( mock_generate_command = mocker.patch.object( Pipenv, "generate_command", return_value="generate_command" ) - mock_run_command = mocker.patch.object( - Pipenv, "_run_command", return_value="_run_command" - ) + mock_run_command = mocker.patch.object(Pipenv, "_run_command", return_value="_run_command") obj = Pipenv(Mock(), tmp_path) assert obj.export(output=expected, **export_kwargs) == expected assert expected.is_file() @@ -116,9 +113,7 @@ def test_version( self, cmd_output: str, expected: str, mocker: MockerFixture, tmp_path: Path ) -> None: """Test version.""" - mock_run_command = mocker.patch.object( - Pipenv, "_run_command", return_value=cmd_output - ) + mock_run_command = mocker.patch.object(Pipenv, "_run_command", return_value=cmd_output) version_cls = mocker.patch(f"{MODULE}.Version", return_value="success") assert Pipenv(Mock(), tmp_path).version == version_cls.return_value mock_run_command.assert_called_once_with([Pipenv.EXECUTABLE, "--version"]) diff --git a/tests/unit/dependency_managers/test__poetry.py b/tests/unit/dependency_managers/test__poetry.py index a74469206..dc88fb3e7 100644 --- a/tests/unit/dependency_managers/test__poetry.py +++ b/tests/unit/dependency_managers/test__poetry.py @@ -3,11 +3,11 @@ from __future__ import annotations import subprocess -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any +from unittest.mock import Mock import pytest import tomli_w -from mock import Mock from runway.dependency_managers import Poetry, PoetryExportFailedError @@ -42,7 +42,7 @@ def test_config_files(self) -> None: ], ) def test_dir_is_project( - self, build_system: Dict[str, Any], expected: bool, tmp_path: Path + self, build_system: dict[str, Any], expected: bool, tmp_path: Path ) -> None: """Test dir_is_project.""" pyproject_contents = {"build-system": build_system} @@ -69,7 +69,7 @@ def test_dir_is_project_file_not_found(self, tmp_path: Path) -> None: ) def test_export( self, - export_kwargs: Dict[str, Any], + export_kwargs: dict[str, Any], mocker: MockerFixture, tmp_path: Path, ) -> None: @@ -78,18 +78,14 @@ def test_export( mock_generate_command = mocker.patch.object( Poetry, "generate_command", return_value="generate_command" ) - mock_run_command = mocker.patch.object( - Poetry, "_run_command", return_value="_run_command" - ) + mock_run_command = mocker.patch.object(Poetry, "_run_command", return_value="_run_command") (tmp_path / "test.requirements.txt").touch() # created by _run_command obj = Poetry(Mock(), tmp_path) assert obj.export(output=expected, **export_kwargs) == expected assert expected.is_file() export_kwargs.update({"output": expected.name}) - export_kwargs.update( - {"format": export_kwargs.pop("output_format", "requirements.txt")} - ) + export_kwargs.update({"format": export_kwargs.pop("output_format", "requirements.txt")}) export_kwargs.setdefault("dev", False) export_kwargs.setdefault("extras", None) export_kwargs.setdefault("with_credentials", True) @@ -120,10 +116,7 @@ def test_export_raise_from_called_process_error( with pytest.raises(PoetryExportFailedError) as excinfo: assert Poetry(Mock(), tmp_path).export(output=output) - assert ( - excinfo.value.message - == "poetry export failed with the following output:\nstderr" - ) + assert excinfo.value.message == "poetry export failed with the following output:\nstderr" def test_export_raise_when_output_does_not_exist( self, @@ -133,9 +126,7 @@ def test_export_raise_when_output_does_not_exist( """Test export raise PoetryExportFailedError from CalledProcessError.""" output = tmp_path / "expected" / "test.requirements.txt" mocker.patch.object(Poetry, "generate_command", return_value="generate_command") - mock_run_command = mocker.patch.object( - Poetry, "_run_command", return_value="_run_command" - ) + mock_run_command = mocker.patch.object(Poetry, "_run_command", return_value="_run_command") with pytest.raises(PoetryExportFailedError) as excinfo: assert Poetry(Mock(), tmp_path).export(output=output) @@ -152,9 +143,7 @@ def test_version( self, cmd_output: str, expected: str, mocker: MockerFixture, tmp_path: Path ) -> None: """Test version.""" - mock_run_command = mocker.patch.object( - Poetry, "_run_command", return_value=cmd_output - ) + mock_run_command = mocker.patch.object(Poetry, "_run_command", return_value=cmd_output) version_cls = mocker.patch(f"{MODULE}.Version", return_value="success") assert Poetry(Mock(), tmp_path).version == version_cls.return_value mock_run_command.assert_called_once_with([Poetry.EXECUTABLE, "--version"]) diff --git a/tests/unit/dependency_managers/test_base_classes.py b/tests/unit/dependency_managers/test_base_classes.py index 15b3b484d..3f5bdeb9f 100644 --- a/tests/unit/dependency_managers/test_base_classes.py +++ b/tests/unit/dependency_managers/test_base_classes.py @@ -3,9 +3,9 @@ from __future__ import annotations from typing import TYPE_CHECKING +from unittest.mock import Mock import pytest -from mock import Mock from runway.dependency_managers.base_classes import DependencyManager diff --git a/tests/unit/env_mgr/test_env_mgr.py b/tests/unit/env_mgr/test_env_mgr.py index cc6400412..a0886cda0 100644 --- a/tests/unit/env_mgr/test_env_mgr.py +++ b/tests/unit/env_mgr/test_env_mgr.py @@ -1,7 +1,5 @@ """Test runway.env_mgr.""" -# pylint: disable=unused-argument -# pyright: basic from __future__ import annotations import logging @@ -14,7 +12,6 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture, MonkeyPatch from pytest_mock import MockerFixture @@ -22,7 +19,7 @@ class TestEnvManager: """Test runway.env_mgr.EnvManager.""" def test___init___darwin( - self, platform_darwin: None, cd_tmp_path: Path, mocker: MockerFixture + self, platform_darwin: None, cd_tmp_path: Path, mocker: MockerFixture # noqa: ARG002 ) -> None: """Test __init__ on Darwin platform.""" home = cd_tmp_path / "home" @@ -37,10 +34,10 @@ def test___init___darwin( def test___init___windows( self, - platform_windows: None, + platform_windows: None, # noqa: ARG002 cd_tmp_path: Path, mocker: MockerFixture, - monkeypatch: MonkeyPatch, + monkeypatch: pytest.MonkeyPatch, ) -> None: """Test __init__ on Windows platform.""" home = cd_tmp_path / "home" @@ -57,7 +54,10 @@ def test___init___windows( assert obj.versions_dir == expected_env_dir / "versions" def test___init___windows_appdata( - self, platform_windows: None, cd_tmp_path: Path, monkeypatch: MonkeyPatch + self, + platform_windows: None, # noqa: ARG002 + cd_tmp_path: Path, + monkeypatch: pytest.MonkeyPatch, ) -> None: """Test __init__ on Windows platform.""" monkeypatch.setenv("APPDATA", str(cd_tmp_path / "custom_path")) @@ -72,7 +72,7 @@ def test___init___windows_appdata( assert obj.versions_dir == expected_env_dir / "versions" def test_bin( - self, platform_darwin: None, cd_tmp_path: Path, mocker: MockerFixture + self, platform_darwin: None, cd_tmp_path: Path, mocker: MockerFixture # noqa: ARG002 ) -> None: """Test bin.""" home = cd_tmp_path / "home" @@ -101,7 +101,7 @@ def test_path(self, cd_tmp_path: Path) -> None: @pytest.mark.parametrize("exists", [False, True]) def test_uninstall( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, exists: bool, mocker: MockerFixture, tmp_path: Path, @@ -119,10 +119,7 @@ def test_uninstall( version_dir.mkdir() (version_dir / "foo").touch() assert obj.uninstall(version) - assert ( - f"uninstalling {bin_name} {version} from {tmp_path}..." - in caplog.messages - ) + assert f"uninstalling {bin_name} {version} from {tmp_path}..." in caplog.messages assert f"uninstalled {bin_name} {version}" in caplog.messages else: assert not obj.uninstall(version) diff --git a/tests/unit/env_mgr/test_kbenv.py b/tests/unit/env_mgr/test_kbenv.py index ad3a7da70..122ab59bb 100644 --- a/tests/unit/env_mgr/test_kbenv.py +++ b/tests/unit/env_mgr/test_kbenv.py @@ -44,11 +44,7 @@ def test_install_version_requested( obj = KBEnvManager(tmp_path) assert obj.install(version_requested) == str(obj.bin) mock_download_kb_release.assert_called_once_with( - ( - version_requested - if version_requested.startswith("v") - else f"v{version_requested}" - ), + (version_requested if version_requested.startswith("v") else f"v{version_requested}"), obj.versions_dir, ) @@ -77,9 +73,7 @@ def test_list_installed_none(self, mocker: MockerFixture, tmp_path: Path) -> Non ("v0.15.0-alpha.13", Version("v0.15.0-alpha.13")), ], ) - def test_parse_version_string( - self, provided: str, expected: Optional[Version] - ) -> None: + def test_parse_version_string(self, provided: str, expected: Optional[Version]) -> None: """Test parse_version_string.""" assert KBEnvManager.parse_version_string(provided) == expected @@ -114,9 +108,7 @@ def test_set_version_same(self, mocker: MockerFixture, tmp_path: Path) -> None: def test_version(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test version.""" - get_version_from_file = mocker.patch.object( - KBEnvManager, "get_version_from_file" - ) + get_version_from_file = mocker.patch.object(KBEnvManager, "get_version_from_file") parse_version_string = mocker.patch.object( KBEnvManager, "parse_version_string", return_value="success" ) @@ -126,9 +118,7 @@ def test_version(self, mocker: MockerFixture, tmp_path: Path) -> None: get_version_from_file.assert_not_called() parse_version_string.assert_called_once_with("version") - def test_version_get_version_from_file( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test_version_get_version_from_file(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test version.""" get_version_from_file = mocker.patch.object( KBEnvManager, "get_version_from_file", return_value="version" @@ -179,6 +169,4 @@ def test_version_file(self, tmp_path: Path) -> None: expected = overlay_path / KB_VERSION_FILENAME expected.touch() assert obj.version_file == mod_path / KB_VERSION_FILENAME - assert ( - KBEnvManager(mod_path, overlay_path=overlay_path).version_file == expected - ) + assert KBEnvManager(mod_path, overlay_path=overlay_path).version_file == expected diff --git a/tests/unit/env_mgr/test_tfenv.py b/tests/unit/env_mgr/test_tfenv.py index 7f6c66113..3b45d1af4 100644 --- a/tests/unit/env_mgr/test_tfenv.py +++ b/tests/unit/env_mgr/test_tfenv.py @@ -6,12 +6,12 @@ import json import re import subprocess -from typing import TYPE_CHECKING, Any, Dict, List, Optional +from typing import TYPE_CHECKING, Any, Optional +from unittest.mock import MagicMock, call import hcl import hcl2 import pytest -from mock import MagicMock, call from runway._logging import LogLevels from runway.env_mgr.tfenv import ( @@ -28,7 +28,6 @@ from pathlib import Path from types import ModuleType - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from pytest_subprocess import FakeProcess @@ -64,9 +63,7 @@ def test_get_available_tf_versions(mocker: MockerFixture) -> None: """Test runway.env_mgr.tfenv.get_available_tf_versions.""" mock_requests = mocker.patch(f"{MODULE}.requests") - response: Dict[str, Any] = { - "terraform": {"versions": {"0.12.0": {}, "0.12.0-beta": {}}} - } + response: dict[str, Any] = {"terraform": {"versions": {"0.12.0": {}, "0.12.0-beta": {}}}} mock_requests.get.return_value = MagicMock(text=json.dumps(response)) assert get_available_tf_versions() == ["0.12.0"] assert get_available_tf_versions(include_prerelease=True) == [ @@ -94,7 +91,7 @@ def test_get_latest_tf_version(mocker: MockerFixture) -> None: ], ) def test_load_terraform_module( - parser: ModuleType, expected: Dict[str, Any], tmp_path: Path + parser: ModuleType, expected: dict[str, Any], tmp_path: Path ) -> None: """Test runway.env_mgr.tfenv.load_terraform_module.""" tf_file = tmp_path / "module.tf" @@ -153,8 +150,8 @@ class TestTFEnvManager: def test_backend( self, mocker: MockerFixture, - response: Dict[str, Any], - expected: Dict[str, Any], + response: dict[str, Any], + expected: dict[str, Any], tmp_path: Path, ) -> None: """Test backend.""" @@ -200,21 +197,13 @@ def test_get_version_from_executable( output: str, ) -> None: """Test get_version_from_executable.""" - fake_process.register_subprocess( - ["usr/tfenv/terraform", "-version"], stdout=output - ) - assert ( - TFEnvManager.get_version_from_executable("usr/tfenv/terraform") == expected - ) + fake_process.register_subprocess(["usr/tfenv/terraform", "-version"], stdout=output) + assert TFEnvManager.get_version_from_executable("usr/tfenv/terraform") == expected def test_get_version_from_executable_raise(self, fake_process: FakeProcess) -> None: """Test get_version_from_executable raise exception.""" - fake_process.register_subprocess( - ["usr/tfenv/terraform", "-version"], returncode=1 - ) - with pytest.raises( - subprocess.CalledProcessError, match="returned non-zero exit status 1" - ): + fake_process.register_subprocess(["usr/tfenv/terraform", "-version"], returncode=1) + with pytest.raises(subprocess.CalledProcessError, match="returned non-zero exit status 1"): TFEnvManager.get_version_from_executable("usr/tfenv/terraform") def test_get_version_from_file(self, tmp_path: Path) -> None: @@ -248,9 +237,7 @@ def test_install(self, mocker: MockerFixture, tmp_path: Path) -> None: str(version), tfenv.versions_dir, tfenv.command_suffix ) - def test_install_already_installed( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test_install_already_installed(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test install.""" version = Version("0.15.5") mocker.patch.object(TFEnvManager, "version", version) @@ -267,9 +254,7 @@ def test_install_set_version(self, mocker: MockerFixture, tmp_path: Path) -> Non mocker.patch.object(TFEnvManager, "version", version) mocker.patch.object(TFEnvManager, "versions_dir", tmp_path) mock_download = mocker.patch(f"{MODULE}.download_tf_release") - mock_set_version = mocker.patch.object( - TFEnvManager, "set_version", return_value=None - ) + mock_set_version = mocker.patch.object(TFEnvManager, "set_version", return_value=None) tfenv = TFEnvManager(tmp_path) assert tfenv.install(str(version)) mock_download.assert_called_once_with( @@ -277,15 +262,11 @@ def test_install_set_version(self, mocker: MockerFixture, tmp_path: Path) -> Non ) mock_set_version.assert_called_once_with(str(version)) - def test_install_version_undefined( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test_install_version_undefined(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test install.""" mocker.patch.object(TFEnvManager, "version", None) tfenv = TFEnvManager(tmp_path) - with pytest.raises( - ValueError, match=r"^version not provided and unable to find .*" - ): + with pytest.raises(ValueError, match=r"^version not provided and unable to find .*"): tfenv.install() def test_list_installed(self, mocker: MockerFixture, tmp_path: Path) -> None: @@ -311,9 +292,7 @@ def test_list_installed_none(self, mocker: MockerFixture, tmp_path: Path) -> Non ("0.15.0-alpha13", Version("0.15.0-alpha13")), ], ) - def test_parse_version_string( - self, provided: str, expected: Optional[Version] - ) -> None: + def test_parse_version_string(self, provided: str, expected: Optional[Version]) -> None: """Test parse_version_string.""" assert TFEnvManager.parse_version_string(provided) == expected @@ -404,10 +383,10 @@ def test_set_version_same(self, mocker: MockerFixture, tmp_path: Path) -> None: ) def test_terraform_block( self, - caplog: LogCaptureFixture, - expected: Dict[str, Any], + caplog: pytest.LogCaptureFixture, + expected: dict[str, Any], mocker: MockerFixture, - response: List[Any], + response: list[Any], tmp_path: Path, ) -> None: """Test terraform_block.""" @@ -461,9 +440,7 @@ def test_version_latest(self, mocker: MockerFixture, tmp_path: Path) -> None: mock_get_version_from_file.assert_called_once_with() mock_get_available_tf_versions.assert_called_once_with(False) - def test_version_latest_partial( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test_version_latest_partial(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test version latest.""" version = Version("0.14.3") mocker.patch.object(TFEnvManager, "versions_dir", tmp_path) diff --git a/tests/unit/factories.py b/tests/unit/factories.py index 61db31633..ffa454c26 100644 --- a/tests/unit/factories.py +++ b/tests/unit/factories.py @@ -1,48 +1,53 @@ """Test classes.""" -# pyright: basic, reportIncompatibleMethodOverride=none +# pyright: reportIncompatibleMethodOverride=none from __future__ import annotations -from typing import TYPE_CHECKING, Any, Dict, List, MutableMapping, Optional, Tuple +from functools import cached_property +from typing import TYPE_CHECKING, Any, cast +from unittest.mock import MagicMock import boto3 import yaml from botocore.stub import Stubber -from mock import MagicMock from packaging.specifiers import SpecifierSet from runway.config.components.runway import RunwayDeploymentDefinition from runway.context import CfnginContext, RunwayContext -from runway.core.components import DeployEnvironment from runway.utils import MutableMap if TYPE_CHECKING: + from collections.abc import MutableMapping from pathlib import Path from boto3.resources.base import ServiceResource from botocore.client import BaseClient + from mypy_boto3_s3.client import S3Client from runway.config import CfnginConfig + from runway.core.components import DeployEnvironment from runway.core.type_defs import RunwayActionTypeDef class MockBoto3Session: - """Mock class that acts like a boto3.session. + """Mock class that acts like a :class:`boto3.session.Session`. - Must be preloaded with stubbers. + Clients must be registered using :meth:`~pytest_runway.MockBoto3Session.register_client` + before the can be created with the usual :meth:`~pytest_runway.MockBoto3Session.client` + call. This is to ensure that all AWS calls are stubbed. """ def __init__( self, *, - clients: Optional[MutableMap] = None, - aws_access_key_id: Optional[str] = None, - aws_secret_access_key: Optional[str] = None, - aws_session_token: Optional[str] = None, - profile_name: Optional[str] = None, - region_name: Optional[str] = None, - ): + clients: MutableMap | None = None, + aws_access_key_id: str | None = None, + aws_secret_access_key: str | None = None, + aws_session_token: str | None = None, + profile_name: str | None = None, + region_name: str | None = None, + ) -> None: """Instantiate class. Args: @@ -55,7 +60,6 @@ def __init__( """ self._clients = clients or MutableMap() - self._client_calls: Dict[str, Any] = {} self._session = MagicMock() self.aws_access_key_id = aws_access_key_id self.aws_secret_access_key = aws_secret_access_key @@ -63,81 +67,95 @@ def __init__( self.profile_name = profile_name self.region_name = region_name - def assert_client_called_with(self, service_name: str, **kwargs: Any) -> None: - """Assert a client was created with the provided kwargs.""" - key = f"{service_name}.{kwargs.get('region_name', self.region_name)}" - assert self._client_calls[key] == kwargs - def client(self, service_name: str, **kwargs: Any) -> BaseClient: """Return a stubbed client. Args: service_name: The name of a service, e.g. 's3' or 'ec2'. + **kwargs: Arbitrary keyword arguments. Returns: Stubbed boto3 client. Raises: - KeyError: Client was not stubbed from Context before trying to use. + ValueError: Client was not stubbed from Context before trying to use. """ - key = f"{service_name}.{kwargs.get('region_name', self.region_name)}" - self._client_calls[key] = kwargs - return self._clients[key] + key = f"{service_name}.{kwargs.get('region_name') or self.region_name}" + try: + return self._clients[key] + except AttributeError: + raise ValueError(f"client not registered for {key}") from None def register_client( - self, service_name: str, region_name: Optional[str] = None - ) -> Tuple[Any, Stubber]: + self, service_name: str, *, region: str | None = None + ) -> tuple[Any, Stubber]: """Register a client for the boto3 session. Args: service_name: The name of a service, e.g. 's3' or 'ec2'. - region_name: AWS region. + region: AWS region. """ - key = f"{service_name}.{region_name or self.region_name}" - client = boto3.client( # type: ignore - service_name, # type: ignore - region_name=region_name or self.region_name, + key = f"{service_name}.{region or self.region_name}" + client = cast( + "BaseClient", + boto3.client( + service_name, # pyright: ignore[reportCallIssue, reportArgumentType] + region_name=region or self.region_name, + ), ) - stubber = Stubber(client) # type: ignore - self._clients[key] = client # type: ignore - return client, stubber # type: ignore + stubber = Stubber(client) + self._clients[key] = client + return client, stubber def resource(self, service_name: str, **kwargs: Any) -> ServiceResource: """Return a stubbed resource.""" kwargs.setdefault("region_name", self.region_name) - resource: ServiceResource = boto3.resource(service_name, **kwargs) # type: ignore - resource.meta.client = self._clients[f"{service_name}.{kwargs['region_name']}"] + resource = cast( + "ServiceResource", + boto3.resource( + service_name, # pyright: ignore[reportCallIssue, reportArgumentType] + **kwargs, + ), + ) + resource.meta.client = self.client(service_name, **kwargs) return resource - def service(self, service_name: str, region_name: Optional[str] = None) -> None: - """Not implimented.""" + def service(self, service_name: str, *, region_name: str | None = None) -> None: + """Not implemented.""" raise NotImplementedError -class MockCFNginContext(CfnginContext): - """Subclass CFNgin context object for tests.""" +class MockCfnginContext(CfnginContext): + """Subclass of :class:`~runway.context.CfnginContext` for tests.""" def __init__( self, *, - config_path: Optional[Path] = None, - config: Optional[CfnginConfig] = None, - deploy_environment: Optional[DeployEnvironment] = None, - parameters: Optional[MutableMapping[str, Any]] = None, - force_stacks: Optional[List[str]] = None, - region: Optional[str] = "us-east-1", - stack_names: Optional[List[str]] = None, - work_dir: Optional[Path] = None, + config: CfnginConfig | None = None, + config_path: Path | None = None, + deploy_environment: DeployEnvironment, + force_stacks: list[str] | None = None, + parameters: MutableMapping[str, Any] | None = None, + stack_names: list[str] | None = None, + work_dir: Path | None = None, **_: Any, ) -> None: - """Instantiate class.""" - self._boto3_test_client = MutableMap() - self._boto3_test_stubber = MutableMap() + """Instantiate class. - # used during init process - self.s3_stubber = self.add_stubber("s3", region=region) + Args: + config: The CFNgin configuration being operated on. + config_path: Path to the config file that was provided. + deploy_environment: The current deploy environment. + force_stacks: A list of stacks to force work on. Used to work on locked stacks. + parameters: Parameters passed from Runway or read from a file. + stack_names: A list of stack_names to operate on. If not passed, + all stacks defined in the config will be operated on. + work_dir: Working directory used by CFNgin. + + """ + self._boto3_sessions: dict[str, MockBoto3Session] = {} super().__init__( config_path=config_path, @@ -149,42 +167,113 @@ def __init__( work_dir=work_dir, ) - def add_stubber(self, service_name: str, region: Optional[str] = None) -> Stubber: + @cached_property + def s3_client(self) -> S3Client: + """AWS S3 client. + + Adds an S3 stubber prior to returning from :attr:`~runway.context.CfnginContext.s3_client`. + + """ + self.add_stubber("s3", region=self.bucket_region) + return super().s3_client + + def add_stubber( + self, + service_name: str, + *, + aws_access_key_id: str | None = None, + aws_secret_access_key: str | None = None, + aws_session_token: str | None = None, + profile: str | None = None, + region: str | None = None, + ) -> Stubber: """Add a stubber to context. Args: - service_name: The name of a service, e.g. 's3' or 'ec2'. - region: AWS region. + service_name: The name of the service to stub. + aws_access_key_id: AWS Access Key ID. + aws_secret_access_key: AWS secret Access Key. + aws_session_token: AWS session token. + profile: The profile for the session. + region: The region for the session. """ - key = f"{service_name}.{region or self.env.aws_region}" - - self._boto3_test_client[key] = boto3.client( # type: ignore - service_name, # type: ignore - region_name=region or self.env.aws_region, + session = self._get_mocked_session( + aws_access_key_id=aws_access_key_id, + aws_secret_access_key=aws_secret_access_key, + aws_session_token=aws_session_token, + profile=profile, + region=region or self.env.aws_region, ) - self._boto3_test_stubber[key] = Stubber(self._boto3_test_client[key]) - return self._boto3_test_stubber[key] + _client, stubber = session.register_client(service_name, region=region) + return stubber - def get_session( + def _get_mocked_session( self, *, - aws_access_key_id: Optional[str] = None, - aws_secret_access_key: Optional[str] = None, - aws_session_token: Optional[str] = None, - profile: Optional[str] = None, - region: Optional[str] = None, + aws_access_key_id: str | None = None, + aws_secret_access_key: str | None = None, + aws_session_token: str | None = None, + profile: str | None = None, + region: str | None = None, ) -> MockBoto3Session: - """Wrap get_session to enable stubbing.""" - return MockBoto3Session( - aws_access_key_id=aws_access_key_id, - aws_secret_access_key=aws_secret_access_key, - aws_session_token=aws_session_token, - clients=self._boto3_test_client, - profile_name=profile, - region_name=region or self.env.aws_region, + """Get a mocked boto3 session.""" + region = region or self.env.aws_region + if region not in self._boto3_sessions: + self._boto3_sessions[region] = MockBoto3Session( + aws_access_key_id=aws_access_key_id, + aws_secret_access_key=aws_secret_access_key, + aws_session_token=aws_session_token, + profile_name=profile, + region_name=region or self.env.aws_region, + ) + return self._boto3_sessions[region] + + def get_session( + self, + *, + aws_access_key_id: str | None = None, + aws_secret_access_key: str | None = None, + aws_session_token: str | None = None, + profile: str | None = None, + region: str | None = None, + ) -> boto3.Session: + """Wrap get_session to enable stubbing. + + A stubber must exist before ``get_session`` is called or an error will be raised. + + Args: + aws_access_key_id: AWS Access Key ID. + aws_secret_access_key: AWS secret Access Key. + aws_session_token: AWS session token. + profile: The profile for the session. + region: The region for the session. + + """ + return cast( + boto3.Session, + self._get_mocked_session( + aws_access_key_id=aws_access_key_id, + aws_secret_access_key=aws_secret_access_key, + aws_session_token=aws_session_token, + profile=profile, + region=region or self.env.aws_region, + ), ) + def get_stubbed_client(self, service_name: str, *, region: str | None = None) -> BaseClient: + """Get an existing stubbed client. + + This can be used after :meth:`~pytest_runway.MockCfnginContext.add_stubber` has + been called to get the stubber client. + + Args: + service_name: The name of the service that was stubbed. + region: The region of the session. + + """ + return self._get_mocked_session(region=region).client(service_name, region_name=region) + class MockRunwayConfig(MutableMap): """Mock Runway config object.""" @@ -201,9 +290,7 @@ def __init__(self, **kwargs: Any) -> None: self.variables = MutableMap() # classmethods - self.find_config_file = MagicMock( - name="find_config_file", return_value="./runway.yml" - ) + self.find_config_file = MagicMock(name="find_config_file", return_value="./runway.yml") self.load_from_file = MagicMock(name="load_from_file", return_value=self) def __call__(self, **kwargs: Any) -> MockRunwayConfig: @@ -213,72 +300,37 @@ def __call__(self, **kwargs: Any) -> MockRunwayConfig: class MockRunwayContext(RunwayContext): - """Subclass Runway context object for tests.""" + """Subclass of :class:`~runway.context.RunwayContext` for tests.""" - _use_concurrent: bool + _use_concurrent: bool = True def __init__( self, *, - command: Optional[RunwayActionTypeDef] = None, - deploy_environment: Any = None, - work_dir: Optional[Path] = None, + command: RunwayActionTypeDef | None = None, + deploy_environment: DeployEnvironment, + work_dir: Path | None = None, **_: Any, ) -> None: - """Instantiate class.""" - if not deploy_environment: - deploy_environment = DeployEnvironment(environ={}, explicit_name="test") - super().__init__( - command=command, deploy_environment=deploy_environment, work_dir=work_dir - ) - self._boto3_test_client = MutableMap() - self._boto3_test_stubber = MutableMap() - self._use_concurrent = True - - def add_stubber(self, service_name: str, region: Optional[str] = None) -> Stubber: - """Add a stubber to context. + """Instantiate class. Args: - service_name: The name of a service, e.g. 's3' or 'ec2'. - region: AWS region name. + command: Runway command/action being run. + deploy_environment: The current deploy environment. + work_dir: Working directory used by Runway. """ - key = f"{service_name}.{region or self.env.aws_region}" + self._boto3_sessions: dict[str, MockBoto3Session] = {} - self._boto3_test_client[key] = boto3.client( # type: ignore - service_name, # type: ignore - region_name=region or self.env.aws_region, - **self.boto3_credentials, - ) - self._boto3_test_stubber[key] = Stubber(self._boto3_test_client[key]) - return self._boto3_test_stubber[key] - - def get_session( - self, - *, - aws_access_key_id: Optional[str] = None, - aws_secret_access_key: Optional[str] = None, - aws_session_token: Optional[str] = None, - profile: Optional[str] = None, - region: Optional[str] = None, - ) -> MockBoto3Session: - """Wrap get_session to enable stubbing.""" - return MockBoto3Session( - aws_access_key_id=aws_access_key_id, - aws_secret_access_key=aws_secret_access_key, - aws_session_token=aws_session_token, - clients=self._boto3_test_client, - profile_name=profile, - region_name=region or self.env.aws_region, - ) + super().__init__(command=command, deploy_environment=deploy_environment, work_dir=work_dir) @property - def use_concurrent(self) -> bool: # pylint: disable=invalid-overridden-method + def use_concurrent(self) -> bool: """Override property of parent with something that can be set.""" return self._use_concurrent - @use_concurrent.setter # type: ignore - def use_concurrent( # pylint: disable=invalid-overridden-method + @use_concurrent.setter + def use_concurrent( # pyright: ignore[reportIncompatibleVariableOverride] self, value: bool ) -> None: """Override property of parent with something that can be set. @@ -289,12 +341,109 @@ def use_concurrent( # pylint: disable=invalid-overridden-method """ self._use_concurrent = value + def add_stubber( + self, + service_name: str, + *, + aws_access_key_id: str | None = None, + aws_secret_access_key: str | None = None, + aws_session_token: str | None = None, + profile: str | None = None, + region: str | None = None, + ) -> Stubber: + """Add a stubber to context. + + Args: + service_name: The name of the service to stub. + aws_access_key_id: AWS Access Key ID. + aws_secret_access_key: AWS secret Access Key. + aws_session_token: AWS session token. + profile: The profile for the session. + region: The region for the session. + + """ + session = self._get_mocked_session( + aws_access_key_id=aws_access_key_id, + aws_secret_access_key=aws_secret_access_key, + aws_session_token=aws_session_token, + profile=profile, + region=region or self.env.aws_region, + ) + _client, stubber = session.register_client(service_name, region=region) + return stubber + + def _get_mocked_session( + self, + *, + aws_access_key_id: str | None = None, + aws_secret_access_key: str | None = None, + aws_session_token: str | None = None, + profile: str | None = None, + region: str | None = None, + ) -> MockBoto3Session: + """Get a mocked boto3 session.""" + region = region or self.env.aws_region + if region not in self._boto3_sessions: + self._boto3_sessions[region] = MockBoto3Session( + aws_access_key_id=aws_access_key_id, + aws_secret_access_key=aws_secret_access_key, + aws_session_token=aws_session_token, + profile_name=profile, + region_name=region or self.env.aws_region, + ) + return self._boto3_sessions[region] + + def get_session( + self, + *, + aws_access_key_id: str | None = None, + aws_secret_access_key: str | None = None, + aws_session_token: str | None = None, + profile: str | None = None, + region: str | None = None, + ) -> boto3.Session: + """Wrap get_session to enable stubbing. + + A stubber must exist before ``get_session`` is called or an error will be raised. + + Args: + aws_access_key_id: AWS Access Key ID. + aws_secret_access_key: AWS secret Access Key. + aws_session_token: AWS session token. + profile: The profile for the session. + region: The region for the session. + + """ + return cast( + boto3.Session, + self._get_mocked_session( + aws_access_key_id=aws_access_key_id, + aws_secret_access_key=aws_secret_access_key, + aws_session_token=aws_session_token, + profile=profile, + region=region or self.env.aws_region, + ), + ) + + def get_stubbed_client(self, service_name: str, *, region: str | None = None) -> BaseClient: + """Get an existing stubbed client. + + This can be used after :meth:`~pytest_runway.MockCfnginContext.add_stubber` has + been called to get the stubber client. + + Args: + service_name: The name of the service that was stubbed. + region: The region of the session. + + """ + return self._get_mocked_session(region=region).client(service_name, region_name=region) + class YamlLoader: """Load YAML files from a directory.""" def __init__( - self, root: Path, load_class: Optional[type] = None, load_type: str = "default" + self, root: Path, load_class: type | None = None, load_type: str = "default" ) -> None: """Instantiate class. diff --git a/tests/unit/fixtures/config.runway.variables.yml b/tests/unit/fixtures/config.runway.variables.yml index 98b4d5e4e..3e603cc18 100644 --- a/tests/unit/fixtures/config.runway.variables.yml +++ b/tests/unit/fixtures/config.runway.variables.yml @@ -1,6 +1,6 @@ test_value: basic value -require_test: True +require_test: true test_list: - list value 1 diff --git a/tests/unit/fixtures/stack_policies/default.json b/tests/unit/fixtures/stack_policies/default.json index 6a3513825..04ba8c8c1 100644 --- a/tests/unit/fixtures/stack_policies/default.json +++ b/tests/unit/fixtures/stack_policies/default.json @@ -1,10 +1,10 @@ { - "Statement" : [ - { - "Effect" : "Allow", - "Action" : "Update:*", - "Principal": "*", - "Resource" : "*" - } - ] + "Statement": [ + { + "Action": "Update:*", + "Effect": "Allow", + "Principal": "*", + "Resource": "*" + } + ] } diff --git a/tests/unit/fixtures/stack_policies/none.json b/tests/unit/fixtures/stack_policies/none.json index daf7f8424..f66cbde7d 100644 --- a/tests/unit/fixtures/stack_policies/none.json +++ b/tests/unit/fixtures/stack_policies/none.json @@ -1,10 +1,10 @@ { - "Statement" : [ - { - "Effect" : "Deny", - "Action" : "Update:*", - "Principal": "*", - "Resource" : "*" - } - ] + "Statement": [ + { + "Action": "Update:*", + "Effect": "Deny", + "Principal": "*", + "Resource": "*" + } + ] } diff --git a/tests/unit/lookups/handlers/test_base.py b/tests/unit/lookups/handlers/test_base.py index 8810bdd31..e4c348289 100644 --- a/tests/unit/lookups/handlers/test_base.py +++ b/tests/unit/lookups/handlers/test_base.py @@ -1,15 +1,13 @@ """Tests for lookup handler base class.""" -# pylint: disable=duplicate-value -# pyright: basic from __future__ import annotations import json -from typing import Dict, Optional +from typing import Optional +from unittest.mock import MagicMock import pytest import yaml -from mock import MagicMock from runway.lookups.handlers.base import LookupHandler from runway.utils import MutableMap @@ -30,9 +28,7 @@ def test_dependencies(self) -> None: This should always return an empty set. """ - assert isinstance( - LookupHandler.dependencies(MagicMock(autospec=VariableValue)), set - ) + assert isinstance(LookupHandler.dependencies(MagicMock(autospec=VariableValue)), set) def test_format_results(self) -> None: """Test format_results.""" @@ -45,18 +41,9 @@ def test_format_results(self) -> None: assert LookupHandler.format_results(test_dict) == test_dict assert LookupHandler.format_results(mute_map) == test_dict - assert ( - LookupHandler.format_results(test_dict, get="test_key") - == test_dict["test_key"] - ) - assert ( - LookupHandler.format_results(mute_map, get="test_key") - == mute_map["test_key"] - ) - assert ( - LookupHandler.format_results(mute_map, get="nested") - == mute_map["nested"].data - ) + assert LookupHandler.format_results(test_dict, get="test_key") == test_dict["test_key"] + assert LookupHandler.format_results(mute_map, get="test_key") == mute_map["test_key"] + assert LookupHandler.format_results(mute_map, get="nested") == mute_map["nested"].data assert ( LookupHandler.format_results(mute_map, get="nested.nested_key") == mute_map["nested"]["nested_key"] @@ -66,12 +53,11 @@ def test_format_results(self) -> None: assert LookupHandler.format_results(mute_map, transform="str") == json.dumps( json.dumps(test_dict, indent=0) ) - assert LookupHandler.format_results( - mute_map, transform="str", indent=2 - ) == json.dumps(json.dumps(test_dict, indent=2)) + assert LookupHandler.format_results(mute_map, transform="str", indent=2) == json.dumps( + json.dumps(test_dict, indent=2) + ) assert ( - LookupHandler.format_results(mute_map, get="nested.bool", transform="str") - == '"True"' + LookupHandler.format_results(mute_map, get="nested.bool", transform="str") == '"True"' ) with pytest.raises(TypeError): @@ -89,9 +75,7 @@ def test_format_results(self) -> None: ("undefined", "undefined"), ], ) - def test_format_results_handle_none( - self, value: str, expected: Optional[str] - ) -> None: + def test_format_results_handle_none(self, value: str, expected: Optional[str]) -> None: """Test format_results.""" assert LookupHandler.format_results(value) == expected if isinstance(expected, str): @@ -133,8 +117,8 @@ def test_load_list(self) -> None: def test_parse( self, query: str, - raw_args: Optional[Dict[str, str]], - expected_args: Dict[str, str], + raw_args: Optional[dict[str, str]], + expected_args: dict[str, str], ) -> None: """Test parse.""" value = f"{query}::{raw_args}" @@ -147,7 +131,8 @@ def test_transform_bool_to_bool(self) -> None: result_true = LookupHandler.transform(True, to_type="bool") result_false = LookupHandler.transform(False, to_type="bool") - assert isinstance(result_true, bool) and isinstance(result_false, bool) + assert isinstance(result_true, bool) + assert isinstance(result_false, bool) assert result_true assert not result_false @@ -162,7 +147,8 @@ def test_transform_str_to_bool(self) -> None: result_true = LookupHandler.transform("true", to_type="bool") result_false = LookupHandler.transform("false", to_type="bool") - assert isinstance(result_true, bool) and isinstance(result_false, bool) + assert isinstance(result_true, bool) + assert isinstance(result_false, bool) assert result_true assert not result_false @@ -194,15 +180,11 @@ def test_transform_str_direct(self) -> None: def test_transform_str_list(self) -> None: """Test list type joined to create string.""" assert LookupHandler.transform(["val1", "val2"], to_type="str") == "val1,val2" - assert ( - LookupHandler.transform({"val", "val"}, to_type="str") # noqa: B033 - == "val" - ) + assert LookupHandler.transform({"val"}, to_type="str") == "val" assert LookupHandler.transform(("val1", "val2"), to_type="str") == "val1,val2" def test_transform_str_list_delimiter(self) -> None: """Test list to string with a specified delimiter.""" assert ( - LookupHandler.transform(["val1", "val2"], to_type="str", delimiter="|") - == "val1|val2" + LookupHandler.transform(["val1", "val2"], to_type="str", delimiter="|") == "val1|val2" ) diff --git a/tests/unit/lookups/handlers/test_cfn.py b/tests/unit/lookups/handlers/test_cfn.py index b1bbafb44..274b2a589 100644 --- a/tests/unit/lookups/handlers/test_cfn.py +++ b/tests/unit/lookups/handlers/test_cfn.py @@ -6,13 +6,13 @@ import json import logging from datetime import datetime -from typing import TYPE_CHECKING, Any, Dict, Optional, Tuple +from typing import TYPE_CHECKING, Any, Optional +from unittest.mock import MagicMock import boto3 import pytest from botocore.exceptions import ClientError from botocore.stub import Stubber -from mock import MagicMock from runway.cfngin.exceptions import StackDoesNotExist from runway.cfngin.providers.aws.default import Provider @@ -21,7 +21,6 @@ if TYPE_CHECKING: from mypy_boto3_cloudformation.client import CloudFormationClient - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from ...factories import MockRunwayContext @@ -29,10 +28,10 @@ def generate_describe_stacks_stack( stack_name: str, - outputs: Dict[str, str], + outputs: dict[str, str], creation_time: Optional[datetime] = None, stack_status: str = "CREATE_COMPLETE", -) -> Dict[str, Any]: +) -> dict[str, Any]: """Generate describe stacks stack. Args: @@ -59,7 +58,7 @@ def generate_describe_stacks_stack( } -def setup_cfn_client() -> Tuple[CloudFormationClient, Stubber]: +def setup_cfn_client() -> tuple[CloudFormationClient, Stubber]: """Create a CloudFormation client & Stubber.""" client = boto3.client("cloudformation") return client, Stubber(client) @@ -96,10 +95,7 @@ def test_handle(self, mocker: MockerFixture) -> None: ) # test happy path when used from CFNgin (provider) - assert ( - CfnLookup.handle(value, context=mock_context, provider=mock_provider) - == "success" - ) + assert CfnLookup.handle(value, context=mock_context, provider=mock_provider) == "success" mock_parse.assert_called_once_with(value) mock_provider.get_output.assert_called_once_with(*query) mock_should_use.assert_called_once_with({"region": region}, mock_provider) @@ -129,16 +125,14 @@ def test_handle(self, mocker: MockerFixture) -> None: ) def test_handle_exception( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, default: Optional[str], exception: Exception, mocker: MockerFixture, ) -> None: """Test handle cls.get_stack_output raise exception.""" caplog.set_level(logging.DEBUG, logger="runway.lookups.handlers.cfn") - mock_should_use = mocker.patch.object( - CfnLookup, "should_use_provider", return_value=False - ) + mock_should_use = mocker.patch.object(CfnLookup, "should_use_provider", return_value=False) mock_context = MagicMock(name="context") mock_session = MagicMock(name="session") mock_context.get_session.return_value = mock_session @@ -150,10 +144,7 @@ def test_handle_exception( query = OutputQuery(*raw_query.split(".")) if default: - assert ( - CfnLookup.handle(raw_query + "::default=" + default, mock_context) - == default - ) + assert CfnLookup.handle(raw_query + "::default=" + default, mock_context) == default mock_should_use.assert_called_once_with({"default": default}, None) assert ( "unable to resolve lookup for CloudFormation Stack output " @@ -190,7 +181,7 @@ def test_handle_exception( ) def test_handle_provider_exception( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, default: Optional[str], exception: Exception, mocker: MockerFixture, @@ -198,9 +189,7 @@ def test_handle_provider_exception( ) -> None: """Test handle provider raise exception.""" caplog.set_level(logging.DEBUG, logger="runway.lookups.handlers.cfn") - mock_should_use = mocker.patch.object( - CfnLookup, "should_use_provider", return_value=True - ) + mock_should_use = mocker.patch.object(CfnLookup, "should_use_provider", return_value=True) mock_provider = MagicMock(region="us-east-1") mock_provider.get_output.side_effect = exception raw_query = "test-stack.output1" @@ -237,14 +226,10 @@ def test_handle_provider_exception( def test_handle_valueerror(self, runway_context: MockRunwayContext) -> None: """Test handle raising ValueError.""" - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="query must be ."): assert CfnLookup.handle("something", runway_context) - assert ( - str(excinfo.value) - == 'query must be .; got "something"' - ) - def test_get_stack_output(self, caplog: LogCaptureFixture) -> None: + def test_get_stack_output(self, caplog: pytest.LogCaptureFixture) -> None: """Test get_stack_output.""" caplog.set_level(logging.DEBUG, logger="runway.lookups.handlers.cfn") client, stubber = setup_cfn_client() @@ -265,7 +250,7 @@ def test_get_stack_output(self, caplog: LogCaptureFixture) -> None: assert f"describing stack: {stack_name}" in caplog.messages assert f"{stack_name} stack outputs: {json.dumps(outputs)}" in caplog.messages - def test_get_stack_output_clienterror(self, caplog: LogCaptureFixture) -> None: + def test_get_stack_output_clienterror(self, caplog: pytest.LogCaptureFixture) -> None: """Test get_stack_output raising ClientError.""" caplog.set_level(logging.DEBUG, logger="runway.lookups.handlers.cfn") client, stubber = setup_cfn_client() @@ -285,7 +270,7 @@ def test_get_stack_output_clienterror(self, caplog: LogCaptureFixture) -> None: stubber.assert_no_pending_responses() assert f"describing stack: {stack_name}" in caplog.messages - def test_get_stack_output_keyerror(self, caplog: LogCaptureFixture) -> None: + def test_get_stack_output_keyerror(self, caplog: pytest.LogCaptureFixture) -> None: """Test get_stack_output raising KeyError.""" caplog.set_level(logging.DEBUG, logger="runway.lookups.handlers.cfn") client, stubber = setup_cfn_client() @@ -315,17 +300,15 @@ def test_get_stack_output_keyerror(self, caplog: LogCaptureFixture) -> None: ) def test_should_use_provider_falsy( self, - args: Dict[str, Any], - caplog: LogCaptureFixture, + args: dict[str, Any], + caplog: pytest.LogCaptureFixture, provider: Optional[Provider], ) -> None: """Test should_use_provider with falsy cases.""" caplog.set_level(logging.DEBUG, logger="runway.lookups.handlers.cfn") assert not CfnLookup.should_use_provider(args, provider) if provider: - assert ( - "not using provider; requested region does not match" in caplog.messages - ) + assert "not using provider; requested region does not match" in caplog.messages assert "using provider" not in caplog.messages @pytest.mark.parametrize( @@ -337,8 +320,8 @@ def test_should_use_provider_falsy( ) def test_should_use_provider_truthy( self, - args: Dict[str, Any], - caplog: LogCaptureFixture, + args: dict[str, Any], + caplog: pytest.LogCaptureFixture, provider: Optional[Provider], ) -> None: """Test should_use_provider with truthy cases.""" diff --git a/tests/unit/lookups/handlers/test_ecr.py b/tests/unit/lookups/handlers/test_ecr.py index 2c48e308b..7cc395e79 100644 --- a/tests/unit/lookups/handlers/test_ecr.py +++ b/tests/unit/lookups/handlers/test_ecr.py @@ -1,7 +1,5 @@ """Test runway.lookups.handlers.ecr.""" -# pylint: disable=redefined-outer-name -# pyright: basic from __future__ import annotations import base64 @@ -13,15 +11,16 @@ from runway.lookups.handlers.ecr import EcrLookup if TYPE_CHECKING: - from mock import MagicMock + from unittest.mock import MagicMock + from pytest_mock import MockerFixture - from ...factories import MockCFNginContext, MockRunwayContext + from ...factories import MockCfnginContext, MockRunwayContext MODULE = "runway.lookups.handlers.ecr" -@pytest.fixture(scope="function") +@pytest.fixture() def mock_format_results(mocker: MockerFixture) -> MagicMock: """Mock EcrLookup.format_results.""" return mocker.patch.object( @@ -33,7 +32,7 @@ class TestEcrLookup: """Test runway.lookups.handlers.ecr.EcrLookup.""" def test_get_login_password( - self, cfngin_context: MockCFNginContext, runway_context: MockRunwayContext + self, cfngin_context: MockCfnginContext, runway_context: MockRunwayContext ) -> None: """Test get_login_password.""" cfngin_stubber = cfngin_context.add_stubber("ecr") @@ -43,9 +42,7 @@ def test_get_login_password( response = { "authorizationData": [ { - "authorizationToken": base64.b64encode( - ("AWS:" + password).encode() - ).decode(), + "authorizationToken": base64.b64encode(("AWS:" + password).encode()).decode(), "expiresAt": datetime.datetime(2015, 1, 1), "proxyEndpoint": "string", } @@ -71,14 +68,15 @@ def test_get_login_password( cfngin_stubber.assert_no_pending_responses() runway_stubber.assert_no_pending_responses() - def test_get_login_password_raise_value_error( - self, runway_context: MockRunwayContext - ) -> None: + def test_get_login_password_raise_value_error(self, runway_context: MockRunwayContext) -> None: """Test get_login_password.""" runway_stubber = runway_context.add_stubber("ecr") runway_stubber.add_response("get_authorization_token", {}, {}) - with runway_stubber, pytest.raises( - ValueError, match="get_authorization_token did not return authorizationData" + with ( + runway_stubber, + pytest.raises( + ValueError, match="get_authorization_token did not return authorizationData" + ), ): assert EcrLookup.get_login_password( runway_context.get_session().client("ecr") # type: ignore @@ -98,19 +96,16 @@ def test_handle_login_password( return_value="EcrLookup.get_login_password()", ) assert ( - EcrLookup.handle("login-password", runway_context) - == mock_format_results.return_value + EcrLookup.handle("login-password", runway_context) == mock_format_results.return_value ) mock_get_login_password.assert_called_once() - mock_format_results.assert_called_once_with( - mock_get_login_password.return_value - ) + mock_format_results.assert_called_once_with(mock_get_login_password.return_value) def test_handle_value_error(self, runway_context: MockRunwayContext) -> None: """Test handle raise ValueError.""" runway_context.add_stubber("ecr") - with pytest.raises(ValueError) as excinfo: + with pytest.raises(ValueError, match="ecr lookup does not support") as excinfo: EcrLookup.handle("unsupported", runway_context) assert str(excinfo.value) == "ecr lookup does not support 'unsupported'" - with pytest.raises(ValueError): + with pytest.raises(ValueError, match="ecr lookup does not support"): EcrLookup.handle("unsupported::default=something", runway_context) diff --git a/tests/unit/lookups/handlers/test_env.py b/tests/unit/lookups/handlers/test_env.py index 4a85ced3a..f0f7d054c 100644 --- a/tests/unit/lookups/handlers/test_env.py +++ b/tests/unit/lookups/handlers/test_env.py @@ -27,5 +27,5 @@ def test_handle(self, runway_context: MockRunwayContext) -> None: def test_handle_not_found(self, runway_context: MockRunwayContext) -> None: """Validate exception when lookup cannot be resolved.""" runway_context.env.vars = ENV_VARS.copy() - with pytest.raises(ValueError): + with pytest.raises(ValueError, match="does not exist in the environment"): EnvLookup.handle("NOT_VALID", context=runway_context) diff --git a/tests/unit/lookups/handlers/test_random_string.py b/tests/unit/lookups/handlers/test_random_string.py index 26fa49e7a..222e99503 100644 --- a/tests/unit/lookups/handlers/test_random_string.py +++ b/tests/unit/lookups/handlers/test_random_string.py @@ -4,9 +4,9 @@ import string from typing import TYPE_CHECKING +from unittest.mock import Mock import pytest -from mock import Mock from runway.lookups.handlers.random_string import ArgsDataModel, RandomStringLookup @@ -95,10 +95,7 @@ class TestRandomStringLookup: ) def test_calculate_char_set(self, args: object, expected: str) -> None: """Test calculate_char_set.""" - assert ( - RandomStringLookup.calculate_char_set(ArgsDataModel.parse_obj(args)) - == expected - ) + assert RandomStringLookup.calculate_char_set(ArgsDataModel.parse_obj(args)) == expected @pytest.mark.parametrize( "args, value, expected", @@ -127,8 +124,7 @@ def test_calculate_char_set(self, args: object, expected: str) -> None: def test_ensure_has_one_of(self, args: object, expected: bool, value: str) -> None: """Test ensure_has_one_of.""" assert ( - RandomStringLookup.ensure_has_one_of(ArgsDataModel.parse_obj(args), value) - is expected + RandomStringLookup.ensure_has_one_of(ArgsDataModel.parse_obj(args), value) is expected ) @pytest.mark.parametrize("length", [1, 3, 5, 7, 8, 9]) @@ -137,10 +133,7 @@ def test_generate_random_string(self, length: int, mocker: MockerFixture) -> Non char_set = "0123456789" choice = Mock(side_effect=list(char_set)) mocker.patch(f"{MODULE}.secrets", choice=choice) - assert ( - RandomStringLookup.generate_random_string(char_set, length) - == char_set[:length] - ) + assert RandomStringLookup.generate_random_string(char_set, length) == char_set[:length] assert choice.call_count == length choice.assert_called_with(char_set) @@ -161,12 +154,8 @@ def test_handle(self, mocker: MockerFixture) -> None: ) assert RandomStringLookup.handle("12", Mock()) == format_results.return_value calculate_char_set.assert_called_once_with(args) - generate_random_string.assert_called_once_with( - calculate_char_set.return_value, 12 - ) - ensure_has_one_of.assert_called_once_with( - args, generate_random_string.return_value - ) + generate_random_string.assert_called_once_with(calculate_char_set.return_value, 12) + ensure_has_one_of.assert_called_once_with(args, generate_random_string.return_value) format_results.assert_called_once_with(generate_random_string.return_value) def test_handle_digit(self, mocker: MockerFixture) -> None: @@ -200,7 +189,7 @@ def test_handle_digit(self, mocker: MockerFixture) -> None: def test_handle_raise_value_error(self) -> None: """Test handle.""" - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 RandomStringLookup.handle("test", Mock()) @pytest.mark.parametrize("value, expected", [(">!?test", False), ("t3st", True)]) diff --git a/tests/unit/lookups/handlers/test_ssm.py b/tests/unit/lookups/handlers/test_ssm.py index 0d8a57135..4ef5616cb 100644 --- a/tests/unit/lookups/handlers/test_ssm.py +++ b/tests/unit/lookups/handlers/test_ssm.py @@ -5,7 +5,7 @@ import json from datetime import datetime -from typing import TYPE_CHECKING, Any, Dict, Optional, Union +from typing import TYPE_CHECKING, Any, Optional, Union import pytest import yaml @@ -14,7 +14,7 @@ from runway.variables import Variable if TYPE_CHECKING: - from ...factories import MockCFNginContext, MockRunwayContext + from ...factories import MockCfnginContext, MockRunwayContext def get_parameter_response( @@ -23,7 +23,7 @@ def get_parameter_response( value_type: str = "String", label: Optional[str] = None, version: int = 1, -) -> Dict[str, Any]: +) -> dict[str, Any]: """Generate a mock ssm.get_parameter response.""" selector = f"{name}/{label or version}" return { @@ -40,9 +40,7 @@ def get_parameter_response( } -def get_parameter_request( - name: str, decrypt: bool = True -) -> Dict[str, Union[bool, str]]: +def get_parameter_request(name: str, decrypt: bool = True) -> dict[str, Union[bool, str]]: """Generate the expected request parameters for ssm.get_parameter.""" return {"Name": name, "WithDecryption": decrypt} @@ -51,7 +49,7 @@ class TestSsmLookup: """Test runway.lookups.handlers.ssm.SsmLookup.""" def test_basic( - self, cfngin_context: MockCFNginContext, runway_context: MockRunwayContext + self, cfngin_context: MockCfnginContext, runway_context: MockRunwayContext ) -> None: """Test resolution of a basic lookup.""" name = "/test/param" @@ -110,9 +108,7 @@ def test_different_region(self, runway_context: MockRunwayContext) -> None: name = "/test/param" value = "test value" stubber = runway_context.add_stubber("ssm", region="us-west-2") - var = Variable( - "test_var", f"${{ssm {name}::region=us-west-2}}", variable_type="runway" - ) + var = Variable("test_var", f"${{ssm {name}::region=us-west-2}}", variable_type="runway") stubber.add_response( "get_parameter", diff --git a/tests/unit/lookups/handlers/test_var.py b/tests/unit/lookups/handlers/test_var.py index 30178c247..e15adc7b6 100644 --- a/tests/unit/lookups/handlers/test_var.py +++ b/tests/unit/lookups/handlers/test_var.py @@ -13,7 +13,7 @@ if TYPE_CHECKING: from ...factories import MockRunwayContext -VARIABLES = MutableMap(**{"str_val": "test", "false_val": False}) +VARIABLES = MutableMap(str_val="test", false_val=False) class TestVarLookup: @@ -21,18 +21,13 @@ class TestVarLookup: def test_handle(self, runway_context: MockRunwayContext) -> None: """Validate handle base functionality.""" - assert ( - VarLookup.handle("str_val", context=runway_context, variables=VARIABLES) - == "test" - ) + assert VarLookup.handle("str_val", context=runway_context, variables=VARIABLES) == "test" def test_handle_false_result(self, runway_context: MockRunwayContext) -> None: """Validate that a bool value of False can be resolved.""" - assert not VarLookup.handle( - "false_val", context=runway_context, variables=VARIABLES - ) + assert not VarLookup.handle("false_val", context=runway_context, variables=VARIABLES) def test_handle_not_found(self, runway_context: MockRunwayContext) -> None: """Validate exception when lookup cannot be resolved.""" - with pytest.raises(ValueError): + with pytest.raises(ValueError, match="does not exist in the variable definition"): VarLookup.handle("NOT_VALID", context=runway_context, variables=VARIABLES) diff --git a/tests/unit/lookups/test_registry.py b/tests/unit/lookups/test_registry.py index 7899709e9..9a53e7353 100644 --- a/tests/unit/lookups/test_registry.py +++ b/tests/unit/lookups/test_registry.py @@ -21,7 +21,7 @@ from ..factories import MockRunwayContext VALUES = {"str_val": "test"} -CONTEXT = MutableMap(**{"env_vars": VALUES}) +CONTEXT = MutableMap(env_vars=VALUES) VARIABLES = MutableMap(**VALUES) @@ -30,9 +30,7 @@ def test_autoloaded_lookup_handlers(mocker: MockerFixture) -> None: mocker.patch.dict(RUNWAY_LOOKUP_HANDLERS, {}) handlers = ["cfn", "ecr", "env", "random.string", "ssm", "var"] for handler in handlers: - assert ( - handler in RUNWAY_LOOKUP_HANDLERS - ), f'Lookup handler: "{handler}" not registered' + assert handler in RUNWAY_LOOKUP_HANDLERS, f'Lookup handler: "{handler}" not registered' assert len(RUNWAY_LOOKUP_HANDLERS) == len( handlers ), f"expected {len(handlers)} autoloaded handlers but found {len(RUNWAY_LOOKUP_HANDLERS)}" diff --git a/tests/unit/mock_docker/fake_api.py b/tests/unit/mock_docker/fake_api.py index b24209064..9b997ea0e 100644 --- a/tests/unit/mock_docker/fake_api.py +++ b/tests/unit/mock_docker/fake_api.py @@ -1,9 +1,8 @@ """Fake Docker API.""" # cspell:disable -# flake8: noqa=D103 -# pylint: disable=consider-using-f-string,invalid-name -from typing import Any, Callable, Dict, Tuple, Union +# ruff: noqa: D103 +from typing import Any, Callable, Union from docker import constants @@ -29,7 +28,7 @@ # for clarity and readability -def get_fake_version() -> Tuple[int, Any]: +def get_fake_version() -> tuple[int, Any]: status_code = 200 response = { "ApiVersion": "1.35", @@ -64,7 +63,7 @@ def get_fake_version() -> Tuple[int, Any]: return status_code, response -def get_fake_info() -> Tuple[int, Any]: +def get_fake_info() -> tuple[int, Any]: status_code = 200 response = { "Containers": 1, @@ -77,23 +76,23 @@ def get_fake_info() -> Tuple[int, Any]: return status_code, response -def post_fake_auth() -> Tuple[int, Any]: +def post_fake_auth() -> tuple[int, Any]: status_code = 200 response = {"Status": "Login Succeeded", "IdentityToken": "9cbaf023786cd7"} return status_code, response -def get_fake_ping() -> Tuple[int, Any]: +def get_fake_ping() -> tuple[int, Any]: return 200, "OK" -def get_fake_search() -> Tuple[int, Any]: +def get_fake_search() -> tuple[int, Any]: status_code = 200 response = [{"Name": "busybox", "Description": "Fake Description"}] return status_code, response -def get_fake_images() -> Tuple[int, Any]: +def get_fake_images() -> tuple[int, Any]: status_code = 200 response = [ { @@ -106,7 +105,7 @@ def get_fake_images() -> Tuple[int, Any]: return status_code, response -def get_fake_image_history() -> Tuple[int, Any]: +def get_fake_image_history() -> tuple[int, Any]: status_code = 200 response = [ {"Id": "b750fe79269d", "Created": 1364102658, "CreatedBy": "/bin/bash"}, @@ -116,14 +115,14 @@ def get_fake_image_history() -> Tuple[int, Any]: return status_code, response -def post_fake_import_image() -> Tuple[int, Any]: +def post_fake_import_image() -> tuple[int, Any]: status_code = 200 response = "Import messages..." return status_code, response -def get_fake_containers() -> Tuple[int, Any]: +def get_fake_containers() -> tuple[int, Any]: status_code = 200 response = [ { @@ -137,27 +136,27 @@ def get_fake_containers() -> Tuple[int, Any]: return status_code, response -def post_fake_start_container() -> Tuple[int, Any]: +def post_fake_start_container() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def post_fake_resize_container() -> Tuple[int, Any]: +def post_fake_resize_container() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def post_fake_create_container() -> Tuple[int, Any]: +def post_fake_create_container() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def get_fake_inspect_container(tty: bool = False) -> Tuple[int, Any]: +def get_fake_inspect_container(tty: bool = False) -> tuple[int, Any]: status_code = 200 - response: Dict[str, Any] = { + response: dict[str, Any] = { "Id": FAKE_CONTAINER_ID, "Config": {"Labels": {"foo": "bar"}, "Privileged": True, "Tty": tty}, "ID": FAKE_CONTAINER_ID, @@ -177,7 +176,7 @@ def get_fake_inspect_container(tty: bool = False) -> Tuple[int, Any]: return status_code, response -def get_fake_inspect_image() -> Tuple[int, Any]: +def get_fake_inspect_image() -> tuple[int, Any]: status_code = 200 response = { "Id": FAKE_IMAGE_ID, @@ -210,19 +209,19 @@ def get_fake_inspect_image() -> Tuple[int, Any]: return status_code, response -def get_fake_insert_image() -> Tuple[int, Any]: +def get_fake_insert_image() -> tuple[int, Any]: status_code = 200 response = {"StatusCode": 0} return status_code, response -def get_fake_wait() -> Tuple[int, Any]: +def get_fake_wait() -> tuple[int, Any]: status_code = 200 response = {"StatusCode": 0} return status_code, response -def get_fake_logs() -> Tuple[int, Any]: +def get_fake_logs() -> tuple[int, Any]: status_code = 200 response = ( b"\x01\x00\x00\x00\x00\x00\x00\x00" @@ -233,13 +232,13 @@ def get_fake_logs() -> Tuple[int, Any]: return status_code, response -def get_fake_diff() -> Tuple[int, Any]: +def get_fake_diff() -> tuple[int, Any]: status_code = 200 response = [{"Path": "/test", "Kind": 1}] return status_code, response -def get_fake_events() -> Tuple[int, Any]: +def get_fake_events() -> tuple[int, Any]: status_code = 200 response = [ { @@ -252,19 +251,19 @@ def get_fake_events() -> Tuple[int, Any]: return status_code, response -def get_fake_export() -> Tuple[int, Any]: +def get_fake_export() -> tuple[int, Any]: status_code = 200 response = "Byte Stream...." return status_code, response -def post_fake_exec_create() -> Tuple[int, Any]: +def post_fake_exec_create() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_EXEC_ID} return status_code, response -def post_fake_exec_start() -> Tuple[int, Any]: +def post_fake_exec_start() -> tuple[int, Any]: status_code = 200 response = ( b"\x01\x00\x00\x00\x00\x00\x00\x11bin\nboot\ndev\netc\n" @@ -274,12 +273,12 @@ def post_fake_exec_start() -> Tuple[int, Any]: return status_code, response -def post_fake_exec_resize() -> Tuple[int, Any]: +def post_fake_exec_resize() -> tuple[int, Any]: status_code = 201 return status_code, "" -def get_fake_exec_inspect() -> Tuple[int, Any]: +def get_fake_exec_inspect() -> tuple[int, Any]: return ( 200, { @@ -301,102 +300,102 @@ def get_fake_exec_inspect() -> Tuple[int, Any]: ) -def post_fake_stop_container() -> Tuple[int, Any]: +def post_fake_stop_container() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def post_fake_kill_container() -> Tuple[int, Any]: +def post_fake_kill_container() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def post_fake_pause_container() -> Tuple[int, Any]: +def post_fake_pause_container() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def post_fake_unpause_container() -> Tuple[int, Any]: +def post_fake_unpause_container() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def post_fake_restart_container() -> Tuple[int, Any]: +def post_fake_restart_container() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def post_fake_rename_container() -> Tuple[int, Any]: +def post_fake_rename_container() -> tuple[int, Any]: status_code = 204 return status_code, None -def delete_fake_remove_container() -> Tuple[int, Any]: +def delete_fake_remove_container() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def post_fake_image_create() -> Tuple[int, Any]: +def post_fake_image_create() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_IMAGE_ID} return status_code, response -def delete_fake_remove_image() -> Tuple[int, Any]: +def delete_fake_remove_image() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_IMAGE_ID} return status_code, response -def get_fake_get_image() -> Tuple[int, Any]: +def get_fake_get_image() -> tuple[int, Any]: status_code = 200 response = "Byte Stream...." return status_code, response -def post_fake_load_image() -> Tuple[int, Any]: +def post_fake_load_image() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_IMAGE_ID} return status_code, response -def post_fake_commit() -> Tuple[int, Any]: +def post_fake_commit() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def post_fake_push() -> Tuple[int, Any]: +def post_fake_push() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_IMAGE_ID} return status_code, response -def post_fake_build_container() -> Tuple[int, Any]: +def post_fake_build_container() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_CONTAINER_ID} return status_code, response -def post_fake_tag_image() -> Tuple[int, Any]: +def post_fake_tag_image() -> tuple[int, Any]: status_code = 200 response = {"Id": FAKE_IMAGE_ID} return status_code, response -def get_fake_stats() -> Tuple[int, Any]: +def get_fake_stats() -> tuple[int, Any]: status_code = 200 response = fake_stat.OBJ return status_code, response -def get_fake_top() -> Tuple[int, Any]: +def get_fake_top() -> tuple[int, Any]: return ( 200, { @@ -417,7 +416,7 @@ def get_fake_top() -> Tuple[int, Any]: ) -def get_fake_volume_list() -> Tuple[int, Any]: +def get_fake_volume_list() -> tuple[int, Any]: status_code = 200 response = { "Volumes": [ @@ -438,7 +437,7 @@ def get_fake_volume_list() -> Tuple[int, Any]: return status_code, response -def get_fake_volume() -> Tuple[int, Any]: +def get_fake_volume() -> tuple[int, Any]: status_code = 200 response = { "Name": "perfectcherryblossom", @@ -450,23 +449,23 @@ def get_fake_volume() -> Tuple[int, Any]: return status_code, response -def fake_remove_volume() -> Tuple[int, Any]: +def fake_remove_volume() -> tuple[int, Any]: return 204, None -def post_fake_update_container() -> Tuple[int, Any]: +def post_fake_update_container() -> tuple[int, Any]: return 200, {"Warnings": []} -def post_fake_update_node() -> Tuple[int, Any]: +def post_fake_update_node() -> tuple[int, Any]: return 200, None -def post_fake_join_swarm() -> Tuple[int, Any]: +def post_fake_join_swarm() -> tuple[int, Any]: return 200, None -def get_fake_network_list() -> Tuple[int, Any]: +def get_fake_network_list() -> tuple[int, Any]: return ( 200, [ @@ -490,7 +489,7 @@ def get_fake_network_list() -> Tuple[int, Any]: "com.docker.network.bridge.default_bridge": "true", "com.docker.network.bridge.enable_icc": "true", "com.docker.network.bridge.enable_ip_masquerade": "true", - "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0", + "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0", # noqa: S104 "com.docker.network.bridge.name": "docker0", "com.docker.network.driver.mtu": "1500", }, @@ -499,23 +498,23 @@ def get_fake_network_list() -> Tuple[int, Any]: ) -def get_fake_network() -> Tuple[int, Any]: +def get_fake_network() -> tuple[int, Any]: return 200, get_fake_network_list()[1][0] -def post_fake_network() -> Tuple[int, Any]: +def post_fake_network() -> tuple[int, Any]: return 201, {"Id": FAKE_NETWORK_ID, "Warnings": []} -def delete_fake_network() -> Tuple[int, Any]: +def delete_fake_network() -> tuple[int, Any]: return 204, None -def post_fake_network_connect() -> Tuple[int, Any]: +def post_fake_network_connect() -> tuple[int, Any]: return 200, None -def post_fake_network_disconnect() -> Tuple[int, Any]: +def post_fake_network_disconnect() -> tuple[int, Any]: return 200, None @@ -524,145 +523,86 @@ def post_fake_network_disconnect() -> Tuple[int, Any]: if constants.IS_WINDOWS_PLATFORM: prefix = "http+docker://localnpipe" -fake_responses: Dict[Union[str, Tuple[str, str]], Callable[..., Tuple[int, Any]]] = { - "{0}/version".format(prefix): get_fake_version, - "{1}/{0}/version".format(CURRENT_VERSION, prefix): get_fake_version, - "{1}/{0}/info".format(CURRENT_VERSION, prefix): get_fake_info, - "{1}/{0}/auth".format(CURRENT_VERSION, prefix): post_fake_auth, - "{1}/{0}/_ping".format(CURRENT_VERSION, prefix): get_fake_ping, - "{1}/{0}/images/search".format(CURRENT_VERSION, prefix): get_fake_search, - "{1}/{0}/images/json".format(CURRENT_VERSION, prefix): get_fake_images, - "{1}/{0}/images/test_image/history".format( - CURRENT_VERSION, prefix - ): get_fake_image_history, - "{1}/{0}/images/create".format(CURRENT_VERSION, prefix): post_fake_import_image, - "{1}/{0}/containers/json".format(CURRENT_VERSION, prefix): get_fake_containers, - "{1}/{0}/containers/3cc2351ab11b/start".format( - CURRENT_VERSION, prefix - ): post_fake_start_container, - "{1}/{0}/containers/3cc2351ab11b/resize".format( - CURRENT_VERSION, prefix - ): post_fake_resize_container, - "{1}/{0}/containers/3cc2351ab11b/json".format( - CURRENT_VERSION, prefix - ): get_fake_inspect_container, - "{1}/{0}/containers/3cc2351ab11b/rename".format( - CURRENT_VERSION, prefix - ): post_fake_rename_container, - "{1}/{0}/images/e9aa60c60128/tag".format( - CURRENT_VERSION, prefix - ): post_fake_tag_image, - "{1}/{0}/containers/3cc2351ab11b/wait".format( - CURRENT_VERSION, prefix - ): get_fake_wait, - "{1}/{0}/containers/3cc2351ab11b/logs".format( - CURRENT_VERSION, prefix - ): get_fake_logs, - "{1}/{0}/containers/3cc2351ab11b/changes".format( - CURRENT_VERSION, prefix - ): get_fake_diff, - "{1}/{0}/containers/3cc2351ab11b/export".format( - CURRENT_VERSION, prefix - ): get_fake_export, - "{1}/{0}/containers/3cc2351ab11b/update".format( - CURRENT_VERSION, prefix - ): post_fake_update_container, - "{1}/{0}/containers/3cc2351ab11b/exec".format( - CURRENT_VERSION, prefix - ): post_fake_exec_create, - "{1}/{0}/exec/d5d177f121dc/start".format( - CURRENT_VERSION, prefix - ): post_fake_exec_start, - "{1}/{0}/exec/d5d177f121dc/json".format( - CURRENT_VERSION, prefix - ): get_fake_exec_inspect, - "{1}/{0}/exec/d5d177f121dc/resize".format( - CURRENT_VERSION, prefix - ): post_fake_exec_resize, - "{1}/{0}/containers/3cc2351ab11b/stats".format( - CURRENT_VERSION, prefix - ): get_fake_stats, - "{1}/{0}/containers/3cc2351ab11b/top".format(CURRENT_VERSION, prefix): get_fake_top, - "{1}/{0}/containers/3cc2351ab11b/stop".format( - CURRENT_VERSION, prefix - ): post_fake_stop_container, - "{1}/{0}/containers/3cc2351ab11b/kill".format( - CURRENT_VERSION, prefix - ): post_fake_kill_container, - "{1}/{0}/containers/3cc2351ab11b/pause".format( - CURRENT_VERSION, prefix - ): post_fake_pause_container, - "{1}/{0}/containers/3cc2351ab11b/unpause".format( - CURRENT_VERSION, prefix - ): post_fake_unpause_container, - "{1}/{0}/containers/3cc2351ab11b/restart".format( - CURRENT_VERSION, prefix - ): post_fake_restart_container, - "{1}/{0}/containers/3cc2351ab11b".format( - CURRENT_VERSION, prefix - ): delete_fake_remove_container, - "{1}/{0}/images/create".format(CURRENT_VERSION, prefix): post_fake_image_create, - "{1}/{0}/images/e9aa60c60128".format( - CURRENT_VERSION, prefix - ): delete_fake_remove_image, - "{1}/{0}/images/e9aa60c60128/get".format( - CURRENT_VERSION, prefix - ): get_fake_get_image, - "{1}/{0}/images/load".format(CURRENT_VERSION, prefix): post_fake_load_image, - "{1}/{0}/images/test_image/json".format( - CURRENT_VERSION, prefix - ): get_fake_inspect_image, - "{1}/{0}/images/test_image/insert".format( - CURRENT_VERSION, prefix - ): get_fake_insert_image, - "{1}/{0}/images/test_image/push".format(CURRENT_VERSION, prefix): post_fake_push, - "{1}/{0}/commit".format(CURRENT_VERSION, prefix): post_fake_commit, - "{1}/{0}/containers/create".format( - CURRENT_VERSION, prefix - ): post_fake_create_container, - "{1}/{0}/build".format(CURRENT_VERSION, prefix): post_fake_build_container, - "{1}/{0}/events".format(CURRENT_VERSION, prefix): get_fake_events, - ("{1}/{0}/volumes".format(CURRENT_VERSION, prefix), "GET"): get_fake_volume_list, - ("{1}/{0}/volumes/create".format(CURRENT_VERSION, prefix), "POST"): get_fake_volume, +fake_responses: dict[Union[str, tuple[str, str]], Callable[..., tuple[int, Any]]] = { + f"{prefix}/version": get_fake_version, + f"{prefix}/{CURRENT_VERSION}/version": get_fake_version, + f"{prefix}/{CURRENT_VERSION}/info": get_fake_info, + f"{prefix}/{CURRENT_VERSION}/auth": post_fake_auth, + f"{prefix}/{CURRENT_VERSION}/_ping": get_fake_ping, + f"{prefix}/{CURRENT_VERSION}/images/search": get_fake_search, + f"{prefix}/{CURRENT_VERSION}/images/json": get_fake_images, + f"{prefix}/{CURRENT_VERSION}/images/test_image/history": get_fake_image_history, + f"{prefix}/{CURRENT_VERSION}/containers/json": get_fake_containers, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/start": post_fake_start_container, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/resize": post_fake_resize_container, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/json": get_fake_inspect_container, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/rename": post_fake_rename_container, + f"{prefix}/{CURRENT_VERSION}/images/e9aa60c60128/tag": post_fake_tag_image, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/wait": get_fake_wait, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/logs": get_fake_logs, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/changes": get_fake_diff, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/export": get_fake_export, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/update": post_fake_update_container, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/exec": post_fake_exec_create, + f"{prefix}/{CURRENT_VERSION}/exec/d5d177f121dc/start": post_fake_exec_start, + f"{prefix}/{CURRENT_VERSION}/exec/d5d177f121dc/json": get_fake_exec_inspect, + f"{prefix}/{CURRENT_VERSION}/exec/d5d177f121dc/resize": post_fake_exec_resize, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/stats": get_fake_stats, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/top": get_fake_top, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/stop": post_fake_stop_container, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/kill": post_fake_kill_container, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/pause": post_fake_pause_container, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/unpause": post_fake_unpause_container, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b/restart": post_fake_restart_container, + f"{prefix}/{CURRENT_VERSION}/containers/3cc2351ab11b": delete_fake_remove_container, + f"{prefix}/{CURRENT_VERSION}/images/create": post_fake_image_create, + f"{prefix}/{CURRENT_VERSION}/images/e9aa60c60128": delete_fake_remove_image, + f"{prefix}/{CURRENT_VERSION}/images/e9aa60c60128/get": get_fake_get_image, + f"{prefix}/{CURRENT_VERSION}/images/load": post_fake_load_image, + f"{prefix}/{CURRENT_VERSION}/images/test_image/json": get_fake_inspect_image, + f"{prefix}/{CURRENT_VERSION}/images/test_image/insert": get_fake_insert_image, + f"{prefix}/{CURRENT_VERSION}/images/test_image/push": post_fake_push, + f"{prefix}/{CURRENT_VERSION}/commit": post_fake_commit, + f"{prefix}/{CURRENT_VERSION}/containers/create": post_fake_create_container, + f"{prefix}/{CURRENT_VERSION}/build": post_fake_build_container, + f"{prefix}/{CURRENT_VERSION}/events": get_fake_events, + (f"{prefix}/{CURRENT_VERSION}/volumes", "GET"): get_fake_volume_list, + (f"{prefix}/{CURRENT_VERSION}/volumes/create", "POST"): get_fake_volume, ( - "{1}/{0}/volumes/{2}".format(CURRENT_VERSION, prefix, FAKE_VOLUME_NAME), + f"{prefix}/{CURRENT_VERSION}/volumes/{FAKE_VOLUME_NAME}", "GET", ): get_fake_volume, ( - "{1}/{0}/volumes/{2}".format(CURRENT_VERSION, prefix, FAKE_VOLUME_NAME), + f"{prefix}/{CURRENT_VERSION}/volumes/{FAKE_VOLUME_NAME}", "DELETE", ): fake_remove_volume, ( - "{1}/{0}/nodes/{2}/update?version=1".format( - CURRENT_VERSION, prefix, FAKE_NODE_ID - ), + f"{prefix}/{CURRENT_VERSION}/nodes/{FAKE_NODE_ID}/update?version=1", "POST", ): post_fake_update_node, ( - "{1}/{0}/swarm/join".format(CURRENT_VERSION, prefix), + f"{prefix}/{CURRENT_VERSION}/swarm/join", "POST", ): post_fake_join_swarm, - ("{1}/{0}/networks".format(CURRENT_VERSION, prefix), "GET"): get_fake_network_list, + (f"{prefix}/{CURRENT_VERSION}/networks", "GET"): get_fake_network_list, ( - "{1}/{0}/networks/create".format(CURRENT_VERSION, prefix), + f"{prefix}/{CURRENT_VERSION}/networks/create", "POST", ): post_fake_network, ( - "{1}/{0}/networks/{2}".format(CURRENT_VERSION, prefix, FAKE_NETWORK_ID), + f"{prefix}/{CURRENT_VERSION}/networks/{FAKE_NETWORK_ID}", "GET", ): get_fake_network, ( - "{1}/{0}/networks/{2}".format(CURRENT_VERSION, prefix, FAKE_NETWORK_ID), + f"{prefix}/{CURRENT_VERSION}/networks/{FAKE_NETWORK_ID}", "DELETE", ): delete_fake_network, ( - "{1}/{0}/networks/{2}/connect".format(CURRENT_VERSION, prefix, FAKE_NETWORK_ID), + f"{prefix}/{CURRENT_VERSION}/networks/{FAKE_NETWORK_ID}/connect", "POST", ): post_fake_network_connect, ( - "{1}/{0}/networks/{2}/disconnect".format( - CURRENT_VERSION, prefix, FAKE_NETWORK_ID - ), + f"{prefix}/{CURRENT_VERSION}/networks/{FAKE_NETWORK_ID}/disconnect", "POST", ): post_fake_network_disconnect, } diff --git a/tests/unit/mock_docker/fake_api_client.py b/tests/unit/mock_docker/fake_api_client.py index 710055da0..1d106f53e 100644 --- a/tests/unit/mock_docker/fake_api_client.py +++ b/tests/unit/mock_docker/fake_api_client.py @@ -1,11 +1,10 @@ """Fake Docker API client.""" -# pylint: disable=attribute-defined-outside-init,protected-access import copy -from typing import Any, Dict, Optional +from typing import Any, Optional +from unittest import mock import docker -import mock from docker.constants import DEFAULT_DOCKER_API_VERSION from . import fake_api @@ -14,18 +13,14 @@ class CopyReturnMagicMock(mock.MagicMock): """A MagicMock which deep copies every return value.""" - def _mock_call( # pylint: disable=arguments-differ - self, *args: Any, **kwargs: Any - ) -> Any: + def _mock_call(self, *args: Any, **kwargs: Any) -> Any: ret = super()._mock_call(*args, **kwargs) # type: ignore if isinstance(ret, (dict, list)): ret = copy.deepcopy(ret) # type: ignore return ret # type: ignore -def make_fake_api_client( - overrides: Optional[Dict[str, Any]] = None -) -> CopyReturnMagicMock: +def make_fake_api_client(overrides: Optional[dict[str, Any]] = None) -> CopyReturnMagicMock: """Return non-complete fake APIClient. This returns most of the default cases correctly, but most arguments that @@ -61,7 +56,7 @@ def make_fake_api_client( return mock_client -def make_fake_client(overrides: Optional[Dict[str, Any]] = None) -> docker.DockerClient: +def make_fake_client(overrides: Optional[dict[str, Any]] = None) -> docker.DockerClient: """Return a Client with a fake APIClient.""" client = docker.DockerClient(version=DEFAULT_DOCKER_API_VERSION) client.api = make_fake_api_client(overrides) diff --git a/tests/unit/mock_docker/fake_stat.py b/tests/unit/mock_docker/fake_stat.py index 98814c704..12c5d1a37 100644 --- a/tests/unit/mock_docker/fake_stat.py +++ b/tests/unit/mock_docker/fake_stat.py @@ -1,9 +1,9 @@ """Stats for fake Docker API.""" # cspell:disable -from typing import Any, Dict +from typing import Any -OBJ: Dict[str, Any] = { +OBJ: dict[str, Any] = { "read": "2015-02-11T19:20:46.667237763+02:00", "network": { "rx_bytes": 567224, diff --git a/tests/unit/module/conftest.py b/tests/unit/module/conftest.py index f1d4a6bea..406de82e4 100644 --- a/tests/unit/module/conftest.py +++ b/tests/unit/module/conftest.py @@ -10,7 +10,7 @@ from pytest_mock import MockerFixture -@pytest.fixture +@pytest.fixture() def patch_module_npm(mocker: MockerFixture) -> None: """Patch methods and functions used during init of RunwayModuleNpm.""" mocker.patch("runway.module.base.RunwayModuleNpm.check_for_npm") diff --git a/tests/unit/module/staticsite/conftest.py b/tests/unit/module/staticsite/conftest.py index acd844651..7c4bb8941 100644 --- a/tests/unit/module/staticsite/conftest.py +++ b/tests/unit/module/staticsite/conftest.py @@ -1,6 +1,5 @@ """Pytest fixtures and plugins.""" -# pylint: disable=redefined-outer-name from __future__ import annotations from pathlib import Path @@ -8,13 +7,13 @@ import pytest -@pytest.fixture(scope="function") +@pytest.fixture() def expected_yaml(local_fixtures: Path) -> Path: """Path to local fixtures expected yaml.""" return local_fixtures / "expected_yaml" -@pytest.fixture(scope="function") +@pytest.fixture() def local_fixtures() -> Path: """Local fixtures directory.""" return Path(__file__).parent / "fixtures" diff --git a/tests/unit/module/staticsite/options/test_components.py b/tests/unit/module/staticsite/options/test_components.py index f705cada2..77ee203bc 100644 --- a/tests/unit/module/staticsite/options/test_components.py +++ b/tests/unit/module/staticsite/options/test_components.py @@ -20,9 +20,7 @@ def test_init(self) -> None: data = RunwayStaticSiteModuleOptionsDataModel( build_output="./dist", build_steps=["runway --help"], - pre_build_steps=[ - RunwayStaticSitePreBuildStepDataModel(command="runway --help") - ], + pre_build_steps=[RunwayStaticSitePreBuildStepDataModel(command="runway --help")], ) obj = StaticSiteOptions(data=data) assert obj.build_output == data.build_output @@ -36,7 +34,4 @@ def test_parse_obj(self) -> None: """Test parse_obj.""" obj = StaticSiteOptions.parse_obj({}) assert isinstance(obj.data, RunwayStaticSiteModuleOptionsDataModel) - assert ( - obj.data.dict(exclude_defaults=True, exclude_none=True, exclude_unset=True) - == {} - ) + assert obj.data.dict(exclude_defaults=True, exclude_none=True, exclude_unset=True) == {} diff --git a/tests/unit/module/staticsite/options/test_models.py b/tests/unit/module/staticsite/options/test_models.py index 385596b52..62372f679 100644 --- a/tests/unit/module/staticsite/options/test_models.py +++ b/tests/unit/module/staticsite/options/test_models.py @@ -4,7 +4,7 @@ from __future__ import annotations from pathlib import Path -from typing import Any, Dict, Optional, cast +from typing import Any, Optional, cast import pytest from pydantic import ValidationError @@ -35,15 +35,12 @@ class TestRunwayStaticSiteExtraFileDataModel: def test_autofill_content_type(self, expected: Optional[str], name: str) -> None: """Test _autofill_content_type.""" assert ( - RunwayStaticSiteExtraFileDataModel(content="test", name=name).content_type - == expected + RunwayStaticSiteExtraFileDataModel(content="test", name=name).content_type == expected ) def test_init_default(self) -> None: """Test init default.""" - obj = RunwayStaticSiteExtraFileDataModel( - content="test-content", name="test-name" - ) + obj = RunwayStaticSiteExtraFileDataModel(content="test-content", name="test-name") assert not obj.content_type assert obj.content == "test-content" assert not obj.file @@ -84,13 +81,13 @@ def test_init_file(self, tmp_path: Path) -> None: @pytest.mark.parametrize( "data", [ - cast(Dict[str, str], {}), + cast(dict[str, str], {}), {"name": "test"}, {"content": "test"}, {"file": "test"}, ], ) - def test_init_required(self, data: Dict[str, Any]) -> None: + def test_init_required(self, data: dict[str, Any]) -> None: """Test init required fields.""" with pytest.raises(ValidationError): RunwayStaticSiteExtraFileDataModel(**data) @@ -103,9 +100,12 @@ def test_init_default(self) -> None: """Test init default.""" obj = RunwayStaticSiteModuleOptionsDataModel() assert obj.build_output == "./" - assert not obj.build_steps and isinstance(obj.build_steps, list) - assert not obj.extra_files and isinstance(obj.extra_files, list) - assert not obj.pre_build_steps and isinstance(obj.pre_build_steps, list) + assert not obj.build_steps + assert isinstance(obj.build_steps, list) + assert not obj.extra_files + assert isinstance(obj.extra_files, list) + assert not obj.pre_build_steps + assert isinstance(obj.pre_build_steps, list) assert obj.source_hashing == RunwayStaticSiteSourceHashingDataModel() def test_init_extra(self) -> None: @@ -159,9 +159,7 @@ def test_init_required(self, tmp_path: Path) -> None: def test_init(self, tmp_path: Path) -> None: """Test init.""" - obj = RunwayStaticSitePreBuildStepDataModel( - command="runway --help", cwd=tmp_path - ) + obj = RunwayStaticSitePreBuildStepDataModel(command="runway --help", cwd=tmp_path) assert obj.command == "runway --help" assert obj.cwd == tmp_path @@ -206,7 +204,8 @@ class TestRunwayStaticSiteSourceHashingDirectoryDataModel: def test_init_default(self, tmp_path: Path) -> None: """Test init default.""" obj = RunwayStaticSiteSourceHashingDirectoryDataModel(path=tmp_path) - assert not obj.exclusions and isinstance(obj.exclusions, list) + assert not obj.exclusions + assert isinstance(obj.exclusions, list) assert obj.path == tmp_path def test_init_extra(self, tmp_path: Path) -> None: diff --git a/tests/unit/module/staticsite/parameters/test_models.py b/tests/unit/module/staticsite/parameters/test_models.py index ad52e66f2..712033827 100644 --- a/tests/unit/module/staticsite/parameters/test_models.py +++ b/tests/unit/module/staticsite/parameters/test_models.py @@ -1,7 +1,7 @@ """Test runway.module.staticsite.parameters.models.""" # pyright: basic -from typing import Any, Dict, cast +from typing import Any, cast import pytest from pydantic import ValidationError @@ -57,12 +57,12 @@ def test_init_extra(self) -> None: @pytest.mark.parametrize( "data", [ - cast(Dict[str, Any], {}), + cast(dict[str, Any], {}), {"arn": "aws:arn:lambda:us-east-1:function:test"}, {"type": "origin-request"}, ], ) - def test_init_required(self, data: Dict[str, Any]) -> None: + def test_init_required(self, data: dict[str, Any]) -> None: """Test init required.""" with pytest.raises(ValidationError): RunwayStaticSiteLambdaFunctionAssociationDataModel.parse_obj(data) @@ -115,9 +115,7 @@ def test_init_default(self) -> None: "font-src 'self' 'unsafe-inline' 'unsafe-eval' data: https:; " "object-src 'none'; " "connect-src 'self' https://*.amazonaws.com https://*.amazoncognito.com", - "Strict-Transport-Security": "max-age=31536000; " - "includeSubdomains; " - "preload", + "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "Referrer-Policy": "same-origin", "X-XSS-Protection": "1; mode=block", "X-Frame-Options": "DENY", @@ -193,10 +191,7 @@ def test_init(self) -> None: } obj = RunwayStaticSiteModuleParametersDataModel(**data) # type: ignore assert obj.acmcert_arn == data["staticsite_acmcert_arn"] - assert ( - obj.additional_redirect_domains - == data["staticsite_additional_redirect_domains"] - ) + assert obj.additional_redirect_domains == data["staticsite_additional_redirect_domains"] assert obj.aliases == data["staticsite_aliases"] assert obj.auth_at_edge is data["staticsite_auth_at_edge"] assert obj.cf_disable is data["staticsite_cf_disable"] @@ -221,10 +216,7 @@ def test_init(self) -> None: assert obj.namespace == data["namespace"] assert obj.non_spa is data["staticsite_non_spa"] assert obj.oauth_scopes == data["staticsite_oauth_scopes"] - assert ( - obj.redirect_path_auth_refresh - == data["staticsite_redirect_path_auth_refresh"] - ) + assert obj.redirect_path_auth_refresh == data["staticsite_redirect_path_auth_refresh"] assert obj.redirect_path_sign_in == data["staticsite_redirect_path_sign_in"] assert obj.redirect_path_sign_out == data["staticsite_redirect_path_sign_out"] assert obj.required_group == data["staticsite_required_group"] @@ -232,9 +224,6 @@ def test_init(self) -> None: assert obj.role_boundary_arn == data["staticsite_role_boundary_arn"] assert obj.service_role == data["cloudformation_service_role"] assert obj.sign_out_url == data["staticsite_sign_out_url"] - assert ( - obj.supported_identity_providers - == data["staticsite_supported_identity_providers"] - ) + assert obj.supported_identity_providers == data["staticsite_supported_identity_providers"] assert obj.user_pool_arn == data["staticsite_user_pool_arn"] assert obj.web_acl == data["staticsite_web_acl"] diff --git a/tests/unit/module/staticsite/test_handler.py b/tests/unit/module/staticsite/test_handler.py index 23f2e01c5..520e4de8d 100644 --- a/tests/unit/module/staticsite/test_handler.py +++ b/tests/unit/module/staticsite/test_handler.py @@ -1,16 +1,14 @@ """Test runway.module.staticsite.handler.""" -# pylint: disable=protected-access -# pyright: basic from __future__ import annotations import logging import platform import string -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any +from unittest.mock import Mock import pytest -from mock import Mock from runway.module.staticsite.handler import StaticSite from runway.module.staticsite.options.components import StaticSiteOptions @@ -21,7 +19,6 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from runway.context import RunwayContext @@ -99,7 +96,7 @@ def test_create_cleanup_yaml( def test_create_dependencies_yaml( self, expected_yaml: Path, - parameters: Dict[str, Any], + parameters: dict[str, Any], runway_context: RunwayContext, test_file_number: str, tmp_path: Path, @@ -137,7 +134,7 @@ def test_create_dependencies_yaml( def test_create_staticsite_yaml( self, expected_yaml: Path, - parameters: Dict[str, Any], + parameters: dict[str, Any], runway_context: RunwayContext, test_file_number: str, tmp_path: Path, @@ -228,17 +225,13 @@ def test_ensure_valid_environment_config_exit( ) -> None: """Test _ensure_valid_environment_config.""" with pytest.raises(SystemExit): - StaticSite( - runway_context, module_root=tmp_path, parameters={"namespace": ""} - ) + StaticSite(runway_context, module_root=tmp_path, parameters={"namespace": ""}) def test_get_client_updater_variables( self, mocker: MockerFixture, runway_context: RunwayContext, tmp_path: Path ) -> None: """Test _get_client_updater_variables.""" - mock_add_url_scheme = mocker.patch( - f"{MODULE}.add_url_scheme", return_value="success" - ) + mock_add_url_scheme = mocker.patch(f"{MODULE}.add_url_scheme", return_value="success") obj = StaticSite( runway_context, module_root=tmp_path, @@ -257,31 +250,18 @@ def test_get_client_updater_variables( assert "rxref test-" in result["client_id"] assert "rxref test::" in result["distribution_domain"] assert result["oauth_scopes"] == site_stack_variables["OAuthScopes"] - assert ( - result["redirect_path_sign_in"] - == site_stack_variables["RedirectPathSignIn"] - ) - assert ( - result["redirect_path_sign_out"] - == site_stack_variables["RedirectPathSignOut"] - ) - assert ( - result["supported_identity_providers"] - == obj.parameters.supported_identity_providers - ) + assert result["redirect_path_sign_in"] == site_stack_variables["RedirectPathSignIn"] + assert result["redirect_path_sign_out"] == site_stack_variables["RedirectPathSignOut"] + assert result["supported_identity_providers"] == obj.parameters.supported_identity_providers def test_init( - self, caplog: LogCaptureFixture, runway_context: RunwayContext, tmp_path: Path + self, caplog: pytest.LogCaptureFixture, runway_context: RunwayContext, tmp_path: Path ) -> None: """Test init.""" caplog.set_level(logging.WARNING, logger=MODULE) - obj = StaticSite( - runway_context, module_root=tmp_path, parameters={"namespace": "test"} - ) + obj = StaticSite(runway_context, module_root=tmp_path, parameters={"namespace": "test"}) assert not obj.init() - assert ( - f"init not currently supported for {StaticSite.__name__}" in caplog.messages - ) + assert f"init not currently supported for {StaticSite.__name__}" in caplog.messages def test_plan( self, mocker: MockerFixture, runway_context: RunwayContext, tmp_path: Path @@ -298,9 +278,7 @@ def test_plan( assert not obj.plan() mock_setup_website_module.assert_called_once_with(command="plan") - @pytest.mark.parametrize( - "provided, expected", [("foo", "foo"), ("foo.bar", "foo-bar")] - ) + @pytest.mark.parametrize("provided, expected", [("foo", "foo"), ("foo.bar", "foo-bar")]) def test_sanitized_name( self, expected: str, diff --git a/tests/unit/module/test_base.py b/tests/unit/module/test_base.py index 53534ffd2..39d323b46 100644 --- a/tests/unit/module/test_base.py +++ b/tests/unit/module/test_base.py @@ -1,13 +1,10 @@ """Test runway.module.base.""" -# pylint: disable=comparison-with-callable -# comparison-with-callable is intermittent - possibly due to use of runway.compat? -# pyright: basic from __future__ import annotations import logging from contextlib import contextmanager -from typing import TYPE_CHECKING, Any, Dict, Iterator, List, cast +from typing import TYPE_CHECKING, Any, cast import pytest @@ -15,9 +12,9 @@ from runway.module.base import NPM_BIN, ModuleOptions, RunwayModule, RunwayModuleNpm if TYPE_CHECKING: + from collections.abc import Iterator from pathlib import Path - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from pytest_subprocess import FakeProcess @@ -48,7 +45,7 @@ class TestRunwayModuleNpm: """Test runway.module.base.RunwayModuleNpm.""" def test_check_for_npm_missing( - self, caplog: LogCaptureFixture, mocker: MockerFixture + self, caplog: pytest.LogCaptureFixture, mocker: MockerFixture ) -> None: """Test check_for_npm missing.""" caplog.set_level(logging.ERROR, logger=MODULE) @@ -74,9 +71,7 @@ def test_init_npm_not_found( mock_check_for_npm = mocker.patch.object( RunwayModuleNpm, "check_for_npm", side_effect=NpmNotFound ) - mock_warn_on_boto_env_vars = mocker.patch.object( - RunwayModuleNpm, "warn_on_boto_env_vars" - ) + mock_warn_on_boto_env_vars = mocker.patch.object(RunwayModuleNpm, "warn_on_boto_env_vars") with pytest.raises(NpmNotFound): RunwayModuleNpm(runway_context, module_root=tmp_path) mock_check_for_npm.assert_called_once() @@ -87,9 +82,7 @@ def test_init( ) -> None: """Test __init__.""" mock_check_for_npm = mocker.patch.object(RunwayModuleNpm, "check_for_npm") - mock_warn_on_boto_env_vars = mocker.patch.object( - RunwayModuleNpm, "warn_on_boto_env_vars" - ) + mock_warn_on_boto_env_vars = mocker.patch.object(RunwayModuleNpm, "warn_on_boto_env_vars") obj = RunwayModuleNpm( runway_context, module_root=tmp_path, @@ -110,7 +103,7 @@ def test_init( def test_log_npm_command( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -130,7 +123,7 @@ def test_log_npm_command( @pytest.mark.parametrize("colorize", [True, False]) def test_npm_install_ci( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, colorize: bool, fake_process: FakeProcess, mocker: MockerFixture, @@ -144,7 +137,7 @@ def test_npm_install_ci( mocker.patch.object(RunwayModuleNpm, "warn_on_boto_env_vars") runway_context.env.ci = True runway_context.env.vars["RUNWAY_COLORIZE"] = str(colorize) - cmd: List[Any] = [NPM_BIN, "ci"] + cmd: list[Any] = [NPM_BIN, "ci"] if not colorize: cmd.append("--no-color") fake_process.register_subprocess(cmd, returncode=0) @@ -166,7 +159,7 @@ def test_npm_install_ci( ) def test_npm_install_install( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, colorize: bool, fake_process: FakeProcess, is_noninteractive: bool, @@ -182,7 +175,7 @@ def test_npm_install_install( mocker.patch.object(RunwayModuleNpm, "warn_on_boto_env_vars") runway_context.env.ci = is_noninteractive runway_context.env.vars["RUNWAY_COLORIZE"] = str(colorize) - cmd: List[Any] = [NPM_BIN, "install"] + cmd: list[Any] = [NPM_BIN, "install"] if not colorize: cmd.append("--no-color") fake_process.register_subprocess(cmd, returncode=0) @@ -192,7 +185,7 @@ def test_npm_install_install( def test_npm_install_skip( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -208,7 +201,7 @@ def test_npm_install_skip( def test_package_json_missing( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -220,12 +213,12 @@ def test_package_json_missing( obj = RunwayModuleNpm(context=runway_context, module_root=tmp_path) assert obj.package_json_missing() - assert ["module is missing package.json"] == caplog.messages + assert caplog.messages == ["module is missing package.json"] (tmp_path / "package.json").touch() assert not obj.package_json_missing() - def test_warn_on_boto_env_vars(self, caplog: LogCaptureFixture) -> None: + def test_warn_on_boto_env_vars(self, caplog: pytest.LogCaptureFixture) -> None: """Test warn_on_boto_env_vars.""" caplog.set_level(logging.WARNING, logger=MODULE) RunwayModuleNpm.warn_on_boto_env_vars({"AWS_DEFAULT_PROFILE": "something"}) @@ -238,13 +231,13 @@ def test_warn_on_boto_env_vars(self, caplog: LogCaptureFixture) -> None: @pytest.mark.parametrize( "env_vars", [ - cast(Dict[str, str], {}), + cast(dict[str, str], {}), {"AWS_PROFILE": "something"}, {"AWS_DEFAULT_PROFILE": "something", "AWS_PROFILE": "something"}, ], ) def test_warn_on_boto_env_vars_no_warn( - self, caplog: LogCaptureFixture, env_vars: Dict[str, str] + self, caplog: pytest.LogCaptureFixture, env_vars: dict[str, str] ) -> None: """Test warn_on_boto_env_vars no warn.""" caplog.set_level(logging.WARNING, logger=MODULE) @@ -259,9 +252,7 @@ def test_warn_on_boto_env_vars_no_warn( class TestRunwayModule: """Test runway.module.base.RunwayModule.""" - def test___init___default( - self, runway_context: MockRunwayContext, tmp_path: Path - ) -> None: + def test___init___default(self, runway_context: MockRunwayContext, tmp_path: Path) -> None: """Test __init__ default values.""" obj = RunwayModule(runway_context, module_root=tmp_path) assert not obj.explicitly_enabled diff --git a/tests/unit/module/test_cdk.py b/tests/unit/module/test_cdk.py index 1265d5a0c..7d5cfc6ac 100644 --- a/tests/unit/module/test_cdk.py +++ b/tests/unit/module/test_cdk.py @@ -1,16 +1,13 @@ """Test runway.module.cdk.""" -# pylint: disable=unused-argument -# pyright: basic from __future__ import annotations import logging from subprocess import CalledProcessError -from typing import TYPE_CHECKING, Any, Dict, List, Optional -from unittest.mock import call +from typing import TYPE_CHECKING, Any, Optional +from unittest.mock import Mock, call import pytest -from mock import Mock from runway.config.models.runway.options.cdk import RunwayCdkModuleOptionsDataModel from runway.module.cdk import CloudDevelopmentKit, CloudDevelopmentKitOptions @@ -18,7 +15,6 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from pytest_subprocess import FakeProcess from pytest_subprocess.fake_popen import FakePopen @@ -35,7 +31,7 @@ class TestCloudDevelopmentKit: def test_cdk_bootstrap( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: RunwayContext, tmp_path: Path, @@ -66,24 +62,20 @@ def test_cdk_bootstrap_raise_called_process_error( ) -> None: """Test cdk_bootstrap raise CalledProcessError.""" mocker.patch.object(CloudDevelopmentKit, "gen_cmd") - mocker.patch( - f"{MODULE}.run_module_command", side_effect=CalledProcessError(1, "") - ) + mocker.patch(f"{MODULE}.run_module_command", side_effect=CalledProcessError(1, "")) with pytest.raises(CalledProcessError): CloudDevelopmentKit(runway_context, module_root=tmp_path).cdk_bootstrap() def test_cdk_deploy( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: RunwayContext, tmp_path: Path, ) -> None: """Test cdk_deploy.""" caplog.set_level(logging.INFO, logger=MODULE) - mock_gen_cmd = mocker.patch.object( - CloudDevelopmentKit, "gen_cmd", return_value=["deploy"] - ) + mock_gen_cmd = mocker.patch.object(CloudDevelopmentKit, "gen_cmd", return_value=["deploy"]) mock_run_module_command = mocker.patch(f"{MODULE}.run_module_command") obj = CloudDevelopmentKit(runway_context, module_root=tmp_path) assert not obj.cdk_deploy() @@ -105,24 +97,20 @@ def test_cdk_deploy_raise_called_process_error( ) -> None: """Test cdk_deploy raise CalledProcessError.""" mocker.patch.object(CloudDevelopmentKit, "gen_cmd") - mocker.patch( - f"{MODULE}.run_module_command", side_effect=CalledProcessError(1, "") - ) + mocker.patch(f"{MODULE}.run_module_command", side_effect=CalledProcessError(1, "")) with pytest.raises(CalledProcessError): CloudDevelopmentKit(runway_context, module_root=tmp_path).cdk_deploy() def test_cdk_destroy( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: RunwayContext, tmp_path: Path, ) -> None: """Test cdk_destroy.""" caplog.set_level(logging.INFO, logger=MODULE) - mock_gen_cmd = mocker.patch.object( - CloudDevelopmentKit, "gen_cmd", return_value=["destroy"] - ) + mock_gen_cmd = mocker.patch.object(CloudDevelopmentKit, "gen_cmd", return_value=["destroy"]) mock_run_module_command = mocker.patch(f"{MODULE}.run_module_command") obj = CloudDevelopmentKit(runway_context, module_root=tmp_path) assert not obj.cdk_destroy() @@ -144,30 +132,24 @@ def test_cdk_destroy_raise_called_process_error( ) -> None: """Test cdk_destroy raise CalledProcessError.""" mocker.patch.object(CloudDevelopmentKit, "gen_cmd") - mocker.patch( - f"{MODULE}.run_module_command", side_effect=CalledProcessError(1, "") - ) + mocker.patch(f"{MODULE}.run_module_command", side_effect=CalledProcessError(1, "")) with pytest.raises(CalledProcessError): CloudDevelopmentKit(runway_context, module_root=tmp_path).cdk_destroy() def test_cdk_diff( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: RunwayContext, tmp_path: Path, ) -> None: """Test cdk_diff.""" caplog.set_level(logging.INFO, logger=MODULE) - mock_gen_cmd = mocker.patch.object( - CloudDevelopmentKit, "gen_cmd", return_value=["diff"] - ) + mock_gen_cmd = mocker.patch.object(CloudDevelopmentKit, "gen_cmd", return_value=["diff"]) mock_run_module_command = mocker.patch(f"{MODULE}.run_module_command") obj = CloudDevelopmentKit(runway_context, module_root=tmp_path) assert not obj.cdk_diff() - mock_gen_cmd.assert_called_once_with( - "diff", args_list=None, include_context=True - ) + mock_gen_cmd.assert_called_once_with("diff", args_list=None, include_context=True) mock_run_module_command.assert_called_once_with( cmd_list=mock_gen_cmd.return_value, env_vars=runway_context.env.vars, @@ -178,9 +160,7 @@ def test_cdk_diff( assert "plan (in progress)" in logs assert "plan (complete)" in logs assert not obj.cdk_diff("stack_name") - mock_gen_cmd.assert_called_with( - "diff", args_list=["stack_name"], include_context=True - ) + mock_gen_cmd.assert_called_with("diff", args_list=["stack_name"], include_context=True) @pytest.mark.parametrize("return_code", [1, 2]) def test_cdk_diff_catch_called_process_error_sys_exit( @@ -208,9 +188,7 @@ def test_cdk_list( tmp_path: Path, ) -> None: """Test cdk_list.""" - mock_gen_cmd = mocker.patch.object( - CloudDevelopmentKit, "gen_cmd", return_value=["list"] - ) + mock_gen_cmd = mocker.patch.object(CloudDevelopmentKit, "gen_cmd", return_value=["list"]) fake_process.register_subprocess( mock_gen_cmd.return_value, returncode=0, stdout="Stack0\nStack1" ) @@ -227,12 +205,8 @@ def test_cdk_list_empty( tmp_path: Path, ) -> None: """Test cdk_list empty.""" - mock_gen_cmd = mocker.patch.object( - CloudDevelopmentKit, "gen_cmd", return_value=["list"] - ) - fake_process.register_subprocess( - mock_gen_cmd.return_value, returncode=0, stdout="" - ) + mock_gen_cmd = mocker.patch.object(CloudDevelopmentKit, "gen_cmd", return_value=["list"]) + fake_process.register_subprocess(mock_gen_cmd.return_value, returncode=0, stdout="") obj = CloudDevelopmentKit(runway_context, module_root=tmp_path) assert obj.cdk_list() == [""] assert fake_process.call_count(mock_gen_cmd.return_value) == 1 @@ -245,9 +219,7 @@ def test_cdk_list_raise_called_process_error( tmp_path: Path, ) -> None: """Test cdk_list raise CalledProcessError.""" - mock_gen_cmd = mocker.patch.object( - CloudDevelopmentKit, "gen_cmd", return_value=["list"] - ) + mock_gen_cmd = mocker.patch.object(CloudDevelopmentKit, "gen_cmd", return_value=["list"]) fake_process.register_subprocess( mock_gen_cmd.return_value, returncode=1, @@ -271,7 +243,7 @@ def test_cdk_list_raise_called_process_error( def test_cli_args( self, debug: bool, - expected: List[str], + expected: list[str], no_color: bool, tmp_path: Path, verbose: bool, @@ -299,9 +271,9 @@ def test_cli_args( ) def test_cli_args_context( self, - expected: List[str], + expected: list[str], runway_context: RunwayContext, - parameters: Dict[str, Any], + parameters: dict[str, Any], tmp_path: Path, ) -> None: """Test cli_args_context.""" @@ -409,10 +381,10 @@ def test_destroy( ) def test_gen_cmd( self, - args_list: Optional[List[str]], + args_list: Optional[list[str]], command: CdkCommandTypeDef, env_ci: bool, - expected: List[str], + expected: list[str], include_context: bool, mocker: MockerFixture, runway_context: RunwayContext, @@ -420,9 +392,7 @@ def test_gen_cmd( ) -> None: """Test gen_cmd.""" mocker.patch.object(CloudDevelopmentKit, "cli_args", ["cli_args"]) - mocker.patch.object( - CloudDevelopmentKit, "cli_args_context", ["cli_args_context"] - ) + mocker.patch.object(CloudDevelopmentKit, "cli_args_context", ["cli_args_context"]) generate_node_command = mocker.patch( f"{MODULE}.generate_node_command", return_value=["success"] ) @@ -495,16 +465,14 @@ def test_plan( def test_run_build_steps_empty( self, - caplog: LogCaptureFixture, - fake_process: FakeProcess, + caplog: pytest.LogCaptureFixture, + fake_process: FakeProcess, # noqa: ARG002 runway_context: RunwayContext, tmp_path: Path, ) -> None: """Test run_build_steps.""" caplog.set_level(logging.INFO, logger=MODULE) - obj = CloudDevelopmentKit( - runway_context, module_root=tmp_path, options={"build_steps": []} - ) + obj = CloudDevelopmentKit(runway_context, module_root=tmp_path, options={"build_steps": []}) assert not obj.run_build_steps() logs = "\n".join(caplog.messages) assert "build steps (in progress)" not in logs @@ -512,10 +480,10 @@ def test_run_build_steps_empty( def test_run_build_steps_linux( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fake_process: FakeProcess, mocker: MockerFixture, - platform_linux: None, + platform_linux: None, # noqa: ARG002 runway_context: RunwayContext, tmp_path: Path, ) -> None: @@ -535,9 +503,9 @@ def test_run_build_steps_linux( def test_run_build_steps_raise_file_not_found( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fake_process: FakeProcess, - platform_linux: None, + platform_linux: None, # noqa: ARG002 runway_context: RunwayContext, tmp_path: Path, ) -> None: @@ -561,7 +529,7 @@ def _callback(process: FakePopen) -> None: def test_run_build_steps_raise_called_process_error( self, fake_process: FakeProcess, - platform_linux: None, + platform_linux: None, # noqa: ARG002 runway_context: RunwayContext, tmp_path: Path, ) -> None: @@ -577,10 +545,10 @@ def test_run_build_steps_raise_called_process_error( def test_run_build_steps_windows( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fake_process: FakeProcess, mocker: MockerFixture, - platform_windows: None, + platform_windows: None, # noqa: ARG002 runway_context: RunwayContext, tmp_path: Path, ) -> None: @@ -611,7 +579,7 @@ def test_run_build_steps_windows( ) def test_skip( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, expected: bool, explicitly_enabled: bool, mocker: MockerFixture, @@ -637,9 +605,7 @@ def test_skip( if package_json_missing: assert "skipped; package.json" in "\n".join(caplog.messages) elif not explicitly_enabled: - assert "skipped; environment required but not defined" in "\n".join( - caplog.messages - ) + assert "skipped; environment required but not defined" in "\n".join(caplog.messages) class TestCloudDevelopmentKitOptions: diff --git a/tests/unit/module/test_cloudformation.py b/tests/unit/module/test_cloudformation.py index 029e98a5b..575e7eeeb 100644 --- a/tests/unit/module/test_cloudformation.py +++ b/tests/unit/module/test_cloudformation.py @@ -3,7 +3,7 @@ # pyright: basic from __future__ import annotations -from typing import TYPE_CHECKING, Any, Dict +from typing import TYPE_CHECKING, Any from runway.core.components import DeployEnvironment from runway.module.cloudformation import CloudFormation @@ -25,16 +25,14 @@ class TestCloudFormation: """Test runway.module.cloudformation.CloudFormation.""" @property - def generic_parameters(self) -> Dict[str, Any]: + def generic_parameters(self) -> dict[str, Any]: """Return generic module options.""" return {"test_key": "test-value"} @staticmethod def get_context(name: str = "test", region: str = "us-east-1") -> MockRunwayContext: """Create a basic Runway context object.""" - context = MockRunwayContext( - deploy_environment=DeployEnvironment(explicit_name=name) - ) + context = MockRunwayContext(deploy_environment=DeployEnvironment(explicit_name=name)) context.env.aws_region = region return context diff --git a/tests/unit/module/test_k8s.py b/tests/unit/module/test_k8s.py index 0bf296bda..20bad3a1f 100644 --- a/tests/unit/module/test_k8s.py +++ b/tests/unit/module/test_k8s.py @@ -5,7 +5,7 @@ import logging from subprocess import CalledProcessError -from typing import TYPE_CHECKING, List, Optional +from typing import TYPE_CHECKING, Optional import pytest import yaml @@ -17,7 +17,6 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from pytest_subprocess import FakeProcess @@ -86,9 +85,9 @@ def test_destroy( ) def test_gen_cmd( self, - args_list: Optional[List[str]], + args_list: Optional[list[str]], command: KubectlCommandTypeDef, - expected: List[str], + expected: list[str], mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -107,7 +106,7 @@ def test_gen_cmd( def test_init( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, runway_context: MockRunwayContext, tmp_path: Path, ) -> None: @@ -122,17 +121,13 @@ def test_kbenv( ) -> None: """Test kbenv.""" mock_env_mgr = mocker.patch(f"{MODULE}.KBEnvManager", return_value="success") - overlay_path = mocker.patch( - f"{MODULE}.K8sOptions.overlay_path", tmp_path / "overlay" - ) - assert ( - K8s(runway_context, module_root=tmp_path).kbenv == mock_env_mgr.return_value - ) + overlay_path = mocker.patch(f"{MODULE}.K8sOptions.overlay_path", tmp_path / "overlay") + assert K8s(runway_context, module_root=tmp_path).kbenv == mock_env_mgr.return_value mock_env_mgr.assert_called_once_with(tmp_path, overlay_path=overlay_path) def test_kubectl_apply( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -161,9 +156,7 @@ def test_kubectl_apply_raise_called_process_error( ) -> None: """Test kubectl_apply raise CalledProcessError.""" mocker.patch.object(K8s, "gen_cmd") - mocker.patch( - f"{MODULE}.run_module_command", side_effect=CalledProcessError(1, "") - ) + mocker.patch(f"{MODULE}.run_module_command", side_effect=CalledProcessError(1, "")) with pytest.raises(CalledProcessError): K8s(runway_context, module_root=tmp_path).kubectl_apply() @@ -180,9 +173,7 @@ def test_kubectl_bin_option( self, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path ) -> None: """Test kubectl_bin.""" - obj = K8s( - runway_context, module_root=tmp_path, options={"kubectl_version": "1.22.0"} - ) + obj = K8s(runway_context, module_root=tmp_path, options={"kubectl_version": "1.22.0"}) mock_install = mocker.patch.object(obj.kbenv, "install", return_value="success") assert obj.kubectl_bin == mock_install.return_value mock_install.assert_called_once_with("1.22.0") @@ -193,9 +184,7 @@ def test_kubectl_bin_handle_version_not_specified( """Test kubectl_bin.""" which = mocker.patch(f"{MODULE}.which", return_value=True) obj = K8s(runway_context, module_root=tmp_path) - mocker.patch.object( - obj.kbenv, "install", side_effect=KubectlVersionNotSpecified - ) + mocker.patch.object(obj.kbenv, "install", side_effect=KubectlVersionNotSpecified) assert obj.kubectl_bin == "kubectl" which.assert_called_once_with("kubectl") @@ -205,16 +194,14 @@ def test_kubectl_bin_handle_version_not_specified_exit( """Test kubectl_bin.""" which = mocker.patch(f"{MODULE}.which", return_value=False) obj = K8s(runway_context, module_root=tmp_path) - mocker.patch.object( - obj.kbenv, "install", side_effect=KubectlVersionNotSpecified - ) + mocker.patch.object(obj.kbenv, "install", side_effect=KubectlVersionNotSpecified) with pytest.raises(SystemExit): assert obj.kubectl_bin which.assert_called_once_with("kubectl") def test_kubectl_delete( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -243,15 +230,13 @@ def test_kubectl_delete_raise_called_process_error( ) -> None: """Test kubectl_delete raise CalledProcessError.""" mocker.patch.object(K8s, "gen_cmd") - mocker.patch( - f"{MODULE}.run_module_command", side_effect=CalledProcessError(1, "") - ) + mocker.patch(f"{MODULE}.run_module_command", side_effect=CalledProcessError(1, "")) with pytest.raises(CalledProcessError): K8s(runway_context, module_root=tmp_path).kubectl_delete() def test_kubectl_kustomize( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, fake_process: FakeProcess, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -261,15 +246,9 @@ def test_kubectl_kustomize( caplog.set_level(logging.DEBUG, logger=MODULE) data = {"key": "val"} data_string = yaml.dump(data, indent=2) - gen_cmd = mocker.patch.object( - K8s, "gen_cmd", return_value=["kubectl", "kustomize"] - ) - fake_process.register_subprocess( - gen_cmd.return_value, stdout=data_string, returncode=0 - ) - assert ( - K8s(runway_context, module_root=tmp_path).kubectl_kustomize() == data_string - ) + gen_cmd = mocker.patch.object(K8s, "gen_cmd", return_value=["kubectl", "kustomize"]) + fake_process.register_subprocess(gen_cmd.return_value, stdout=data_string, returncode=0) + assert K8s(runway_context, module_root=tmp_path).kubectl_kustomize() == data_string assert fake_process.call_count(gen_cmd.return_value) == 1 logs = "\n".join(caplog.messages) assert f"kustomized yaml generated by kubectl:\n\n{data_string}" in logs @@ -282,9 +261,7 @@ def test_kubectl_kustomize_raise_called_process_error( tmp_path: Path, ) -> None: """Test kubectl_kustomize.""" - gen_cmd = mocker.patch.object( - K8s, "gen_cmd", return_value=["kubectl", "kustomize"] - ) + gen_cmd = mocker.patch.object(K8s, "gen_cmd", return_value=["kubectl", "kustomize"]) fake_process.register_subprocess(gen_cmd.return_value, returncode=1) with pytest.raises(CalledProcessError): assert K8s(runway_context, module_root=tmp_path).kubectl_kustomize() @@ -302,7 +279,7 @@ def test_skip(self, runway_context: MockRunwayContext, tmp_path: Path) -> None: @pytest.mark.parametrize("skip", [False, True]) def test_plan( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, skip: bool, @@ -311,9 +288,7 @@ def test_plan( """Test plan.""" caplog.set_level(logging.INFO, logger=MODULE) mocker.patch.object(K8s, "skip", skip) - kubectl_kustomize = mocker.patch.object( - K8s, "kubectl_kustomize", return_value="success" - ) + kubectl_kustomize = mocker.patch.object(K8s, "kubectl_kustomize", return_value="success") assert not K8s(runway_context, module_root=tmp_path).plan() if skip: kubectl_kustomize.assert_not_called() @@ -321,8 +296,7 @@ def test_plan( kubectl_kustomize.assert_called_once_with() logs = "\n".join(caplog.messages) assert ( - f"kustomized yaml generated by kubectl:\n\n{kubectl_kustomize.return_value}" - in logs + f"kustomized yaml generated by kubectl:\n\n{kubectl_kustomize.return_value}" in logs ) @@ -348,18 +322,13 @@ def test_gen_overlay_dirs(self) -> None: (["test2/kustomization.yaml"], "test"), ], ) - def test_get_overlay_dir( - self, expected: str, files: List[str], tmp_path: Path - ) -> None: + def test_get_overlay_dir(self, expected: str, files: list[str], tmp_path: Path) -> None: """Test get_overlay_dir.""" for f in files: tmp_file = tmp_path / f tmp_file.parent.mkdir(parents=True, exist_ok=True) tmp_file.touch() - assert ( - K8sOptions.get_overlay_dir(tmp_path, "test", "us-east-1") - == tmp_path / expected - ) + assert K8sOptions.get_overlay_dir(tmp_path, "test", "us-east-1") == tmp_path / expected def test_kustomize_config( self, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path @@ -367,9 +336,7 @@ def test_kustomize_config( """Test kustomize_config.""" overlay_path = tmp_path / "overlays" / "test" mocker.patch.object(K8sOptions, "overlay_path", overlay_path) - obj = K8sOptions.parse_obj( - deploy_environment=runway_context.env, obj={}, path=tmp_path - ) + obj = K8sOptions.parse_obj(deploy_environment=runway_context.env, obj={}, path=tmp_path) assert obj.kustomize_config == overlay_path / "kustomization.yaml" def test_overlay_path_found( @@ -380,9 +347,7 @@ def test_overlay_path_found( mock_get_overlay_dir = mocker.patch.object( K8sOptions, "get_overlay_dir", return_value=overlay_path ) - obj = K8sOptions.parse_obj( - deploy_environment=runway_context.env, obj={}, path=tmp_path - ) + obj = K8sOptions.parse_obj(deploy_environment=runway_context.env, obj={}, path=tmp_path) assert obj.overlay_path == overlay_path mock_get_overlay_dir.assert_called_once_with( path=tmp_path / "overlays", @@ -390,9 +355,7 @@ def test_overlay_path_found( region=runway_context.env.aws_region, ) - def test_overlay_path_provided( - self, runway_context: MockRunwayContext, tmp_path: Path - ) -> None: + def test_overlay_path_provided(self, runway_context: MockRunwayContext, tmp_path: Path) -> None: """Test overlay_path provided.""" overlay_path = tmp_path / "overlays" / "test" obj = K8sOptions.parse_obj( @@ -405,9 +368,7 @@ def test_overlay_path_provided( def test_parse_obj(self, runway_context: MockRunwayContext, tmp_path: Path) -> None: """Test parse_obj.""" config = {"kubectl_version": "0.13.0"} - obj = K8sOptions.parse_obj( - deploy_environment=runway_context.env, obj=config, path=tmp_path - ) + obj = K8sOptions.parse_obj(deploy_environment=runway_context.env, obj=config, path=tmp_path) assert isinstance(obj.data, RunwayK8sModuleOptionsDataModel) assert obj.data.kubectl_version == config["kubectl_version"] assert not obj.data.overlay_path diff --git a/tests/unit/module/test_serverless.py b/tests/unit/module/test_serverless.py index 6a3ab4670..4929f63ff 100644 --- a/tests/unit/module/test_serverless.py +++ b/tests/unit/module/test_serverless.py @@ -5,11 +5,11 @@ import logging from pathlib import Path -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast +from typing import TYPE_CHECKING, Any, Optional, Union, cast +from unittest.mock import ANY, MagicMock, Mock, call import pytest import yaml -from mock import ANY, MagicMock, Mock, call from pydantic import ValidationError from runway.config.models.runway.options.serverless import ( @@ -23,7 +23,6 @@ ) if TYPE_CHECKING: - from pytest import LogCaptureFixture from pytest_mock import MockerFixture from pytest_subprocess.fake_process import FakeProcess @@ -40,9 +39,7 @@ class TestServerless: def test___init__(self, runway_context: MockRunwayContext, tmp_path: Path) -> None: """Test __init__ and the attributes set in __init__.""" - obj = Serverless( - runway_context, module_root=tmp_path, options={"skip_npm_ci": True} - ) + obj = Serverless(runway_context, module_root=tmp_path, options={"skip_npm_ci": True}) assert isinstance(obj.options, ServerlessOptions) assert obj.region == runway_context.env.aws_region assert obj.stage == runway_context.env.name @@ -56,7 +53,7 @@ def test___init__(self, runway_context: MockRunwayContext, tmp_path: Path) -> No def test__deploy_package( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tempfile_temporary_directory: MagicMock, @@ -65,9 +62,7 @@ def test__deploy_package( """Test _deploy_package.""" caplog.set_level(logging.INFO, logger=MODULE) sls_deploy = mocker.patch.object(Serverless, "sls_deploy") - assert not Serverless( # pylint: disable=protected-access - runway_context, module_root=tmp_path - )._deploy_package() + assert not Serverless(runway_context, module_root=tmp_path)._deploy_package() tempfile_temporary_directory.assert_not_called() sls_deploy.assert_called_once_with() assert f"{tmp_path.name}:deploy (in progress)" in caplog.messages @@ -75,7 +70,7 @@ def test__deploy_package( def test__deploy_package_promotezip( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tempfile_temporary_directory: MagicMock, @@ -84,25 +79,17 @@ def test__deploy_package_promotezip( """Test _deploy_package.""" caplog.set_level(logging.INFO, logger=MODULE) artifact = Mock(package_path=tmp_path) - artifact_class = mocker.patch( - f"{MODULE}.ServerlessArtifact", return_value=artifact - ) + artifact_class = mocker.patch(f"{MODULE}.ServerlessArtifact", return_value=artifact) sls_deploy = mocker.patch.object(Serverless, "sls_deploy") - sls_package = mocker.patch.object( - Serverless, "sls_package", return_value=str(tmp_path) - ) - sls_print = mocker.patch.object( - Serverless, "sls_print", return_value="print output" - ) + sls_package = mocker.patch.object(Serverless, "sls_package", return_value=str(tmp_path)) + sls_print = mocker.patch.object(Serverless, "sls_print", return_value="print output") obj = Serverless( runway_context, module_root=tmp_path, options={"promotezip": {"bucketname": "test-bucket"}}, ) - assert not obj._deploy_package() # pylint: disable=protected-access - tempfile_temporary_directory.assert_called_once_with( - dir=runway_context.work_dir - ) + assert not obj._deploy_package() + tempfile_temporary_directory.assert_called_once_with(dir=runway_context.work_dir) sls_print.assert_called_once() artifact_class.assert_called_once_with( runway_context, @@ -284,13 +271,12 @@ def test_env_file(self, runway_context: MockRunwayContext, tmp_path: Path) -> No def test_extend_serverless_yml( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, ) -> None: """Test extend_serverless_yml.""" - # pylint: disable=no-member mock_merge = mocker.patch("runway.module.serverless.merge_dicts") caplog.set_level(logging.DEBUG, logger="runway") mock_func = MagicMock() @@ -312,14 +298,10 @@ def test_extend_serverless_yml( tmp_file = obj.options.update_args.call_args[0][1] # 'no way to check the prefix since it will be a uuid' assert tmp_file.endswith(".tmp.serverless.yml") - assert not ( - tmp_path / tmp_file - ).exists(), 'should always be deleted after calling "func"' + assert not (tmp_path / tmp_file).exists(), 'should always be deleted after calling "func"' caplog.clear() - mocker.patch( - "pathlib.Path.unlink", MagicMock(side_effect=OSError("test OSError")) - ) + mocker.patch("pathlib.Path.unlink", MagicMock(side_effect=OSError("test OSError"))) assert not obj.extend_serverless_yml(mock_func) assert ( f"{tmp_path.name}:encountered an error when trying to delete the " @@ -373,7 +355,7 @@ def test_gen_cmd( def test_init( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, runway_context: MockRunwayContext, tmp_path: Path, ) -> None: @@ -388,7 +370,7 @@ def test_init( def test_plan( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, runway_context: MockRunwayContext, tmp_path: Path, ) -> None: @@ -396,13 +378,11 @@ def test_plan( caplog.set_level(logging.INFO, logger="runway") obj = Serverless(runway_context, module_root=tmp_path) assert not obj.plan() - assert [ - f"{tmp_path.name}:plan not currently supported for Serverless" - ] == caplog.messages + assert [f"{tmp_path.name}:plan not currently supported for Serverless"] == caplog.messages def test_skip( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -410,7 +390,7 @@ def test_skip( """Test skip.""" caplog.set_level(logging.INFO, logger="runway") obj = Serverless(runway_context, module_root=tmp_path) - mocker.patch.object(obj, "package_json_missing", lambda: True) + mocker.patch.object(obj, "package_json_missing", return_value=True) mocker.patch.object(obj, "env_file", False) assert obj.skip @@ -420,7 +400,7 @@ def test_skip( ] == caplog.messages caplog.clear() - mocker.patch.object(obj, "package_json_missing", lambda: False) + mocker.patch.object(obj, "package_json_missing", return_value=False) assert obj.skip assert [ f"{tmp_path.name}:skipped; config file for this stage/region not found" @@ -494,9 +474,7 @@ def test_sls_package( else: npm_install.assert_called_once_with() if output_path: - gen_cmd.assert_called_once_with( - "package", args_list=["--package", str(output_path)] - ) + gen_cmd.assert_called_once_with("package", args_list=["--package", str(output_path)]) else: gen_cmd.assert_called_once_with("package", args_list=[]) run_module_command.assert_called_once_with( @@ -517,9 +495,7 @@ def test_sls_print( """Test sls_print.""" expected_dict = {"status": "success"} mock_check_output = MagicMock(return_value=yaml.safe_dump(expected_dict)) - gen_cmd = mocker.patch.object( - Serverless, "gen_cmd", MagicMock(return_value=["print"]) - ) + gen_cmd = mocker.patch.object(Serverless, "gen_cmd", MagicMock(return_value=["print"])) npm_install = mocker.patch.object(Serverless, "npm_install", MagicMock()) mocker.patch("subprocess.check_output", mock_check_output) assert ( @@ -553,9 +529,7 @@ def test_sls_remove( ) -> None: """Test sls_remove.""" fake_process.register_subprocess("remove", stdout="success") - gen_cmd = mocker.patch.object( - Serverless, "gen_cmd", MagicMock(return_value=["remove"]) - ) + gen_cmd = mocker.patch.object(Serverless, "gen_cmd", MagicMock(return_value=["remove"])) npm_install = mocker.patch.object(Serverless, "npm_install", MagicMock()) assert not Serverless(runway_context, module_root=tmp_path).sls_remove( skip_install=skip_install @@ -648,14 +622,12 @@ def test_source_hash( self, mocker: MockerFixture, runway_context: MockRunwayContext, - service: Union[Dict[str, Any], str], + service: Union[dict[str, Any], str], service_name: str, tmp_path: Path, ) -> None: """Test source_hash.""" - get_hash_of_files = mocker.patch( - f"{MODULE}.get_hash_of_files", Mock(return_value="hash") - ) + get_hash_of_files = mocker.patch(f"{MODULE}.get_hash_of_files", Mock(return_value="hash")) assert ServerlessArtifact( runway_context, { @@ -680,7 +652,7 @@ def test_source_hash_individually( self, mocker: MockerFixture, runway_context: MockRunwayContext, - service: Union[Dict[str, Any], str], + service: Union[dict[str, Any], str], tmp_path: Path, ) -> None: """Test source_hash.""" @@ -711,9 +683,7 @@ def test_sync_with_s3_download( self, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path ) -> None: """Test sync_with_s3.""" - does_s3_object_exist = mocker.patch( - f"{MODULE}.does_s3_object_exist", return_value=True - ) + does_s3_object_exist = mocker.patch(f"{MODULE}.does_s3_object_exist", return_value=True) download = mocker.patch(f"{MODULE}.download") session = Mock() package_path = tmp_path / "package" @@ -744,9 +714,7 @@ def test_sync_with_s3_upload( self, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path ) -> None: """Test sync_with_s3.""" - does_s3_object_exist = mocker.patch( - f"{MODULE}.does_s3_object_exist", return_value=False - ) + does_s3_object_exist = mocker.patch(f"{MODULE}.does_s3_object_exist", return_value=False) download = mocker.patch(f"{MODULE}.download") session = Mock() package_path = tmp_path / "package" @@ -779,9 +747,7 @@ def test_sync_with_s3_upload_not_exist( self, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path ) -> None: """Test sync_with_s3.""" - does_s3_object_exist = mocker.patch( - f"{MODULE}.does_s3_object_exist", return_value=False - ) + does_s3_object_exist = mocker.patch(f"{MODULE}.does_s3_object_exist", return_value=False) download = mocker.patch(f"{MODULE}.download") session = Mock() package_path = tmp_path / "package" @@ -819,7 +785,7 @@ class TestServerlessOptions: (["-u"], ["-u"]), ], ) - def test_args(self, args: List[str], expected: List[str]) -> None: + def test_args(self, args: list[str], expected: list[str]) -> None: """Test args.""" obj = ServerlessOptions.parse_obj({"args": args}) assert obj.args == expected @@ -862,21 +828,21 @@ def test_args(self, args: List[str], expected: List[str]) -> None: ), ], ) - def test_parse(self, config: Dict[str, Any]) -> None: + def test_parse(self, config: dict[str, Any]) -> None: """Test parse.""" obj = ServerlessOptions.parse_obj(config) assert obj.args == config.get("args", []) assert obj.extend_serverless_yml == config.get( - "extend_serverless_yml", cast(Dict[str, Any], {}) + "extend_serverless_yml", cast(dict[str, Any], {}) ) if config.get("promotezip"): assert obj.promotezip else: assert not obj.promotezip - assert obj.promotezip.bucketname == config.get( - "promotezip", cast(Dict[str, Any], {}) - ).get("bucketname") + assert obj.promotezip.bucketname == config.get("promotezip", cast(dict[str, Any], {})).get( + "bucketname" + ) assert obj.skip_npm_ci == config.get("skip_npm_ci", False) def test_parse_invalid_promotezip(self) -> None: diff --git a/tests/unit/module/test_terraform.py b/tests/unit/module/test_terraform.py index 517149db9..d61ec5e8e 100644 --- a/tests/unit/module/test_terraform.py +++ b/tests/unit/module/test_terraform.py @@ -1,16 +1,15 @@ """Test runway.module.terraform.""" -# pylint: disable=too-many-statements,too-many-lines -# pyright: basic, reportFunctionMemberAccess=none +# pyright: reportFunctionMemberAccess=none from __future__ import annotations import json import logging import subprocess -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Type, Union +from typing import TYPE_CHECKING, Any, Optional, Union +from unittest.mock import MagicMock, Mock import pytest -from mock import MagicMock, Mock from runway._logging import LogLevels from runway.module.terraform import ( @@ -25,7 +24,6 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture, MonkeyPatch from pytest_mock import MockerFixture from ..factories import MockRunwayContext @@ -60,7 +58,7 @@ def test_update_env_vars_with_tf_var_values() -> None: assert result == expected -class TestTerraform: # pylint: disable=too-many-public-methods +class TestTerraform: """Test runway.module.terraform.Terraform.""" def test___init__(self, runway_context: MockRunwayContext, tmp_path: Path) -> None: @@ -90,7 +88,7 @@ def test___init___options_workspace( def test_auto_tfvars( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -122,7 +120,7 @@ def test_auto_tfvars( def test_auto_tfvars_unsupported_version( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -144,7 +142,7 @@ def test_auto_tfvars_unsupported_version( def test_cleanup_dot_terraform( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, runway_context: MockRunwayContext, tmp_path: Path, ) -> None: @@ -180,10 +178,7 @@ def test_current_workspace( mock_terraform_workspace_show = mocker.patch.object( Terraform, "terraform_workspace_show", return_value="default" ) - assert ( - Terraform(runway_context, module_root=tmp_path).current_workspace - == "default" - ) + assert Terraform(runway_context, module_root=tmp_path).current_workspace == "default" mock_terraform_workspace_show.assert_called_once_with() @pytest.mark.parametrize( @@ -197,7 +192,7 @@ def test_current_workspace( ) def test_env_file( self, - filename: Union[List[str], str], + filename: Union[list[str], str], expected: Optional[str], runway_context: MockRunwayContext, tmp_path: Path, @@ -216,10 +211,10 @@ def test_env_file( assert not obj.env_file @pytest.mark.parametrize("action", ["deploy", "destroy", "init", "plan"]) - def test_execute( + def test_execute( # noqa: PLR0915 self, action: str, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -232,9 +227,7 @@ def test_execute( mocker.patch.object(Terraform, "handle_parameters", MagicMock()) mocker.patch.object(Terraform, "terraform_init", MagicMock()) mocker.patch.object(Terraform, "current_workspace", "test") - mocker.patch.object( - Terraform, "terraform_workspace_list", MagicMock(return_value="* test") - ) + mocker.patch.object(Terraform, "terraform_workspace_list", MagicMock(return_value="* test")) mocker.patch.object(Terraform, "terraform_workspace_select", MagicMock()) mocker.patch.object(Terraform, "terraform_workspace_new", MagicMock()) mocker.patch.object(Terraform, "terraform_get", MagicMock()) @@ -248,8 +241,6 @@ def test_execute( ) command = "apply" if action == "deploy" else action - # pylint: disable=no-member - # module is skipped obj = Terraform(runway_context, module_root=tmp_path) assert not obj[action]() obj.handle_backend.assert_called_once_with() @@ -291,9 +282,7 @@ def test_execute( assert "re-running init after workspace change..." in logs # module is run; create workspace - mocker.patch.object( - Terraform, "terraform_workspace_list", MagicMock(return_value="") - ) + mocker.patch.object(Terraform, "terraform_workspace_list", MagicMock(return_value="")) assert not obj[action]() obj.terraform_workspace_new.assert_called_once_with("test") @@ -311,9 +300,9 @@ def test_execute( ) def test_gen_command( self, - command: Union[List[str], str], - args_list: Optional[List[str]], - expected: List[str], + command: Union[list[str], str], + args_list: Optional[list[str]], + expected: list[str], mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -332,7 +321,7 @@ def test_gen_command( def test_handle_backend_no_handler( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -340,7 +329,7 @@ def test_handle_backend_no_handler( """Test handle_backend with no handler.""" caplog.set_level(LogLevels.DEBUG, logger=MODULE) mock_get_full_configuration = MagicMock(return_value={}) - backend: Dict[str, Union[Dict[str, Any], str]] = { + backend: dict[str, Union[dict[str, Any], str]] = { "type": "unsupported", "config": {}, } @@ -360,7 +349,7 @@ def test_handle_backend_no_handler( def test_handle_backend_no_type( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -374,8 +363,8 @@ def test_handle_backend_no_type( def test_handle_backend_remote_name( self, - caplog: LogCaptureFixture, - monkeypatch: MonkeyPatch, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, runway_context: MockRunwayContext, tmp_path: Path, ) -> None: @@ -401,8 +390,8 @@ def test_handle_backend_remote_name( def test_handle_backend_remote_prefix( self, - caplog: LogCaptureFixture, - monkeypatch: MonkeyPatch, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, runway_context: MockRunwayContext, tmp_path: Path, ) -> None: @@ -429,8 +418,8 @@ def test_handle_backend_remote_prefix( def test_handle_backend_remote_undetermined( self, - caplog: LogCaptureFixture, - monkeypatch: MonkeyPatch, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, runway_context: MockRunwayContext, tmp_path: Path, ) -> None: @@ -438,7 +427,7 @@ def test_handle_backend_remote_undetermined( caplog.set_level(LogLevels.WARNING, logger=MODULE) monkeypatch.delenv("TF_WORKSPACE", raising=False) mock_get_full_configuration = MagicMock(return_value={}) - backend: Dict[str, Union[Dict[str, Any], str]] = { + backend: dict[str, Union[dict[str, Any], str]] = { "type": "remote", "config": {}, } @@ -453,9 +442,7 @@ def test_handle_backend_remote_undetermined( assert not obj.handle_backend() mock_get_full_configuration.assert_called_once_with() - assert '"workspaces" not defined in backend config' in "\n".join( - caplog.messages - ) + assert '"workspaces" not defined in backend config' in "\n".join(caplog.messages) def test_handle_parameters( self, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path @@ -536,7 +523,7 @@ def test_tf_bin_global( def test_tf_bin_missing( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, mocker: MockerFixture, runway_context: MockRunwayContext, tmp_path: Path, @@ -552,9 +539,8 @@ def test_tf_bin_missing( assert obj.tf_bin assert excinfo.value.code == 1 mock_which.assert_called_once_with("terraform") - assert ( - "terraform not available and a version to install not specified" - in "\n".join(caplog.messages) + assert "terraform not available and a version to install not specified" in "\n".join( + caplog.messages ) def test_tf_bin_options( @@ -606,7 +592,7 @@ def test_terraform_apply( ) def test_terraform_destroy( self, - expected_options: List[str], + expected_options: list[str], expected_subcmd: str, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -618,9 +604,7 @@ def test_terraform_destroy( Terraform, "gen_command", return_value=["mock_gen_command"] ) mocker.patch.object(Terraform, "version", version) - mock_run_command = mocker.patch( - f"{MODULE}.run_module_command", return_value=None - ) + mock_run_command = mocker.patch(f"{MODULE}.run_module_command", return_value=None) obj = Terraform(runway_context, module_root=tmp_path) mocker.patch.object(obj, "env_file", ["env_file"]) @@ -658,7 +642,7 @@ def test_terraform_init( Terraform, "gen_command", return_value=["mock_gen_command"] ) mock_run_command = mocker.patch(f"{MODULE}.run_module_command") - options: Dict[str, Union[Dict[str, Any], str]] = { + options: dict[str, Union[dict[str, Any], str]] = { "args": {"init": ["init_arg"]}, "terraform_backend_config": {"bucket": "name"}, } @@ -773,9 +757,7 @@ def test_terraform_workspace_show( ) mock_subprocess = mocker.patch(f"{MODULE}.subprocess") check_output_result = MagicMock( - strip=MagicMock( - return_value=MagicMock(decode=MagicMock(return_value="decoded")) - ) + strip=MagicMock(return_value=MagicMock(decode=MagicMock(return_value="decoded"))) ) mock_subprocess.check_output.return_value = check_output_result @@ -835,9 +817,7 @@ def test_version_raise_value_error( tfenv.get_version_from_executable.return_value = None mocker.patch.object(Terraform, "tfenv", tfenv) mocker.patch.object(Terraform, "tf_bin", "/bin/terraform") - with pytest.raises( - ValueError, match="unable to retrieve version from /bin/terraform" - ): + with pytest.raises(ValueError, match="unable to retrieve version from /bin/terraform"): assert Terraform(runway_context, module_root=tmp_path).version @@ -930,7 +910,7 @@ def test_backend_config( ], ) def test_parse_obj( - self, config: Dict[str, Any], runway_context: MockRunwayContext, tmp_path: Path + self, config: dict[str, Any], runway_context: MockRunwayContext, tmp_path: Path ) -> None: """Test parse_obj.""" obj = TerraformOptions.parse_obj( @@ -992,25 +972,17 @@ def test_get_full_configuration( }, ["bucket=test-bucket", "dynamodb_table=test-table", "region=us-east-1"], ), - ( - { - "bucket": "test-bucket", - "dynamodb_table": "test-table", - "region": "us-east-1", - }, - ["bucket=test-bucket", "dynamodb_table=test-table", "region=us-east-1"], - ), ], ) def test_init_args( self, - expected_items: List[str], - input_data: Dict[str, str], + expected_items: list[str], + input_data: dict[str, str], runway_context: MockRunwayContext, tmp_path: Path, ) -> None: """Test init_args.""" - expected: List[str] = [] + expected: list[str] = [] for i in expected_items: expected.extend(["-backend-config", i]) assert ( @@ -1022,7 +994,7 @@ def test_init_args( def test_init_args_file( self, - caplog: LogCaptureFixture, + caplog: pytest.LogCaptureFixture, runway_context: MockRunwayContext, tmp_path: Path, ) -> None: @@ -1049,10 +1021,7 @@ def test_gen_backend_filenames(self) -> None: "backend.tfvars", ] - assert ( - TerraformBackendConfig.gen_backend_filenames("test", "us-east-1") - == expected - ) + assert TerraformBackendConfig.gen_backend_filenames("test", "us-east-1") == expected @pytest.mark.parametrize( "filename, expected", @@ -1069,7 +1038,7 @@ def test_gen_backend_filenames(self) -> None: ], ) def test_get_backend_file( - self, tmp_path: Path, filename: Union[List[str], str], expected: Optional[str] + self, tmp_path: Path, filename: Union[list[str], str], expected: Optional[str] ) -> None: """Test get_backend_file.""" if isinstance(filename, list): @@ -1095,7 +1064,7 @@ def test_get_backend_file( ) def test_parse_obj( self, - config: Dict[str, str], + config: dict[str, str], expected_region: str, mocker: MockerFixture, runway_context: MockRunwayContext, @@ -1104,11 +1073,11 @@ def test_parse_obj( """Test parse_obj.""" def assert_get_backend_file_args( - _cls: Type[TerraformBackendConfig], + _cls: type[TerraformBackendConfig], path: Path, env_name: str, env_region: str, - ): + ) -> str: """Assert args passed to the method during parse.""" assert path == tmp_path assert env_name == "test" diff --git a/tests/unit/module/test_utils.py b/tests/unit/module/test_utils.py index 74972149e..91b7cbaaf 100644 --- a/tests/unit/module/test_utils.py +++ b/tests/unit/module/test_utils.py @@ -1,12 +1,9 @@ """Test runway.module.utils.""" -# pylint: disable=unused-argument -# pyright: basic from __future__ import annotations -from pathlib import Path from subprocess import CalledProcessError -from typing import TYPE_CHECKING, Any, List +from typing import TYPE_CHECKING, Any import pytest @@ -20,6 +17,8 @@ ) if TYPE_CHECKING: + from pathlib import Path + from pytest_mock import MockerFixture from pytest_subprocess import FakeProcess @@ -36,7 +35,7 @@ ], ) def test_format_npm_command_for_logging_darwin( - command: List[str], expected: str, platform_darwin: None + command: list[str], expected: str, platform_darwin: None # noqa: ARG001 ) -> None: """Test format_npm_command_for_logging on Darwin/macOS.""" assert format_npm_command_for_logging(command) == expected @@ -52,7 +51,7 @@ def test_format_npm_command_for_logging_darwin( ], ) def test_format_npm_command_for_logging_windows( - command: List[str], expected: str, platform_windows: None + command: list[str], expected: str, platform_windows: None # noqa: ARG001 ) -> None: """Test format_npm_command_for_logging on windows.""" assert format_npm_command_for_logging(command) == expected @@ -62,7 +61,7 @@ def test_format_npm_command_for_logging_windows( "command, opts", [("test", []), ("test", ["arg1"]), ("test", ["arg1", "arg2"])] ) def test_generate_node_command( - command: str, mocker: MockerFixture, opts: List[str], tmp_path: Path + command: str, mocker: MockerFixture, opts: list[str], tmp_path: Path ) -> None: """Test generate_node_command.""" mock_which = mocker.patch(f"{MODULE}.which", return_value=False) @@ -83,9 +82,9 @@ def test_generate_node_command( ) def test_generate_node_command_npx( command: str, - expected: List[str], + expected: list[str], mocker: MockerFixture, - opts: List[str], + opts: list[str], tmp_path: Path, ) -> None: """Test generate_node_command.""" @@ -94,9 +93,7 @@ def test_generate_node_command_npx( mock_which.assert_called_once_with(NPX_BIN) -def test_generate_node_command_npx_package( - mocker: MockerFixture, tmp_path: Path -) -> None: +def test_generate_node_command_npx_package(mocker: MockerFixture, tmp_path: Path) -> None: """Test generate_node_command.""" mock_which = mocker.patch(f"{MODULE}.which", return_value=True) assert generate_node_command( @@ -170,7 +167,7 @@ def test_use_npm_ci( (tmp_path / "package-lock.json").touch() if has_shrinkwrap: (tmp_path / "package-lock.json").touch() - cmd: List[Any] = [NPM_BIN, "ci", "-h"] + cmd: list[Any] = [NPM_BIN, "ci", "-h"] fake_process.register_subprocess(cmd, returncode=exit_code) assert use_npm_ci(tmp_path) is expected diff --git a/tests/unit/test_compat.py b/tests/unit/test_compat.py index 8edd79d48..b9c3cd5c0 100644 --- a/tests/unit/test_compat.py +++ b/tests/unit/test_compat.py @@ -15,9 +15,7 @@ MODULE = "runway.compat" -py37 = pytest.mark.skipif( - sys.version_info >= (3, 8), reason="requires python3.8 or higher" -) +py37 = pytest.mark.skipif(sys.version_info >= (3, 8), reason="requires python3.8 or higher") @py37 diff --git a/tests/unit/test_mixins.py b/tests/unit/test_mixins.py index 5703c3ed1..eaa974a08 100644 --- a/tests/unit/test_mixins.py +++ b/tests/unit/test_mixins.py @@ -1,13 +1,12 @@ """Test runway.mixins.""" -# pylint: disable=protected-access,unused-argument from __future__ import annotations import subprocess -from typing import TYPE_CHECKING, Any, Dict, List, Optional +from typing import TYPE_CHECKING, Any, Optional +from unittest.mock import Mock import pytest -from mock import Mock from runway.compat import cached_property from runway.mixins import CliInterfaceMixin, DelCachedPropMixin @@ -35,17 +34,13 @@ def __init__(self, context: CfnginContext, cwd: Path) -> None: @pytest.mark.parametrize("env", [None, {"foo": "bar"}]) def test__run_command( - self, env: Optional[Dict[str, str]], mocker: MockerFixture, tmp_path: Path + self, env: Optional[dict[str, str]], mocker: MockerFixture, tmp_path: Path ) -> None: """Test _run_command.""" ctx_env = {"foo": "bar", "bar": "foo"} - mock_subprocess = mocker.patch( - f"{MODULE}.subprocess.check_output", return_value="success" - ) + mock_subprocess = mocker.patch(f"{MODULE}.subprocess.check_output", return_value="success") assert ( - self.Kls(Mock(env=Mock(vars=ctx_env)), tmp_path)._run_command( - "test", env=env - ) + self.Kls(Mock(env=Mock(vars=ctx_env)), tmp_path)._run_command("test", env=env) == mock_subprocess.return_value ) mock_subprocess.assert_called_once_with( @@ -57,17 +52,11 @@ def test__run_command( text=True, ) - def test__run_command_no_suppress_output( - self, mocker: MockerFixture, tmp_path: Path - ) -> None: + def test__run_command_no_suppress_output(self, mocker: MockerFixture, tmp_path: Path) -> None: """Test _run_command.""" env = {"foo": "bar"} - mock_list2cmdline = mocker.patch.object( - self.Kls, "list2cmdline", return_value="success" - ) - mock_subprocess = mocker.patch( - f"{MODULE}.subprocess.check_call", return_value=0 - ) + mock_list2cmdline = mocker.patch.object(self.Kls, "list2cmdline", return_value="success") + mock_subprocess = mocker.patch(f"{MODULE}.subprocess.check_call", return_value=0) assert not self.Kls(Mock(env=Mock(vars=env)), tmp_path)._run_command( ["foo", "bar"], suppress_output=False ) @@ -87,9 +76,7 @@ def test__run_command_no_suppress_output( ("--", "foo-bar", "--foo-bar"), ], ) - def test_convert_to_cli_arg( - self, expected: str, prefix: Optional[str], provided: str - ) -> None: + def test_convert_to_cli_arg(self, expected: str, prefix: Optional[str], provided: str) -> None: """Test convert_to_cli_arg.""" if prefix: assert self.Kls.convert_to_cli_arg(provided, prefix=prefix) == expected @@ -117,9 +104,9 @@ def test_found_in_path(self, mocker: MockerFixture, return_value: bool) -> None: ) def test_generate_command( self, - expected: List[str], + expected: list[str], mocker: MockerFixture, - provided: Dict[str, Any], + provided: dict[str, Any], ) -> None: """Test generate_command.""" exe = mocker.patch.object(self.Kls, "EXECUTABLE", "test.exe", create=True) @@ -130,7 +117,7 @@ def test_generate_command( ] def test_list2cmdline_darwin( - self, mocker: MockerFixture, platform_darwin: None + self, mocker: MockerFixture, platform_darwin: None # noqa: ARG002 ) -> None: """Test list2cmdline on Darwin/macOS systems.""" mock_list2cmdline = mocker.patch(f"{MODULE}.subprocess.list2cmdline") @@ -140,7 +127,7 @@ def test_list2cmdline_darwin( mock_join.assert_called_once_with("foo") def test_list2cmdline_linus( - self, mocker: MockerFixture, platform_linux: None + self, mocker: MockerFixture, platform_linux: None # noqa: ARG002 ) -> None: """Test list2cmdline on Linux systems.""" mock_list2cmdline = mocker.patch(f"{MODULE}.subprocess.list2cmdline") @@ -150,7 +137,7 @@ def test_list2cmdline_linus( mock_join.assert_called_once_with("foo") def test_list2cmdline_windows( - self, mocker: MockerFixture, platform_windows: None + self, mocker: MockerFixture, platform_windows: None # noqa: ARG002 ) -> None: """Test list2cmdline on Windows systems.""" mock_list2cmdline = mocker.patch( diff --git a/tests/unit/test_variables.py b/tests/unit/test_variables.py index 2d9e0f86f..6aea2af7f 100644 --- a/tests/unit/test_variables.py +++ b/tests/unit/test_variables.py @@ -1,17 +1,14 @@ """Tests for runway.variables.""" -# pylint: disable=expression-not-assigned,protected-access,unused-argument -# pylint: disable=too-many-lines # pyright: basic from __future__ import annotations -from typing import TYPE_CHECKING, Any, ClassVar, List, Union +from typing import TYPE_CHECKING, Any, ClassVar, Union +from unittest.mock import MagicMock, call import pytest -from mock import MagicMock, call from pydantic import BaseModel -from runway.context import CfnginContext, RunwayContext from runway.exceptions import ( FailedLookup, FailedVariableLookup, @@ -39,20 +36,18 @@ if TYPE_CHECKING: from pytest_mock import MockerFixture - from .factories import MockCFNginContext + from .factories import MockCfnginContext class MockLookupHandler(LookupHandler): """Mock lookup handler.""" return_value: ClassVar[Any] = "resolved" - side_effect: ClassVar[Union[Any, List[Any]]] = None + side_effect: ClassVar[Union[Any, list[Any]]] = None @classmethod - def handle( # pylint: disable=arguments-differ + def handle( cls, - value: str, - context: Union[CfnginContext, RunwayContext], *__args: Any, **__kwargs: Any, ) -> Any: @@ -64,24 +59,21 @@ def handle( # pylint: disable=arguments-differ return cls._handle_side_effect(cls.side_effect) @classmethod - def _handle_side_effect(cls, side_effect: Any): + def _handle_side_effect(cls, side_effect: Any) -> Any: """Handle side_effect.""" if isinstance(side_effect, BaseException): raise side_effect return side_effect -@pytest.fixture(autouse=True, scope="function") +@pytest.fixture(autouse=True) def patch_lookups(mocker: MockerFixture) -> None: """Patch registered lookups.""" for registry in [CFNGIN_LOOKUP_HANDLERS, RUNWAY_LOOKUP_HANDLERS]: - # mocked = {k: MockLookupHandler for k in registry} - # mocked["test"] = MockLookupHandler - # mocker.patch.dict(registry, mocked) mocker.patch.dict(registry, {"test": MockLookupHandler}) -def test_resolve_variables(cfngin_context: MockCFNginContext) -> None: +def test_resolve_variables(cfngin_context: MockCfnginContext) -> None: """Test resolve_variables.""" variable = MagicMock() assert not resolve_variables([variable], cfngin_context) @@ -99,7 +91,7 @@ def test_dependencies(self, mocker: MockerFixture) -> None: ) assert Variable("Param", "val").dependencies == {"test"} - def test_get(self, mocker: MockerFixture) -> None: + def test_get(self) -> None: """Test get.""" obj = Variable("Para", {"key": "val"}) assert obj.get("missing") is None @@ -117,9 +109,7 @@ def test_init(self, variable_type: VariableTypeLiteralTypeDef) -> None: def test_multiple_lookup_dict(self, mocker: MockerFixture) -> None: """Test multiple lookup dict.""" - mocker.patch.object( - MockLookupHandler, "side_effect", ["resolved0", "resolved1"] - ) + mocker.patch.object(MockLookupHandler, "side_effect", ["resolved0", "resolved1"]) value = { "something": "${test query0}", "other": "${test query1}", @@ -131,9 +121,7 @@ def test_multiple_lookup_dict(self, mocker: MockerFixture) -> None: def test_multiple_lookup_list(self, mocker: MockerFixture) -> None: """Test multiple lookup list.""" - mocker.patch.object( - MockLookupHandler, "side_effect", ["resolved0", "resolved1"] - ) + mocker.patch.object(MockLookupHandler, "side_effect", ["resolved0", "resolved1"]) value = [ "something", "${test query0}", @@ -170,9 +158,7 @@ def test_multiple_lookup_string(self, mocker: MockerFixture) -> None: """Test multiple lookup string.""" var = Variable("Param1", "url://${test query0}@${test query1}") assert isinstance(var._value, VariableValueConcatenation) - mocker.patch.object( - MockLookupHandler, "side_effect", ["resolved0", "resolved1"] - ) + mocker.patch.object(MockLookupHandler, "side_effect", ["resolved0", "resolved1"]) var.resolve(MagicMock(), MagicMock()) assert var.resolved is True assert var.value == "url://resolved0@resolved1" @@ -214,9 +200,7 @@ def test_no_lookup_str(self) -> None: @pytest.mark.parametrize("resolved", [False, True]) def test_resolved(self, mocker: MockerFixture, resolved: bool) -> None: """Test resolved.""" - mocker.patch.object( - VariableValue, "parse_obj", return_value=MagicMock(resolved=resolved) - ) + mocker.patch.object(VariableValue, "parse_obj", return_value=MagicMock(resolved=resolved)) assert Variable("Param", "val").resolved is resolved def test_resolve_failed(self, mocker: MockerFixture) -> None: @@ -231,7 +215,7 @@ def test_resolve_failed(self, mocker: MockerFixture) -> None: assert excinfo.value.cause == lookup_error assert excinfo.value.variable == obj - def test_repr(self) -> None: + def test___repr__(self) -> None: """Test __repr__.""" assert repr(Variable("Param", "val")) == "Variable[Param=val]" @@ -254,31 +238,29 @@ def test_simple_lookup(self) -> None: assert var.resolved is True assert var.value == "resolved" - def test_value_unresolved(self, mocker: MockerFixture): + def test_value_unresolved(self, mocker: MockerFixture) -> None: """Test value UnresolvedVariable.""" - mocker.patch.object( - VariableValue, "parse_obj", return_value=MagicMock(value="value") - ) + mocker.patch.object(VariableValue, "parse_obj", return_value=MagicMock(value="value")) def test_value(self) -> None: """Test value.""" with pytest.raises(UnresolvedVariable): - Variable("Param", "${test query}").value + Variable("Param", "${test query}").value # noqa: B018 class TestVariableValue: """Test runway.variables.VariableValue.""" + def test___iter__(self) -> None: + """Test __iter__.""" + with pytest.raises(NotImplementedError): + iter(VariableValue()) + def test_dependencies(self) -> None: """Test dependencies.""" obj = VariableValue() assert obj.dependencies == set() - def test_iter(self) -> None: - """Test __iter__.""" - with pytest.raises(NotImplementedError): - iter(VariableValue()) - def test_parse_obj_dict_empty(self) -> None: """Test parse_obj dict empty.""" assert isinstance(VariableValue.parse_obj({}), VariableValueDict) @@ -308,9 +290,7 @@ def test_parse_obj_literal_str(self) -> None: def test_parse_obj_pydantic_model(self) -> None: """Test parse_obj pydantic model.""" - assert isinstance( - VariableValue.parse_obj(BaseModel()), VariableValuePydanticModel - ) + assert isinstance(VariableValue.parse_obj(BaseModel()), VariableValuePydanticModel) def test_repr(self) -> None: """Test __repr__.""" @@ -320,9 +300,9 @@ def test_repr(self) -> None: def test_resolved(self) -> None: """Test resolved.""" with pytest.raises(NotImplementedError): - VariableValue().resolved # pylint: disable=expression-not-assigned + VariableValue().resolved # noqa: B018 - def test_resolve(self, cfngin_context: MockCFNginContext) -> None: + def test_resolve(self, cfngin_context: MockCfnginContext) -> None: """Test resolve.""" assert not VariableValue().resolve(context=cfngin_context) @@ -334,7 +314,7 @@ def test_simplified(self) -> None: def test_value(self) -> None: """Test value.""" with pytest.raises(NotImplementedError): - VariableValue().value # pylint: disable=expression-not-assigned + VariableValue().value # noqa: B018 class TestVariableValueConcatenation: @@ -392,14 +372,10 @@ def test_resolved(self) -> None: is False ) - def test_resolve( - self, cfngin_context: MockCFNginContext, mocker: MockerFixture - ) -> None: + def test_resolve(self, cfngin_context: MockCfnginContext, mocker: MockerFixture) -> None: """Test resolve.""" mock_provider = MagicMock() - mock_resolve = mocker.patch.object( - VariableValueLiteral, "resolve", return_value=None - ) + mock_resolve = mocker.patch.object(VariableValueLiteral, "resolve", return_value=None) obj = VariableValueConcatenation([VariableValueLiteral("val0")]) assert not obj.resolve( cfngin_context, @@ -440,42 +416,25 @@ def test_simplified_list(self) -> None: """Test simplified list.""" assert [ i.value - for i in VariableValueConcatenation( - [VariableValueList(["foo", "bar"])] - ).simplified + for i in VariableValueConcatenation([VariableValueList(["foo", "bar"])]).simplified ] == ["foo", "bar"] def test_simplified_literal_bool(self) -> None: """Test simplified literal bool.""" - assert ( - VariableValueConcatenation([VariableValueLiteral(True)]).simplified.value - is True - ) - assert ( - VariableValueConcatenation([VariableValueLiteral(False)]).simplified.value - is False - ) + assert VariableValueConcatenation([VariableValueLiteral(True)]).simplified.value is True + assert VariableValueConcatenation([VariableValueLiteral(False)]).simplified.value is False def test_simplified_literal_empty(self) -> None: """Test simplified literal empty.""" - assert ( - VariableValueConcatenation([VariableValueLiteral("")]).simplified.value - == "" - ) + assert VariableValueConcatenation([VariableValueLiteral("")]).simplified.value == "" def test_simplified_literal_int(self) -> None: """Test simplified literal int.""" - assert ( - VariableValueConcatenation([VariableValueLiteral(13)]).simplified.value - == 13 - ) + assert VariableValueConcatenation([VariableValueLiteral(13)]).simplified.value == 13 def test_simplified_literal_str(self) -> None: """Test simplified literal str.""" - assert ( - VariableValueConcatenation([VariableValueLiteral("foo")]).simplified.value - == "foo" - ) + assert VariableValueConcatenation([VariableValueLiteral("foo")]).simplified.value == "foo" assert ( VariableValueConcatenation( [VariableValueLiteral("foo"), VariableValueLiteral("bar")] @@ -483,29 +442,36 @@ def test_simplified_literal_str(self) -> None: == "foobar" ) - def test_value_multiple(self) -> None: - """Test multiple.""" - assert ( - VariableValueConcatenation( - [VariableValueLiteral("foo"), VariableValueLiteral("bar")] - ).value - == "foobar" - ) - assert ( - VariableValueConcatenation( - [VariableValueLiteral(13), VariableValueLiteral("/test")] # type: ignore - ).value - == "13/test" - ) - assert ( - VariableValueConcatenation( - [VariableValueLiteral(5), VariableValueLiteral(13)] - ).value - == "513" - ) + @pytest.mark.parametrize( + "variable, expected", + [ + ( + VariableValueConcatenation( + [VariableValueLiteral("foo"), VariableValueLiteral("bar")] + ), + "foobar", + ), + ( + VariableValueConcatenation( + [VariableValueLiteral(13), VariableValueLiteral("/test")] + ), + "13/test", + ), + ( + VariableValueConcatenation([VariableValueLiteral(5), VariableValueLiteral(13)]), + "513", + ), + ], + ) + def test_value_multiple(self, expected: str, variable: VariableValueConcatenation[Any]) -> None: + """Test value multiple.""" + assert variable.value == expected + + def test_value_multiple_raise_concatenation_error(self) -> None: + """Test value multiple raises InvalidLookupConcatenationError.""" with pytest.raises(InvalidLookupConcatenation): - VariableValueConcatenation( - [VariableValueLiteral(True), VariableValueLiteral("test")] # type: ignore + VariableValueConcatenation( # noqa: B018 + [VariableValueLiteral(True), VariableValueLiteral(VariableValueLiteral)] # type: ignore ).value def test_value_single(self) -> None: @@ -560,7 +526,7 @@ def test_len(self) -> None: def test_repr(self) -> None: """Test __repr__.""" obj = VariableValueDict({"key0": "val0", "key1": "val1"}) - assert repr(obj) == "Dict[key0=Literal[val0], key1=Literal[val1]]" + assert repr(obj) == "dict[key0=Literal[val0], key1=Literal[val1]]" @pytest.mark.parametrize("resolved", [False, True]) def test_resolved(self, mocker: MockerFixture, resolved: bool) -> None: @@ -570,9 +536,7 @@ def test_resolved(self, mocker: MockerFixture, resolved: bool) -> None: obj = VariableValueDict({"key": "val"}) assert obj.resolved is resolved - def test_resolve( - self, cfngin_context: MockCFNginContext, mocker: MockerFixture - ) -> None: + def test_resolve(self, cfngin_context: MockCfnginContext, mocker: MockerFixture) -> None: """Test resolve.""" mock_literal = MagicMock() mock_provider = MagicMock() @@ -634,8 +598,6 @@ def test_getitem(self) -> None: """Test __getitem__.""" obj = VariableValueList(["val0", "val1"]) assert obj[1].value == "val1" - # for some reason, the current version of pylint does not see this as iterable - # pylint: disable=not-an-iterable assert [i.value for i in obj[:2]] == ["val0", "val1"] def test_init(self, mocker: MockerFixture) -> None: @@ -667,7 +629,7 @@ def test_len(self) -> None: def test_repr(self) -> None: """Test __repr__.""" obj = VariableValueList(["val0", "val1"]) - assert repr(obj) == "List[Literal[val0], Literal[val1]]" + assert repr(obj) == "list[Literal[val0], Literal[val1]]" @pytest.mark.parametrize("resolved", [False, True]) def test_resolved(self, mocker: MockerFixture, resolved: bool) -> None: @@ -677,9 +639,7 @@ def test_resolved(self, mocker: MockerFixture, resolved: bool) -> None: obj = VariableValueList(["val0"]) assert obj.resolved is resolved - def test_resolve( - self, cfngin_context: MockCFNginContext, mocker: MockerFixture - ) -> None: + def test_resolve(self, cfngin_context: MockCfnginContext, mocker: MockerFixture) -> None: """Test resolve.""" mock_literal = MagicMock() mock_provider = MagicMock() @@ -765,20 +725,16 @@ def test_dependencies_no_attr(self) -> None: class FakeLookup: """Fake lookup.""" - obj = VariableValueLookup( - VariableValueLiteral("test"), "query", FakeLookup # type: ignore - ) + obj = VariableValueLookup(VariableValueLiteral("test"), "query", FakeLookup) # type: ignore assert obj.dependencies == set() def test_dependencies(self, mocker: MockerFixture) -> None: """Test dependencies.""" mocker.patch.object(MockLookupHandler, "dependencies", return_value={"test"}) - obj = VariableValueLookup( - VariableValueLiteral("test"), "query", MockLookupHandler - ) + obj = VariableValueLookup(VariableValueLiteral("test"), "query", MockLookupHandler) assert obj.dependencies == {"test"} - def test_init_convert_query(self) -> None: + def test___init___convert_query(self) -> None: """Test __init__ convert query.""" obj = VariableValueLookup( VariableValueLiteral("test"), "query", MockLookupHandler, "runway" @@ -786,15 +742,13 @@ def test_init_convert_query(self) -> None: assert isinstance(obj.lookup_query, VariableValueLiteral) assert obj.lookup_query.value == "query" - def test_init_find_handler_cfngin(self, mocker: MockerFixture) -> None: + def test___init___find_handler_cfngin(self, mocker: MockerFixture) -> None: """Test __init__ find handler cfngin.""" mocker.patch.dict(CFNGIN_LOOKUP_HANDLERS, {"test": "success"}) - obj = VariableValueLookup( - VariableValueLiteral("test"), VariableValueLiteral("query") - ) + obj = VariableValueLookup(VariableValueLiteral("test"), VariableValueLiteral("query")) assert obj.handler == "success" - def test_init_find_handler_runway(self, mocker: MockerFixture) -> None: + def test___init___find_handler_runway(self, mocker: MockerFixture) -> None: """Test __init__ find handler runway.""" mocker.patch.dict(RUNWAY_LOOKUP_HANDLERS, {"test": "success"}) obj = VariableValueLookup( @@ -804,16 +758,16 @@ def test_init_find_handler_runway(self, mocker: MockerFixture) -> None: ) assert obj.handler == "success" - def test_init_find_handler_value_error(self) -> None: + def test___init___find_handler_value_error(self) -> None: """Test __init__ fund handler ValueError.""" - with pytest.raises(ValueError): + with pytest.raises(ValueError, match="Variable type must be one of"): VariableValueLookup( VariableValueLiteral("test"), VariableValueLiteral("query"), variable_type="invalid", # type: ignore ) - def test_init_find_handler_unknown_lookup_type(self) -> None: + def test___init___find_handler_unknown_lookup_type(self) -> None: """Test __init__ fund handler UnknownLookupType.""" with pytest.raises(UnknownLookupType): VariableValueLookup( @@ -821,7 +775,7 @@ def test_init_find_handler_unknown_lookup_type(self) -> None: VariableValueLiteral("query"), ) - def test_init(self) -> None: + def test___init__(self) -> None: """Test __init__.""" name = VariableValueLiteral("test") query = VariableValueLiteral("query") @@ -831,12 +785,12 @@ def test_init(self) -> None: assert obj.lookup_query == query assert obj.variable_type == "runway" - def test_iter(self) -> None: + def test___iter__(self) -> None: """Test __iter__.""" obj = VariableValueLookup(VariableValueLiteral("test"), "query") assert list(iter(obj)) == [obj] - def test_repr(self) -> None: + def test___repr__(self) -> None: """Test __repr__.""" obj = VariableValueLookup(VariableValueLiteral("test"), "query") assert repr(obj) == "Lookup[Literal[test] Literal[query]]" @@ -867,16 +821,10 @@ def test_resolve(self, mocker: MockerFixture) -> None: "variables": MagicMock(), "kwarg": "something", } - mock_handle = mocker.patch.object( - MockLookupHandler, "handle", return_value="resolved" - ) - mock_resolve = mocker.patch.object( - VariableValueLookup, "_resolve", return_value=None - ) + mock_handle = mocker.patch.object(MockLookupHandler, "handle", return_value="resolved") + mock_resolve = mocker.patch.object(VariableValueLookup, "_resolve", return_value=None) mock_resolve_query = mocker.patch.object(VariableValueLiteral, "resolve") - obj = VariableValueLookup( - VariableValueLiteral("test"), VariableValueLiteral("query") - ) + obj = VariableValueLookup(VariableValueLiteral("test"), VariableValueLiteral("query")) assert not obj.resolve(**kwargs) # type: ignore mock_resolve_query.assert_called_once_with(**kwargs) mock_handle.assert_called_once_with("query", **kwargs) @@ -887,19 +835,16 @@ def test_simplified(self) -> None: obj = VariableValueLookup(VariableValueLiteral("test"), "query") assert obj.simplified == obj - def test_str(self) -> None: + def test___str__(self) -> None: """Test __str__.""" - assert ( - str(VariableValueLookup(VariableValueLiteral("test"), "query")) - == "${test query}" - ) + assert str(VariableValueLookup(VariableValueLiteral("test"), "query")) == "${test query}" def test_value(self) -> None: """Test value.""" obj = VariableValueLookup(VariableValueLiteral("test"), "query") assert obj.resolved is False with pytest.raises(UnresolvedVariableValue): - obj.value # pylint: disable=pointless-statement + assert obj.value obj._resolve("success") assert obj.resolved is True assert obj.value == "success" @@ -922,9 +867,7 @@ def test___delitem__(self) -> None: def test___getitem__(self, mocker: MockerFixture) -> None: """Test __getitem__.""" - mocker.patch.object( - VariableValuePydanticModel, "parse_obj", return_value="parsed_val" - ) + mocker.patch.object(VariableValuePydanticModel, "parse_obj", return_value="parsed_val") obj = VariableValuePydanticModel(self.ModelClass()) assert obj["test"] == "parsed_val" @@ -956,9 +899,7 @@ def test___repr__(self) -> None: def test___setitem__(self, mocker: MockerFixture) -> None: """Test __setitem__.""" - mocker.patch.object( - VariableValuePydanticModel, "parse_obj", return_value="parsed_val" - ) + mocker.patch.object(VariableValuePydanticModel, "parse_obj", return_value="parsed_val") obj = VariableValuePydanticModel(self.ModelClass()) obj["test"] = "new" # type: ignore assert obj["test"] == "new" @@ -966,21 +907,15 @@ def test___setitem__(self, mocker: MockerFixture) -> None: def test_dependencies(self, mocker: MockerFixture) -> None: """Test dependencies.""" mock_literal = MagicMock(dependencies=set("foobar")) - mocker.patch.object( - VariableValuePydanticModel, "parse_obj", return_value=mock_literal - ) + mocker.patch.object(VariableValuePydanticModel, "parse_obj", return_value=mock_literal) obj = VariableValuePydanticModel(self.ModelClass()) assert obj.dependencies == mock_literal.dependencies - def test_resolve( - self, cfngin_context: MockCFNginContext, mocker: MockerFixture - ) -> None: + def test_resolve(self, cfngin_context: MockCfnginContext, mocker: MockerFixture) -> None: """Test resolve.""" mock_literal = MagicMock() mock_provider = MagicMock() - mocker.patch.object( - VariableValuePydanticModel, "parse_obj", return_value=mock_literal - ) + mocker.patch.object(VariableValuePydanticModel, "parse_obj", return_value=mock_literal) obj = VariableValuePydanticModel(self.ModelClass()) assert not obj.resolve( cfngin_context, @@ -999,26 +934,20 @@ def test_resolve( def test_resolved(self, mocker: MockerFixture, resolved: bool) -> None: """Test resolved.""" mock_literal = MagicMock(resolved=resolved) - mocker.patch.object( - VariableValuePydanticModel, "parse_obj", return_value=mock_literal - ) + mocker.patch.object(VariableValuePydanticModel, "parse_obj", return_value=mock_literal) obj = VariableValuePydanticModel(self.ModelClass()) assert obj.resolved is resolved def test_simplified(self, mocker: MockerFixture) -> None: """Test simplified.""" mock_literal = MagicMock(simplified="simplified") - mocker.patch.object( - VariableValuePydanticModel, "parse_obj", return_value=mock_literal - ) + mocker.patch.object(VariableValuePydanticModel, "parse_obj", return_value=mock_literal) obj = VariableValuePydanticModel(self.ModelClass()) assert obj.simplified == {"test": "simplified"} def test_value(self, mocker: MockerFixture) -> None: """Test value.""" mock_literal = MagicMock(value="value") - mocker.patch.object( - VariableValuePydanticModel, "parse_obj", return_value=mock_literal - ) + mocker.patch.object(VariableValuePydanticModel, "parse_obj", return_value=mock_literal) obj = VariableValuePydanticModel(self.ModelClass()) assert obj.value == self.ModelClass(test=mock_literal.value) diff --git a/tests/unit/utils/test_utils.py b/tests/unit/utils/test_utils.py index aaa09fb0d..8ff083275 100644 --- a/tests/unit/utils/test_utils.py +++ b/tests/unit/utils/test_utils.py @@ -1,6 +1,5 @@ """Test runway.utils.__init__.""" -# pyright: basic from __future__ import annotations import datetime @@ -10,12 +9,13 @@ import os import string import sys +from contextlib import suppress from copy import deepcopy from decimal import Decimal -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union +from typing import TYPE_CHECKING, Any, Optional, Union +from unittest.mock import MagicMock, patch import pytest -from mock import MagicMock, patch from runway.utils import ( JsonEncoder, @@ -33,7 +33,6 @@ if TYPE_CHECKING: from pathlib import Path - from pytest import LogCaptureFixture, MonkeyPatch from pytest_mock import MockerFixture MODULE = "runway.utils" @@ -121,21 +120,19 @@ def test_find_default(self) -> None: """Validate default value functionality.""" mute_map = MutableMap(**VALUE) - assert ( - mute_map.find("NOT_VALID", "default_val") == "default_val" - ), "default should be used" + assert mute_map.find("NOT_VALID", "default_val") == "default_val", "default should be used" assert ( mute_map.find("str_val", "default_val") == VALUE["str_val"] ), "default should be ignored" -TestParamsTypeDef = Optional[Union[Dict[str, str], List[str], str]] +TestParamsTypeDef = Optional[Union[dict[str, str], list[str], str]] class TestSafeHaven: """Test SafeHaven context manager.""" - TEST_PARAMS: List[TestParamsTypeDef] = [ + TEST_PARAMS: list[TestParamsTypeDef] = [ (None), ("string"), ({}), @@ -144,7 +141,7 @@ class TestSafeHaven: ] def test_context_manager_magic( - self, caplog: LogCaptureFixture, monkeypatch: MonkeyPatch + self, caplog: pytest.LogCaptureFixture, monkeypatch: pytest.MonkeyPatch ) -> None: """Test init and the attributes it sets.""" mock_reset_all = MagicMock() @@ -165,8 +162,8 @@ def test_context_manager_magic( def test_os_environ( self, provided: TestParamsTypeDef, - caplog: LogCaptureFixture, - monkeypatch: MonkeyPatch, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, ) -> None: """Test os.environ interactions.""" caplog.set_level(logging.DEBUG, "runway.SafeHaven") @@ -191,7 +188,7 @@ def test_os_environ( assert caplog.messages == expected_logs def test_reset_all( - self, caplog: LogCaptureFixture, monkeypatch: MonkeyPatch + self, caplog: pytest.LogCaptureFixture, monkeypatch: pytest.MonkeyPatch ) -> None: """Test reset_all.""" mock_method = MagicMock() @@ -218,8 +215,8 @@ def test_reset_all( def test_sys_argv( self, provided: TestParamsTypeDef, - caplog: LogCaptureFixture, - monkeypatch: MonkeyPatch, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, ) -> None: """Test sys.argv interactions.""" caplog.set_level(logging.DEBUG, "runway.SafeHaven") @@ -241,19 +238,16 @@ def test_sys_argv( assert caplog.messages == expected_logs def test_sys_modules( - self, caplog: LogCaptureFixture, monkeypatch: MonkeyPatch + self, caplog: pytest.LogCaptureFixture, monkeypatch: pytest.MonkeyPatch ) -> None: """Test sys.modules interactions.""" - caplog.set_level(logging.DEBUG, "runway.SafeHaven") + caplog.set_level(1, "runway.SafeHaven") monkeypatch.setattr(SafeHaven, "reset_all", MagicMock()) - orig_val = {} - for k, v in sys.modules.items(): - orig_val[k] = v + orig_val = dict(sys.modules) expected_logs = ["entering a safe haven...", "resetting sys.modules..."] with SafeHaven() as obj: - # pylint: disable=import-outside-toplevel from ..fixtures import mock_hooks # noqa: F401 assert sys.modules != orig_val @@ -262,7 +256,7 @@ def test_sys_modules( assert caplog.messages[:2] == expected_logs assert caplog.messages[-1] == "leaving the safe haven..." - def test_sys_modules_exclude(self, monkeypatch: MonkeyPatch) -> None: + def test_sys_modules_exclude(self, monkeypatch: pytest.MonkeyPatch) -> None: """Test sys.modules interactions with excluded module.""" monkeypatch.setattr(SafeHaven, "reset_all", MagicMock()) @@ -270,7 +264,6 @@ def test_sys_modules_exclude(self, monkeypatch: MonkeyPatch) -> None: assert module not in sys.modules with SafeHaven(sys_modules_exclude=[module]) as obj: - # pylint: disable=import-outside-toplevel from ..fixtures import mock_hooks # noqa: F401 assert module in sys.modules @@ -284,8 +277,8 @@ def test_sys_modules_exclude(self, monkeypatch: MonkeyPatch) -> None: def test_sys_path( self, provided: TestParamsTypeDef, - caplog: LogCaptureFixture, - monkeypatch: MonkeyPatch, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, ) -> None: """Test sys.path interactions.""" caplog.set_level(logging.DEBUG, "runway.SafeHaven") @@ -383,17 +376,15 @@ def test_load_object_from_string() -> None: assert load_object_from_string(obj_path, try_reload=True) == "us-west-2" -def test_load_object_from_string_reload_conditions(monkeypatch: MonkeyPatch) -> None: +def test_load_object_from_string_reload_conditions(monkeypatch: pytest.MonkeyPatch) -> None: """Test load_object_from_string reload conditions.""" mock_reload = MagicMock() monkeypatch.setattr("runway.utils.importlib.reload", mock_reload) builtin_test = "sys.version_info" mock_hook = "tests.unit.fixtures.mock_hooks.GLOBAL_VALUE" - try: + with suppress(Exception): del sys.modules["tests.unit.fixtures.mock_hooks"] - except: # noqa pylint: disable=bare-except - pass load_object_from_string(builtin_test, try_reload=False) mock_reload.assert_not_called() diff --git a/typings/awacs/acm_pca.pyi b/typings/awacs/acm_pca.pyi index 267cdcf4e..9766f1b1b 100644 --- a/typings/awacs/acm_pca.pyi +++ b/typings/awacs/acm_pca.pyi @@ -21,9 +21,7 @@ DeleteCertificateAuthority = Action("DeleteCertificateAuthority") DeletePermission = Action("DeletePermission") DeletePolicy = Action("DeletePolicy") DescribeCertificateAuthority = Action("DescribeCertificateAuthority") -DescribeCertificateAuthorityAuditReport = Action( - "DescribeCertificateAuthorityAuditReport" -) +DescribeCertificateAuthorityAuditReport = Action("DescribeCertificateAuthorityAuditReport") GetCertificate = Action("GetCertificate") GetCertificateAuthorityCertificate = Action("GetCertificateAuthorityCertificate") GetCertificateAuthorityCsr = Action("GetCertificateAuthorityCsr") diff --git a/typings/awacs/aws_marketplace.pyi b/typings/awacs/aws_marketplace.pyi index 98a395cf3..4c390335d 100644 --- a/typings/awacs/aws_marketplace.pyi +++ b/typings/awacs/aws_marketplace.pyi @@ -15,9 +15,7 @@ class ARN(BaseARN): def __init__(self, resource=..., region=..., account=...) -> None: ... AcceptAgreementApprovalRequest = Action("AcceptAgreementApprovalRequest") -AssociateProductsWithPrivateMarketplace = Action( - "AssociateProductsWithPrivateMarketplace" -) +AssociateProductsWithPrivateMarketplace = Action("AssociateProductsWithPrivateMarketplace") BatchMeterUsage = Action("BatchMeterUsage") CancelAgreementRequest = Action("CancelAgreementRequest") CancelChangeSet = Action("CancelChangeSet") @@ -34,13 +32,9 @@ DescribePrivateMarketplaceProfile = Action("DescribePrivateMarketplaceProfile") DescribePrivateMarketplaceRequests = Action("DescribePrivateMarketplaceRequests") DescribePrivateMarketplaceSettings = Action("DescribePrivateMarketplaceSettings") DescribePrivateMarketplaceStatus = Action("DescribePrivateMarketplaceStatus") -DescribeProcurementSystemConfiguration = Action( - "DescribeProcurementSystemConfiguration" -) +DescribeProcurementSystemConfiguration = Action("DescribeProcurementSystemConfiguration") DescribeTask = Action("DescribeTask") -DisassociateProductsFromPrivateMarketplace = Action( - "DisassociateProductsFromPrivateMarketplace" -) +DisassociateProductsFromPrivateMarketplace = Action("DisassociateProductsFromPrivateMarketplace") GetAgreementApprovalRequest = Action("GetAgreementApprovalRequest") GetAgreementRequest = Action("GetAgreementRequest") GetAgreementTerms = Action("GetAgreementTerms") diff --git a/typings/awacs/chime.pyi b/typings/awacs/chime.pyi index 958bf2c23..3d10fe81b 100644 --- a/typings/awacs/chime.pyi +++ b/typings/awacs/chime.pyi @@ -19,15 +19,11 @@ ActivateUsers = Action("ActivateUsers") AddDomain = Action("AddDomain") AddOrUpdateGroups = Action("AddOrUpdateGroups") AssociatePhoneNumberWithUser = Action("AssociatePhoneNumberWithUser") -AssociatePhoneNumbersWithVoiceConnector = Action( - "AssociatePhoneNumbersWithVoiceConnector" -) +AssociatePhoneNumbersWithVoiceConnector = Action("AssociatePhoneNumbersWithVoiceConnector") AssociatePhoneNumbersWithVoiceConnectorGroup = Action( "AssociatePhoneNumbersWithVoiceConnectorGroup" ) -AssociateSigninDelegateGroupsWithAccount = Action( - "AssociateSigninDelegateGroupsWithAccount" -) +AssociateSigninDelegateGroupsWithAccount = Action("AssociateSigninDelegateGroupsWithAccount") AuthorizeDirectory = Action("AuthorizeDirectory") BatchCreateAttendee = Action("BatchCreateAttendee") BatchCreateRoomMembership = Action("BatchCreateRoomMembership") @@ -73,23 +69,15 @@ DeleteVoiceConnectorEmergencyCallingConfiguration = Action( DeleteVoiceConnectorGroup = Action("DeleteVoiceConnectorGroup") DeleteVoiceConnectorOrigination = Action("DeleteVoiceConnectorOrigination") DeleteVoiceConnectorProxy = Action("DeleteVoiceConnectorProxy") -DeleteVoiceConnectorStreamingConfiguration = Action( - "DeleteVoiceConnectorStreamingConfiguration" -) +DeleteVoiceConnectorStreamingConfiguration = Action("DeleteVoiceConnectorStreamingConfiguration") DeleteVoiceConnectorTermination = Action("DeleteVoiceConnectorTermination") -DeleteVoiceConnectorTerminationCredentials = Action( - "DeleteVoiceConnectorTerminationCredentials" -) +DeleteVoiceConnectorTerminationCredentials = Action("DeleteVoiceConnectorTerminationCredentials") DisassociatePhoneNumberFromUser = Action("DisassociatePhoneNumberFromUser") -DisassociatePhoneNumbersFromVoiceConnector = Action( - "DisassociatePhoneNumbersFromVoiceConnector" -) +DisassociatePhoneNumbersFromVoiceConnector = Action("DisassociatePhoneNumbersFromVoiceConnector") DisassociatePhoneNumbersFromVoiceConnectorGroup = Action( "DisassociatePhoneNumbersFromVoiceConnectorGroup" ) -DisassociateSigninDelegateGroupsFromAccount = Action( - "DisassociateSigninDelegateGroupsFromAccount" -) +DisassociateSigninDelegateGroupsFromAccount = Action("DisassociateSigninDelegateGroupsFromAccount") DisconnectDirectory = Action("DisconnectDirectory") GetAccount = Action("GetAccount") GetAccountResource = Action("GetAccountResource") @@ -122,9 +110,7 @@ GetVoiceConnectorGroup = Action("GetVoiceConnectorGroup") GetVoiceConnectorLoggingConfiguration = Action("GetVoiceConnectorLoggingConfiguration") GetVoiceConnectorOrigination = Action("GetVoiceConnectorOrigination") GetVoiceConnectorProxy = Action("GetVoiceConnectorProxy") -GetVoiceConnectorStreamingConfiguration = Action( - "GetVoiceConnectorStreamingConfiguration" -) +GetVoiceConnectorStreamingConfiguration = Action("GetVoiceConnectorStreamingConfiguration") GetVoiceConnectorTermination = Action("GetVoiceConnectorTermination") GetVoiceConnectorTerminationHealth = Action("GetVoiceConnectorTerminationHealth") InviteDelegate = Action("InviteDelegate") @@ -154,9 +140,7 @@ ListRooms = Action("ListRooms") ListTagsForResource = Action("ListTagsForResource") ListUsers = Action("ListUsers") ListVoiceConnectorGroups = Action("ListVoiceConnectorGroups") -ListVoiceConnectorTerminationCredentials = Action( - "ListVoiceConnectorTerminationCredentials" -) +ListVoiceConnectorTerminationCredentials = Action("ListVoiceConnectorTerminationCredentials") ListVoiceConnectors = Action("ListVoiceConnectors") LogoutUser = Action("LogoutUser") PutEventsConfiguration = Action("PutEventsConfiguration") @@ -167,13 +151,9 @@ PutVoiceConnectorEmergencyCallingConfiguration = Action( PutVoiceConnectorLoggingConfiguration = Action("PutVoiceConnectorLoggingConfiguration") PutVoiceConnectorOrigination = Action("PutVoiceConnectorOrigination") PutVoiceConnectorProxy = Action("PutVoiceConnectorProxy") -PutVoiceConnectorStreamingConfiguration = Action( - "PutVoiceConnectorStreamingConfiguration" -) +PutVoiceConnectorStreamingConfiguration = Action("PutVoiceConnectorStreamingConfiguration") PutVoiceConnectorTermination = Action("PutVoiceConnectorTermination") -PutVoiceConnectorTerminationCredentials = Action( - "PutVoiceConnectorTerminationCredentials" -) +PutVoiceConnectorTerminationCredentials = Action("PutVoiceConnectorTerminationCredentials") RedactConversationMessage = Action("RedactConversationMessage") RedactRoomMessage = Action("RedactRoomMessage") RegenerateSecurityToken = Action("RegenerateSecurityToken") diff --git a/typings/awacs/cloudfront.pyi b/typings/awacs/cloudfront.pyi index 413cf87f4..f3da6f29d 100644 --- a/typings/awacs/cloudfront.pyi +++ b/typings/awacs/cloudfront.pyi @@ -36,9 +36,7 @@ DeleteStreamingDistribution = Action("DeleteStreamingDistribution") GetCachePolicy = Action("GetCachePolicy") GetCachePolicyConfig = Action("GetCachePolicyConfig") GetCloudFrontOriginAccessIdentity = Action("GetCloudFrontOriginAccessIdentity") -GetCloudFrontOriginAccessIdentityConfig = Action( - "GetCloudFrontOriginAccessIdentityConfig" -) +GetCloudFrontOriginAccessIdentityConfig = Action("GetCloudFrontOriginAccessIdentityConfig") GetDistribution = Action("GetDistribution") GetDistributionConfig = Action("GetDistributionConfig") GetFieldLevelEncryption = Action("GetFieldLevelEncryption") @@ -57,9 +55,7 @@ ListCloudFrontOriginAccessIdentities = Action("ListCloudFrontOriginAccessIdentit ListDistributions = Action("ListDistributions") ListDistributionsByCachePolicyId = Action("ListDistributionsByCachePolicyId") ListDistributionsByLambdaFunction = Action("ListDistributionsByLambdaFunction") -ListDistributionsByOriginRequestPolicyId = Action( - "ListDistributionsByOriginRequestPolicyId" -) +ListDistributionsByOriginRequestPolicyId = Action("ListDistributionsByOriginRequestPolicyId") ListDistributionsByWebACLId = Action("ListDistributionsByWebACLId") ListFieldLevelEncryptionConfigs = Action("ListFieldLevelEncryptionConfigs") ListFieldLevelEncryptionProfiles = Action("ListFieldLevelEncryptionProfiles") diff --git a/typings/awacs/codecommit.pyi b/typings/awacs/codecommit.pyi index f2309c7da..87e8ef117 100644 --- a/typings/awacs/codecommit.pyi +++ b/typings/awacs/codecommit.pyi @@ -14,9 +14,7 @@ class Action(BaseAction): class ARN(BaseARN): def __init__(self, resource=..., region=..., account=...) -> None: ... -AssociateApprovalRuleTemplateWithRepository = Action( - "AssociateApprovalRuleTemplateWithRepository" -) +AssociateApprovalRuleTemplateWithRepository = Action("AssociateApprovalRuleTemplateWithRepository") BatchAssociateApprovalRuleTemplateWithRepositories = Action( "BatchAssociateApprovalRuleTemplateWithRepositories" ) @@ -81,9 +79,7 @@ ListAssociatedApprovalRuleTemplatesForRepository = Action( ListBranches = Action("ListBranches") ListPullRequests = Action("ListPullRequests") ListRepositories = Action("ListRepositories") -ListRepositoriesForApprovalRuleTemplate = Action( - "ListRepositoriesForApprovalRuleTemplate" -) +ListRepositoriesForApprovalRuleTemplate = Action("ListRepositoriesForApprovalRuleTemplate") ListTagsForResource = Action("ListTagsForResource") MergeBranchesByFastForward = Action("MergeBranchesByFastForward") MergeBranchesBySquash = Action("MergeBranchesBySquash") diff --git a/typings/awacs/config.pyi b/typings/awacs/config.pyi index 4ff9b853c..4cfd0ab2b 100644 --- a/typings/awacs/config.pyi +++ b/typings/awacs/config.pyi @@ -31,9 +31,7 @@ DeleteRemediationExceptions = Action("DeleteRemediationExceptions") DeleteResourceConfig = Action("DeleteResourceConfig") DeleteRetentionConfiguration = Action("DeleteRetentionConfiguration") DeliverConfigSnapshot = Action("DeliverConfigSnapshot") -DescribeAggregateComplianceByConfigRules = Action( - "DescribeAggregateComplianceByConfigRules" -) +DescribeAggregateComplianceByConfigRules = Action("DescribeAggregateComplianceByConfigRules") DescribeAggregationAuthorizations = Action("DescribeAggregationAuthorizations") DescribeComplianceByConfigRule = Action("DescribeComplianceByConfigRule") DescribeComplianceByResource = Action("DescribeComplianceByResource") @@ -50,25 +48,17 @@ DescribeConformancePackStatus = Action("DescribeConformancePackStatus") DescribeConformancePacks = Action("DescribeConformancePacks") DescribeDeliveryChannelStatus = Action("DescribeDeliveryChannelStatus") DescribeDeliveryChannels = Action("DescribeDeliveryChannels") -DescribeOrganizationConfigRuleStatuses = Action( - "DescribeOrganizationConfigRuleStatuses" -) +DescribeOrganizationConfigRuleStatuses = Action("DescribeOrganizationConfigRuleStatuses") DescribeOrganizationConfigRules = Action("DescribeOrganizationConfigRules") -DescribeOrganizationConformancePackStatuses = Action( - "DescribeOrganizationConformancePackStatuses" -) +DescribeOrganizationConformancePackStatuses = Action("DescribeOrganizationConformancePackStatuses") DescribeOrganizationConformancePacks = Action("DescribeOrganizationConformancePacks") DescribePendingAggregationRequests = Action("DescribePendingAggregationRequests") DescribeRemediationConfigurations = Action("DescribeRemediationConfigurations") DescribeRemediationExceptions = Action("DescribeRemediationExceptions") DescribeRemediationExecutionStatus = Action("DescribeRemediationExecutionStatus") DescribeRetentionConfigurations = Action("DescribeRetentionConfigurations") -GetAggregateComplianceDetailsByConfigRule = Action( - "GetAggregateComplianceDetailsByConfigRule" -) -GetAggregateConfigRuleComplianceSummary = Action( - "GetAggregateConfigRuleComplianceSummary" -) +GetAggregateComplianceDetailsByConfigRule = Action("GetAggregateComplianceDetailsByConfigRule") +GetAggregateConfigRuleComplianceSummary = Action("GetAggregateConfigRuleComplianceSummary") GetAggregateDiscoveredResourceCounts = Action("GetAggregateDiscoveredResourceCounts") GetAggregateResourceConfig = Action("GetAggregateResourceConfig") GetComplianceDetailsByConfigRule = Action("GetComplianceDetailsByConfigRule") @@ -78,9 +68,7 @@ GetComplianceSummaryByResourceType = Action("GetComplianceSummaryByResourceType" GetConformancePackComplianceDetails = Action("GetConformancePackComplianceDetails") GetConformancePackComplianceSummary = Action("GetConformancePackComplianceSummary") GetDiscoveredResourceCounts = Action("GetDiscoveredResourceCounts") -GetOrganizationConfigRuleDetailedStatus = Action( - "GetOrganizationConfigRuleDetailedStatus" -) +GetOrganizationConfigRuleDetailedStatus = Action("GetOrganizationConfigRuleDetailedStatus") GetOrganizationConformancePackDetailedStatus = Action( "GetOrganizationConformancePackDetailedStatus" ) diff --git a/typings/awacs/connect.pyi b/typings/awacs/connect.pyi index 70ec992d5..f4d529b45 100644 --- a/typings/awacs/connect.pyi +++ b/typings/awacs/connect.pyi @@ -59,9 +59,7 @@ UpdateContactAttributes = Action("UpdateContactAttributes") UpdateContactFlowContent = Action("UpdateContactFlowContent") UpdateContactFlowName = Action("UpdateContactFlowName") UpdateRoutingProfileConcurrency = Action("UpdateRoutingProfileConcurrency") -UpdateRoutingProfileDefaultOutboundQueue = Action( - "UpdateRoutingProfileDefaultOutboundQueue" -) +UpdateRoutingProfileDefaultOutboundQueue = Action("UpdateRoutingProfileDefaultOutboundQueue") UpdateRoutingProfileName = Action("UpdateRoutingProfileName") UpdateRoutingProfileQueues = Action("UpdateRoutingProfileQueues") UpdateUserHierarchy = Action("UpdateUserHierarchy") diff --git a/typings/awacs/deepracer.pyi b/typings/awacs/deepracer.pyi index 2e96c5cf3..4949c27e6 100644 --- a/typings/awacs/deepracer.pyi +++ b/typings/awacs/deepracer.pyi @@ -38,7 +38,5 @@ ListTrainingJobs = Action("ListTrainingJobs") SetAlias = Action("SetAlias") StartEvaluation = Action("StartEvaluation") StopEvaluation = Action("StopEvaluation") -StopTrainingReinforcementLearningModel = Action( - "StopTrainingReinforcementLearningModel" -) +StopTrainingReinforcementLearningModel = Action("StopTrainingReinforcementLearningModel") TestRewardFunction = Action("TestRewardFunction") diff --git a/typings/awacs/directconnect.pyi b/typings/awacs/directconnect.pyi index ee81ae998..74ccf62e8 100644 --- a/typings/awacs/directconnect.pyi +++ b/typings/awacs/directconnect.pyi @@ -57,12 +57,8 @@ DescribeConnectionsOnInterconnect = Action("DescribeConnectionsOnInterconnect") DescribeDirectConnectGatewayAssociationProposals = Action( "DescribeDirectConnectGatewayAssociationProposals" ) -DescribeDirectConnectGatewayAssociations = Action( - "DescribeDirectConnectGatewayAssociations" -) -DescribeDirectConnectGatewayAttachments = Action( - "DescribeDirectConnectGatewayAttachments" -) +DescribeDirectConnectGatewayAssociations = Action("DescribeDirectConnectGatewayAssociations") +DescribeDirectConnectGatewayAttachments = Action("DescribeDirectConnectGatewayAttachments") DescribeDirectConnectGateways = Action("DescribeDirectConnectGateways") DescribeHostedConnections = Action("DescribeHostedConnections") DescribeInterconnectLoa = Action("DescribeInterconnectLoa") diff --git a/typings/awacs/discovery.pyi b/typings/awacs/discovery.pyi index d84b085d6..8ad928255 100644 --- a/typings/awacs/discovery.pyi +++ b/typings/awacs/discovery.pyi @@ -14,9 +14,7 @@ class Action(BaseAction): class ARN(BaseARN): def __init__(self, resource=..., region=..., account=...) -> None: ... -AssociateConfigurationItemsToApplication = Action( - "AssociateConfigurationItemsToApplication" -) +AssociateConfigurationItemsToApplication = Action("AssociateConfigurationItemsToApplication") BatchDeleteImportData = Action("BatchDeleteImportData") CreateApplication = Action("CreateApplication") CreateTags = Action("CreateTags") diff --git a/typings/awacs/dms.pyi b/typings/awacs/dms.pyi index 4b3027aec..1cbcf4c0a 100644 --- a/typings/awacs/dms.pyi +++ b/typings/awacs/dms.pyi @@ -40,9 +40,7 @@ DescribeRefreshSchemasStatus = Action("DescribeRefreshSchemasStatus") DescribeReplicationInstanceTaskLogs = Action("DescribeReplicationInstanceTaskLogs") DescribeReplicationInstances = Action("DescribeReplicationInstances") DescribeReplicationSubnetGroups = Action("DescribeReplicationSubnetGroups") -DescribeReplicationTaskAssessmentResults = Action( - "DescribeReplicationTaskAssessmentResults" -) +DescribeReplicationTaskAssessmentResults = Action("DescribeReplicationTaskAssessmentResults") DescribeReplicationTasks = Action("DescribeReplicationTasks") DescribeSchemas = Action("DescribeSchemas") DescribeTableStatistics = Action("DescribeTableStatistics") diff --git a/typings/awacs/ec2.pyi b/typings/awacs/ec2.pyi index 4b1f50509..8050a6021 100644 --- a/typings/awacs/ec2.pyi +++ b/typings/awacs/ec2.pyi @@ -22,9 +22,7 @@ AcceptVpcPeeringConnection = Action("AcceptVpcPeeringConnection") AdvertiseByoipCidr = Action("AdvertiseByoipCidr") AllocateAddress = Action("AllocateAddress") AllocateHosts = Action("AllocateHosts") -ApplySecurityGroupsToClientVpnTargetNetwork = Action( - "ApplySecurityGroupsToClientVpnTargetNetwork" -) +ApplySecurityGroupsToClientVpnTargetNetwork = Action("ApplySecurityGroupsToClientVpnTargetNetwork") AssignIpv6Addresses = Action("AssignIpv6Addresses") AssignPrivateIpAddresses = Action("AssignPrivateIpAddresses") AssociateAddress = Action("AssociateAddress") @@ -33,9 +31,7 @@ AssociateDhcpOptions = Action("AssociateDhcpOptions") AssociateIamInstanceProfile = Action("AssociateIamInstanceProfile") AssociateRouteTable = Action("AssociateRouteTable") AssociateSubnetCidrBlock = Action("AssociateSubnetCidrBlock") -AssociateTransitGatewayMulticastDomain = Action( - "AssociateTransitGatewayMulticastDomain" -) +AssociateTransitGatewayMulticastDomain = Action("AssociateTransitGatewayMulticastDomain") AssociateTransitGatewayRouteTable = Action("AssociateTransitGatewayRouteTable") AssociateVpcCidrBlock = Action("AssociateVpcCidrBlock") AttachClassicLinkVpc = Action("AttachClassicLinkVpc") @@ -78,9 +74,7 @@ CreateKeyPair = Action("CreateKeyPair") CreateLaunchTemplate = Action("CreateLaunchTemplate") CreateLaunchTemplateVersion = Action("CreateLaunchTemplateVersion") CreateLocalGatewayRoute = Action("CreateLocalGatewayRoute") -CreateLocalGatewayRouteTableVpcAssociation = Action( - "CreateLocalGatewayRouteTableVpcAssociation" -) +CreateLocalGatewayRouteTableVpcAssociation = Action("CreateLocalGatewayRouteTableVpcAssociation") CreateManagedPrefixList = Action("CreateManagedPrefixList") CreateNatGateway = Action("CreateNatGateway") CreateNetworkAcl = Action("CreateNetworkAcl") @@ -104,18 +98,14 @@ CreateTrafficMirrorTarget = Action("CreateTrafficMirrorTarget") CreateTransitGateway = Action("CreateTransitGateway") CreateTransitGatewayMulticastDomain = Action("CreateTransitGatewayMulticastDomain") CreateTransitGatewayPeeringAttachment = Action("CreateTransitGatewayPeeringAttachment") -CreateTransitGatewayPrefixListReference = Action( - "CreateTransitGatewayPrefixListReference" -) +CreateTransitGatewayPrefixListReference = Action("CreateTransitGatewayPrefixListReference") CreateTransitGatewayRoute = Action("CreateTransitGatewayRoute") CreateTransitGatewayRouteTable = Action("CreateTransitGatewayRouteTable") CreateTransitGatewayVpcAttachment = Action("CreateTransitGatewayVpcAttachment") CreateVolume = Action("CreateVolume") CreateVpc = Action("CreateVpc") CreateVpcEndpoint = Action("CreateVpcEndpoint") -CreateVpcEndpointConnectionNotification = Action( - "CreateVpcEndpointConnectionNotification" -) +CreateVpcEndpointConnectionNotification = Action("CreateVpcEndpointConnectionNotification") CreateVpcEndpointServiceConfiguration = Action("CreateVpcEndpointServiceConfiguration") CreateVpcPeeringConnection = Action("CreateVpcPeeringConnection") CreateVpnConnection = Action("CreateVpnConnection") @@ -135,9 +125,7 @@ DeleteKeyPair = Action("DeleteKeyPair") DeleteLaunchTemplate = Action("DeleteLaunchTemplate") DeleteLaunchTemplateVersions = Action("DeleteLaunchTemplateVersions") DeleteLocalGatewayRoute = Action("DeleteLocalGatewayRoute") -DeleteLocalGatewayRouteTableVpcAssociation = Action( - "DeleteLocalGatewayRouteTableVpcAssociation" -) +DeleteLocalGatewayRouteTableVpcAssociation = Action("DeleteLocalGatewayRouteTableVpcAssociation") DeleteManagedPrefixList = Action("DeleteManagedPrefixList") DeleteNatGateway = Action("DeleteNatGateway") DeleteNetworkAcl = Action("DeleteNetworkAcl") @@ -159,20 +147,14 @@ DeleteTrafficMirrorTarget = Action("DeleteTrafficMirrorTarget") DeleteTransitGateway = Action("DeleteTransitGateway") DeleteTransitGatewayMulticastDomain = Action("DeleteTransitGatewayMulticastDomain") DeleteTransitGatewayPeeringAttachment = Action("DeleteTransitGatewayPeeringAttachment") -DeleteTransitGatewayPrefixListReference = Action( - "DeleteTransitGatewayPrefixListReference" -) +DeleteTransitGatewayPrefixListReference = Action("DeleteTransitGatewayPrefixListReference") DeleteTransitGatewayRoute = Action("DeleteTransitGatewayRoute") DeleteTransitGatewayRouteTable = Action("DeleteTransitGatewayRouteTable") DeleteTransitGatewayVpcAttachment = Action("DeleteTransitGatewayVpcAttachment") DeleteVolume = Action("DeleteVolume") DeleteVpc = Action("DeleteVpc") -DeleteVpcEndpointConnectionNotifications = Action( - "DeleteVpcEndpointConnectionNotifications" -) -DeleteVpcEndpointServiceConfigurations = Action( - "DeleteVpcEndpointServiceConfigurations" -) +DeleteVpcEndpointConnectionNotifications = Action("DeleteVpcEndpointConnectionNotifications") +DeleteVpcEndpointServiceConfigurations = Action("DeleteVpcEndpointServiceConfigurations") DeleteVpcEndpoints = Action("DeleteVpcEndpoints") DeleteVpcPeeringConnection = Action("DeleteVpcPeeringConnection") DeleteVpnConnection = Action("DeleteVpnConnection") @@ -221,9 +203,7 @@ DescribeFpgaImages = Action("DescribeFpgaImages") DescribeHostReservationOfferings = Action("DescribeHostReservationOfferings") DescribeHostReservations = Action("DescribeHostReservations") DescribeHosts = Action("DescribeHosts") -DescribeIamInstanceProfileAssociations = Action( - "DescribeIamInstanceProfileAssociations" -) +DescribeIamInstanceProfileAssociations = Action("DescribeIamInstanceProfileAssociations") DescribeIdFormat = Action("DescribeIdFormat") DescribeIdentityIdFormat = Action("DescribeIdentityIdFormat") DescribeImageAttribute = Action("DescribeImageAttribute") @@ -232,9 +212,7 @@ DescribeImportImageTasks = Action("DescribeImportImageTasks") DescribeImportSnapshotTasks = Action("DescribeImportSnapshotTasks") DescribeInstanceAttribute = Action("DescribeInstanceAttribute") DescribeInstanceCreditSpecifications = Action("DescribeInstanceCreditSpecifications") -DescribeInstanceEventNotificationAttributes = Action( - "DescribeInstanceEventNotificationAttributes" -) +DescribeInstanceEventNotificationAttributes = Action("DescribeInstanceEventNotificationAttributes") DescribeInstanceStatus = Action("DescribeInstanceStatus") DescribeInstanceTypeOfferings = Action("DescribeInstanceTypeOfferings") DescribeInstanceTypes = Action("DescribeInstanceTypes") @@ -250,9 +228,7 @@ DescribeLocalGatewayRouteTableVpcAssociations = Action( "DescribeLocalGatewayRouteTableVpcAssociations" ) DescribeLocalGatewayRouteTables = Action("DescribeLocalGatewayRouteTables") -DescribeLocalGatewayVirtualInterfaceGroups = Action( - "DescribeLocalGatewayVirtualInterfaceGroups" -) +DescribeLocalGatewayVirtualInterfaceGroups = Action("DescribeLocalGatewayVirtualInterfaceGroups") DescribeLocalGatewayVirtualInterfaces = Action("DescribeLocalGatewayVirtualInterfaces") DescribeLocalGateways = Action("DescribeLocalGateways") DescribeManagedPrefixLists = Action("DescribeManagedPrefixLists") @@ -269,9 +245,7 @@ DescribePublicIpv4Pools = Action("DescribePublicIpv4Pools") DescribeRegions = Action("DescribeRegions") DescribeReservedInstances = Action("DescribeReservedInstances") DescribeReservedInstancesListings = Action("DescribeReservedInstancesListings") -DescribeReservedInstancesModifications = Action( - "DescribeReservedInstancesModifications" -) +DescribeReservedInstancesModifications = Action("DescribeReservedInstancesModifications") DescribeReservedInstancesOfferings = Action("DescribeReservedInstancesOfferings") DescribeRouteTables = Action("DescribeRouteTables") DescribeScheduledInstanceAvailability = Action("DescribeScheduledInstanceAvailability") @@ -293,12 +267,8 @@ DescribeTrafficMirrorFilters = Action("DescribeTrafficMirrorFilters") DescribeTrafficMirrorSessions = Action("DescribeTrafficMirrorSessions") DescribeTrafficMirrorTargets = Action("DescribeTrafficMirrorTargets") DescribeTransitGatewayAttachments = Action("DescribeTransitGatewayAttachments") -DescribeTransitGatewayMulticastDomains = Action( - "DescribeTransitGatewayMulticastDomains" -) -DescribeTransitGatewayPeeringAttachments = Action( - "DescribeTransitGatewayPeeringAttachments" -) +DescribeTransitGatewayMulticastDomains = Action("DescribeTransitGatewayMulticastDomains") +DescribeTransitGatewayPeeringAttachments = Action("DescribeTransitGatewayPeeringAttachments") DescribeTransitGatewayRouteTables = Action("DescribeTransitGatewayRouteTables") DescribeTransitGatewayVpcAttachments = Action("DescribeTransitGatewayVpcAttachments") DescribeTransitGateways = Action("DescribeTransitGateways") @@ -309,13 +279,9 @@ DescribeVolumesModifications = Action("DescribeVolumesModifications") DescribeVpcAttribute = Action("DescribeVpcAttribute") DescribeVpcClassicLink = Action("DescribeVpcClassicLink") DescribeVpcClassicLinkDnsSupport = Action("DescribeVpcClassicLinkDnsSupport") -DescribeVpcEndpointConnectionNotifications = Action( - "DescribeVpcEndpointConnectionNotifications" -) +DescribeVpcEndpointConnectionNotifications = Action("DescribeVpcEndpointConnectionNotifications") DescribeVpcEndpointConnections = Action("DescribeVpcEndpointConnections") -DescribeVpcEndpointServiceConfigurations = Action( - "DescribeVpcEndpointServiceConfigurations" -) +DescribeVpcEndpointServiceConfigurations = Action("DescribeVpcEndpointServiceConfigurations") DescribeVpcEndpointServicePermissions = Action("DescribeVpcEndpointServicePermissions") DescribeVpcEndpointServices = Action("DescribeVpcEndpointServices") DescribeVpcEndpoints = Action("DescribeVpcEndpoints") @@ -330,9 +296,7 @@ DetachVolume = Action("DetachVolume") DetachVpnGateway = Action("DetachVpnGateway") DisableEbsEncryptionByDefault = Action("DisableEbsEncryptionByDefault") DisableFastSnapshotRestores = Action("DisableFastSnapshotRestores") -DisableTransitGatewayRouteTablePropagation = Action( - "DisableTransitGatewayRouteTablePropagation" -) +DisableTransitGatewayRouteTablePropagation = Action("DisableTransitGatewayRouteTablePropagation") DisableVgwRoutePropagation = Action("DisableVgwRoutePropagation") DisableVpcClassicLink = Action("DisableVpcClassicLink") DisableVpcClassicLinkDnsSupport = Action("DisableVpcClassicLinkDnsSupport") @@ -341,16 +305,12 @@ DisassociateClientVpnTargetNetwork = Action("DisassociateClientVpnTargetNetwork" DisassociateIamInstanceProfile = Action("DisassociateIamInstanceProfile") DisassociateRouteTable = Action("DisassociateRouteTable") DisassociateSubnetCidrBlock = Action("DisassociateSubnetCidrBlock") -DisassociateTransitGatewayMulticastDomain = Action( - "DisassociateTransitGatewayMulticastDomain" -) +DisassociateTransitGatewayMulticastDomain = Action("DisassociateTransitGatewayMulticastDomain") DisassociateTransitGatewayRouteTable = Action("DisassociateTransitGatewayRouteTable") DisassociateVpcCidrBlock = Action("DisassociateVpcCidrBlock") EnableEbsEncryptionByDefault = Action("EnableEbsEncryptionByDefault") EnableFastSnapshotRestores = Action("EnableFastSnapshotRestores") -EnableTransitGatewayRouteTablePropagation = Action( - "EnableTransitGatewayRouteTablePropagation" -) +EnableTransitGatewayRouteTablePropagation = Action("EnableTransitGatewayRouteTablePropagation") EnableVgwRoutePropagation = Action("EnableVgwRoutePropagation") EnableVolumeIO = Action("EnableVolumeIO") EnableVpcClassicLink = Action("EnableVpcClassicLink") @@ -374,19 +334,13 @@ GetManagedPrefixListAssociations = Action("GetManagedPrefixListAssociations") GetManagedPrefixListEntries = Action("GetManagedPrefixListEntries") GetPasswordData = Action("GetPasswordData") GetReservedInstancesExchangeQuote = Action("GetReservedInstancesExchangeQuote") -GetTransitGatewayAttachmentPropagations = Action( - "GetTransitGatewayAttachmentPropagations" -) +GetTransitGatewayAttachmentPropagations = Action("GetTransitGatewayAttachmentPropagations") GetTransitGatewayMulticastDomainAssociations = Action( "GetTransitGatewayMulticastDomainAssociations" ) GetTransitGatewayPrefixListReferences = Action("GetTransitGatewayPrefixListReferences") -GetTransitGatewayRouteTableAssociations = Action( - "GetTransitGatewayRouteTableAssociations" -) -GetTransitGatewayRouteTablePropagations = Action( - "GetTransitGatewayRouteTablePropagations" -) +GetTransitGatewayRouteTableAssociations = Action("GetTransitGatewayRouteTableAssociations") +GetTransitGatewayRouteTablePropagations = Action("GetTransitGatewayRouteTablePropagations") ImportClientVpnClientCertificateRevocationList = Action( "ImportClientVpnClientCertificateRevocationList" ) @@ -406,9 +360,7 @@ ModifyIdFormat = Action("ModifyIdFormat") ModifyIdentityIdFormat = Action("ModifyIdentityIdFormat") ModifyImageAttribute = Action("ModifyImageAttribute") ModifyInstanceAttribute = Action("ModifyInstanceAttribute") -ModifyInstanceCapacityReservationAttributes = Action( - "ModifyInstanceCapacityReservationAttributes" -) +ModifyInstanceCapacityReservationAttributes = Action("ModifyInstanceCapacityReservationAttributes") ModifyInstanceCreditSpecification = Action("ModifyInstanceCreditSpecification") ModifyInstanceEventStartTime = Action("ModifyInstanceEventStartTime") ModifyInstanceMetadataOptions = Action("ModifyInstanceMetadataOptions") @@ -420,23 +372,17 @@ ModifyReservedInstances = Action("ModifyReservedInstances") ModifySnapshotAttribute = Action("ModifySnapshotAttribute") ModifySpotFleetRequest = Action("ModifySpotFleetRequest") ModifySubnetAttribute = Action("ModifySubnetAttribute") -ModifyTrafficMirrorFilterNetworkServices = Action( - "ModifyTrafficMirrorFilterNetworkServices" -) +ModifyTrafficMirrorFilterNetworkServices = Action("ModifyTrafficMirrorFilterNetworkServices") ModifyTrafficMirrorFilterRule = Action("ModifyTrafficMirrorFilterRule") ModifyTrafficMirrorSession = Action("ModifyTrafficMirrorSession") ModifyTransitGateway = Action("ModifyTransitGateway") -ModifyTransitGatewayPrefixListReference = Action( - "ModifyTransitGatewayPrefixListReference" -) +ModifyTransitGatewayPrefixListReference = Action("ModifyTransitGatewayPrefixListReference") ModifyTransitGatewayVpcAttachment = Action("ModifyTransitGatewayVpcAttachment") ModifyVolume = Action("ModifyVolume") ModifyVolumeAttribute = Action("ModifyVolumeAttribute") ModifyVpcAttribute = Action("ModifyVpcAttribute") ModifyVpcEndpoint = Action("ModifyVpcEndpoint") -ModifyVpcEndpointConnectionNotification = Action( - "ModifyVpcEndpointConnectionNotification" -) +ModifyVpcEndpointConnectionNotification = Action("ModifyVpcEndpointConnectionNotification") ModifyVpcEndpointServiceConfiguration = Action("ModifyVpcEndpointServiceConfiguration") ModifyVpcEndpointServicePermissions = Action("ModifyVpcEndpointServicePermissions") ModifyVpcPeeringConnectionOptions = Action("ModifyVpcPeeringConnectionOptions") @@ -452,15 +398,9 @@ PurchaseReservedInstancesOffering = Action("PurchaseReservedInstancesOffering") PurchaseScheduledInstances = Action("PurchaseScheduledInstances") RebootInstances = Action("RebootInstances") RegisterImage = Action("RegisterImage") -RegisterInstanceEventNotificationAttributes = Action( - "RegisterInstanceEventNotificationAttributes" -) -RegisterTransitGatewayMulticastGroupMembers = Action( - "RegisterTransitGatewayMulticastGroupMembers" -) -RegisterTransitGatewayMulticastGroupSources = Action( - "RegisterTransitGatewayMulticastGroupSources" -) +RegisterInstanceEventNotificationAttributes = Action("RegisterInstanceEventNotificationAttributes") +RegisterTransitGatewayMulticastGroupMembers = Action("RegisterTransitGatewayMulticastGroupMembers") +RegisterTransitGatewayMulticastGroupSources = Action("RegisterTransitGatewayMulticastGroupSources") RejectTransitGatewayPeeringAttachment = Action("RejectTransitGatewayPeeringAttachment") RejectTransitGatewayVpcAttachment = Action("RejectTransitGatewayVpcAttachment") RejectVpcEndpointConnections = Action("RejectVpcEndpointConnections") @@ -503,10 +443,6 @@ TerminateInstances = Action("TerminateInstances") UnassignIpv6Addresses = Action("UnassignIpv6Addresses") UnassignPrivateIpAddresses = Action("UnassignPrivateIpAddresses") UnmonitorInstances = Action("UnmonitorInstances") -UpdateSecurityGroupRuleDescriptionsEgress = Action( - "UpdateSecurityGroupRuleDescriptionsEgress" -) -UpdateSecurityGroupRuleDescriptionsIngress = Action( - "UpdateSecurityGroupRuleDescriptionsIngress" -) +UpdateSecurityGroupRuleDescriptionsEgress = Action("UpdateSecurityGroupRuleDescriptionsEgress") +UpdateSecurityGroupRuleDescriptionsIngress = Action("UpdateSecurityGroupRuleDescriptionsIngress") WithdrawByoipCidr = Action("WithdrawByoipCidr") diff --git a/typings/awacs/elasticache.pyi b/typings/awacs/elasticache.pyi index 04fbfadcf..bbe8753dd 100644 --- a/typings/awacs/elasticache.pyi +++ b/typings/awacs/elasticache.pyi @@ -29,9 +29,7 @@ CreateReplicationGroup = Action("CreateReplicationGroup") CreateSnapshot = Action("CreateSnapshot") CreateUser = Action("CreateUser") CreateUserGroup = Action("CreateUserGroup") -DecreaseNodeGroupsInGlobalReplicationGroup = Action( - "DecreaseNodeGroupsInGlobalReplicationGroup" -) +DecreaseNodeGroupsInGlobalReplicationGroup = Action("DecreaseNodeGroupsInGlobalReplicationGroup") DecreaseReplicaCount = Action("DecreaseReplicaCount") DeleteCacheCluster = Action("DeleteCacheCluster") DeleteCacheParameterGroup = Action("DeleteCacheParameterGroup") @@ -61,9 +59,7 @@ DescribeUserGroups = Action("DescribeUserGroups") DescribeUsers = Action("DescribeUsers") DisassociateGlobalReplicationGroup = Action("DisassociateGlobalReplicationGroup") FailoverGlobalReplicationGroup = Action("FailoverGlobalReplicationGroup") -IncreaseNodeGroupsInGlobalReplicationGroup = Action( - "IncreaseNodeGroupsInGlobalReplicationGroup" -) +IncreaseNodeGroupsInGlobalReplicationGroup = Action("IncreaseNodeGroupsInGlobalReplicationGroup") IncreaseReplicaCount = Action("IncreaseReplicaCount") ListAllowedNodeTypeModifications = Action("ListAllowedNodeTypeModifications") ListTagsForResource = Action("ListTagsForResource") @@ -72,15 +68,11 @@ ModifyCacheParameterGroup = Action("ModifyCacheParameterGroup") ModifyCacheSubnetGroup = Action("ModifyCacheSubnetGroup") ModifyGlobalReplicationGroup = Action("ModifyGlobalReplicationGroup") ModifyReplicationGroup = Action("ModifyReplicationGroup") -ModifyReplicationGroupShardConfiguration = Action( - "ModifyReplicationGroupShardConfiguration" -) +ModifyReplicationGroupShardConfiguration = Action("ModifyReplicationGroupShardConfiguration") ModifyUser = Action("ModifyUser") ModifyUserGroup = Action("ModifyUserGroup") PurchaseReservedCacheNodesOffering = Action("PurchaseReservedCacheNodesOffering") -RebalanceSlotsInGlobalReplicationGroup = Action( - "RebalanceSlotsInGlobalReplicationGroup" -) +RebalanceSlotsInGlobalReplicationGroup = Action("RebalanceSlotsInGlobalReplicationGroup") RebootCacheCluster = Action("RebootCacheCluster") RemoveTagsFromResource = Action("RemoveTagsFromResource") ResetCacheParameterGroup = Action("ResetCacheParameterGroup") diff --git a/typings/awacs/elasticbeanstalk.pyi b/typings/awacs/elasticbeanstalk.pyi index 6f8098cc4..765a15a05 100644 --- a/typings/awacs/elasticbeanstalk.pyi +++ b/typings/awacs/elasticbeanstalk.pyi @@ -37,9 +37,7 @@ DescribeApplications = Action("DescribeApplications") DescribeConfigurationOptions = Action("DescribeConfigurationOptions") DescribeConfigurationSettings = Action("DescribeConfigurationSettings") DescribeEnvironmentHealth = Action("DescribeEnvironmentHealth") -DescribeEnvironmentManagedActionHistory = Action( - "DescribeEnvironmentManagedActionHistory" -) +DescribeEnvironmentManagedActionHistory = Action("DescribeEnvironmentManagedActionHistory") DescribeEnvironmentManagedActions = Action("DescribeEnvironmentManagedActions") DescribeEnvironmentResources = Action("DescribeEnvironmentResources") DescribeEnvironments = Action("DescribeEnvironments") diff --git a/typings/awacs/elasticloadbalancing.pyi b/typings/awacs/elasticloadbalancing.pyi index c543d76cf..7919d78ef 100644 --- a/typings/awacs/elasticloadbalancing.pyi +++ b/typings/awacs/elasticloadbalancing.pyi @@ -50,12 +50,8 @@ DescribeTargetGroupAttributes = Action("DescribeTargetGroupAttributes") DescribeTargetGroups = Action("DescribeTargetGroups") DescribeTargetHealth = Action("DescribeTargetHealth") DetachLoadBalancerFromSubnets = Action("DetachLoadBalancerFromSubnets") -DisableAvailabilityZonesForLoadBalancer = Action( - "DisableAvailabilityZonesForLoadBalancer" -) -EnableAvailabilityZonesForLoadBalancer = Action( - "EnableAvailabilityZonesForLoadBalancer" -) +DisableAvailabilityZonesForLoadBalancer = Action("DisableAvailabilityZonesForLoadBalancer") +EnableAvailabilityZonesForLoadBalancer = Action("EnableAvailabilityZonesForLoadBalancer") ModifyListener = Action("ModifyListener") ModifyLoadBalancerAttributes = Action("ModifyLoadBalancerAttributes") ModifyRule = Action("ModifyRule") @@ -67,9 +63,7 @@ RemoveListenerCertificates = Action("RemoveListenerCertificates") RemoveTags = Action("RemoveTags") SetIpAddressType = Action("SetIpAddressType") SetLoadBalancerListenerSSLCertificate = Action("SetLoadBalancerListenerSSLCertificate") -SetLoadBalancerPoliciesForBackendServer = Action( - "SetLoadBalancerPoliciesForBackendServer" -) +SetLoadBalancerPoliciesForBackendServer = Action("SetLoadBalancerPoliciesForBackendServer") SetLoadBalancerPoliciesOfListener = Action("SetLoadBalancerPoliciesOfListener") SetRulePriorities = Action("SetRulePriorities") SetSecurityGroups = Action("SetSecurityGroups") diff --git a/typings/awacs/es.pyi b/typings/awacs/es.pyi index e2c689fda..fd9f819fc 100644 --- a/typings/awacs/es.pyi +++ b/typings/awacs/es.pyi @@ -14,29 +14,19 @@ class Action(BaseAction): class ARN(BaseARN): def __init__(self, resource=..., region=..., account=...) -> None: ... -AcceptInboundCrossClusterSearchConnection = Action( - "AcceptInboundCrossClusterSearchConnection" -) +AcceptInboundCrossClusterSearchConnection = Action("AcceptInboundCrossClusterSearchConnection") AddTags = Action("AddTags") CreateElasticsearchDomain = Action("CreateElasticsearchDomain") CreateElasticsearchServiceRole = Action("CreateElasticsearchServiceRole") -CreateOutboundCrossClusterSearchConnection = Action( - "CreateOutboundCrossClusterSearchConnection" -) +CreateOutboundCrossClusterSearchConnection = Action("CreateOutboundCrossClusterSearchConnection") DeleteElasticsearchDomain = Action("DeleteElasticsearchDomain") DeleteElasticsearchServiceRole = Action("DeleteElasticsearchServiceRole") -DeleteInboundCrossClusterSearchConnection = Action( - "DeleteInboundCrossClusterSearchConnection" -) -DeleteOutboundCrossClusterSearchConnection = Action( - "DeleteOutboundCrossClusterSearchConnection" -) +DeleteInboundCrossClusterSearchConnection = Action("DeleteInboundCrossClusterSearchConnection") +DeleteOutboundCrossClusterSearchConnection = Action("DeleteOutboundCrossClusterSearchConnection") DescribeElasticsearchDomain = Action("DescribeElasticsearchDomain") DescribeElasticsearchDomainConfig = Action("DescribeElasticsearchDomainConfig") DescribeElasticsearchDomains = Action("DescribeElasticsearchDomains") -DescribeElasticsearchInstanceTypeLimits = Action( - "DescribeElasticsearchInstanceTypeLimits" -) +DescribeElasticsearchInstanceTypeLimits = Action("DescribeElasticsearchInstanceTypeLimits") DescribeInboundCrossClusterSearchConnections = Action( "DescribeInboundCrossClusterSearchConnections" ) @@ -46,9 +36,7 @@ DescribeOutboundCrossClusterSearchConnections = Action( DescribeReservedElasticsearchInstanceOfferings = Action( "DescribeReservedElasticsearchInstanceOfferings" ) -DescribeReservedElasticsearchInstances = Action( - "DescribeReservedElasticsearchInstances" -) +DescribeReservedElasticsearchInstances = Action("DescribeReservedElasticsearchInstances") ESCrossClusterGet = Action("ESCrossClusterGet") ESHttpDelete = Action("ESHttpDelete") ESHttpGet = Action("ESHttpGet") @@ -68,9 +56,7 @@ PurchaseReservedElasticsearchInstance = Action("PurchaseReservedElasticsearchIns PurchaseReservedElasticsearchInstanceOffering = Action( "PurchaseReservedElasticsearchInstanceOffering" ) -RejectInboundCrossClusterSearchConnection = Action( - "RejectInboundCrossClusterSearchConnection" -) +RejectInboundCrossClusterSearchConnection = Action("RejectInboundCrossClusterSearchConnection") RemoveTags = Action("RemoveTags") UpdateElasticsearchDomainConfig = Action("UpdateElasticsearchDomainConfig") UpgradeElasticsearchDomain = Action("UpgradeElasticsearchDomain") diff --git a/typings/awacs/health.pyi b/typings/awacs/health.pyi index f326ccfba..53c7b8b33 100644 --- a/typings/awacs/health.pyi +++ b/typings/awacs/health.pyi @@ -14,13 +14,9 @@ class Action(BaseAction): class ARN(BaseARN): def __init__(self, resource=..., region=..., account=...) -> None: ... -DescribeAffectedAccountsForOrganization = Action( - "DescribeAffectedAccountsForOrganization" -) +DescribeAffectedAccountsForOrganization = Action("DescribeAffectedAccountsForOrganization") DescribeAffectedEntities = Action("DescribeAffectedEntities") -DescribeAffectedEntitiesForOrganization = Action( - "DescribeAffectedEntitiesForOrganization" -) +DescribeAffectedEntitiesForOrganization = Action("DescribeAffectedEntitiesForOrganization") DescribeEntityAggregates = Action("DescribeEntityAggregates") DescribeEventAggregates = Action("DescribeEventAggregates") DescribeEventDetails = Action("DescribeEventDetails") @@ -28,12 +24,6 @@ DescribeEventDetailsForOrganization = Action("DescribeEventDetailsForOrganizatio DescribeEventTypes = Action("DescribeEventTypes") DescribeEvents = Action("DescribeEvents") DescribeEventsForOrganization = Action("DescribeEventsForOrganization") -DescribeHealthServiceStatusForOrganization = Action( - "DescribeHealthServiceStatusForOrganization" -) -DisableHealthServiceAccessForOrganization = Action( - "DisableHealthServiceAccessForOrganization" -) -EnableHealthServiceAccessForOrganization = Action( - "EnableHealthServiceAccessForOrganization" -) +DescribeHealthServiceStatusForOrganization = Action("DescribeHealthServiceStatusForOrganization") +DisableHealthServiceAccessForOrganization = Action("DisableHealthServiceAccessForOrganization") +EnableHealthServiceAccessForOrganization = Action("EnableHealthServiceAccessForOrganization") diff --git a/typings/awacs/iam.pyi b/typings/awacs/iam.pyi index 9c088782e..6453d1439 100644 --- a/typings/awacs/iam.pyi +++ b/typings/awacs/iam.pyi @@ -89,9 +89,7 @@ GetSAMLProvider = Action("GetSAMLProvider") GetSSHPublicKey = Action("GetSSHPublicKey") GetServerCertificate = Action("GetServerCertificate") GetServiceLastAccessedDetails = Action("GetServiceLastAccessedDetails") -GetServiceLastAccessedDetailsWithEntities = Action( - "GetServiceLastAccessedDetailsWithEntities" -) +GetServiceLastAccessedDetailsWithEntities = Action("GetServiceLastAccessedDetailsWithEntities") GetServiceLinkedRoleDeletionStatus = Action("GetServiceLinkedRoleDeletionStatus") GetUser = Action("GetUser") GetUserPolicy = Action("GetUserPolicy") @@ -129,9 +127,7 @@ PutRolePermissionsBoundary = Action("PutRolePermissionsBoundary") PutRolePolicy = Action("PutRolePolicy") PutUserPermissionsBoundary = Action("PutUserPermissionsBoundary") PutUserPolicy = Action("PutUserPolicy") -RemoveClientIDFromOpenIDConnectProvider = Action( - "RemoveClientIDFromOpenIDConnectProvider" -) +RemoveClientIDFromOpenIDConnectProvider = Action("RemoveClientIDFromOpenIDConnectProvider") RemoveRoleFromInstanceProfile = Action("RemoveRoleFromInstanceProfile") RemoveUserFromGroup = Action("RemoveUserFromGroup") RequestSmsMfaRegistration = Action("RequestSmsMfaRegistration") diff --git a/typings/awacs/iotsitewise.pyi b/typings/awacs/iotsitewise.pyi index 72bf2063a..d268005f2 100644 --- a/typings/awacs/iotsitewise.pyi +++ b/typings/awacs/iotsitewise.pyi @@ -54,9 +54,7 @@ DescribeAssetTemplates = Action("DescribeAssetTemplates") DescribeAssets = Action("DescribeAssets") DescribeDashboard = Action("DescribeDashboard") DescribeGateway = Action("DescribeGateway") -DescribeGatewayCapabilityConfiguration = Action( - "DescribeGatewayCapabilityConfiguration" -) +DescribeGatewayCapabilityConfiguration = Action("DescribeGatewayCapabilityConfiguration") DescribeGateways = Action("DescribeGateways") DescribeGroups = Action("DescribeGroups") DescribeLoggingOptions = Action("DescribeLoggingOptions") diff --git a/typings/awacs/kinesisanalytics.pyi b/typings/awacs/kinesisanalytics.pyi index c499c154d..5867d5cb7 100644 --- a/typings/awacs/kinesisanalytics.pyi +++ b/typings/awacs/kinesisanalytics.pyi @@ -16,18 +16,14 @@ class ARN(BaseARN): AddApplicationCloudWatchLoggingOption = Action("AddApplicationCloudWatchLoggingOption") AddApplicationInput = Action("AddApplicationInput") -AddApplicationInputProcessingConfiguration = Action( - "AddApplicationInputProcessingConfiguration" -) +AddApplicationInputProcessingConfiguration = Action("AddApplicationInputProcessingConfiguration") AddApplicationOutput = Action("AddApplicationOutput") AddApplicationReferenceDataSource = Action("AddApplicationReferenceDataSource") AddApplicationVpcConfiguration = Action("AddApplicationVpcConfiguration") CreateApplication = Action("CreateApplication") CreateApplicationSnapshot = Action("CreateApplicationSnapshot") DeleteApplication = Action("DeleteApplication") -DeleteApplicationCloudWatchLoggingOption = Action( - "DeleteApplicationCloudWatchLoggingOption" -) +DeleteApplicationCloudWatchLoggingOption = Action("DeleteApplicationCloudWatchLoggingOption") DeleteApplicationInputProcessingConfiguration = Action( "DeleteApplicationInputProcessingConfiguration" ) diff --git a/typings/awacs/license_manager.pyi b/typings/awacs/license_manager.pyi index ae27c01a1..ea6bf0d57 100644 --- a/typings/awacs/license_manager.pyi +++ b/typings/awacs/license_manager.pyi @@ -18,9 +18,7 @@ CreateLicenseConfiguration = Action("CreateLicenseConfiguration") DeleteLicenseConfiguration = Action("DeleteLicenseConfiguration") GetLicenseConfiguration = Action("GetLicenseConfiguration") GetServiceSettings = Action("GetServiceSettings") -ListAssociationsForLicenseConfiguration = Action( - "ListAssociationsForLicenseConfiguration" -) +ListAssociationsForLicenseConfiguration = Action("ListAssociationsForLicenseConfiguration") ListLicenseConfigurations = Action("ListLicenseConfigurations") ListLicenseSpecificationsForResource = Action("ListLicenseSpecificationsForResource") ListResourceInventory = Action("ListResourceInventory") @@ -29,7 +27,5 @@ ListUsageForLicenseConfiguration = Action("ListUsageForLicenseConfiguration") TagResource = Action("TagResource") UntagResource = Action("UntagResource") UpdateLicenseConfiguration = Action("UpdateLicenseConfiguration") -UpdateLicenseSpecificationsForResource = Action( - "UpdateLicenseSpecificationsForResource" -) +UpdateLicenseSpecificationsForResource = Action("UpdateLicenseSpecificationsForResource") UpdateServiceSettings = Action("UpdateServiceSettings") diff --git a/typings/awacs/lightsail.pyi b/typings/awacs/lightsail.pyi index 2d2a8b8f0..d05e95414 100644 --- a/typings/awacs/lightsail.pyi +++ b/typings/awacs/lightsail.pyi @@ -88,9 +88,7 @@ GetRelationalDatabaseBundles = Action("GetRelationalDatabaseBundles") GetRelationalDatabaseEvents = Action("GetRelationalDatabaseEvents") GetRelationalDatabaseLogEvents = Action("GetRelationalDatabaseLogEvents") GetRelationalDatabaseLogStreams = Action("GetRelationalDatabaseLogStreams") -GetRelationalDatabaseMasterUserPassword = Action( - "GetRelationalDatabaseMasterUserPassword" -) +GetRelationalDatabaseMasterUserPassword = Action("GetRelationalDatabaseMasterUserPassword") GetRelationalDatabaseMetricData = Action("GetRelationalDatabaseMetricData") GetRelationalDatabaseParameters = Action("GetRelationalDatabaseParameters") GetRelationalDatabaseSnapshot = Action("GetRelationalDatabaseSnapshot") diff --git a/typings/awacs/rds.pyi b/typings/awacs/rds.pyi index 914e39782..f71af3b67 100644 --- a/typings/awacs/rds.pyi +++ b/typings/awacs/rds.pyi @@ -78,9 +78,7 @@ DescribeDBSecurityGroups = Action("DescribeDBSecurityGroups") DescribeDBSnapshotAttributes = Action("DescribeDBSnapshotAttributes") DescribeDBSnapshots = Action("DescribeDBSnapshots") DescribeDBSubnetGroups = Action("DescribeDBSubnetGroups") -DescribeEngineDefaultClusterParameters = Action( - "DescribeEngineDefaultClusterParameters" -) +DescribeEngineDefaultClusterParameters = Action("DescribeEngineDefaultClusterParameters") DescribeEngineDefaultParameters = Action("DescribeEngineDefaultParameters") DescribeEventCategories = Action("DescribeEventCategories") DescribeEventSubscriptions = Action("DescribeEventSubscriptions") @@ -122,9 +120,7 @@ RegisterDBProxyTargets = Action("RegisterDBProxyTargets") RemoveFromGlobalCluster = Action("RemoveFromGlobalCluster") RemoveRoleFromDBCluster = Action("RemoveRoleFromDBCluster") RemoveRoleFromDBInstance = Action("RemoveRoleFromDBInstance") -RemoveSourceIdentifierFromSubscription = Action( - "RemoveSourceIdentifierFromSubscription" -) +RemoveSourceIdentifierFromSubscription = Action("RemoveSourceIdentifierFromSubscription") RemoveTagsFromResource = Action("RemoveTagsFromResource") ResetDBClusterParameterGroup = Action("ResetDBClusterParameterGroup") ResetDBParameterGroup = Action("ResetDBParameterGroup") diff --git a/typings/awacs/route53.pyi b/typings/awacs/route53.pyi index b1ed79a0d..2df1bddfb 100644 --- a/typings/awacs/route53.pyi +++ b/typings/awacs/route53.pyi @@ -63,9 +63,7 @@ ListTagsForResource = Action("ListTagsForResource") ListTagsForResources = Action("ListTagsForResources") ListTrafficPolicies = Action("ListTrafficPolicies") ListTrafficPolicyInstances = Action("ListTrafficPolicyInstances") -ListTrafficPolicyInstancesByHostedZone = Action( - "ListTrafficPolicyInstancesByHostedZone" -) +ListTrafficPolicyInstancesByHostedZone = Action("ListTrafficPolicyInstancesByHostedZone") ListTrafficPolicyInstancesByPolicy = Action("ListTrafficPolicyInstancesByPolicy") ListTrafficPolicyVersions = Action("ListTrafficPolicyVersions") ListVPCAssociationAuthorizations = Action("ListVPCAssociationAuthorizations") diff --git a/typings/awacs/route53resolver.pyi b/typings/awacs/route53resolver.pyi index d3cefff03..b32add6db 100644 --- a/typings/awacs/route53resolver.pyi +++ b/typings/awacs/route53resolver.pyi @@ -35,9 +35,7 @@ GetResolverRuleAssociation = Action("GetResolverRuleAssociation") GetResolverRulePolicy = Action("GetResolverRulePolicy") ListResolverEndpointIpAddresses = Action("ListResolverEndpointIpAddresses") ListResolverEndpoints = Action("ListResolverEndpoints") -ListResolverQueryLogConfigAssociations = Action( - "ListResolverQueryLogConfigAssociations" -) +ListResolverQueryLogConfigAssociations = Action("ListResolverQueryLogConfigAssociations") ListResolverQueryLogConfigs = Action("ListResolverQueryLogConfigs") ListResolverRuleAssociations = Action("ListResolverRuleAssociations") ListResolverRules = Action("ListResolverRules") diff --git a/typings/awacs/sagemaker.pyi b/typings/awacs/sagemaker.pyi index 77ff503b5..9f8ef51c2 100644 --- a/typings/awacs/sagemaker.pyi +++ b/typings/awacs/sagemaker.pyi @@ -84,9 +84,7 @@ DescribeModel = Action("DescribeModel") DescribeModelPackage = Action("DescribeModelPackage") DescribeMonitoringSchedule = Action("DescribeMonitoringSchedule") DescribeNotebookInstance = Action("DescribeNotebookInstance") -DescribeNotebookInstanceLifecycleConfig = Action( - "DescribeNotebookInstanceLifecycleConfig" -) +DescribeNotebookInstanceLifecycleConfig = Action("DescribeNotebookInstanceLifecycleConfig") DescribeProcessingJob = Action("DescribeProcessingJob") DescribeSubscribedWorkteam = Action("DescribeSubscribedWorkteam") DescribeTrainingJob = Action("DescribeTrainingJob") @@ -125,9 +123,7 @@ ListProcessingJobs = Action("ListProcessingJobs") ListSubscribedWorkteams = Action("ListSubscribedWorkteams") ListTags = Action("ListTags") ListTrainingJobs = Action("ListTrainingJobs") -ListTrainingJobsForHyperParameterTuningJob = Action( - "ListTrainingJobsForHyperParameterTuningJob" -) +ListTrainingJobsForHyperParameterTuningJob = Action("ListTrainingJobsForHyperParameterTuningJob") ListTransformJobs = Action("ListTransformJobs") ListTrialComponents = Action("ListTrialComponents") ListTrials = Action("ListTrials") diff --git a/typings/awacs/servicecatalog.pyi b/typings/awacs/servicecatalog.pyi index f4c2daee0..cacf4c1f6 100644 --- a/typings/awacs/servicecatalog.pyi +++ b/typings/awacs/servicecatalog.pyi @@ -58,9 +58,7 @@ DescribeProvisioningArtifact = Action("DescribeProvisioningArtifact") DescribeProvisioningParameters = Action("DescribeProvisioningParameters") DescribeRecord = Action("DescribeRecord") DescribeServiceAction = Action("DescribeServiceAction") -DescribeServiceActionExecutionParameters = Action( - "DescribeServiceActionExecutionParameters" -) +DescribeServiceActionExecutionParameters = Action("DescribeServiceActionExecutionParameters") DescribeTagOption = Action("DescribeTagOption") DisableAWSOrganizationsAccess = Action("DisableAWSOrganizationsAccess") DisassociateBudgetFromResource = Action("DisassociateBudgetFromResource") @@ -72,9 +70,7 @@ DisassociateServiceActionFromProvisioningArtifact = Action( DisassociateTagOptionFromResource = Action("DisassociateTagOptionFromResource") EnableAWSOrganizationsAccess = Action("EnableAWSOrganizationsAccess") ExecuteProvisionedProductPlan = Action("ExecuteProvisionedProductPlan") -ExecuteProvisionedProductServiceAction = Action( - "ExecuteProvisionedProductServiceAction" -) +ExecuteProvisionedProductServiceAction = Action("ExecuteProvisionedProductServiceAction") GetAWSOrganizationsAccessStatus = Action("GetAWSOrganizationsAccessStatus") ListAcceptedPortfolioShares = Action("ListAcceptedPortfolioShares") ListBudgetsForResource = Action("ListBudgetsForResource") @@ -87,18 +83,12 @@ ListPortfoliosForProduct = Action("ListPortfoliosForProduct") ListPrincipalsForPortfolio = Action("ListPrincipalsForPortfolio") ListProvisionedProductPlans = Action("ListProvisionedProductPlans") ListProvisioningArtifacts = Action("ListProvisioningArtifacts") -ListProvisioningArtifactsForServiceAction = Action( - "ListProvisioningArtifactsForServiceAction" -) +ListProvisioningArtifactsForServiceAction = Action("ListProvisioningArtifactsForServiceAction") ListRecordHistory = Action("ListRecordHistory") ListResourcesForTagOption = Action("ListResourcesForTagOption") ListServiceActions = Action("ListServiceActions") -ListServiceActionsForProvisioningArtifact = Action( - "ListServiceActionsForProvisioningArtifact" -) -ListStackInstancesForProvisionedProduct = Action( - "ListStackInstancesForProvisionedProduct" -) +ListServiceActionsForProvisioningArtifact = Action("ListServiceActionsForProvisioningArtifact") +ListStackInstancesForProvisionedProduct = Action("ListStackInstancesForProvisionedProduct") ListTagOptions = Action("ListTagOptions") ProvisionProduct = Action("ProvisionProduct") RejectPortfolioShare = Action("RejectPortfolioShare") diff --git a/typings/awacs/servicequotas.pyi b/typings/awacs/servicequotas.pyi index b4919cc81..bbe455f59 100644 --- a/typings/awacs/servicequotas.pyi +++ b/typings/awacs/servicequotas.pyi @@ -23,22 +23,14 @@ GetAWSDefaultServiceQuota = Action("GetAWSDefaultServiceQuota") GetAssociationForServiceQuotaTemplate = Action("GetAssociationForServiceQuotaTemplate") GetRequestedServiceQuotaChange = Action("GetRequestedServiceQuotaChange") GetServiceQuota = Action("GetServiceQuota") -GetServiceQuotaIncreaseRequestFromTemplate = Action( - "GetServiceQuotaIncreaseRequestFromTemplate" -) +GetServiceQuotaIncreaseRequestFromTemplate = Action("GetServiceQuotaIncreaseRequestFromTemplate") ListAWSDefaultServiceQuotas = Action("ListAWSDefaultServiceQuotas") -ListRequestedServiceQuotaChangeHistory = Action( - "ListRequestedServiceQuotaChangeHistory" -) +ListRequestedServiceQuotaChangeHistory = Action("ListRequestedServiceQuotaChangeHistory") ListRequestedServiceQuotaChangeHistoryByQuota = Action( "ListRequestedServiceQuotaChangeHistoryByQuota" ) -ListServiceQuotaIncreaseRequestsInTemplate = Action( - "ListServiceQuotaIncreaseRequestsInTemplate" -) +ListServiceQuotaIncreaseRequestsInTemplate = Action("ListServiceQuotaIncreaseRequestsInTemplate") ListServiceQuotas = Action("ListServiceQuotas") ListServices = Action("ListServices") -PutServiceQuotaIncreaseRequestIntoTemplate = Action( - "PutServiceQuotaIncreaseRequestIntoTemplate" -) +PutServiceQuotaIncreaseRequestIntoTemplate = Action("PutServiceQuotaIncreaseRequestIntoTemplate") RequestServiceQuotaIncrease = Action("RequestServiceQuotaIncrease") diff --git a/typings/awacs/ses.pyi b/typings/awacs/ses.pyi index 3c785dfc0..c450bec15 100644 --- a/typings/awacs/ses.pyi +++ b/typings/awacs/ses.pyi @@ -16,9 +16,7 @@ class ARN(BaseARN): CloneReceiptRuleSet = Action("CloneReceiptRuleSet") CreateConfigurationSet = Action("CreateConfigurationSet") -CreateConfigurationSetEventDestination = Action( - "CreateConfigurationSetEventDestination" -) +CreateConfigurationSetEventDestination = Action("CreateConfigurationSetEventDestination") CreateConfigurationSetTrackingOptions = Action("CreateConfigurationSetTrackingOptions") CreateCustomVerificationEmailTemplate = Action("CreateCustomVerificationEmailTemplate") CreateDedicatedIpPool = Action("CreateDedicatedIpPool") @@ -29,9 +27,7 @@ CreateReceiptRule = Action("CreateReceiptRule") CreateReceiptRuleSet = Action("CreateReceiptRuleSet") CreateTemplate = Action("CreateTemplate") DeleteConfigurationSet = Action("DeleteConfigurationSet") -DeleteConfigurationSetEventDestination = Action( - "DeleteConfigurationSetEventDestination" -) +DeleteConfigurationSetEventDestination = Action("DeleteConfigurationSetEventDestination") DeleteConfigurationSetTrackingOptions = Action("DeleteConfigurationSetTrackingOptions") DeleteCustomVerificationEmailTemplate = Action("DeleteCustomVerificationEmailTemplate") DeleteDedicatedIpPool = Action("DeleteDedicatedIpPool") @@ -102,9 +98,7 @@ SendTemplatedEmail = Action("SendTemplatedEmail") SetActiveReceiptRuleSet = Action("SetActiveReceiptRuleSet") SetIdentityDkimEnabled = Action("SetIdentityDkimEnabled") SetIdentityFeedbackForwardingEnabled = Action("SetIdentityFeedbackForwardingEnabled") -SetIdentityHeadersInNotificationsEnabled = Action( - "SetIdentityHeadersInNotificationsEnabled" -) +SetIdentityHeadersInNotificationsEnabled = Action("SetIdentityHeadersInNotificationsEnabled") SetIdentityMailFromDomain = Action("SetIdentityMailFromDomain") SetIdentityNotificationTopic = Action("SetIdentityNotificationTopic") SetReceiptRulePosition = Action("SetReceiptRulePosition") @@ -112,9 +106,7 @@ TagResource = Action("TagResource") TestRenderTemplate = Action("TestRenderTemplate") UntagResource = Action("UntagResource") UpdateAccountSendingEnabled = Action("UpdateAccountSendingEnabled") -UpdateConfigurationSetEventDestination = Action( - "UpdateConfigurationSetEventDestination" -) +UpdateConfigurationSetEventDestination = Action("UpdateConfigurationSetEventDestination") UpdateConfigurationSetReputationMetricsEnabled = Action( "UpdateConfigurationSetReputationMetricsEnabled" ) diff --git a/typings/awacs/sms_voice.pyi b/typings/awacs/sms_voice.pyi index ad1b21f8e..aefe486a6 100644 --- a/typings/awacs/sms_voice.pyi +++ b/typings/awacs/sms_voice.pyi @@ -15,16 +15,10 @@ class ARN(BaseARN): def __init__(self, resource=..., region=..., account=...) -> None: ... CreateConfigurationSet = Action("CreateConfigurationSet") -CreateConfigurationSetEventDestination = Action( - "CreateConfigurationSetEventDestination" -) +CreateConfigurationSetEventDestination = Action("CreateConfigurationSetEventDestination") DeleteConfigurationSet = Action("DeleteConfigurationSet") -DeleteConfigurationSetEventDestination = Action( - "DeleteConfigurationSetEventDestination" -) +DeleteConfigurationSetEventDestination = Action("DeleteConfigurationSetEventDestination") GetConfigurationSetEventDestinations = Action("GetConfigurationSetEventDestinations") ListConfigurationSets = Action("ListConfigurationSets") SendVoiceMessage = Action("SendVoiceMessage") -UpdateConfigurationSetEventDestination = Action( - "UpdateConfigurationSetEventDestination" -) +UpdateConfigurationSetEventDestination = Action("UpdateConfigurationSetEventDestination") diff --git a/typings/awacs/ssm.pyi b/typings/awacs/ssm.pyi index 2d379ac19..f28299ff6 100644 --- a/typings/awacs/ssm.pyi +++ b/typings/awacs/ssm.pyi @@ -49,24 +49,18 @@ DescribeDocument = Action("DescribeDocument") DescribeDocumentParameters = Action("DescribeDocumentParameters") DescribeDocumentPermission = Action("DescribeDocumentPermission") DescribeEffectiveInstanceAssociations = Action("DescribeEffectiveInstanceAssociations") -DescribeEffectivePatchesForPatchBaseline = Action( - "DescribeEffectivePatchesForPatchBaseline" -) +DescribeEffectivePatchesForPatchBaseline = Action("DescribeEffectivePatchesForPatchBaseline") DescribeInstanceAssociationsStatus = Action("DescribeInstanceAssociationsStatus") DescribeInstanceInformation = Action("DescribeInstanceInformation") DescribeInstancePatchStates = Action("DescribeInstancePatchStates") -DescribeInstancePatchStatesForPatchGroup = Action( - "DescribeInstancePatchStatesForPatchGroup" -) +DescribeInstancePatchStatesForPatchGroup = Action("DescribeInstancePatchStatesForPatchGroup") DescribeInstancePatches = Action("DescribeInstancePatches") DescribeInstanceProperties = Action("DescribeInstanceProperties") DescribeInventoryDeletions = Action("DescribeInventoryDeletions") DescribeMaintenanceWindowExecutionTaskInvocations = Action( "DescribeMaintenanceWindowExecutionTaskInvocations" ) -DescribeMaintenanceWindowExecutionTasks = Action( - "DescribeMaintenanceWindowExecutionTasks" -) +DescribeMaintenanceWindowExecutionTasks = Action("DescribeMaintenanceWindowExecutionTasks") DescribeMaintenanceWindowExecutions = Action("DescribeMaintenanceWindowExecutions") DescribeMaintenanceWindowSchedule = Action("DescribeMaintenanceWindowSchedule") DescribeMaintenanceWindowTargets = Action("DescribeMaintenanceWindowTargets") @@ -92,9 +86,7 @@ GetInventorySchema = Action("GetInventorySchema") GetMaintenanceWindow = Action("GetMaintenanceWindow") GetMaintenanceWindowExecution = Action("GetMaintenanceWindowExecution") GetMaintenanceWindowExecutionTask = Action("GetMaintenanceWindowExecutionTask") -GetMaintenanceWindowExecutionTaskInvocation = Action( - "GetMaintenanceWindowExecutionTaskInvocation" -) +GetMaintenanceWindowExecutionTaskInvocation = Action("GetMaintenanceWindowExecutionTaskInvocation") GetMaintenanceWindowTask = Action("GetMaintenanceWindowTask") GetManifest = Action("GetManifest") GetOpsItem = Action("GetOpsItem") diff --git a/typings/awacs/sso.pyi b/typings/awacs/sso.pyi index 72bf2f685..21cd346ea 100644 --- a/typings/awacs/sso.pyi +++ b/typings/awacs/sso.pyi @@ -38,17 +38,11 @@ DeletePermissionSet = Action("DeletePermissionSet") DeletePermissionsPolicy = Action("DeletePermissionsPolicy") DeleteProfile = Action("DeleteProfile") DeleteUser = Action("DeleteUser") -DescribeAccountAssignmentCreationStatus = Action( - "DescribeAccountAssignmentCreationStatus" -) -DescribeAccountAssignmentDeletionStatus = Action( - "DescribeAccountAssignmentDeletionStatus" -) +DescribeAccountAssignmentCreationStatus = Action("DescribeAccountAssignmentCreationStatus") +DescribeAccountAssignmentDeletionStatus = Action("DescribeAccountAssignmentDeletionStatus") DescribeGroups = Action("DescribeGroups") DescribePermissionSet = Action("DescribePermissionSet") -DescribePermissionSetProvisioningStatus = Action( - "DescribePermissionSetProvisioningStatus" -) +DescribePermissionSetProvisioningStatus = Action("DescribePermissionSetProvisioningStatus") DescribePermissionsPolicies = Action("DescribePermissionsPolicies") DescribeRegisteredRegions = Action("DescribeRegisteredRegions") DescribeUsers = Action("DescribeUsers") @@ -77,9 +71,7 @@ ImportApplicationInstanceServiceProviderMetadata = Action( ListAccountAssignmentCreationStatus = Action("ListAccountAssignmentCreationStatus") ListAccountAssignmentDeletionStatus = Action("ListAccountAssignmentDeletionStatus") ListAccountAssignments = Action("ListAccountAssignments") -ListAccountsForProvisionedPermissionSet = Action( - "ListAccountsForProvisionedPermissionSet" -) +ListAccountsForProvisionedPermissionSet = Action("ListAccountsForProvisionedPermissionSet") ListApplicationInstanceCertificates = Action("ListApplicationInstanceCertificates") ListApplicationInstances = Action("ListApplicationInstances") ListApplicationTemplates = Action("ListApplicationTemplates") @@ -91,9 +83,7 @@ ListManagedPoliciesInPermissionSet = Action("ListManagedPoliciesInPermissionSet" ListMembersInGroup = Action("ListMembersInGroup") ListPermissionSetProvisioningStatus = Action("ListPermissionSetProvisioningStatus") ListPermissionSets = Action("ListPermissionSets") -ListPermissionSetsProvisionedToAccount = Action( - "ListPermissionSetsProvisionedToAccount" -) +ListPermissionSetsProvisionedToAccount = Action("ListPermissionSetsProvisionedToAccount") ListProfileAssociations = Action("ListProfileAssociations") ListProfiles = Action("ListProfiles") ListTagsForResource = Action("ListTagsForResource") @@ -108,9 +98,7 @@ SetTemporaryPassword = Action("SetTemporaryPassword") StartSSO = Action("StartSSO") TagResource = Action("TagResource") UntagResource = Action("UntagResource") -UpdateApplicationInstanceActiveCertificate = Action( - "UpdateApplicationInstanceActiveCertificate" -) +UpdateApplicationInstanceActiveCertificate = Action("UpdateApplicationInstanceActiveCertificate") UpdateApplicationInstanceDisplayData = Action("UpdateApplicationInstanceDisplayData") UpdateApplicationInstanceResponseConfiguration = Action( "UpdateApplicationInstanceResponseConfiguration" @@ -127,9 +115,7 @@ UpdateApplicationInstanceServiceProviderConfiguration = Action( UpdateApplicationInstanceStatus = Action("UpdateApplicationInstanceStatus") UpdateDirectoryAssociation = Action("UpdateDirectoryAssociation") UpdateGroup = Action("UpdateGroup") -UpdateManagedApplicationInstanceStatus = Action( - "UpdateManagedApplicationInstanceStatus" -) +UpdateManagedApplicationInstanceStatus = Action("UpdateManagedApplicationInstanceStatus") UpdatePermissionSet = Action("UpdatePermissionSet") UpdateProfile = Action("UpdateProfile") UpdateSSOConfiguration = Action("UpdateSSOConfiguration") diff --git a/typings/awacs/sso_directory.pyi b/typings/awacs/sso_directory.pyi index df113247b..830a4a338 100644 --- a/typings/awacs/sso_directory.pyi +++ b/typings/awacs/sso_directory.pyi @@ -18,16 +18,12 @@ AddMemberToGroup = Action("AddMemberToGroup") CompleteVirtualMfaDeviceRegistration = Action("CompleteVirtualMfaDeviceRegistration") CreateAlias = Action("CreateAlias") CreateBearerToken = Action("CreateBearerToken") -CreateExternalIdPConfigurationForDirectory = Action( - "CreateExternalIdPConfigurationForDirectory" -) +CreateExternalIdPConfigurationForDirectory = Action("CreateExternalIdPConfigurationForDirectory") CreateGroup = Action("CreateGroup") CreateProvisioningTenant = Action("CreateProvisioningTenant") CreateUser = Action("CreateUser") DeleteBearerToken = Action("DeleteBearerToken") -DeleteExternalIdPConfigurationForDirectory = Action( - "DeleteExternalIdPConfigurationForDirectory" -) +DeleteExternalIdPConfigurationForDirectory = Action("DeleteExternalIdPConfigurationForDirectory") DeleteGroup = Action("DeleteGroup") DeleteMfaDeviceForUser = Action("DeleteMfaDeviceForUser") DeleteProvisioningTenant = Action("DeleteProvisioningTenant") @@ -35,19 +31,13 @@ DeleteUser = Action("DeleteUser") DescribeDirectory = Action("DescribeDirectory") DescribeGroups = Action("DescribeGroups") DescribeUsers = Action("DescribeUsers") -DisableExternalIdPConfigurationForDirectory = Action( - "DisableExternalIdPConfigurationForDirectory" -) +DisableExternalIdPConfigurationForDirectory = Action("DisableExternalIdPConfigurationForDirectory") DisableUser = Action("DisableUser") -EnableExternalIdPConfigurationForDirectory = Action( - "EnableExternalIdPConfigurationForDirectory" -) +EnableExternalIdPConfigurationForDirectory = Action("EnableExternalIdPConfigurationForDirectory") EnableUser = Action("EnableUser") GetAWSSPConfigurationForDirectory = Action("GetAWSSPConfigurationForDirectory") ListBearerTokens = Action("ListBearerTokens") -ListExternalIdPConfigurationsForDirectory = Action( - "ListExternalIdPConfigurationsForDirectory" -) +ListExternalIdPConfigurationsForDirectory = Action("ListExternalIdPConfigurationsForDirectory") ListGroupsForUser = Action("ListGroupsForUser") ListMembersInGroup = Action("ListMembersInGroup") ListMfaDevicesForUser = Action("ListMfaDevicesForUser") @@ -56,9 +46,7 @@ RemoveMemberFromGroup = Action("RemoveMemberFromGroup") SearchGroups = Action("SearchGroups") SearchUsers = Action("SearchUsers") StartVirtualMfaDeviceRegistration = Action("StartVirtualMfaDeviceRegistration") -UpdateExternalIdPConfigurationForDirectory = Action( - "UpdateExternalIdPConfigurationForDirectory" -) +UpdateExternalIdPConfigurationForDirectory = Action("UpdateExternalIdPConfigurationForDirectory") UpdateGroup = Action("UpdateGroup") UpdatePassword = Action("UpdatePassword") UpdateUser = Action("UpdateUser") diff --git a/typings/awacs/support.pyi b/typings/awacs/support.pyi index ae31fb669..d1dba3123 100644 --- a/typings/awacs/support.pyi +++ b/typings/awacs/support.pyi @@ -25,9 +25,7 @@ DescribeIssueTypes = Action("DescribeIssueTypes") DescribeServices = Action("DescribeServices") DescribeSeverityLevels = Action("DescribeSeverityLevels") DescribeSupportLevel = Action("DescribeSupportLevel") -DescribeTrustedAdvisorCheckRefreshStatuses = Action( - "DescribeTrustedAdvisorCheckRefreshStatuses" -) +DescribeTrustedAdvisorCheckRefreshStatuses = Action("DescribeTrustedAdvisorCheckRefreshStatuses") DescribeTrustedAdvisorCheckResult = Action("DescribeTrustedAdvisorCheckResult") DescribeTrustedAdvisorCheckSummaries = Action("DescribeTrustedAdvisorCheckSummaries") DescribeTrustedAdvisorChecks = Action("DescribeTrustedAdvisorChecks") diff --git a/typings/awacs/swf.pyi b/typings/awacs/swf.pyi index 73ed5b8f6..e5641b1b6 100644 --- a/typings/awacs/swf.pyi +++ b/typings/awacs/swf.pyi @@ -45,9 +45,7 @@ RegisterActivityType = Action("RegisterActivityType") RegisterDomain = Action("RegisterDomain") RegisterWorkflowType = Action("RegisterWorkflowType") RequestCancelActivityTask = Action("RequestCancelActivityTask") -RequestCancelExternalWorkflowExecution = Action( - "RequestCancelExternalWorkflowExecution" -) +RequestCancelExternalWorkflowExecution = Action("RequestCancelExternalWorkflowExecution") RequestCancelWorkflowExecution = Action("RequestCancelWorkflowExecution") RespondActivityTaskCanceled = Action("RespondActivityTaskCanceled") RespondActivityTaskCompleted = Action("RespondActivityTaskCompleted") diff --git a/typings/awacs/transcribe.pyi b/typings/awacs/transcribe.pyi index 317d910f7..a420f51af 100644 --- a/typings/awacs/transcribe.pyi +++ b/typings/awacs/transcribe.pyi @@ -37,9 +37,7 @@ ListTranscriptionJobs = Action("ListTranscriptionJobs") ListVocabularies = Action("ListVocabularies") ListVocabularyFilters = Action("ListVocabularyFilters") StartMedicalStreamTranscription = Action("StartMedicalStreamTranscription") -StartMedicalStreamTranscriptionWebSocket = Action( - "StartMedicalStreamTranscriptionWebSocket" -) +StartMedicalStreamTranscriptionWebSocket = Action("StartMedicalStreamTranscriptionWebSocket") StartMedicalTranscriptionJob = Action("StartMedicalTranscriptionJob") StartStreamTranscription = Action("StartStreamTranscription") StartStreamTranscriptionWebSocket = Action("StartStreamTranscriptionWebSocket") diff --git a/typings/awacs/worklink.pyi b/typings/awacs/worklink.pyi index 9932c4a73..8cf4f1b03 100644 --- a/typings/awacs/worklink.pyi +++ b/typings/awacs/worklink.pyi @@ -28,12 +28,8 @@ DescribeFleetMetadata = Action("DescribeFleetMetadata") DescribeIdentityProviderConfiguration = Action("DescribeIdentityProviderConfiguration") DescribeWebsiteCertificateAuthority = Action("DescribeWebsiteCertificateAuthority") DisassociateDomain = Action("DisassociateDomain") -DisassociateWebsiteAuthorizationProvider = Action( - "DisassociateWebsiteAuthorizationProvider" -) -DisassociateWebsiteCertificateAuthority = Action( - "DisassociateWebsiteCertificateAuthority" -) +DisassociateWebsiteAuthorizationProvider = Action("DisassociateWebsiteAuthorizationProvider") +DisassociateWebsiteCertificateAuthority = Action("DisassociateWebsiteCertificateAuthority") ListDevices = Action("ListDevices") ListDomains = Action("ListDomains") ListFleets = Action("ListFleets") diff --git a/typings/botocore/client.pyi b/typings/botocore/client.pyi index 7503a7226..69fa41c52 100644 --- a/typings/botocore/client.pyi +++ b/typings/botocore/client.pyi @@ -60,9 +60,7 @@ class ClientEndpointBridge(object): default_endpoint=..., service_signing_name=..., ) -> None: ... - def resolve( - self, service_name, region_name=..., endpoint_url=..., is_secure=... - ): ... + def resolve(self, service_name, region_name=..., endpoint_url=..., is_secure=...): ... class BaseClient(object): _PY_TO_OP_NAME = ... diff --git a/typings/botocore/credentials.pyi b/typings/botocore/credentials.pyi index 9b86c5c68..de61b01ef 100644 --- a/typings/botocore/credentials.pyi +++ b/typings/botocore/credentials.pyi @@ -34,9 +34,7 @@ class ProfileProviderBuilder(object): the source profile chain created by the assume role provider. """ - def __init__( - self, session, cache=..., region_name=..., sso_token_cache=... - ) -> None: ... + def __init__(self, session, cache=..., region_name=..., sso_token_cache=...) -> None: ... def providers(self, profile_name, disable_env_vars=...): ... def get_credentials(session): ... diff --git a/typings/botocore/discovery.pyi b/typings/botocore/discovery.pyi index 11b3ba516..ff08c689a 100644 --- a/typings/botocore/discovery.pyi +++ b/typings/botocore/discovery.pyi @@ -34,9 +34,7 @@ class EndpointDiscoveryModel(object): def gather_identifiers(self, operation, params): ... class EndpointDiscoveryManager(object): - def __init__( - self, client, cache=..., current_time=..., always_discover=... - ) -> None: ... + def __init__(self, client, cache=..., current_time=..., always_discover=...) -> None: ... def gather_identifiers(self, operation, params): ... def delete_endpoints(self, **kwargs): ... def describe_endpoint(self, **kwargs): ... diff --git a/typings/botocore/docs/method.pyi b/typings/botocore/docs/method.pyi index 2cc52c5e3..9553a0cce 100644 --- a/typings/botocore/docs/method.pyi +++ b/typings/botocore/docs/method.pyi @@ -15,9 +15,7 @@ def get_instance_public_methods(instance): """ ... -def document_model_driven_signature( - section, name, operation_model, include=..., exclude=... -): +def document_model_driven_signature(section, name, operation_model, include=..., exclude=...): """Documents the signature of a model-driven method :param section: The section to write the documentation to. diff --git a/typings/botocore/docs/shape.pyi b/typings/botocore/docs/shape.pyi index 53f95ecdd..963401f1c 100644 --- a/typings/botocore/docs/shape.pyi +++ b/typings/botocore/docs/shape.pyi @@ -4,9 +4,7 @@ This type stub file was generated by pyright. class ShapeDocumenter(object): EVENT_NAME = ... - def __init__( - self, service_name, operation_name, event_emitter, context=... - ) -> None: ... + def __init__(self, service_name, operation_name, event_emitter, context=...) -> None: ... def traverse_and_document_shape( self, section, diff --git a/typings/botocore/handlers.pyi b/typings/botocore/handlers.pyi index 6508e6258..990cb2abe 100644 --- a/typings/botocore/handlers.pyi +++ b/typings/botocore/handlers.pyi @@ -21,9 +21,7 @@ logger = logging.getLogger(__name__) REGISTER_FIRST = object() REGISTER_LAST = object() VALID_BUCKET = re.compile(r"^[a-zA-Z0-9.\-_]{1,255}$") -_ACCESSPOINT_ARN = ( - r"^arn:(aws).*:s3:[a-z\-0-9]+:[0-9]{12}:accesspoint[/:]" r"[a-zA-Z0-9\-]{1,63}$" -) +_ACCESSPOINT_ARN = r"^arn:(aws).*:s3:[a-z\-0-9]+:[0-9]{12}:accesspoint[/:]" r"[a-zA-Z0-9\-]{1,63}$" _OUTPOST_ARN = ( r"^arn:(aws).*:s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:]" r"[a-zA-Z0-9\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\-]{1,63}$" @@ -266,8 +264,7 @@ BUILTIN_HANDLERS = [ "docs.*.glacier.*.complete-section", AutoPopulatedParam( "accountId", - 'Note: this parameter is set to "-" by' - "default if no value is not specified.", + 'Note: this parameter is set to "-" by' "default if no value is not specified.", ).document_auto_populated_param, ), ( diff --git a/typings/botocore/hooks.pyi b/typings/botocore/hooks.pyi index 1e78a99da..b1ac1e00f 100644 --- a/typings/botocore/hooks.pyi +++ b/typings/botocore/hooks.pyi @@ -72,9 +72,7 @@ class BaseEventHooks(object): """ ... - def register_first( - self, event_name, handler, unique_id=..., unique_id_uses_count=... - ): + def register_first(self, event_name, handler, unique_id=..., unique_id_uses_count=...): """Register an event handler to be called first for an event. All event handlers registered with ``register_first()`` will @@ -84,9 +82,7 @@ class BaseEventHooks(object): """ ... - def register_last( - self, event_name, handler, unique_id=..., unique_id_uses_count=... - ): + def register_last(self, event_name, handler, unique_id=..., unique_id_uses_count=...): """Register an event handler to be called last for an event. All event handlers registered with ``register_last()`` will be called @@ -95,9 +91,7 @@ class BaseEventHooks(object): """ ... - def unregister( - self, event_name, handler=..., unique_id=..., unique_id_uses_count=... - ): + def unregister(self, event_name, handler=..., unique_id=..., unique_id_uses_count=...): """Unregister an event handler for a given event. If no ``unique_id`` was given during registration, then the @@ -137,27 +131,17 @@ class HierarchicalEmitter(BaseEventHooks): """ ... - def unregister( - self, event_name, handler=..., unique_id=..., unique_id_uses_count=... - ): ... + def unregister(self, event_name, handler=..., unique_id=..., unique_id_uses_count=...): ... def __copy__(self): ... class EventAliaser(BaseEventHooks): def __init__(self, event_emitter, event_aliases=...) -> None: ... def emit(self, event_name, **kwargs): ... def emit_until_response(self, event_name, **kwargs): ... - def register( - self, event_name, handler, unique_id=..., unique_id_uses_count=... - ): ... - def register_first( - self, event_name, handler, unique_id=..., unique_id_uses_count=... - ): ... - def register_last( - self, event_name, handler, unique_id=..., unique_id_uses_count=... - ): ... - def unregister( - self, event_name, handler=..., unique_id=..., unique_id_uses_count=... - ): ... + def register(self, event_name, handler, unique_id=..., unique_id_uses_count=...): ... + def register_first(self, event_name, handler, unique_id=..., unique_id_uses_count=...): ... + def register_last(self, event_name, handler, unique_id=..., unique_id_uses_count=...): ... + def unregister(self, event_name, handler=..., unique_id=..., unique_id_uses_count=...): ... def __copy__(self): ... class _PrefixTrie(object): diff --git a/typings/botocore/regions.pyi b/typings/botocore/regions.pyi index 1f95f4311..b59e41395 100644 --- a/typings/botocore/regions.pyi +++ b/typings/botocore/regions.pyi @@ -53,9 +53,7 @@ class BaseEndpointResolver(object): """ ... - def get_available_endpoints( - self, service_name, partition_name=..., allow_non_regional=... - ): + def get_available_endpoints(self, service_name, partition_name=..., allow_non_regional=...): """Lists the endpoint names of a particular partition. :type service_name: string @@ -84,7 +82,5 @@ class EndpointResolver(BaseEndpointResolver): ... def get_available_partitions(self): ... - def get_available_endpoints( - self, service_name, partition_name=..., allow_non_regional=... - ): ... + def get_available_endpoints(self, service_name, partition_name=..., allow_non_regional=...): ... def construct_endpoint(self, service_name, region_name=..., partition_name=...): ... diff --git a/typings/botocore/retries/throttling.pyi b/typings/botocore/retries/throttling.pyi index d167740af..cf176be64 100644 --- a/typings/botocore/retries/throttling.pyi +++ b/typings/botocore/retries/throttling.pyi @@ -9,9 +9,7 @@ CubicParams = namedtuple("CubicParams", ["w_max", "k", "last_fail"]) class CubicCalculator(object): _SCALE_CONSTANT = ... _BETA = ... - def __init__( - self, starting_max_rate, start_time, scale_constant=..., beta=... - ) -> None: ... + def __init__(self, starting_max_rate, start_time, scale_constant=..., beta=...) -> None: ... def success_received(self, timestamp): ... def error_received(self, current_rate, timestamp): ... def get_params_snapshot(self): diff --git a/typings/botocore/session.pyi b/typings/botocore/session.pyi index aed30a706..7fa3fac45 100644 --- a/typings/botocore/session.pyi +++ b/typings/botocore/session.pyi @@ -320,9 +320,7 @@ class Session(object): """ ... - def unregister( - self, event_name, handler=..., unique_id=..., unique_id_uses_count=... - ): + def unregister(self, event_name, handler=..., unique_id=..., unique_id_uses_count=...): """Unregister a handler with an event. :type event_name: str @@ -450,9 +448,7 @@ class Session(object): """ ... - def get_available_regions( - self, service_name, partition_name=..., allow_non_regional=... - ): + def get_available_regions(self, service_name, partition_name=..., allow_non_regional=...): """Lists the region and endpoint names of a particular partition. :type service_name: string diff --git a/typings/botocore/signers.pyi b/typings/botocore/signers.pyi index 5e3b30912..65f12dbff 100644 --- a/typings/botocore/signers.pyi +++ b/typings/botocore/signers.pyi @@ -90,9 +90,7 @@ class RequestSigner(object): """ ... - def get_auth_instance( - self, signing_name, region_name, signature_version=..., **kwargs - ): + def get_auth_instance(self, signing_name, region_name, signature_version=..., **kwargs): """ Get an auth instance which can be used to sign a request using the given signature version. @@ -199,9 +197,7 @@ class CloudFrontSigner(object): """ ... - def build_policy( - self, resource, date_less_than, date_greater_than=..., ip_address=... - ): + def build_policy(self, resource, date_less_than, date_greater_than=..., ip_address=...): """A helper to build policy. :type resource: str @@ -289,9 +285,7 @@ class S3PostPresigner(object): ... def add_generate_presigned_url(class_attributes, **kwargs): ... -def generate_presigned_url( - self, ClientMethod, Params=..., ExpiresIn=..., HttpMethod=... -): +def generate_presigned_url(self, ClientMethod, Params=..., ExpiresIn=..., HttpMethod=...): """Generate a presigned url given a client, its method, and arguments :type ClientMethod: string @@ -314,9 +308,7 @@ def generate_presigned_url( ... def add_generate_presigned_post(class_attributes, **kwargs): ... -def generate_presigned_post( - self, Bucket, Key, Fields=..., Conditions=..., ExpiresIn=... -): +def generate_presigned_post(self, Bucket, Key, Fields=..., Conditions=..., ExpiresIn=...): """Builds the url and the form fields used for a presigned s3 post :type Bucket: string diff --git a/typings/botocore/translate.pyi b/typings/botocore/translate.pyi index eab388da5..e29d44509 100644 --- a/typings/botocore/translate.pyi +++ b/typings/botocore/translate.pyi @@ -2,9 +2,7 @@ This type stub file was generated by pyright. """ -def build_retry_config( - endpoint_prefix, retry_model, definitions, client_retry_config=... -): ... +def build_retry_config(endpoint_prefix, retry_model, definitions, client_retry_config=...): ... def resolve_references(config, definitions): """Recursively replace $ref keys. diff --git a/typings/botocore/utils.pyi b/typings/botocore/utils.pyi index ca334b7a5..f41771a99 100644 --- a/typings/botocore/utils.pyi +++ b/typings/botocore/utils.pyi @@ -405,9 +405,7 @@ def check_dns_name(bucket_name): """ ... -def fix_s3_host( - request, signature_version, region_name, default_endpoint_url=..., **kwargs -): +def fix_s3_host(request, signature_version, region_name, default_endpoint_url=..., **kwargs): """ This handler looks at S3 requests just before they are signed. If there is a bucket name on the path (true for everything except @@ -419,9 +417,7 @@ def fix_s3_host( """ ... -def switch_to_virtual_host_style( - request, signature_version, default_endpoint_url=..., **kwargs -): +def switch_to_virtual_host_style(request, signature_version, default_endpoint_url=..., **kwargs): """ This is a handler to force virtual host style s3 addressing no matter the signature version (which is taken in consideration for the default diff --git a/typings/botocore/vendored/six.pyi b/typings/botocore/vendored/six.pyi index d6edc13ed..448890af8 100644 --- a/typings/botocore/vendored/six.pyi +++ b/typings/botocore/vendored/six.pyi @@ -85,18 +85,14 @@ class _MovedItems(_LazyModule): _moved_attributes = [ MovedAttribute("cStringIO", "cStringIO", "io", "StringIO"), MovedAttribute("filter", "itertools", "builtins", "ifilter", "filter"), - MovedAttribute( - "filterfalse", "itertools", "itertools", "ifilterfalse", "filterfalse" - ), + MovedAttribute("filterfalse", "itertools", "itertools", "ifilterfalse", "filterfalse"), MovedAttribute("input", "__builtin__", "builtins", "raw_input", "input"), MovedAttribute("intern", "__builtin__", "sys"), MovedAttribute("map", "itertools", "builtins", "imap", "map"), MovedAttribute("getcwd", "os", "os", "getcwdu", "getcwd"), MovedAttribute("getcwdb", "os", "os", "getcwd", "getcwdb"), MovedAttribute("range", "__builtin__", "builtins", "xrange", "range"), - MovedAttribute( - "reload_module", "__builtin__", "importlib" if PY34 else "imp", "reload" - ), + MovedAttribute("reload_module", "__builtin__", "importlib" if PY34 else "imp", "reload"), MovedAttribute("reduce", "__builtin__", "functools"), MovedAttribute("shlex_quote", "pipes", "shlex", "quote"), MovedAttribute("StringIO", "StringIO", "io"), @@ -105,9 +101,7 @@ _moved_attributes = [ MovedAttribute("UserString", "UserString", "collections"), MovedAttribute("xrange", "__builtin__", "builtins", "xrange", "range"), MovedAttribute("zip", "itertools", "builtins", "izip", "zip"), - MovedAttribute( - "zip_longest", "itertools", "itertools", "izip_longest", "zip_longest" - ), + MovedAttribute("zip_longest", "itertools", "itertools", "izip_longest", "zip_longest"), MovedModule("builtins", "__builtin__"), MovedModule("configparser", "ConfigParser"), MovedModule("copyreg", "copy_reg"), @@ -119,9 +113,7 @@ _moved_attributes = [ MovedModule("html_parser", "HTMLParser", "html.parser"), MovedModule("http_client", "httplib", "http.client"), MovedModule("email_mime_multipart", "email.MIMEMultipart", "email.mime.multipart"), - MovedModule( - "email_mime_nonmultipart", "email.MIMENonMultipart", "email.mime.nonmultipart" - ), + MovedModule("email_mime_nonmultipart", "email.MIMENonMultipart", "email.mime.nonmultipart"), MovedModule("email_mime_text", "email.MIMEText", "email.mime.text"), MovedModule("email_mime_base", "email.MIMEBase", "email.mime.base"), MovedModule("BaseHTTPServer", "BaseHTTPServer", "http.server"), diff --git a/typings/docker/__init__.pyi b/typings/docker/__init__.pyi index 3cbfdd399..6e00a7009 100644 --- a/typings/docker/__init__.pyi +++ b/typings/docker/__init__.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.api import APIClient diff --git a/typings/docker/api/__init__.pyi b/typings/docker/api/__init__.pyi index d92182f0e..a247d02f2 100644 --- a/typings/docker/api/__init__.pyi +++ b/typings/docker/api/__init__.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.api.client import APIClient diff --git a/typings/docker/api/build.pyi b/typings/docker/api/build.pyi index ef391cf6c..2afdee0d8 100644 --- a/typings/docker/api/build.pyi +++ b/typings/docker/api/build.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker import utils diff --git a/typings/docker/api/client.pyi b/typings/docker/api/client.pyi index 64843193b..adffdf13e 100644 --- a/typings/docker/api/client.pyi +++ b/typings/docker/api/client.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations import requests diff --git a/typings/docker/api/config.pyi b/typings/docker/api/config.pyi index 3855bbe0e..f9ddbe6dc 100644 --- a/typings/docker/api/config.pyi +++ b/typings/docker/api/config.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker import utils diff --git a/typings/docker/api/container.pyi b/typings/docker/api/container.pyi index b026e5313..67ad56d85 100644 --- a/typings/docker/api/container.pyi +++ b/typings/docker/api/container.pyi @@ -1,15 +1,12 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker import utils class ContainerApiMixin: @utils.check_resource("container") - def attach( - self, container, stdout=..., stderr=..., stream=..., logs=..., demux=... - ): ... + def attach(self, container, stdout=..., stderr=..., stream=..., logs=..., demux=...): ... @utils.check_resource("container") def attach_socket(self, container, params=..., ws=...): ... @utils.check_resource("container") diff --git a/typings/docker/api/daemon.pyi b/typings/docker/api/daemon.pyi index 063fb71f5..519e55434 100644 --- a/typings/docker/api/daemon.pyi +++ b/typings/docker/api/daemon.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker import utils diff --git a/typings/docker/api/exec_api.pyi b/typings/docker/api/exec_api.pyi index f81bae60a..cbbbc2575 100644 --- a/typings/docker/api/exec_api.pyi +++ b/typings/docker/api/exec_api.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker import utils @@ -24,6 +23,4 @@ class ExecApiMixin: def exec_inspect(self, exec_id): ... def exec_resize(self, exec_id, height=..., width=...): ... @utils.check_resource("exec_id") - def exec_start( - self, exec_id, detach=..., tty=..., stream=..., socket=..., demux=... - ): ... + def exec_start(self, exec_id, detach=..., tty=..., stream=..., socket=..., demux=...): ... diff --git a/typings/docker/api/image.pyi b/typings/docker/api/image.pyi index 1d91eb761..57c6329fc 100644 --- a/typings/docker/api/image.pyi +++ b/typings/docker/api/image.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations import logging @@ -26,12 +25,8 @@ class ImageApiMixin: self, src=..., repository=..., tag=..., image=..., changes=..., stream_src=... ): ... def import_image_from_data(self, data, repository=..., tag=..., changes=...): ... - def import_image_from_file( - self, filename, repository=..., tag=..., changes=... - ): ... - def import_image_from_stream( - self, stream, repository=..., tag=..., changes=... - ): ... + def import_image_from_file(self, filename, repository=..., tag=..., changes=...): ... + def import_image_from_stream(self, stream, repository=..., tag=..., changes=...): ... def import_image_from_url(self, url, repository=..., tag=..., changes=...): ... def import_image_from_image(self, image, repository=..., tag=..., changes=...): ... @utils.check_resource("image") @@ -41,13 +36,9 @@ class ImageApiMixin: def inspect_distribution( self, image: str, auth_config: Optional[Dict[str, Any]] = ... ) -> Dict[str, Any]: ... - def load_image( - self, data: bytes, quiet: bool = ... - ) -> Iterator[Dict[str, Any]]: ... + def load_image(self, data: bytes, quiet: bool = ...) -> Iterator[Dict[str, Any]]: ... @utils.minimum_version("1.25") - def prune_images( - self, filters: Optional[Dict[str, Any]] = ... - ) -> Dict[str, Any]: ... + def prune_images(self, filters: Optional[Dict[str, Any]] = ...) -> Dict[str, Any]: ... def pull( self, repository: Optional[str], diff --git a/typings/docker/api/network.pyi b/typings/docker/api/network.pyi index c03b90bd6..68f058aef 100644 --- a/typings/docker/api/network.pyi +++ b/typings/docker/api/network.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.utils import check_resource, minimum_version diff --git a/typings/docker/api/plugin.pyi b/typings/docker/api/plugin.pyi index 520bb7cfc..3d01fc2dc 100644 --- a/typings/docker/api/plugin.pyi +++ b/typings/docker/api/plugin.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker import utils diff --git a/typings/docker/api/secret.pyi b/typings/docker/api/secret.pyi index 68b2f9dec..d281624a9 100644 --- a/typings/docker/api/secret.pyi +++ b/typings/docker/api/secret.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker import utils diff --git a/typings/docker/api/service.pyi b/typings/docker/api/service.pyi index 2187d00b7..0707a5b4b 100644 --- a/typings/docker/api/service.pyi +++ b/typings/docker/api/service.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker import utils diff --git a/typings/docker/api/swarm.pyi b/typings/docker/api/swarm.pyi index a4d4b7d54..46c939637 100644 --- a/typings/docker/api/swarm.pyi +++ b/typings/docker/api/swarm.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker import utils diff --git a/typings/docker/api/volume.pyi b/typings/docker/api/volume.pyi index a1bc8dd6f..2a5dc510b 100644 --- a/typings/docker/api/volume.pyi +++ b/typings/docker/api/volume.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker import utils diff --git a/typings/docker/auth.pyi b/typings/docker/auth.pyi index 9295443de..9e1482ece 100644 --- a/typings/docker/auth.pyi +++ b/typings/docker/auth.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations INDEX_NAME = ... diff --git a/typings/docker/client.pyi b/typings/docker/client.pyi index 2dc2b10e9..514c1223c 100644 --- a/typings/docker/client.pyi +++ b/typings/docker/client.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W from __future__ import annotations from typing import Any, Callable, Dict, Optional diff --git a/typings/docker/context/__init__.pyi b/typings/docker/context/__init__.pyi index ee928ab93..395a4de61 100644 --- a/typings/docker/context/__init__.pyi +++ b/typings/docker/context/__init__.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.context.api import ContextAPI diff --git a/typings/docker/context/api.pyi b/typings/docker/context/api.pyi index fbac2caa2..d06c35588 100644 --- a/typings/docker/context/api.pyi +++ b/typings/docker/context/api.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations class ContextAPI: diff --git a/typings/docker/context/config.pyi b/typings/docker/context/config.pyi index a76d9b0e6..989bfc0f2 100644 --- a/typings/docker/context/config.pyi +++ b/typings/docker/context/config.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations METAFILE = ... diff --git a/typings/docker/context/context.pyi b/typings/docker/context/context.pyi index 6cc742cd4..e93eb7f66 100644 --- a/typings/docker/context/context.pyi +++ b/typings/docker/context/context.pyi @@ -1,12 +1,9 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations class Context: - def __init__( - self, name, orchestrator=..., host=..., endpoints=..., tls=... - ) -> None: ... + def __init__(self, name, orchestrator=..., host=..., endpoints=..., tls=...) -> None: ... def set_endpoint( self, name=..., host=..., tls_cfg=..., skip_tls_verify=..., def_namespace=... ): ... diff --git a/typings/docker/credentials/__init__.pyi b/typings/docker/credentials/__init__.pyi index bbda7eb7d..cdff60906 100644 --- a/typings/docker/credentials/__init__.pyi +++ b/typings/docker/credentials/__init__.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.credentials.constants import * diff --git a/typings/docker/credentials/constants.pyi b/typings/docker/credentials/constants.pyi index d4cec0c3e..70fc204d1 100644 --- a/typings/docker/credentials/constants.pyi +++ b/typings/docker/credentials/constants.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations PROGRAM_PREFIX = ... diff --git a/typings/docker/credentials/errors.pyi b/typings/docker/credentials/errors.pyi index 46c7b9bbc..82b56aa7d 100644 --- a/typings/docker/credentials/errors.pyi +++ b/typings/docker/credentials/errors.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations class StoreError(RuntimeError): ... diff --git a/typings/docker/credentials/store.pyi b/typings/docker/credentials/store.pyi index 6db5ec8de..ecde83374 100644 --- a/typings/docker/credentials/store.pyi +++ b/typings/docker/credentials/store.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations class Store: diff --git a/typings/docker/credentials/utils.pyi b/typings/docker/credentials/utils.pyi index 8a2e80fe6..66ac821b7 100644 --- a/typings/docker/credentials/utils.pyi +++ b/typings/docker/credentials/utils.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations def find_executable(executable, path=...): ... diff --git a/typings/docker/errors.pyi b/typings/docker/errors.pyi index 9fc98295c..6aaa3f665 100644 --- a/typings/docker/errors.pyi +++ b/typings/docker/errors.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from typing import Optional diff --git a/typings/docker/models/__init__.pyi b/typings/docker/models/__init__.pyi index eb6b39d23..15de94a44 100644 --- a/typings/docker/models/__init__.pyi +++ b/typings/docker/models/__init__.pyi @@ -1,4 +1,3 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations diff --git a/typings/docker/models/configs.pyi b/typings/docker/models/configs.pyi index d4e9e86b5..6d1f3b1a3 100644 --- a/typings/docker/models/configs.pyi +++ b/typings/docker/models/configs.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.models.resource import Collection, Model diff --git a/typings/docker/models/containers.pyi b/typings/docker/models/containers.pyi index 3a3042182..9934f2365 100644 --- a/typings/docker/models/containers.pyi +++ b/typings/docker/models/containers.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations import datetime diff --git a/typings/docker/models/images.pyi b/typings/docker/models/images.pyi index ce1ce5c1f..eb301da89 100644 --- a/typings/docker/models/images.pyi +++ b/typings/docker/models/images.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from typing import Any, BinaryIO, Dict, Iterator, List, Optional, Tuple, Union, overload @@ -17,9 +16,7 @@ class Image(Model): @property def tags(self) -> List[str]: ... def history(self) -> str: ... - def save( - self, chunk_size: int = ..., named: Union[bool, str] = ... - ) -> Iterator[bytes]: ... + def save(self, chunk_size: int = ..., named: Union[bool, str] = ...) -> Iterator[bytes]: ... def tag( self, repository: Optional[str], @@ -70,9 +67,7 @@ class ImageCollection(Collection): use_config_proxy: bool = ..., ) -> Tuple[Image, Iterator[Dict[str, str]]]: ... def get(self, name: str) -> Image: ... - def get_registry_data( - self, name: str, auth_config: Dict[str, Any] = ... - ) -> RegistryData: ... + def get_registry_data(self, name: str, auth_config: Dict[str, Any] = ...) -> RegistryData: ... def list( self, name: Optional[str] = ..., @@ -138,12 +133,8 @@ class ImageCollection(Collection): decode: bool, stream: bool = ..., ) -> Union[Iterator[str], str]: ... - def remove( - self, *args: Any, force: bool = ..., image: str, noprune: bool = ... - ) -> Any: ... - def search( - self, *args: Any, limit: Optional[int] = ..., term: str - ) -> List[Dict[str, Any]]: ... + def remove(self, *args: Any, force: bool = ..., image: str, noprune: bool = ...) -> Any: ... + def search(self, *args: Any, limit: Optional[int] = ..., term: str) -> List[Dict[str, Any]]: ... def prune(self, filters: Optional[Dict[str, Any]] = ...) -> Dict[str, Any]: ... def prune_builds(self, *args: Any, **kwargs: Any) -> Dict[str, Any]: ... diff --git a/typings/docker/models/networks.pyi b/typings/docker/models/networks.pyi index e50cb4dc8..ae47587a2 100644 --- a/typings/docker/models/networks.pyi +++ b/typings/docker/models/networks.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.models.resource import Collection, Model diff --git a/typings/docker/models/nodes.pyi b/typings/docker/models/nodes.pyi index 42496d31b..6f1bcd7bc 100644 --- a/typings/docker/models/nodes.pyi +++ b/typings/docker/models/nodes.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.models.resource import Collection, Model diff --git a/typings/docker/models/plugins.pyi b/typings/docker/models/plugins.pyi index 67684b2c2..14d8f68e1 100644 --- a/typings/docker/models/plugins.pyi +++ b/typings/docker/models/plugins.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.models.resource import Collection, Model diff --git a/typings/docker/models/resource.pyi b/typings/docker/models/resource.pyi index 2f5c9138b..e7ebf79f4 100644 --- a/typings/docker/models/resource.pyi +++ b/typings/docker/models/resource.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from typing import Any, Dict, List, NoReturn, Optional, Type diff --git a/typings/docker/models/secrets.pyi b/typings/docker/models/secrets.pyi index 596ea4c9a..fcdac9cfd 100644 --- a/typings/docker/models/secrets.pyi +++ b/typings/docker/models/secrets.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.models.resource import Collection, Model diff --git a/typings/docker/models/services.pyi b/typings/docker/models/services.pyi index b5632c1e9..5ef0adeeb 100644 --- a/typings/docker/models/services.pyi +++ b/typings/docker/models/services.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.models.resource import Collection, Model diff --git a/typings/docker/models/swarm.pyi b/typings/docker/models/swarm.pyi index 8ba76a306..3fd681ce8 100644 --- a/typings/docker/models/swarm.pyi +++ b/typings/docker/models/swarm.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.models.resource import Model diff --git a/typings/docker/models/volumes.pyi b/typings/docker/models/volumes.pyi index dab510db7..9f0a40ee0 100644 --- a/typings/docker/models/volumes.pyi +++ b/typings/docker/models/volumes.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.models.resource import Collection, Model diff --git a/typings/docker/tls.pyi b/typings/docker/tls.pyi index 616c310fd..3739809f0 100644 --- a/typings/docker/tls.pyi +++ b/typings/docker/tls.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations class TLSConfig: diff --git a/typings/docker/transport/__init__.pyi b/typings/docker/transport/__init__.pyi index dcc905229..a97a8401b 100644 --- a/typings/docker/transport/__init__.pyi +++ b/typings/docker/transport/__init__.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.transport.ssladapter import SSLHTTPAdapter diff --git a/typings/docker/transport/basehttpadapter.pyi b/typings/docker/transport/basehttpadapter.pyi index adc87d0b0..8df9ac8aa 100644 --- a/typings/docker/transport/basehttpadapter.pyi +++ b/typings/docker/transport/basehttpadapter.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations import requests diff --git a/typings/docker/transport/npipeconn.pyi b/typings/docker/transport/npipeconn.pyi index 185766491..55d8bb929 100644 --- a/typings/docker/transport/npipeconn.pyi +++ b/typings/docker/transport/npipeconn.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations import http.client as httplib @@ -18,8 +17,6 @@ class NpipeHTTPConnectionPool(urllib3.connectionpool.HTTPConnectionPool): class NpipeHTTPAdapter(BaseHTTPAdapter): __attrs__ = ... - def __init__( - self, base_url, timeout=..., pool_connections=..., max_pool_size=... - ) -> None: ... + def __init__(self, base_url, timeout=..., pool_connections=..., max_pool_size=...) -> None: ... def get_connection(self, url, proxies=...): ... def request_url(self, request, proxies): ... diff --git a/typings/docker/transport/npipesocket.pyi b/typings/docker/transport/npipesocket.pyi index d82110f40..84ce94b02 100644 --- a/typings/docker/transport/npipesocket.pyi +++ b/typings/docker/transport/npipesocket.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations import io diff --git a/typings/docker/transport/sshconn.pyi b/typings/docker/transport/sshconn.pyi index 596d8277c..993d2487b 100644 --- a/typings/docker/transport/sshconn.pyi +++ b/typings/docker/transport/sshconn.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations import http.client as httplib diff --git a/typings/docker/transport/ssladapter.pyi b/typings/docker/transport/ssladapter.pyi index 76c4dad05..441f9f1db 100644 --- a/typings/docker/transport/ssladapter.pyi +++ b/typings/docker/transport/ssladapter.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations import sys diff --git a/typings/docker/transport/unixconn.pyi b/typings/docker/transport/unixconn.pyi index 837bb40b9..4eb81d1d6 100644 --- a/typings/docker/transport/unixconn.pyi +++ b/typings/docker/transport/unixconn.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations import http.client as httplib diff --git a/typings/docker/types/__init__.pyi b/typings/docker/types/__init__.pyi index 1dfa98021..9af6c6eff 100644 --- a/typings/docker/types/__init__.pyi +++ b/typings/docker/types/__init__.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.types.containers import ( diff --git a/typings/docker/types/base.pyi b/typings/docker/types/base.pyi index d7e6fc757..dc27de019 100644 --- a/typings/docker/types/base.pyi +++ b/typings/docker/types/base.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations class DictType(dict): diff --git a/typings/docker/types/containers.pyi b/typings/docker/types/containers.pyi index 9113f86ea..a68a4e78f 100644 --- a/typings/docker/types/containers.pyi +++ b/typings/docker/types/containers.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from .base import DictType diff --git a/typings/docker/types/daemon.pyi b/typings/docker/types/daemon.pyi index 7a5adea2a..c566cdb0f 100644 --- a/typings/docker/types/daemon.pyi +++ b/typings/docker/types/daemon.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations class CancellableStream: diff --git a/typings/docker/types/healthcheck.pyi b/typings/docker/types/healthcheck.pyi index 0e29c2019..8018f2cb5 100644 --- a/typings/docker/types/healthcheck.pyi +++ b/typings/docker/types/healthcheck.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.types.base import DictType diff --git a/typings/docker/types/networks.pyi b/typings/docker/types/networks.pyi index 26fa5b13f..727910590 100644 --- a/typings/docker/types/networks.pyi +++ b/typings/docker/types/networks.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations class EndpointConfig(dict): @@ -22,6 +21,4 @@ class IPAMConfig(dict): def __init__(self, driver=..., pool_configs=..., options=...) -> None: ... class IPAMPool(dict): - def __init__( - self, subnet=..., iprange=..., gateway=..., aux_addresses=... - ) -> None: ... + def __init__(self, subnet=..., iprange=..., gateway=..., aux_addresses=...) -> None: ... diff --git a/typings/docker/types/services.pyi b/typings/docker/types/services.pyi index c81717186..6fd90ff71 100644 --- a/typings/docker/types/services.pyi +++ b/typings/docker/types/services.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from typing import Any, Dict, List, Optional, Tuple, Union diff --git a/typings/docker/types/swarm.pyi b/typings/docker/types/swarm.pyi index 708472f31..422845de3 100644 --- a/typings/docker/types/swarm.pyi +++ b/typings/docker/types/swarm.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations class SwarmSpec(dict): diff --git a/typings/docker/utils/__init__.pyi b/typings/docker/utils/__init__.pyi index 2a1f785e4..b3f2702cd 100644 --- a/typings/docker/utils/__init__.pyi +++ b/typings/docker/utils/__init__.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from docker.utils.build import create_archive, exclude_paths, mkbuildcontext, tar diff --git a/typings/docker/utils/build.pyi b/typings/docker/utils/build.pyi index 4768f0ca8..538345774 100644 --- a/typings/docker/utils/build.pyi +++ b/typings/docker/utils/build.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations _SEP = ... diff --git a/typings/docker/utils/config.pyi b/typings/docker/utils/config.pyi index f0eeaf649..1d0861ab3 100644 --- a/typings/docker/utils/config.pyi +++ b/typings/docker/utils/config.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations DOCKER_CONFIG_FILENAME = ... diff --git a/typings/docker/utils/decorators.pyi b/typings/docker/utils/decorators.pyi index f7cc4d3c7..d08a82a77 100644 --- a/typings/docker/utils/decorators.pyi +++ b/typings/docker/utils/decorators.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations from typing import Callable, TypeVar diff --git a/typings/docker/utils/fnmatch.pyi b/typings/docker/utils/fnmatch.pyi index d62816661..f0be5f6ca 100644 --- a/typings/docker/utils/fnmatch.pyi +++ b/typings/docker/utils/fnmatch.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations _cache = ... diff --git a/typings/docker/utils/json_stream.pyi b/typings/docker/utils/json_stream.pyi index 5a848c187..ce02f34d7 100644 --- a/typings/docker/utils/json_stream.pyi +++ b/typings/docker/utils/json_stream.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations json_decoder = ... diff --git a/typings/docker/utils/proxy.pyi b/typings/docker/utils/proxy.pyi index 42afe9ec0..2bc6c4833 100644 --- a/typings/docker/utils/proxy.pyi +++ b/typings/docker/utils/proxy.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations class ProxyConfig(dict): diff --git a/typings/docker/utils/socket.pyi b/typings/docker/utils/socket.pyi index d39c96805..d324b5397 100644 --- a/typings/docker/utils/socket.pyi +++ b/typings/docker/utils/socket.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations STDOUT = ... diff --git a/typings/docker/utils/utils.pyi b/typings/docker/utils/utils.pyi index 434b7b9b2..4bdb0192d 100644 --- a/typings/docker/utils/utils.pyi +++ b/typings/docker/utils/utils.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations def create_ipam_pool(*args, **kwargs): ... diff --git a/typings/docker/version.pyi b/typings/docker/version.pyi index 3c105daa9..a0b476047 100644 --- a/typings/docker/version.pyi +++ b/typings/docker/version.pyi @@ -1,6 +1,5 @@ """This type stub file was generated by pyright.""" -# pylint: disable=C,E,W,R from __future__ import annotations version = ... diff --git a/typings/s3transfer/__init__.pyi b/typings/s3transfer/__init__.pyi index c44c8575b..992adef53 100644 --- a/typings/s3transfer/__init__.pyi +++ b/typings/s3transfer/__init__.pyi @@ -35,9 +35,7 @@ class ReadFileChunk: enable_callback=..., ) -> None: ... @classmethod - def from_filename( - cls, filename, start_byte, chunk_size, callback=..., enable_callback=... - ): ... + def from_filename(cls, filename, start_byte, chunk_size, callback=..., enable_callback=...): ... def read(self, amount=...): ... def enable_callback(self): ... def disable_callback(self): ... @@ -71,9 +69,7 @@ class ShutdownQueue(queue.Queue): class MultipartDownloader: def __init__(self, client, config, osutil, executor_cls=...) -> None: ... - def download_file( - self, bucket, key, filename, object_size, extra_args, callback=... - ): ... + def download_file(self, bucket, key, filename, object_size, extra_args, callback=...): ... class TransferConfig: def __init__( diff --git a/typings/s3transfer/bandwidth.pyi b/typings/s3transfer/bandwidth.pyi index f44ffab42..03d8f197b 100644 --- a/typings/s3transfer/bandwidth.pyi +++ b/typings/s3transfer/bandwidth.pyi @@ -11,9 +11,7 @@ class TimeUtils: class BandwidthLimiter: def __init__(self, leaky_bucket, time_utils=...) -> None: ... - def get_bandwith_limited_stream( - self, fileobj, transfer_coordinator, enabled=... - ): ... + def get_bandwith_limited_stream(self, fileobj, transfer_coordinator, enabled=...): ... class BandwidthLimitedStream: def __init__( diff --git a/typings/s3transfer/download.pyi b/typings/s3transfer/download.pyi index bf3465b6a..7bf41156d 100644 --- a/typings/s3transfer/download.pyi +++ b/typings/s3transfer/download.pyi @@ -35,9 +35,7 @@ class DownloadSeekableOutputManager(DownloadOutputManager): def get_final_io_task(self): ... class DownloadNonSeekableOutputManager(DownloadOutputManager): - def __init__( - self, osutil, transfer_coordinator, io_executor, defer_queue=... - ) -> None: ... + def __init__(self, osutil, transfer_coordinator, io_executor, defer_queue=...) -> None: ... @classmethod def is_compatible(cls, download_target, osutil): ... def get_download_task_tag(self): ... @@ -47,9 +45,7 @@ class DownloadNonSeekableOutputManager(DownloadOutputManager): def get_io_write_task(self, fileobj, data, offset): ... class DownloadSpecialFilenameOutputManager(DownloadNonSeekableOutputManager): - def __init__( - self, osutil, transfer_coordinator, io_executor, defer_queue=... - ) -> None: ... + def __init__(self, osutil, transfer_coordinator, io_executor, defer_queue=...) -> None: ... @classmethod def is_compatible(cls, download_target, osutil): ... def get_fileobj_for_io_writes(self, transfer_future): ... diff --git a/typings/s3transfer/futures.pyi b/typings/s3transfer/futures.pyi index 1f892433a..d6c2c2e9a 100644 --- a/typings/s3transfer/futures.pyi +++ b/typings/s3transfer/futures.pyi @@ -89,9 +89,7 @@ class TransferCoordinator: @property def status( self, - ) -> Literal[ - "not-started", "queued", "running", "cancelled", "failed", "success" - ]: ... + ) -> Literal["not-started", "queued", "running", "cancelled", "failed", "success"]: ... def set_result(self, result: Any) -> None: ... def set_exception(self, exception: Exception, override: bool = ...) -> None: ... def result(self) -> Any: ... @@ -148,9 +146,7 @@ class NonThreadedExecutor(BaseExecutor): class NonThreadedExecutorFuture: def __init__(self) -> None: ... def set_result(self, result: Any) -> None: ... - def set_exception_info( - self, exception: Exception, traceback: TracebackException - ) -> None: ... + def set_exception_info(self, exception: Exception, traceback: TracebackException) -> None: ... def result(self, timeout: Optional[int] = ...) -> Any: ... def done(self) -> bool: ... def add_done_callback(self, fn: Callable[..., Any]) -> None: ... diff --git a/typings/s3transfer/processpool.pyi b/typings/s3transfer/processpool.pyi index 917ae75c6..9a0f2d69f 100644 --- a/typings/s3transfer/processpool.pyi +++ b/typings/s3transfer/processpool.pyi @@ -45,9 +45,7 @@ class ProcessTransferConfig: class ProcessPoolDownloader: def __init__(self, client_kwargs=..., config=...) -> None: ... - def download_file( - self, bucket, key, filename, extra_args=..., expected_size=... - ): ... + def download_file(self, bucket, key, filename, extra_args=..., expected_size=...): ... def shutdown(self): ... def __enter__(self): ... def __exit__(self, exc_type, exc_value, *args): ... diff --git a/typings/s3transfer/utils.pyi b/typings/s3transfer/utils.pyi index b9f7a2e64..dbe287716 100644 --- a/typings/s3transfer/utils.pyi +++ b/typings/s3transfer/utils.pyi @@ -35,9 +35,7 @@ logger: Logger = ... S3_RETRYABLE_DOWNLOAD_ERRORS: Tuple[Type[Exception], ...] = ... def random_file_extension(num_digits: int = ...) -> str: ... -def signal_not_transferring( - request: Any, operation_name: str, **kwargs: Any -) -> None: ... +def signal_not_transferring(request: Any, operation_name: str, **kwargs: Any) -> None: ... def signal_transferring(request: Any, operation_name: str, **kwargs: Any) -> None: ... def calculate_num_parts(size: int, part_size: int) -> int: ... def calculate_range_parameter( @@ -49,9 +47,7 @@ def get_callbacks( def invoke_progress_callbacks( callbacks: List[Callable[..., Any]], bytes_transferred: int ) -> None: ... -def get_filtered_dict( - original_dict: Dict[_K, _V], whitelisted_keys: List[str] -) -> Dict[_K, _V]: ... +def get_filtered_dict(original_dict: Dict[_K, _V], whitelisted_keys: List[str]) -> Dict[_K, _V]: ... _CopySource = TypedDict("_CopySource", Bucket=str, Key=str) @@ -96,18 +92,14 @@ class OSUtils: ) -> ReadFileChunk: ... def open(self, filename: _AnyPath, mode: str) -> Any: ... def remove_file(self, filename: _AnyPath) -> None: ... - def rename_file( - self, current_filename: _AnyPath, new_filename: _AnyPath - ) -> None: ... + def rename_file(self, current_filename: _AnyPath, new_filename: _AnyPath) -> None: ... @classmethod def is_special_file(cls, filename: _AnyPath) -> bool: ... def get_temp_filename(self, filename: _AnyPath) -> str: ... def allocate(self, filename: _AnyPath, size: int) -> None: ... class DeferredOpenFile: - def __init__( - self, filename, start_byte=..., mode=..., open_function=... - ) -> None: ... + def __init__(self, filename, start_byte=..., mode=..., open_function=...) -> None: ... @property def name(self): ... def read(self, amount=...): ...