fix: duplicate code-workspace declarations (#596)

* fix: issue causing duplicate code workspace files * chore: refresh tests; account for deprecation of beaker template; new tests * chore: windows edge cases * chore: remove test template --------- Co-authored-by: Neil Campbell <[email protected]>
algorandfoundation · Nov 28, 2024 · 505c6c6 · 505c6c6 · github-actions · Nov 28, 2024
1 parent 682efa7
commit 505c6c6
Show file tree

Hide file tree

Showing 15 changed files with 181 additions and 109 deletions.
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ AlgoKit helps you develop Algorand solutions:
 
 AlgoKit can help you deploy and operate Algorand solutions.
 
-AlgoKit comes with out-of-the-box [Continuous Integration / Continuous Deployment (CI/CD) templates](https://github.com/algorandfoundation/algokit-beaker-default-template) that help you rapidly set up best-practice software delivery processes that ensure you build quality in and have a solution that can evolve
+AlgoKit comes with out-of-the-box [Continuous Integration / Continuous Deployment (CI/CD) templates](https://github.com/algorandfoundation/algokit-python-template) that help you rapidly set up best-practice software delivery processes that ensure you build quality in and have a solution that can evolve
 
 ## What can AlgoKit help me do?
 
@@ -266,7 +266,7 @@ Per the above output, the doctor command output is a helpful tool if you need to
 
 This section addresses specific edge cases and issues that some users might encounter when interacting with the CLI. The following table provides solutions to known edge cases:
 
-| Issue Description                                                                                                                                   | OS(s) with observed behaviour                             | Steps to mitigate                                                                                                                                                                                                                                                                                                                      | References                                        |
-| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
-| This scenario may arise if installed `python` was build without `--with-ssl` flag enabled, causing pip to fail when trying to install dependencies. | Debian 12                                                 | Run `sudo apt-get install -y libssl-dev` to install the required openssl dependency. Afterwards, ensure to reinstall python with `--with-ssl` flag enabled. This includes options like [building python from source code](https://medium.com/@enahwe/how-to-06bc8a042345) or using tools like [pyenv](https://github.com/pyenv/pyenv). | https://github.com/actions/setup-python/issues/93 |
-| `poetry install` invoked directly or via `algokit project bootstrap all` fails on `Could NOT find PkgConfig (missing: PKG_CONFIG_EXECUTABLE)`.      | `MacOS` >=14 using `python` 3.13 installed via `homebrew` | Install dependencies deprecated in `3.13` and latest MacOS versions via `brew install pkg-config`, delete the virtual environment folder and retry the `poetry install` command invocation.                                                                                                                                            | N/A                                               |
+| Issue Description                                                                                                                                   | OS(s) with observed behaviour                             | Steps to mitigate                                                                                                                                                                                                                                                                                                                      | References                                          |
+| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
+| This scenario may arise if installed `python` was build without `--with-ssl` flag enabled, causing pip to fail when trying to install dependencies. | Debian 12                                                 | Run `sudo apt-get install -y libssl-dev` to install the required openssl dependency. Afterwards, ensure to reinstall python with `--with-ssl` flag enabled. This includes options like [building python from source code](https://medium.com/@enahwe/how-to-06bc8a042345) or using tools like [pyenv](https://github.com/pyenv/pyenv). | <https://github.com/actions/setup-python/issues/93> |
+| `poetry install` invoked directly or via `algokit project bootstrap all` fails on `Could NOT find PkgConfig (missing: PKG_CONFIG_EXECUTABLE)`.      | `MacOS` >=14 using `python` 3.13 installed via `homebrew` | Install dependencies deprecated in `3.13` and latest MacOS versions via `brew install pkg-config`, delete the virtual environment folder and retry the `poetry install` command invocation.                                                                                                                                            | N/A                                                 |
diff --git a/src/algokit/core/init.py b/src/algokit/core/init.py
@@ -89,20 +89,26 @@ def append_project_to_vscode_workspace(project_path: Path, workspace_path: Path)
 
     try:
         workspace = _load_vscode_workspace(workspace_path)
-        # Convert paths to POSIX format for consistent handling, and ensure relative paths are correctly interpreted
-        processed_project_path = project_path.relative_to(workspace_path.parent).as_posix()
-        # Normalize the new project path for comparison, ensuring it does not end with a slash unless it's the root
-        normalized_project_path = processed_project_path if processed_project_path != "." else "./"
-
-        # Normalize existing paths in the workspace for comparison
-        existing_paths = [
-            folder.get("path", "").rstrip("/").replace("\\", "/") for folder in workspace.get("folders", [])
-        ]
-        # Ensure the normalized new path is not already in the workspace
-        if normalized_project_path not in existing_paths:
-            workspace.setdefault("folders", []).append({"path": processed_project_path})
+
+        # Compute the project path relative to the workspace root
+        processed_project_path = project_path.relative_to(workspace_path.parent)
+        project_abs_path = (workspace_path.parent / processed_project_path).resolve(strict=False)
+
+        # Gather existing paths as absolute paths
+        existing_abs_paths = []
+        for folder in workspace.get("folders", []):
+            folder_path = Path(folder.get("path", "").replace("\\", "/"))
+            existing_abs_path = (workspace_path.parent / folder_path).resolve(strict=False)
+            existing_abs_paths.append(existing_abs_path)
+
+        # Check if the project path is already in the workspace
+        if project_abs_path not in existing_abs_paths:
+            workspace.setdefault("folders", []).append({"path": str(processed_project_path).replace("\\", "/")})
             _save_vscode_workspace(workspace_path, workspace)
-        logger.debug(f"Appended project {project_path} to workspace {workspace_path}.")
+            logger.debug(f"Appended project {project_path} to workspace {workspace_path}.")
+        else:
+            logger.debug(f"Project {project_path} is already in workspace {workspace_path}, not appending.")
+
     except json.JSONDecodeError as json_err:
         logger.warning(f"Invalid JSON format in the workspace file {workspace_path}. {json_err}")
     except Exception as e:

diff --git a/tests/init/test_init.py b/tests/init/test_init.py
@@ -8,6 +8,7 @@
 import click
 import pytest
 from _pytest.tmpdir import TempPathFactory
+from algokit.core.init import append_project_to_vscode_workspace
 from approvaltests.namer import NamerFactory
 from approvaltests.pytest.py_test_namer import PyTestNamer
 from approvaltests.scrubbers.scrubbers import Scrubber
@@ -88,9 +89,8 @@ class ExtendedTemplateKey(str, Enum):
     TEALSCRIPT = "tealscript"
     FULLSTACK = "fullstack"
     REACT = "react"
-    BEAKER = "beaker"
     PLAYGROUND = "playground"
-    BEAKER_WITH_VERSION = "beaker_with_version"
+    PYTHON_WITH_VERSION = "python_with_version"
     SIMPLE = "simple"
 
 
@@ -106,28 +106,24 @@ def _set_blessed_templates(mocker: MockerFixture) -> None:
 
     blessed_templates = {
         ExtendedTemplateKey.SIMPLE: BlessedTemplateSource(
-            url="gh:robdmoore/copier-helloworld",
+            url="gh:algorandfoundation/algokit-base-template",
             description="Does nothing helpful. simple",
         ),
-        ExtendedTemplateKey.BEAKER: BlessedTemplateSource(
-            url="gh:algorandfoundation/algokit-beaker-default-template",
-            description="Provides a good starting point to build Beaker smart contracts productively.",
-        ),
-        ExtendedTemplateKey.BEAKER_WITH_VERSION: BlessedTemplateSource(
-            url="gh:algorandfoundation/algokit-beaker-default-template",
-            commit="96fc7fd766fac607cdf5d69ee6e85ade04dddd47",
-            description="Provides a good starting point to build Beaker smart contracts productively, but pinned.",
+        ExtendedTemplateKey.PYTHON_WITH_VERSION: BlessedTemplateSource(
+            url="gh:algorandfoundation/algokit-python-template",
+            commit="f97be2c0e3975adfaeb16ef07a2b4bd6ce2afcff",
+            description="Provides a good starting point to build python smart contracts productively, but pinned.",
         ),
         ExtendedTemplateKey.FULLSTACK: BlessedTemplateSource(
-            url="gh:robdmoore/copier-helloworld",
+            url="gh:algorandfoundation/algokit-base-template",
             description="Does nothing helpful. fullstack",
         ),
         ExtendedTemplateKey.PYTHON: BlessedTemplateSource(
-            url="gh:robdmoore/copier-helloworld",
+            url="gh:algorandfoundation/algokit-python-template",
             description="Does nothing helpful. python",
         ),
         ExtendedTemplateKey.REACT: BlessedTemplateSource(
-            url="gh:robdmoore/copier-helloworld",
+            url="gh:algorandfoundation/algokit-base-template",
             description="Does nothing helpful. react",
         ),
         ExtendedTemplateKey.BASE: BlessedTemplateSource(
@@ -567,7 +563,7 @@ def test_init_template_url_and_ref(tmp_path_factory: TempPathFactory, mocker: Mo
     cwd = tmp_path_factory.mktemp("cwd")
     result = invoke(
         "init --name myapp --no-git --no-bootstrap "
-        "--template-url gh:algorandfoundation/algokit-beaker-default-template "
+        "--template-url gh:algorandfoundation/algokit-python-template "
         f"--template-url-ref {ref} "
         "--UNSAFE-SECURITY-accept-template-url --no-workspace",
         cwd=cwd,
@@ -585,7 +581,7 @@ def test_init_blessed_template_url_get_community_warning(
     mock_questionary_input.send_text("N")  # community warning
     result = invoke(
         "init --name myapp --no-git "
-        "--template-url gh:algorandfoundation/algokit-beaker-default-template --defaults "
+        "--template-url gh:algorandfoundation/algokit-python-template --defaults "
         "-a author_name None -a author_email None ",
         cwd=cwd,
     )
@@ -601,7 +597,7 @@ def test_init_with_any_template_url_get_community_warning(
     mock_questionary_input.send_text("Y")
     result = invoke(
         "init --name myapp --no-git --no-bootstrap "
-        "--template-url gh:algorandfoundation/algokit-beaker-default-template --defaults --no-workspace "
+        "--template-url gh:algorandfoundation/algokit-python-template --defaults --no-workspace "
         "-a author_name None -a author_email None ",
         cwd=cwd,
     )
@@ -625,7 +621,7 @@ def test_init_with_any_template_url_get_community_warning_with_unsafe_tag(tmp_pa
     cwd = tmp_path_factory.mktemp("cwd")
     result = invoke(
         "init --name myapp --no-git --no-bootstrap "
-        "--template-url gh:algorandfoundation/algokit-beaker-default-template --defaults --no-workspace "
+        "--template-url gh:algorandfoundation/algokit-python-template --defaults --no-workspace "
         "-a author_name None -a author_email None --UNSAFE-SECURITY-accept-template-url",
         cwd=cwd,
     )
@@ -679,7 +675,7 @@ def test_init_with_official_template_name(tmp_path_factory: TempPathFactory) ->
     cwd = tmp_path_factory.mktemp("cwd")
 
     result = invoke(
-        "init --name myapp --no-git --no-bootstrap --template beaker --defaults --no-workspace "
+        "init --name myapp --no-git --no-bootstrap --template python --defaults --no-workspace "
         "-a author_name None -a author_email None ",
         cwd=cwd,
     )
@@ -703,7 +699,7 @@ def test_init_with_official_template_name_and_hash(tmp_path_factory: TempPathFac
     cwd = tmp_path_factory.mktemp("cwd")
 
     result = invoke(
-        "init --name myapp --no-git --template beaker_with_version"
+        "init --name myapp --no-git --template python_with_version"
         " --defaults -a run_poetry_install False -a author_name None -a author_email None --no-workspace ",
         cwd=cwd,
     )
@@ -725,7 +721,7 @@ def test_init_with_custom_env(tmp_path_factory: TempPathFactory) -> None:
 
     result = invoke(
         (
-            "init --name myapp --no-git --no-bootstrap --template beaker --defaults --no-workspace "
+            "init --name myapp --no-git --no-bootstrap --template python --defaults --no-workspace "
             "-a author_name None -a author_email None "
             '-a algod_token "abcdefghijklmnopqrstuvwxyz" -a algod_server http://mylocalserver -a algod_port 1234 '
             '-a indexer_token "zyxwvutsrqponmlkjihgfedcba" -a indexer_server http://myotherserver -a indexer_port 6789 '
@@ -821,7 +817,7 @@ def test_init_template_with_python_task_works(dummy_algokit_template_with_python
         ],
         [
             MockQuestionaryAnswer("Custom Template", [MockPipeInput.UP, MockPipeInput.ENTER]),
-            "gh:robdmoore/copier-helloworld\n",  # custom template URL
+            "gh:algorandfoundation/algokit-base-template\n",  # custom template URL
         ],
     ],
 )
@@ -896,7 +892,7 @@ def test_init_wizard_v2_github_folder_with_workspace(
 
     # Act
     result = invoke(
-        "init -t beaker --no-git --defaults --name myapp "
+        "init -t python --no-git --defaults --name myapp "
         "--UNSAFE-SECURITY-accept-template-url -a preset_name 'production'",
         cwd=cwd,
     )
@@ -922,7 +918,7 @@ def test_init_wizard_v2_github_folder_with_workspace_partial(
 
     # Act
     result = invoke(
-        "init -t beaker --no-git --defaults --name myapp "
+        "init -t python --no-git --defaults --name myapp "
         "--UNSAFE-SECURITY-accept-template-url -a preset_name 'production'",
         input="y\n",
         cwd=cwd,
@@ -931,7 +927,7 @@ def test_init_wizard_v2_github_folder_with_workspace_partial(
     # Assert
     cwd /= "myapp"
     assert result.exit_code == 0
-    assert not (cwd / "projects/myapp/.github/workflows/production-beaker-cd.yaml").exists()
+    assert not (cwd / "projects/myapp/.github/workflows/cd.yaml").exists()
     assert (cwd / ".github/workflows/myapp-cd.yaml").read_text() != ""
     assert cwd.glob(".github/workflows/*.yaml")
 
@@ -947,7 +943,7 @@ def test_init_wizard_v2_github_folder_no_workspace(
 
     # Act
     result = invoke(
-        "init -t beaker --no-git --defaults --name myapp "
+        "init -t python --no-git --defaults --name myapp "
         "--UNSAFE-SECURITY-accept-template-url -a preset_name 'production' --no-workspace",
         cwd=cwd,
     )
@@ -1008,7 +1004,7 @@ def test_init_wizard_v2_append_to_vscode_workspace(
 
     # Act
     project_a_result = invoke(
-        "init -t beaker --no-git --defaults --name myapp "
+        "init -t python --no-git --defaults --name myapp "
         "--UNSAFE-SECURITY-accept-template-url -a preset_name 'production'",
         cwd=cwd,
     )
@@ -1017,7 +1013,7 @@ def test_init_wizard_v2_append_to_vscode_workspace(
         workspace_file.write_text(workspace_content)
 
     project_b_result = invoke(
-        "init -t beaker --no-git --defaults --name myapp2 "
+        "init -t python --no-git --defaults --name myapp2 "
         "--UNSAFE-SECURITY-accept-template-url -a preset_name 'starter'",
         cwd=cwd / "myapp",
     )
@@ -1031,3 +1027,94 @@ def test_init_wizard_v2_append_to_vscode_workspace(
     if expect_warning:
         # This assumes the existence of a function `verify` to check for warnings in the output
         verify(project_b_result.output)
+
+
+@pytest.mark.parametrize(
+    ("initial_workspace", "project_path", "expected_workspace", "should_append"),
+    [
+        # Test case 1: Different representations of root path
+        (
+            {"folders": [{"path": "./"}]},
+            ".",
+            {"folders": [{"path": "./"}]},
+            False,
+        ),
+        # Test case 2: Normalized paths
+        (
+            {"folders": [{"path": "projects/app1"}]},
+            "projects/app1",
+            {"folders": [{"path": "projects/app1"}]},
+            False,
+        ),
+        # Test case 3: Different path separators
+        (
+            {"folders": [{"path": "projects\\app1"}]},
+            "projects/app1",
+            {"folders": [{"path": "projects\\app1"}]},
+            False,
+        ),
+        # Test case 4: Relative paths
+        (
+            {"folders": [{"path": "./projects/app1"}]},
+            "projects/app1",
+            {"folders": [{"path": "./projects/app1"}]},
+            False,
+        ),
+        # Test case 5: New unique path
+        (
+            {"folders": [{"path": "projects/app1"}]},
+            "projects/app2",
+            {"folders": [{"path": "projects/app1"}, {"path": "projects/app2"}]},
+            True,
+        ),
+        # Test case 6: Empty workspace
+        (
+            {"folders": []},
+            "projects/app1",
+            {"folders": [{"path": "projects/app1"}]},
+            True,
+        ),
+        # Test case 7: Path with trailing slash
+        (
+            {"folders": [{"path": "projects/app1/"}]},
+            "projects/app1",
+            {"folders": [{"path": "projects/app1/"}]},
+            False,
+        ),
+    ],
+)
+def test_append_to_workspace_path_normalization(
+    *,
+    tmp_path_factory: pytest.TempPathFactory,
+    initial_workspace: dict,
+    project_path: str,
+    expected_workspace: dict,
+    should_append: bool,
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    """Test various path normalization scenarios when appending to workspace."""
+
+    # Arrange
+    tmp_path = tmp_path_factory.mktemp("workspace")
+    workspace_file = tmp_path / "test.code-workspace"
+    with workspace_file.open("w") as f:
+        json.dump(initial_workspace, f)
+
+    project_path_obj = tmp_path / project_path
+    project_path_obj.mkdir(parents=True, exist_ok=True)
+
+    # Act
+    append_project_to_vscode_workspace(project_path_obj, workspace_file)
+
+    # Assert
+    with workspace_file.open("r") as f:
+        actual_workspace = json.load(f)
+
+    assert actual_workspace == expected_workspace
+
+    # Check logging
+    debug_messages = [r.message for r in caplog.records if r.levelname == "DEBUG"]
+    if should_append:
+        assert any("Appended project" in msg for msg in debug_messages)
+    else:
+        assert any("already in workspace" in msg for msg in debug_messages)
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
__init__.py	47	3	94%	31–34
codespace.py	50	9	82%	28, 114, 137, 150–155
completions.py	108	9	92%	63–64, 83, 93–99
dispenser.py	121	1	99%	77
doctor.py	53	3	94%	146–148
explore.py	63	15	76%	35–40, 42–47, 85–92, 113
generate.py	70	3	96%	76–77, 155
goal.py	54	5	91%	85, 96, 107–109
init.py	310	24	92%	491–492, 497–498, 501, 522, 525–527, 538, 542, 600, 626, 655, 688, 697–699, 702–707, 720, 739, 751–752
localnet.py	164	32	80%	67, 88–115, 164–168, 212, 233, 248–258, 271, 322, 343–344
task.py	34	3	91%	25–28
src/algokit/cli/common
utils.py	37	2	95%	137, 139
src/algokit/cli/project
bootstrap.py	32	1	97%	33
deploy.py	117	20	83%	47, 49, 102, 125, 147–149, 270, 277, 291–299, 302–311
link.py	91	16	82%	61, 66–67, 102–106, 116–121, 149–150, 219–220, 224
list.py	33	5	85%	21–23, 51–56
run.py	46	2	96%	38, 174
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	106	15	86%	51, 73, 100–103, 108, 113, 131–132, 158, 335–339
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	114	46	60%	29–37, 43–46, 78–79, 103–104, 128–136, 155–165, 212, 261–262, 282–293, 300–302, 324
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
codespace.py	175	68	61%	34–37, 41–44, 48–71, 111–112, 125–133, 191, 200–202, 210, 216–217, 229–236, 251–298, 311–313, 338–344, 348, 395
conf.py	57	9	84%	12, 24, 28, 36, 38, 73–75, 80
dispenser.py	202	26	87%	92, 124–125, 142–150, 192–193, 199–201, 219–220, 260–261, 319, 333–335, 346–347, 357, 370, 385
doctor.py	65	7	89%	67–69, 92–94, 134
generate.py	50	3	94%	44, 85, 103
goal.py	65	4	94%	21, 36–37, 47
init.py	72	10	86%	53, 57–62, 70, 81, 88, 114–115
log_handlers.py	68	7	90%	50–51, 63, 112–116, 125
proc.py	45	1	98%	99
sandbox.py	276	23	92%	32, 89–92, 97, 101–103, 174, 222–229, 240, 611, 627, 652, 660
typed_client_generation.py	173	20	88%	65–67, 106–111, 135, 138–141, 159, 162–165, 232, 235–238
utils.py	150	40	73%	50–51, 57–69, 125–131, 155, 158, 164–177, 206–208, 237–240, 262
src/algokit/core/_vendor/auth0/authentication
token_verifier.py	157	111	29%	16, 45, 58, 73–85, 98–107, 119–124, 136–137, 140, 170, 178–180, 190–199, 206–213, 227–236, 258, 280–287, 314–323, 333–444
src/algokit/core/compilers
python.py	28	5	82%	19–20, 25, 49–50
src/algokit/core/config_commands
container_engine.py	41	21	49%	24, 29–31, 47–76
version_prompt.py	92	14	85%	37–38, 68, 87–90, 108, 118–125, 148
src/algokit/core/project
__init__.py	53	3	94%	50, 86, 145
bootstrap.py	120	8	93%	47, 126–127, 149, 176, 207–209
deploy.py	69	9	87%	108–111, 120–122, 126, 131
run.py	132	13	90%	83, 88, 97–98, 133–134, 138–139, 143, 147, 277–278, 293
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	74	9	88%	123–133
models.py	92	17	82%	50, 52, 57, 71–74, 81–90
TOTAL	4955	772	84%