fix: fix issue of goal command interacting with filename containing d…

…ot (#424) * fix: fixed issue with filename containing dot * fix: make the regex simpler
algorandfoundation · Feb 19, 2024 · 22ece81 · 22ece81 · github-actions · Feb 19, 2024
1 parent 40765e7
commit 22ece81
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 1 deletion.
diff --git a/src/algokit/core/goal.py b/src/algokit/core/goal.py
@@ -16,7 +16,7 @@ def get_volume_mount_path_local(directory_name: str) -> Path:
     return get_app_config_dir().joinpath(directory_name, "goal_mount")
 
 
-filename_pattern = re.compile(r"^[\w-]+\.\w+$")
+filename_pattern = re.compile(r"^[\w\-\.]+\.\w+$")
 
 
 def is_path_or_filename(argument: str) -> bool:

diff --git a/tests/goal/test_goal.py b/tests/goal/test_goal.py
@@ -523,3 +523,48 @@ def test_goal_simple_args_on_named_localnet(proc_mock: ProcMock, app_dir_mock: A
 
     assert result.exit_code == 0
     verify(_normalize_output(result.output.replace(str(app_dir_mock.app_config_dir), "{app_config}")))
+
+
+@pytest.mark.usefixtures(
+    "mocked_goal_mount_path",
+    "_setup_input_files",
+    "_setup_latest_dummy_compose",
+    "_mock_proc_with_running_localnet",
+    "_mock_proc_with_algod_running_state",
+)
+@pytest.mark.parametrize(
+    "_setup_input_files", [[{"name": "contract.approval.teal", "content": DUMMY_CONTRACT_TEAL}]], indirect=True
+)
+def test_goal_simple_args_with_input_output_files_with_dot_convention_name(
+    proc_mock: ProcMock,
+    cwd: Path,
+    app_dir_mock: AppDirs,
+) -> None:
+    expected_arguments = [
+        "docker",
+        "exec",
+        "--interactive",
+        "--workdir",
+        "/root",
+        "algokit_sandbox_algod",
+        "goal",
+        "clerk",
+        "compile",
+    ]
+
+    proc_mock.set_output(
+        expected_arguments, output=["File compiled"], side_effect=dump_file, side_effect_args={"cwd": cwd}
+    )
+
+    result = invoke("goal clerk compile contract.approval.teal -o approval.compiled", cwd=cwd)
+
+    # Check if the paths in command have changed in preprocess step
+    assert _normalize_output(proc_mock.called[3].command[9]) == "/root/goal_mount/contract.approval.teal"
+    assert _normalize_output(proc_mock.called[3].command[11]) == "/root/goal_mount/approval.compiled"
+
+    # Check for the result status
+    assert result.exit_code == 0
+
+    # Check if the output file is created and copied in cwd in postprocess step
+    assert (cwd / "approval.compiled").exists()
+    verify(_normalize_output(result.output.replace(str(app_dir_mock.app_config_dir), "{app_config}")))
diff --git a/..._goal.test_goal_simple_args_with_input_output_files_with_dot_convention_name.approved.txt b/..._goal.test_goal_simple_args_with_input_output_files_with_dot_convention_name.approved.txt
@@ -0,0 +1,9 @@
+DEBUG: Running 'docker version' in '{current_working_directory}'
+DEBUG: docker: STDOUT
+DEBUG: docker: STDERR
+DEBUG: Running 'docker compose ls --format json --filter name=algokit_sandbox*' in '{current_working_directory}'
+DEBUG: docker: []
+DEBUG: Running 'docker compose ps algod --format json' in '{app_config}/sandbox'
+DEBUG: docker: [{"Name": "algokit_sandbox_algod", "State": "running"}]
+DEBUG: Running 'docker exec --interactive --workdir /root algokit_sandbox_algod goal clerk compile /root/goal_mount/contract.approval.teal -o /root/goal_mount/approval.compiled' in '{current_working_directory}'
+ File compiled
File	Stmts	Miss	Cover	Missing
src/algokit
__init__.py	15	7	53%	6–13, 17–24, 32–34
__main__.py	4	4	0%	1–7
src/algokit/cli
completions.py	108	2	98%	83, 98
deploy.py	72	7	90%	44, 46, 92–94, 158, 182
dispenser.py	121	1	99%	77
doctor.py	48	3	94%	142–144
explore.py	50	12	76%	34–39, 41–46
generate.py	67	3	96%	74–75, 140
goal.py	44	1	98%	71
init.py	195	16	92%	284–285, 335, 338–340, 351, 395, 421, 461, 470–472, 475–480, 493
localnet.py	119	15	87%	74–78, 111, 123, 138–148, 161, 206, 227–228
task.py	34	3	91%	25–28
src/algokit/cli/common
utils.py	26	2	92%	120, 123
src/algokit/cli/tasks
analyze.py	81	1	99%	81
assets.py	82	13	84%	65–66, 72, 74–75, 105, 119, 125–126, 132, 134, 136–137
ipfs.py	51	8	84%	52, 80, 92, 94–95, 105–107
mint.py	66	4	94%	48, 70, 91, 250
send_transaction.py	65	10	85%	52–53, 57, 89, 158, 170–174
sign_transaction.py	59	8	86%	21, 28–30, 71–72, 109, 123
transfer.py	39	3	92%	26, 90, 117
utils.py	99	45	55%	26–34, 40–43, 75–76, 100–101, 125–133, 152–162, 209, 258–259, 279–290, 297–299
vanity_address.py	56	10	82%	41, 45–48, 112, 114, 121–123
wallet.py	79	4	95%	21, 66, 136, 162
src/algokit/core
bootstrap.py	117	10	91%	101–102, 124, 151, 180–185
conf.py	54	8	85%	12, 24, 28, 36, 38, 71–73
deploy.py	69	11	84%	61–64, 73–75, 79, 84, 91–93
dispenser.py	202	26	87%	91, 123–124, 141–149, 191–192, 198–200, 218–219, 259–260, 318, 332–334, 345–346, 356, 369, 384
doctor.py	65	7	89%	67–69, 92–94, 134
generate.py	48	3	94%	44, 81, 99
goal.py	60	3	95%	30–31, 41
log_handlers.py	68	7	90%	50–51, 63, 112–116, 125
proc.py	45	1	98%	98
sandbox.py	218	18	92%	62, 73–75, 96, 142–149, 160, 456, 472, 497, 505
typed_client_generation.py	80	5	94%	55–57, 70, 75
utils.py	104	31	70%	44–45, 49–68, 129, 132, 138–152
version_prompt.py	72	8	89%	26–27, 39, 58–61, 79, 108
src/algokit/core/tasks
analyze.py	93	3	97%	105–112, 187
ipfs.py	63	7	89%	58–64, 140, 144, 146, 152
nfd.py	49	13	73%	25, 31, 34–41, 70–72, 99–101
vanity_address.py	90	34	62%	49–50, 54, 59–75, 92–108, 128–131
wallet.py	71	5	93%	37, 129, 155–157
src/algokit/core/tasks/mint
mint.py	78	10	87%	123–133, 187
models.py	90	11	88%	50, 52, 57, 71–74, 85–88
TOTAL	3486	403	88%