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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: prepare-assignment
-Version: 0.4.3
+Version: 0.4.5
 Summary: Prepare assignment
 Author-email: Bonajo <m.bonajo@fontys.nl>
 License: MIT

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

@@ -77,18 +77,18 @@ def __build_json_schema(props: TaskProperties, task: TaskDefinition) -> Dict[str
         },
         "required": ["uses"],
     }
-    if len(task.inputs) > 0:
-        properties: Dict[str, Any] = {}
-        required: List[str] = []
-        for inp in task.inputs:
-            properties[inp.name] = inp.to_schema_definition()
-            if inp.required:
-                required.append(inp.name)
-        with_schema: Dict[str, Any] = {"type": "object", "additionalProperties": False, "properties": properties}
-        if len(required) > 0:
-            with_schema["required"] = required
-            schema["required"].append("with")
-        schema["properties"]["with"] = with_schema
+    # A task without inputs still accepts an empty 'with'
+    properties: Dict[str, Any] = {}
+    required: List[str] = []
+    for inp in task.inputs:
+        properties[inp.name] = inp.to_schema_definition()
+        if inp.required:
+            required.append(inp.name)
+    with_schema: Dict[str, Any] = {"type": "object", "additionalProperties": False, "properties": properties}
+    if len(required) > 0:
+        with_schema["required"] = required
+        schema["required"].append("with")
+    schema["properties"]["with"] = with_schema
     return schema
 
 
