cognite-toolkit 0.6.98__tar.gz → 0.6.99__tar.gz

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/.vscode/launch.json

@@ -35,6 +35,18 @@
       "console": "integratedTerminal",
       "justMyCode": false
     },
+    {
+      "name": "cdf auth init",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "./cdf-tk-dev.py",
+      "args": [
+        "auth",
+        "init"
+      ],
+      "console": "integratedTerminal",
+      "justMyCode": false
+    },
     {
       "name": "cdf run function local",
       "type": "debugpy",
@@ -188,6 +200,7 @@
         "clean",
         "--env", 
         "local",
+        "--verbose"
       ],
       "console": "integratedTerminal",
       "justMyCode": false
@@ -262,7 +275,7 @@
       "type": "debugpy",
       "request": "launch",
       "program": "./cdf-tk-dev.py",
-      "args": ["modules", "init"],
+      "args": ["modules", "init", "."],
       "console": "integratedTerminal",
       "justMyCode": false
     },

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite_toolkit
-Version: 0.6.98
+Version: 0.6.99
 Summary: Official Cognite Data Fusion tool for project templates and configuration deployment
 Project-URL: Homepage, https://docs.cognite.com/cdf/deploy/cdf_toolkit/
 Project-URL: Changelog, https://github.com/cognitedata/toolkit/releases

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/cdf.toml

@@ -32,7 +32,7 @@ dev = true
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.6.98"
+version = "0.6.99"
 
 
 [library.toolkit-data]

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/cognite_toolkit/_cdf_tk/apps/_core_app.py

@@ -345,7 +345,16 @@ class CoreApp(typer.Typer):
             list[str] | None,
             typer.Option(
                 "--include",
-                help=f"Specify which resource types to deploy, supported types: {AVAILABLE_DATA_TYPES}",
+                help=f"Specify which resource types to clean, supported types: {AVAILABLE_DATA_TYPES}",
+            ),
+        ] = None,
+        module: Annotated[
+            str | None,
+            typer.Option(
+                "--module",
+                "-m",
+                help="Specify name or path of the module to clean",
+                hidden=not Flags.v07.is_enabled(),
             ),
         ] = None,
         verbose: Annotated[
@@ -368,6 +377,8 @@ class CoreApp(typer.Typer):
                 build_env_name,
                 dry_run,
                 include,
+                module,
                 verbose,
+                all_modules=True if not Flags.v07.is_enabled() else False,
             )
         )

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/cognite_toolkit/_cdf_tk/commands/clean.py

@@ -2,6 +2,7 @@ import traceback
 from graphlib import TopologicalSorter
 from pathlib import Path
 
+import questionary
 from cognite.client.exceptions import CogniteAPIError, CogniteNotFoundError
 from cognite.client.utils.useful_types import SequenceNotStr
 from rich import print
