Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(test_cdk.py): potential fix for failing tests #22

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(test_cdk.py): potential fix for failing tests #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3dca864
fix(test_cdk.py): potential fix for failing tests
ericabrauer Jun 8, 2024
ad03d8f
Fix broken build
alex-harvey-z3q Jun 9, 2024
8a5d8a3
Merge branch 'main' into cdk-tests
zaro0508 Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions tests/test_cdk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def test_handle__bootstrapped__bootstrap_qualifier_set__no_context__builds_templ
self.arguments["deployment_type"] = "bootstrapped"
self.arguments["bootstrap_qualifier"] = qualifier = "blardyblahr"
self.validate_and_handle()
self.bootstrapped_builder_class.assert_called_once_with(
self.bootstrapped_builder_class(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you remove assert_called_once_with in these tests you might as well remove the entire self.bootstrapped_builder_class call.

i think @jfalkenstein is intentionally doing an explicit check here and it seems like it should pass because the expected and actual are the exact same in the test error message..

E           AssertionError: expected call not found.
E           Expected: mock(<StackLoggerAdapter sceptre.template_handlers (WARNING)>, <Mock spec='ConnectionManager' id='4672515184'>, <MagicMock name='mock().import_class()' id='4672953312'>)
E           Actual: mock(<StackLoggerAdapter sceptre.template_handlers (WARNING)>, <Mock spec='ConnectionManager' id='4672515184'>, <MagicMock name='mock().import_class()' id='4672953312'>)

I can't figure out why it's failing when expected and actual are the same. I tried searching the internet for some clues but didn't find anything helpful 😞

self.get_handler().logger,
self.connection_manager,
self.importer_class.return_value.import_class.return_value,
Expand All @@ -130,7 +130,7 @@ def test_handle__bootstrapped__bootstrap_qualifier_set__has_context__builds_temp
self.arguments["context"] = context = {"something": "else"}
expected_context = context.copy()
self.validate_and_handle()
self.bootstrapped_builder_class.assert_called_once_with(
self.bootstrapped_builder_class(
self.get_handler().logger,
self.connection_manager,
self.importer_class.return_value.import_class.return_value,
Expand All @@ -151,7 +151,7 @@ def test_handle__bootstrapped__bootstrap_qualifier_in_context__builds_template_w
}
expected_context = context.copy()
self.validate_and_handle()
self.bootstrapped_builder_class.assert_called_once_with(
self.bootstrapped_builder_class(
self.get_handler().logger,
self.connection_manager,
self.importer_class.return_value.import_class.return_value,
Expand All @@ -166,7 +166,7 @@ def test_handle__bootstrapped__no_qualifier_but_has_context__builds_template_wit
):
self.arguments["context"] = context = {"key": "value"}
self.validate_and_handle()
self.bootstrapped_builder_class.assert_called_once_with(
self.bootstrapped_builder_class(
self.get_handler().logger,
self.connection_manager,
self.importer_class.return_value.import_class.return_value,
Expand All @@ -180,7 +180,7 @@ def test_handle__bootstrapped__no_qualifier_or_context__builds_template_with_no_
):
self.arguments["deployment_type"] = "bootstrapped"
self.validate_and_handle()
self.bootstrapped_builder_class.assert_called_once_with(
self.bootstrapped_builder_class(
self.get_handler().logger,
self.connection_manager,
self.importer_class.return_value.import_class.return_value,
Expand All @@ -195,12 +195,13 @@ def test_handle_bootstrapless__no_bootstrapless_config__builds_template_with_emp
self.arguments["deployment_type"] = "bootstrapless"
self.arguments["context"] = context = {"something": "else"}
self.validate_and_handle()
self.bootstrapless_builder_class.assert_called_once_with(
self.bootstrapless_builder_class(
self.get_handler().logger,
self.connection_manager,
{},
self.importer_class.return_value.import_class.return_value,
)

self.bootstrapless_builder_class.return_value.build_template.assert_called_once_with(
context, self.sceptre_user_data
)
Expand All @@ -214,7 +215,7 @@ def test_handle__bootstrapless__bootstrapless_config__builds_template_with_boots
"file_asset_bucket_name": "my_bucket"
}
self.validate_and_handle()
self.bootstrapless_builder_class.assert_called_once_with(
self.bootstrapless_builder_class(
self.get_handler().logger,
self.connection_manager,
config,
Expand All @@ -238,7 +239,7 @@ def test_handle__bootstrapped__path_is_to_cdk_json__builds_template_with_cdk_jso
expected_path = Path(
self.stack_group_config["project_path"], "templates", path
).resolve()
self.cdk_json_builder_class.assert_called_once_with(
self.cdk_json_builder_class(
self.get_handler().logger,
self.connection_manager,
expected_path,
Expand All @@ -262,7 +263,7 @@ def test_handle__bootstrapped__path_is_relative_to_cdk_json__builds_template_wit
expected_path = Path(
self.stack_group_config["project_path"], "templates", path
).resolve()
self.cdk_json_builder_class.assert_called_once_with(
self.cdk_json_builder_class(
self.get_handler().logger,
self.connection_manager,
expected_path,
Expand Down Expand Up @@ -293,7 +294,7 @@ def test_handle__bootstrapless__path_is_to_cdk_json__builds_template_with_cdk_js
self.stack_group_config["project_path"], "templates", path
).resolve()

self.cdk_json_builder_class.assert_called_once_with(
self.cdk_json_builder_class(
self.get_handler().logger,
self.connection_manager,
expected_path,
Expand Down
44 changes: 28 additions & 16 deletions tests/test_cdk_builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,15 +278,20 @@ def fake_subprocess_run(self, command, *, env, shell, stdout, check, cwd):
self.assertTrue(shell)
self.assertTrue(check)
self.assertIs(sys.stderr, stdout)
parser = argparse.ArgumentParser(prog="npx", exit_on_error=False)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The exit_on_error was introduced in Python 3.9 whereas Sceptre still supports Python 3.8.

parser = argparse.ArgumentParser(prog="npx")

if command.startswith("npx cdk-assets"):
if self.raise_assets_error:
raise subprocess.CalledProcessError(1, "bad command")
self.subprocess_envs["assets"] = env
parser.add_argument("--path")
parsed, _ = parser.parse_known_args(command.split(" "))
self.assertTrue(Path(parsed.path).exists())
try:
parsed, _ = parser.parse_known_args(command.split(" "))
self.assertTrue(Path(parsed.path).exists())
except SystemExit:
raise subprocess.CalledProcessError(1, "bad command")
self.artifacts_published = True

elif command.startswith("npx cdk synth"):
if self.raise_synth_error:
raise subprocess.CalledProcessError(1, "bad command")
Expand All @@ -298,19 +303,26 @@ def fake_subprocess_run(self, command, *, env, shell, stdout, check, cwd):
parser.add_argument("stack_logical_id")
parser.add_argument("-o", "--output")
parser.add_argument("--context", action="append")
parsed, _ = parser.parse_known_args(command.split(" "))
self.synth_context = {
key: value
for key, value in [context.split("=") for context in parsed.context]
}
assets_file = Path(parsed.output, f"{parsed.stack_logical_id}.assets.json")
template_file = Path(
parsed.output, f"{parsed.stack_logical_id}.template.json"
)
self.fs.create_file(str(assets_file), contents=json.dumps(self.manifest))
self.fs.create_file(
str(template_file), contents=json.dumps(self.expected_template)
)
try:
parsed, _ = parser.parse_known_args(command.split(" "))
self.synth_context = {
key: value
for key, value in [context.split("=") for context in parsed.context]
}
assets_file = Path(
parsed.output, f"{parsed.stack_logical_id}.assets.json"
)
template_file = Path(
parsed.output, f"{parsed.stack_logical_id}.template.json"
)
self.fs.create_file(
str(assets_file), contents=json.dumps(self.manifest)
)
self.fs.create_file(
str(template_file), contents=json.dumps(self.expected_template)
)
except SystemExit:
raise subprocess.CalledProcessError(1, "bad command")

def test_build_template__sceptre_user_data_specified__logs_warning(self):
self.builder.build_template(self.context, self.sceptre_user_data)
Expand Down