prepare-assignment 0.4.1__tar.gz → 0.4.3__tar.gz

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/.github/workflows/semantic-release.yml

@@ -38,11 +38,17 @@ jobs:
           node-version: 22
 
       # Pinned to an exact version: this action publishes no floating major
-      # tags, so @v6 would not resolve. All three plugins in .releaserc.json
-      # ship with the semantic-release core it bundles.
+      # tags, so @v6 would not resolve. The plugins in .releaserc.json ship
+      # with the semantic-release core it bundles, the conventionalcommits
+      # preset (which understands `feat!:`) has to be installed. Version 9:
+      # version 10 needs a newer changelog writer than the bundled
+      # release-notes-generator uses.
       - name: Semantic release
         id: semantic
         uses: cycjimmy/semantic-release-action@v6.0.0
+        with:
+          extra_plugins: |
+            conventional-changelog-conventionalcommits@9
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

prepare_assignment-0.4.3/.releaserc.json

@@ -0,0 +1,9 @@
+{
+  "branches": ["main"],
+  "tagFormat": "v${version}",
+  "plugins": [
+    ["@semantic-release/commit-analyzer", { "preset": "conventionalcommits" }],
+    ["@semantic-release/release-notes-generator", { "preset": "conventionalcommits" }],
+    "@semantic-release/github"
+  ]
+}

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: prepare-assignment
-Version: 0.4.1
+Version: 0.4.3
 Summary: Prepare assignment
 Author-email: Bonajo <m.bonajo@fontys.nl>
 License: MIT
@@ -11,7 +11,7 @@ Requires-Dist: gitpython>=3.1.59
 Requires-Dist: jsonschema>=4.21.1
 Requires-Dist: multipledispatch>=1.0.0
 Requires-Dist: packaging>=24.0
-Requires-Dist: prepare-toolbox==0.4.0
+Requires-Dist: prepare-toolbox>=1.0.1
 Requires-Dist: ruamel-yaml>=0.18.5
 Requires-Dist: simpleeval>=1.0.0
 Requires-Dist: treelib>=1.7.0
@@ -30,7 +30,7 @@ Prepare assignment is a GitHub Actions inspired helper tool to prepare assignmen
 
 ## Installation
 