@@ -273,8 +273,6 @@ def __prepare_tasks(tasks: List[Any], parsed: Optional[Dict[str, ValidableTask]]
         else:
             logger.debug(f"Task '{props}' has already been loaded in this run")
         if check_inputs and file is not None:
-            if task_def.get("with", None) is None:
-                task_def["with"] = {}
             validate_tasks(file, task_def, parsed[str(props)]["schema"])
     logger.debug("All (sub-)tasks prepared")
     return parsed

{prepare_assignment-0.4.3 → prepare_assignment-0.4.5}/prepare_assignment/core/task_handler.py

@@ -9,7 +9,7 @@ from treelib import Tree
 from prepare_assignment.core.preparer import __prepare_tasks
 from prepare_assignment.core.versions import get_git_url, is_fixed_version
 from prepare_assignment.data.task_definition import TaskDefinition
-from prepare_assignment.data.task_properties import TaskProperties
+from prepare_assignment.data.task_properties import TaskProperties, directory_to_version
 from prepare_assignment.utils.files import remove_tree
 from prepare_assignment.utils.dependency import get_dependencies
 from prepare_assignment.utils.paths import get_tasks_path
@@ -88,7 +88,7 @@ def ls() -> None:
             version_path = os.path.join(org_path, task)
             versions = sorted(os.listdir(version_path))
             for version in versions:
-                tree.create_node(version, parent=task)
+                tree.create_node(directory_to_version(version), parent=task)
     t = tree.show(stdout=False)
     print(t)
 

{prepare_assignment-0.4.3 → prepare_assignment-0.4.5}/prepare_assignment/data/task_properties.py

@@ -18,7 +18,14 @@ class TaskProperties:
 
     @cached_property
     def task_path(self) -> Path:
-        return Path(os.path.join(tasks_path, self.organization, self.name, self.version))
+        return Path(os.path.join(tasks_path, self.organization, self.name, self.version_directory))
+
+    @property
+    def version_directory(self) -> str:
+        """
+        The version as a single directory name, a branch can contain a slash (e.g. fix/something)
+        """
+        return version_to_directory(self.version)
 
     @cached_property
     def repo_path(self) -> Path:
@@ -38,19 +45,21 @@ class TaskProperties:
 
     @classmethod
     def of(cls, task: str) -> TaskProperties:
-        parts = task.split("/")
+        # Everything after the first '@' is the version, a branch can contain a slash
+        name, separator, version = task.partition("@")
+        if not separator:
+            version = "latest"
+        parts = name.split("/")
         if len(parts) > 2:
             raise ValueError("Tasks cannot have more than one slash")
         elif len(parts) == 1:
             parts.insert(0, "prepare-assignment")
-        organization: str = parts[0]
-        name = parts[1]
-        split = name.split("@")
-        version: str = "latest"
-        task_name: str = name
-        if len(split) > 2:
-            raise ValueError("Cannot have multiple '@' symbols in the name")
-        elif len(split) == 2:
-            task_name = split[0]
-            version = split[1]
-        return cls(organization, task_name, version)
+        return cls(parts[0], parts[1], version)
+
+
+def version_to_directory(version: str) -> str:
+    return version.replace("%", "%25").replace("/", "%2F")
+
+
+def directory_to_version(directory: str) -> str:
+    return directory.replace("%2F", "/").replace("%25", "%")

{prepare_assignment-0.4.3 → prepare_assignment-0.4.5}/prepare_assignment/utils/tasks.py

@@ -2,7 +2,7 @@ import os
 from typing import List
 
 from prepare_assignment.data.task_definition import TaskDefinition
-from prepare_assignment.data.task_properties import TaskProperties
+from prepare_assignment.data.task_properties import TaskProperties, directory_to_version
 from prepare_assignment.utils.paths import get_tasks_path
 from prepare_assignment.utils.yml_loader import YAML_LOADER
 
@@ -20,7 +20,7 @@ def get_all_tasks() -> List[TaskProperties]:
             version_path = os.path.join(org_path, task)
             versions = os.listdir(version_path)
             for version in versions:
-                tasks.append(TaskProperties.of(f"{org}/{task}@{version}"))
+                tasks.append(TaskProperties(org, task, directory_to_version(version)))
     return tasks
 
 

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

@@ -1,6 +1,6 @@
 [project]
 name = "prepare-assignment"
-version = "0.4.3"
+version = "0.4.5"
 description = "Prepare assignment"
 authors = [{name = "Bonajo", email = "m.bonajo@fontys.nl"}]
 license = {text = "MIT"}

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

@@ -8,7 +8,7 @@ import pytest
 from pytest_mock import MockerFixture
 
 from prepare_assignment.core.preparer import prepare_tasks, __task_install_dependencies
-from prepare_assignment.data.errors import DependencyError, PrepareTaskError
+from prepare_assignment.data.errors import DependencyError, PrepareTaskError, ValidationError
 from virtualenv import cli_run  # type: ignore
 
 from prepare_assignment.utils.files import remove_tree
@@ -317,3 +317,36 @@ def test_cached_composite_duplicate_id_is_rejected(mocker: MockerFixture) -> Non
     with pytest.raises(PrepareTaskError) as exc:
         prepare_tasks("prepare.yml", prepare)
     assert "multiple steps with id 'same'" in str(exc.value.cause)
+
+
+NO_INPUTS_TASK: Final[Dict[str, Any]] = {
+    'id': 'noinputs',
+    'name': 'No inputs',
+    'description': 'Task without inputs',
+    'runs': {'using': 'composite', 'tasks': [{'name': 'say', 'run': 'echo hello'}]}
+}
+
+
+@pytest.mark.parametrize("step", [
+    {'name': 'no with', 'uses': 'noinputs'},
+    {'name': 'empty with', 'uses': 'noinputs', 'with': {}},
+    {'name': 'null with', 'uses': 'noinputs', 'with': None},
+])
+def test_task_without_inputs(mocker: MockerFixture, step: Dict[str, Any]) -> None:
+    __clean_cache()
+    mocker.patch("prepare_assignment.core.preparer.__download_task",
+                 side_effect=lambda props: props.repo_path.mkdir(parents=True, exist_ok=True))
+    mocker.patch("prepare_assignment.core.preparer.validate_task_definition", return_value=NO_INPUTS_TASK)
+    mapping = prepare_tasks("prepare.yml", {'prepare': [step]})
+    assert list(mapping) == ["prepare-assignment/noinputs@latest"]
+
+
+def test_task_without_inputs_rejects_unknown_input(mocker: MockerFixture) -> None:
+    __clean_cache()
+    mocker.patch("prepare_assignment.core.preparer.__download_task",
+                 side_effect=lambda props: props.repo_path.mkdir(parents=True, exist_ok=True))
+    mocker.patch("prepare_assignment.core.preparer.validate_task_definition", return_value=NO_INPUTS_TASK)
+    step = {'name': 'typo', 'uses': 'noinputs', 'with': {'inptu': 'x'}}
+    with pytest.raises(ValidationError) as exc:
+        prepare_tasks("prepare.yml", {'prepare': [step]})
+    assert "'inptu' was unexpected" in exc.value.message

{prepare_assignment-0.4.3 → prepare_assignment-0.4.5}/tests/core/test_task_handler.py

@@ -93,3 +93,14 @@ def test_load_task_uses_task_path(tasks_dir: Path) -> None:
     props = TaskProperties.of("remove")
     _install_fake(props, "x")
     assert load_task(props).path == props.task_path
+
+
+def test_version_with_slash(tasks_dir: Path, mocker: MockerFixture, capsys: pytest.CaptureFixture) -> None:
+    from prepare_assignment.utils.tasks import get_all_tasks
+    mocker.patch("prepare_assignment.utils.tasks.get_tasks_path", return_value=tasks_dir)
+    mocker.patch("prepare_assignment.core.task_handler.tasks_path", tasks_dir)
+    props = TaskProperties.of("remove@fix/something")
+    _install_fake(props, "branch")
+    assert get_all_tasks() == [props]
+    task_handler.ls()
+    assert "fix/something" in capsys.readouterr().out

prepare_assignment-0.4.5/tests/data/test_task_properties.py

@@ -0,0 +1,45 @@
+import os
+
+import pytest
+
+from prepare_assignment.data.task_properties import TaskProperties, directory_to_version, version_to_directory
+
+
+@pytest.mark.parametrize("task, expected", [
+    ("remove", TaskProperties("prepare-assignment", "remove", "latest")),
+    ("remove@v1", TaskProperties("prepare-assignment", "remove", "v1")),
+    ("prepare-assignment/remove", TaskProperties("prepare-assignment", "remove", "latest")),
+    ("org/remove@v1.0.0", TaskProperties("org", "remove", "v1.0.0")),
+    ("prc2-assignment@fix/tasks-and-shell", TaskProperties("prepare-assignment", "prc2-assignment",
+                                                           "fix/tasks-and-shell")),
+    ("prepare-assignment/remove@fix/something", TaskProperties("prepare-assignment", "remove", "fix/something")),
+    ("remove@feat/a@b", TaskProperties("prepare-assignment", "remove", "feat/a@b")),
+])
+def test_of(task: str, expected: TaskProperties) -> None:
+    assert TaskProperties.of(task) == expected
+
+
+def test_of_more_than_one_slash_in_name() -> None:
+    with pytest.raises(ValueError):
+        TaskProperties.of("a/b/c@v1")
+
+
+def test_str_keeps_slash_in_version() -> None:
+    assert str(TaskProperties.of("remove@fix/something")) == "prepare-assignment/remove@fix/something"
+
+
+def test_task_path_is_single_directory_for_version() -> None:
+    props = TaskProperties.of("remove@fix/something")
+    assert props.task_path.name == "fix%2Fsomething"
+    assert props.task_path.parent.name == "remove"
+
+
+def test_task_path_unchanged_for_plain_version() -> None:
+    assert TaskProperties.of("remove@v1.0.0").task_path.name == "v1.0.0"
+
+
+@pytest.mark.parametrize("version", ["v1", "fix/something", "a/b/c", "100%", "%2F", "a%2F/b%25"])
+def test_version_directory_round_trip(version: str) -> None:
+    directory = version_to_directory(version)
+    assert os.sep not in directory
+    assert directory_to_version(directory) == version