@@ -40,8 +41,10 @@ from cognite_toolkit._cdf_tk.data_classes import (
 from cognite_toolkit._cdf_tk.data_classes._module_directories import ReadModule
 from cognite_toolkit._cdf_tk.exceptions import (
     ToolkitCleanResourceError,
+    ToolkitMissingModuleError,
     ToolkitNotADirectoryError,
     ToolkitValidationError,
+    ToolkitValueError,
 )
 from cognite_toolkit._cdf_tk.tk_warnings import (
     LowSeverityWarning,
@@ -185,6 +188,23 @@ class CleanCommand(ToolkitCommand):
                 self._verbose_print_drop(resource_drop_count, resource_ids, loader, dry_run)
         return nr_of_dropped
 
+    def _interactive_module_selection(self, built_modules: list[ReadModule] | None) -> list[ReadModule] | None:
+        if not built_modules:
+            return None
+        choices = [
+            questionary.Choice(title=built_module.dir.name, value=built_module) for built_module in built_modules
+        ]
+
+        selected_modules = questionary.checkbox(
+            "Which modules would you like to clean?",
+            instruction="Use arrow up/down, press space to select item(s) and enter to save",
+            choices=choices,
+        ).ask()
+
+        if not selected_modules:
+            return None
+        return selected_modules
+
     def _verbose_print_drop(
         self, drop_count: int, resource_ids: SequenceNotStr[T_ID], loader: ResourceContainerCRUD, dry_run: bool
     ) -> None:
@@ -204,6 +224,11 @@ class CleanCommand(ToolkitCommand):
             # Count is not supported
             print(f" {prefix} all {loader.item_name} from {loader.display_name}: {_print_ids_or_length(resource_ids)}.")
 
+    def _select_modules(self, clean_state: BuildEnvironment, module_str: str | None) -> list[ReadModule] | None:
+        if module_str:
+            return [module for module in clean_state.read_modules if module.dir.name == module_str]
+        return self._interactive_module_selection(clean_state.read_modules)
+
     def execute(
         self,
         env_vars: EnvironmentVariables,
@@ -211,7 +236,9 @@ class CleanCommand(ToolkitCommand):
         build_env_name: str | None,
         dry_run: bool,
         include: list[str] | None,
+        module_str: str | None,
         verbose: bool,
+        all_modules: bool = False,
     ) -> None:
         if not build_dir.exists():
             raise ToolkitNotADirectoryError(
@@ -245,9 +272,31 @@ class CleanCommand(ToolkitCommand):
         )
 
         if not build_dir.is_dir():
-            raise ToolkitNotADirectoryError(f"'{build_dir}'. Did you forget to run `cdf-tk build` first?")
+            raise ToolkitNotADirectoryError(f"'{build_dir}'. Did you forget to run `cdf build` first?")
+
+        selected_modules: list[ReadModule]
+        if all_modules:
+            selected_modules = clean_state.read_modules or []
+            if not selected_modules:
+                raise ToolkitValueError("No modules available to clean.")
+        elif module_str:
+            selected_modules = [module for module in clean_state.read_modules if module.dir.name == module_str]
+            if not selected_modules:
+                available_module_names = {module.dir.name for module in clean_state.read_modules}
+                raise ToolkitMissingModuleError(
+                    f"No modules matched the selection: {module_str}. Available modules: {sorted(available_module_names)}"
+                )
+        else:
+            selected_modules = self._interactive_module_selection(clean_state.read_modules) or []
+            if not selected_modules:
+                raise ToolkitValueError(
+                    "No module specified with the --module option and no modules selected interactively."
+                )
 
-        selected_loaders = self.get_selected_loaders(build_dir, clean_state.read_resource_folders, include)
+        selected_resource_folders = {
+            resource_folder for module in selected_modules for resource_folder in module.resource_directories
+        }
+        selected_loaders = self.get_selected_loaders(build_dir, selected_resource_folders, include)
 
         results = DeployResults([], "clean", dry_run=dry_run)
 
@@ -274,7 +323,7 @@ class CleanCommand(ToolkitCommand):
             result = self.clean_resources(
                 loader,
                 env_vars=env_vars,
-                read_modules=clean_state.read_modules,
+                read_modules=selected_modules,
                 drop=True,
                 dry_run=dry_run,
                 drop_data=True,

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/cognite_toolkit/_repo_files/GitHub/.github/workflows/deploy.yaml

@@ -12,7 +12,7 @@ jobs:
     environment: dev
     name: Deploy
     container:
-      image: cognite/toolkit:0.6.98
+      image: cognite/toolkit:0.6.99
       env:
         CDF_CLUSTER: ${{ vars.CDF_CLUSTER }}
         CDF_PROJECT: ${{ vars.CDF_PROJECT }}

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/cognite_toolkit/_repo_files/GitHub/.github/workflows/dry-run.yaml

@@ -10,7 +10,7 @@ jobs:
     environment: dev
     name: Deploy Dry Run
     container:
-      image: cognite/toolkit:0.6.98
+      image: cognite/toolkit:0.6.99
       env:
         CDF_CLUSTER: ${{ vars.CDF_CLUSTER }}
         CDF_PROJECT: ${{ vars.CDF_PROJECT }}

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/cognite_toolkit/_resources/cdf.toml

@@ -4,7 +4,7 @@ default_env = "<DEFAULT_ENV_PLACEHOLDER>"
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.6.98"
+version = "0.6.99"
 
 [alpha_flags]
 external-libraries = true

cognite_toolkit-0.6.99/cognite_toolkit/_version.py

@@ -0,0 +1 @@
+__version__ = "0.6.99"

cognite_toolkit-0.6.99/last_changelog_entry.md

@@ -0,0 +1,11 @@
+## cdf 
+
+### Changed
+
+- [alpha] The clean command requires the module name to be passed as a
+parameter. If not, the user will be prompted to select modules
+interactively.
+
+## templates
+
+No changes.

cognite_toolkit-0.6.99/last_git_message.txt

@@ -0,0 +1,31 @@
+[CDF-26131] Clean module limit (#2191)
+
+# Description
+
+From v0.7, the clean command will require a `-m`/`--module` parameter.
+If not provided, the user will be required to select one or more modules
+interactively. This is to reduce the damage potential of an unintended
+`cdf clean` command.
+
+
+## Changelog
+
+- [x] Patch
+- [ ] Skip
+
+## cdf
+
+### Changed
+
+- [alpha] The clean command requires the module name to be passed as a
+parameter. If not, the user will be prompted to select modules
+interactively.
+
+## templates
+
+No changes.
+
+---------
+
+Co-authored-by: Anders Albert <60234212+doctrino@users.noreply.github.com>
+Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

cognite_toolkit-0.6.99/last_version.txt

@@ -0,0 +1 @@
+0.6.98

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cognite_toolkit"
-version = "0.6.98"
+version = "0.6.99"
 description = "Official Cognite Data Fusion tool for project templates and configuration deployment"
 authors = [
     {name ="Cognite AS", email="support@cognite.com"}

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/tests/test_unit/approval_client/config.py

@@ -570,6 +570,7 @@ API_RESOURCES = [
                 Method(api_class_method="list", mock_class_method="return_values"),
                 Method(api_class_method="retrieve_multiple", mock_class_method="return_values"),
             ],
+            "delete": [Method(api_class_method="delete", mock_class_method="delete_id_external_id")],
         },
     ),
     APIResource(
@@ -580,6 +581,7 @@ API_RESOURCES = [
         _write_list_cls=ThreeDModelWriteList,
         methods={
             "create": [Method(api_class_method="create", mock_class_method="create_3dmodel")],
+            "delete": [Method(api_class_method="delete", mock_class_method="delete_id_external_id")],
             "retrieve": [
                 Method(api_class_method="__iter__", mock_class_method="iterate_values"),
             ],

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/tests/test_unit/conftest.py

@@ -19,8 +19,10 @@ from cognite_toolkit._cdf_tk.client import ToolkitClientConfig
 from cognite_toolkit._cdf_tk.client.data_classes.canvas import IndustrialCanvas
 from cognite_toolkit._cdf_tk.client.data_classes.migration import InstanceSource
 from cognite_toolkit._cdf_tk.client.testing import monkeypatch_toolkit_client
-from cognite_toolkit._cdf_tk.commands import ModulesCommand, RepoCommand
-from cognite_toolkit._cdf_tk.constants import MODULES
+from cognite_toolkit._cdf_tk.commands import BuildCommand, ModulesCommand, RepoCommand
+from cognite_toolkit._cdf_tk.constants import BUILD_ENVIRONMENT_FILE, MODULES
+from cognite_toolkit._cdf_tk.data_classes._config_yaml import BuildEnvironment
+from cognite_toolkit._cdf_tk.utils import read_yaml_file
 from cognite_toolkit._cdf_tk.utils.auth import EnvironmentVariables
 from tests.constants import REPO_ROOT
 from tests.data import (
@@ -136,6 +138,26 @@ def buildable_modules_mutable(
     return organization_dir
 
 
+@pytest.fixture
+def build_environment(
+    build_tmp_path: Path,
+    complete_org_dir: Path,
+    env_vars_with_client: EnvironmentVariables,
+) -> BuildEnvironment:
+    """Fixture that builds modules and returns the BuildEnvironment."""
+    BuildCommand(silent=True, skip_tracking=True).execute(
+        verbose=False,
+        organization_dir=complete_org_dir,
+        build_dir=build_tmp_path,
+        selected=None,
+        no_clean=False,
+        client=env_vars_with_client.get_client(),
+        build_env_name="dev",
+        on_error="raise",
+    )
+    return BuildEnvironment.load(read_yaml_file(build_tmp_path / BUILD_ENVIRONMENT_FILE), "dev", "build")
+
+
 @pytest.fixture
 def capture_print(monkeypatch: MonkeyPatch) -> PrintCapture:
     capture = PrintCapture()

cognite_toolkit-0.6.99/tests/test_unit/test_cdf_tk/test_commands/test_clean.py

@@ -0,0 +1,16 @@
+from cognite_toolkit._cdf_tk.commands import CleanCommand
+from cognite_toolkit._cdf_tk.data_classes._config_yaml import BuildEnvironment
+
+
+class TestCleanCommandSelectModules:
+    """Test the CleanCommand._select_modules method."""
+
+    def test_select_specific_module(
+        self,
+        build_environment: BuildEnvironment,
+    ) -> None:
+        """Test that when a specific module is specified, it is returned."""
+        cmd = CleanCommand(silent=True, skip_tracking=True)
+        result = cmd._select_modules(build_environment, module_str="my_example_module")
+        assert len(result) == 1
+        assert result[0].dir.name == "my_example_module", f"Expected 'my_example_module', got {result[0].dir.name}"

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/tests/test_unit/test_cli/test_command_sequences.py

@@ -172,6 +172,8 @@ def test_init_build_clean(
         build_env_name="dev",
         dry_run=False,
         include=None,
+        module_str=module_path.name,
+        all_modules=True,
         verbose=False,
     )
 

{cognite_toolkit-0.6.98 → cognite_toolkit-0.6.99}/uv.lock

@@ -272,7 +272,7 @@ wheels = [
 
 [[package]]
 name = "cognite-toolkit"
-version = "0.6.98"
+version = "0.6.99"
 source = { editable = "." }
 dependencies = [
     { name = "cognite-sdk" },

cognite_toolkit-0.6.98/cognite_toolkit/_version.py

@@ -1 +0,0 @@
-__version__ = "0.6.98"

cognite_toolkit-0.6.98/last_changelog_entry.md

@@ -1,9 +0,0 @@
-## cdf 
-
-### Changed
-
-- Deprecating the `run` plugin in favour of the new `dev` plugin
-
-## templates
-
-No changes.

cognite_toolkit-0.6.98/last_git_message.txt

@@ -1,24 +0,0 @@
-[CDF-26132] A new dev plugin for v0.7 (#2197)
-
-# Description
-
-As part of the plan to improve development support, we want to have a
-family of `cdf dev ... ` commands.
-
-This is just the first step of enabling the `cdf dev` app and `cdf dev
-run` as a subapp.
-
-## Changelog
-
-- [x] Patch
-- [ ] Skip
-
-## cdf
-
-### Changed
-
-- Deprecating the `run` plugin in favour of the new `dev` plugin
-
-## templates
-
-No changes.

cognite_toolkit-0.6.98/last_version.txt

@@ -1 +0,0 @@
-0.6.97