-Prepare-assignment is available from [PyPI](https://pypi.org/).
+Prepare-assignment is available from [PyPI](https://pypi.org/project/prepare-assignment/).
 
 
 ```bash
@@ -47,13 +47,13 @@ To execute a `prepare.yml` simply run `prepare run` from the same directory.
 
 ### Command line interface
 
-Use `prepare --help` to which commands and flags are available.
+Use `prepare --help` to see which commands and flags are available.
 
 ## Example `prepare.yml`
 
 First we need to have tasks available that can be executed. Take for example a look at the [remove](https://github.com/prepare-assignment/remove) task.
 
-The tests use a [testproject](https://github.com/prepare-assignment/core/tree/tests/testproject), which contains an example of a `prepare.yml`, see below for convenience.
+The tests use a [testproject](https://github.com/prepare-assignment/core/tree/main/tests/testproject), which contains an example of a `prepare.yml`, see below for convenience.
 
 ```yaml
 name: Test project
@@ -200,9 +200,9 @@ Releases are automated with [semantic-release](https://semantic-release.gitbook.
 
 | PR title | Release |
 |----------|---------|
-| `fix: ...` | patch (1.2.3 → 1.2.4) |
+| `fix: ...`, `perf: ...` | patch (1.2.3 → 1.2.4) |
 | `feat: ...` | minor (1.2.3 → 1.3.0) |
-| `feat!: ...` or a `BREAKING CHANGE:` footer | major (1.2.3 → 2.0.0) |
-| `docs:`, `chore:`, `ci:`, `build:`, `refactor:`, `test:`, `style:`, `perf:` | no release |
+| `!` after the type (e.g. `feat!: ...`, `refactor!: ...`) or a `BREAKING CHANGE:` footer | major (1.2.3 → 2.0.0) |
+| `docs:`, `chore:`, `ci:`, `build:`, `refactor:`, `test:`, `style:`, `revert:` | no release |
 
 On every merge to `main` the next version is determined, tagged (`vX.Y.Z`), a GitHub release is created and the package is published to PyPI. The version is set during the build and is not committed, so the version in `pyproject.toml` is not the released version.

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/README.md

@@ -9,7 +9,7 @@ Prepare assignment is a GitHub Actions inspired helper tool to prepare assignmen
 
 ## Installation
 
-Prepare-assignment is available from [PyPI](https://pypi.org/).
+Prepare-assignment is available from [PyPI](https://pypi.org/project/prepare-assignment/).
 
 
 ```bash
@@ -26,13 +26,13 @@ To execute a `prepare.yml` simply run `prepare run` from the same directory.
 
 ### Command line interface
 
-Use `prepare --help` to which commands and flags are available.
+Use `prepare --help` to see which commands and flags are available.
 
 ## Example `prepare.yml`
 
 First we need to have tasks available that can be executed. Take for example a look at the [remove](https://github.com/prepare-assignment/remove) task.
 
-The tests use a [testproject](https://github.com/prepare-assignment/core/tree/tests/testproject), which contains an example of a `prepare.yml`, see below for convenience.
+The tests use a [testproject](https://github.com/prepare-assignment/core/tree/main/tests/testproject), which contains an example of a `prepare.yml`, see below for convenience.
 
 ```yaml
 name: Test project
@@ -179,9 +179,9 @@ Releases are automated with [semantic-release](https://semantic-release.gitbook.
 
 | PR title | Release |
 |----------|---------|
-| `fix: ...` | patch (1.2.3 → 1.2.4) |
+| `fix: ...`, `perf: ...` | patch (1.2.3 → 1.2.4) |
 | `feat: ...` | minor (1.2.3 → 1.3.0) |
-| `feat!: ...` or a `BREAKING CHANGE:` footer | major (1.2.3 → 2.0.0) |
-| `docs:`, `chore:`, `ci:`, `build:`, `refactor:`, `test:`, `style:`, `perf:` | no release |
+| `!` after the type (e.g. `feat!: ...`, `refactor!: ...`) or a `BREAKING CHANGE:` footer | major (1.2.3 → 2.0.0) |
+| `docs:`, `chore:`, `ci:`, `build:`, `refactor:`, `test:`, `style:`, `revert:` | no release |
 
 On every merge to `main` the next version is determined, tagged (`vX.Y.Z`), a GitHub release is created and the package is published to PyPI. The version is set during the build and is not committed, so the version in `pyproject.toml` is not the released version.

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/prepare_assignment/core/preparer.py

@@ -12,7 +12,7 @@ from virtualenv import cli_run
 
 from prepare_assignment.core.versions import COMMIT_HASH_RE, get_git_url, resolve_version
 from prepare_assignment.core.validator import validate_task_definition, validate_tasks, load_yaml, \
-    validate_default_values
+    validate_default_values, validate_unique_ids
 from prepare_assignment.data.errors import DependencyError, ValidationError, PrepareTaskError
 from prepare_assignment.data.task_definition import TaskDefinition, CompositeTaskDefinition, \
     PythonTaskDefinition, ValidableTask
@@ -154,10 +154,19 @@ def __sub_tasks(task: TaskDefinition) -> List[Any]:
     return [step for step in task.tasks if step.get("uses", None) is not None]
 
 
+def __validate_sub_task_ids(props: TaskProperties, task: TaskDefinition) -> None:
+    if isinstance(task, CompositeTaskDefinition):
+        validate_unique_ids(str(props.definition_path), f"task '{task.name}'", task.tasks)
+
+
 def __load_task_from_disk(props: TaskProperties, parsed: Dict[str, ValidableTask]) -> None:
     logger.debug(f"Task '{props}' is already available, loading from disk")
     task_yaml = load_yaml(props.definition_path)
     task = TaskDefinition.of(task_yaml, props.task_path)
+    try:
+        __validate_sub_task_ids(props, task)
+    except ValidationError as e:
+        raise PrepareTaskError(f"Unable to prepare task '{props}'", e) from e
     # Always rebuild the schema, so schemas generated by older versions of prepare are updated
     json_schema = __build_json_schema(props, task)
     with open(__schema_path(props), "r", encoding="utf-8") as handle:
@@ -181,6 +190,7 @@ def __prepare_task(props: TaskProperties) -> ValidableTask:
         task_yaml = validate_task_definition(props.definition_path)
         task: TaskDefinition = TaskDefinition.of(task_yaml, props.task_path)
         validate_default_values(task)
+        __validate_sub_task_ids(props, task)
         if isinstance(task, PythonTaskDefinition):
             main_path = os.path.join(props.repo_path, Path(task.main))  # type: ignore
             if not Path(main_path).resolve().is_relative_to(props.repo_path.resolve()):

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/prepare_assignment/core/validator.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import logging
 import os
 from pathlib import Path
-from typing import Dict, Any
+from typing import Dict, Any, List
 
 from jsonschema.exceptions import ValidationError
 from jsonschema.validators import validate
@@ -37,9 +37,32 @@ def validate_prepare(prepare_file: str, prepare: Dict[str, Any]) -> None:
     except ValidationError as ve:
         message = f"Error in: {prepare_file}, unable to verify '{ve.json_path}'\n\t -> {ve.message}"
         raise VE(message)
+    for job, steps in prepare["jobs"].items():
+        validate_unique_ids(prepare_file, f"job '{job}'", steps)
     logger.debug("✓ Prepare file is valid")
 
 
+def validate_unique_ids(file: str, where: str, steps: List[Dict[str, Any]]) -> None:
+    """
+    Validate that the ids of the steps are unique, the outputs of a step are stored under its id
+    NOTE: steps without an id are not checked
+    :param file: path/name of the file that contains the steps
+    :param where: the job or composite task that contains the steps, used in the error message
+    :param steps: the steps of the job or composite task
+    :return: None
+    :raises: ValidationError: if multiple steps have the same id
+    """
+    names: Dict[str, List[str]] = {}
+    for step in steps:
+        step_id = step.get("id", None)
+        if step_id is not None:
+            names.setdefault(step_id, []).append(step.get("name", ""))
+    for step_id, step_names in names.items():
+        if len(step_names) > 1:
+            quoted = ", ".join(f"'{name}'" for name in step_names)
+            raise VE(f"Error in: {file}, {where} has multiple steps with id '{step_id}': {quoted}")
+
+
 def validate_tasks(file: str, task: Dict[str, Any], json_schema: Any) -> None:
     """
     Validate all tasks based on their respective json schemas

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "prepare-assignment"
-version = "0.4.1"
+version = "0.4.3"
 description = "Prepare assignment"
 authors = [{name = "Bonajo", email = "m.bonajo@fontys.nl"}]
 license = {text = "MIT"}
@@ -10,7 +10,7 @@ dependencies = [
     "ruamel-yaml>=0.18.5",
     "jsonschema>=4.21.1",
     "gitpython>=3.1.59",
-    "prepare-toolbox==0.4.0",
+    "prepare-toolbox>=1.0.1",
     "virtualenv>=20.25.0",
     "typer==0.27.2",
     "treelib>=1.7.0",

prepare_assignment-0.4.3/tests/conftest.py

@@ -0,0 +1,25 @@
+import logging
+from typing import Iterator
+
+import pytest
+
+# Loggers that prepare() configures (level, handlers), see prepare_assignment/core/main.py
+_LOGGERS = ("prepare_assignment", "tasks")
+
+
+@pytest.fixture(autouse=True)
+def reset_loggers() -> Iterator[None]:
+    """
+    Restore the prepare loggers after every test. prepare() sets their level (e.g. ERROR for verbosity 0), which made
+    tests that check log output with caplog fail when they ran after a test that calls prepare().
+    """
+    saved = {}
+    for name in _LOGGERS:
+        logger = logging.getLogger(name)
+        saved[name] = (logger.level, list(logger.handlers), logger.propagate)
+    yield
+    for name, (level, handlers, propagate) in saved.items():
+        logger = logging.getLogger(name)
+        logger.setLevel(level)
+        logger.handlers[:] = handlers
+        logger.propagate = propagate

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/tests/core/test_command.py

@@ -178,3 +178,20 @@ def test_handle_set_output_wrong_item_type(caplog: pytest.LogCaptureFixture) ->
                                current_task_definition=definition, current_task=task)
     handle_set_output(fresh_env, ["", json.dumps({"l": ["a", 1]})])
     assert 'l' not in fresh_env.outputs['id']
+
+
+def test_toolbox_set_output_with_separator_contract(capsys: pytest.CaptureFixture) -> None:
+    """Values containing the separator (escaped by prepare-toolbox >= 1.0.1) must arrive unchanged."""
+    from pathlib import Path
+    from prepare_toolbox.core import set_output
+    from prepare_assignment.core import runner
+    set_output("files", ["a:PA:b.txt", Path("src") / "A.java"])
+    line = capsys.readouterr().out
+    output_definition = TaskOutputDefinition(description="files", type="array", items="string")
+    definition = PythonTaskDefinition(outputs={"files": output_definition}, description="t", inputs=[], id="t",
+                                      name="t", path="path", main="main.py")  # type: ignore
+    fresh_env = JobEnvironment(environment={}, outputs={"id": {}}, inputs={},
+                               current_task_definition=definition, current_task=task)
+    runner.__process_output_line(line, fresh_env)  # type: ignore[attr-defined]
+    assert fresh_env.task_errors == []
+    assert fresh_env.outputs["id"]["files"] == ["a:PA:b.txt", str(Path("src") / "A.java")]

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/tests/core/test_preparer.py

@@ -283,3 +283,37 @@ def test_outdated_schema_is_updated_on_load(mocker: MockerFixture) -> None:
     spy.assert_not_called()
     with open(schema_file) as handle:
         assert "if" in json.load(handle)["properties"]
+
+
+DUPLICATE_ID_COMPOSITE: Final[Dict[str, Any]] = {
+    'id': 'duplicate',
+    'name': 'duplicate',
+    'description': 'Composite task with a duplicate step id',
+    'runs': {
+        'using': 'composite',
+        'tasks': [{'name': 'first', 'id': 'same', 'run': 'echo 1'},
+                  {'name': 'second', 'id': 'same', 'run': 'echo 2'}]
+    }
+}
+
+
+def test_composite_duplicate_id_is_rejected(mocker: MockerFixture) -> None:
+    __clean_cache()
+    mocker.patch("prepare_assignment.core.preparer.__download_task")
+    mocker.patch("prepare_assignment.core.preparer.validate_task_definition", return_value=DUPLICATE_ID_COMPOSITE)
+    remove = mocker.patch("prepare_assignment.core.preparer.remove_tree")
+    prepare = {'prepare': [{'name': 'duplicate', 'uses': 'duplicate', 'with': {}}]}
+    with pytest.raises(PrepareTaskError) as exc:
+        prepare_tasks("prepare.yml", prepare)
+    assert "multiple steps with id 'same'" in str(exc.value.cause)
+    remove.assert_called()
+
+
+def test_cached_composite_duplicate_id_is_rejected(mocker: MockerFixture) -> None:
+    __clean_cache()
+    mocker.patch("prepare_assignment.core.preparer.__is_installed", return_value=True)
+    mocker.patch("prepare_assignment.core.preparer.load_yaml", return_value=DUPLICATE_ID_COMPOSITE)
+    prepare = {'prepare': [{'name': 'duplicate', 'uses': 'duplicate', 'with': {}}]}
+    with pytest.raises(PrepareTaskError) as exc:
+        prepare_tasks("prepare.yml", prepare)
+    assert "multiple steps with id 'same'" in str(exc.value.cause)

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/tests/core/test_validator.py

@@ -5,7 +5,8 @@ import pytest
 from pytest_mock import MockerFixture
 
 from prepare_assignment.core.validator import (validate_prepare, validate_tasks, load_yaml,
-                                               validate_task_definition, validate_default_values)
+                                               validate_task_definition, validate_default_values,
+                                               validate_unique_ids)
 from prepare_assignment.data.task_definition import PythonTaskDefinition
 from prepare_assignment.data.errors import ValidationError
 
@@ -179,3 +180,33 @@ def test_validate_default_values_bool_for_integer_invalid() -> None:
     task_copy["inputs"]["num"] = {'description': 'n', 'type': 'integer', 'default': True, 'required': False}
     with pytest.raises(ValidationError):
         validate_default_values(PythonTaskDefinition.of(task_copy, "test.yml"))
+
+
+def test_validate_unique_ids_valid() -> None:
+    steps = [{'name': 'a', 'id': 'a', 'run': 'echo'}, {'name': 'b', 'id': 'b', 'run': 'echo'},
+             {'name': 'no id', 'run': 'echo'}, {'name': 'no id', 'run': 'echo'}]
+    validate_unique_ids("prepare.yml", "job 'build'", steps)
+
+
+def test_validate_unique_ids_duplicate() -> None:
+    steps = [{'name': 'Remove old artefacts', 'id': 'remove', 'uses': 'remove'},
+             {'name': 'other', 'id': 'other', 'uses': 'remove'},
+             {'name': 'Remove old temp directory', 'id': 'remove', 'uses': 'remove'}]
+    with pytest.raises(ValidationError) as exc:
+        validate_unique_ids("prepare.yml", "job 'build'", steps)
+    assert exc.value.message == ("Error in: prepare.yml, job 'build' has multiple steps with id 'remove': "
+                                 "'Remove old artefacts', 'Remove old temp directory'")
+
+
+def test_validate_prepare_duplicate_id() -> None:
+    prepare = {'name': 'Duplicate', 'jobs': {'build': [{'name': 'a', 'id': 'same', 'run': 'echo'},
+                                                       {'name': 'b', 'id': 'same', 'run': 'echo'}]}}
+    with pytest.raises(ValidationError) as exc:
+        validate_prepare("prepare.yml", prepare)
+    assert "job 'build'" in exc.value.message
+
+
+def test_validate_prepare_same_id_in_different_jobs() -> None:
+    prepare = {'name': 'Different jobs', 'jobs': {'build': [{'name': 'a', 'id': 'same', 'run': 'echo'}],
+                                                  'test': [{'name': 'b', 'id': 'same', 'run': 'echo'}]}}
+    validate_prepare("prepare.yml", prepare)

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/tests/test_main.py

@@ -86,3 +86,13 @@ def test_multiple_prepare_files_message(monkeypatch: pytest.MonkeyPatch, tmp_pat
     with pytest.raises(AssertionError) as exc:
         prepare(None)
     assert "both a prepare.yml and a prepare.yaml" in str(exc.value)
+
+
+def test_prepare_file_in_directory_with_special_characters(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
+    """With prepare-toolbox < 0.4.4 the directory name was interpreted as part of the glob"""
+    from prepare_assignment.core.main import get_prepare_file
+    project = tmp_path / "[week 1] assignment"
+    project.mkdir()
+    (project / "prepare.yml").write_text("name: a\njobs: {}\n")
+    monkeypatch.chdir(project)
+    assert get_prepare_file(None) == "prepare.yml"

{prepare_assignment-0.4.1 → prepare_assignment-0.4.3}/uv.lock

@@ -582,7 +582,7 @@ requires-dist = [
     { name = "jsonschema", specifier = ">=4.21.1" },
     { name = "multipledispatch", specifier = ">=1.0.0" },
     { name = "packaging", specifier = ">=24.0" },
-    { name = "prepare-toolbox", specifier = "==0.4.0" },
+    { name = "prepare-toolbox", specifier = ">=1.0.1" },
     { name = "ruamel-yaml", specifier = ">=0.18.5" },
     { name = "simpleeval", specifier = ">=1.0.0" },
     { name = "treelib", specifier = ">=1.7.0" },
@@ -601,14 +601,14 @@ test = [
 
 [[package]]
 name = "prepare-toolbox"
-version = "0.4.0"
+version = "1.0.1"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "braceexpand" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/1d/c3/b6d5ad3819fa8f9149a3cbd3653dbcb9208103f91fec3a379d528602e7eb/prepare_toolbox-0.4.0.tar.gz", hash = "sha256:825f50b9bccefcaf091d0e29b7881c311ce7c9a2f510ec481951beffd29871b9", size = 4952, upload-time = "2023-11-01T19:10:30.85Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/80/67/85a18c89af943534c23ce825de8e6e17550481f8c90e02db1c3a2d8a865e/prepare_toolbox-1.0.1.tar.gz", hash = "sha256:c11f499018b181ae4bc548669de698ee50dfbd309d9080e9538920c046798959", size = 55292, upload-time = "2026-09-22T06:15:35.074Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/81/3d/9569c6585515e637f32e3ca691ce5df85a01903ca7aa0ce9e4f75580640e/prepare_toolbox-0.4.0-py3-none-any.whl", hash = "sha256:15f694af2883463ec83cb568885f85bca4a4225816d86846b296da69c027c5e8", size = 6836, upload-time = "2023-11-01T19:10:29.84Z" },
+    { url = "https://files.pythonhosted.org/packages/b4/35/dd4cacca4d58361b66394160f9ca0f4062c2b5e55c0a8aa1dc557d347a63/prepare_toolbox-1.0.1-py3-none-any.whl", hash = "sha256:41e10ac9fa61e0cfe53d5c04b69baf2b0ee8a607dda2c9825c6ce0293055fd57", size = 7443, upload-time = "2026-09-22T06:15:34.015Z" },
 ]
 
 [[package]]

prepare_assignment-0.4.1/.releaserc.json

@@ -1,9 +0,0 @@
-{
-  "branches": ["main"],
-  "tagFormat": "v${version}",
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/github"
-  ]
-}