cognite-toolkit 0.7.11__tar.gz → 0.7.12__tar.gz

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite_toolkit
-Version: 0.7.11
+Version: 0.7.12
 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.7.11 → cognite_toolkit-0.7.12}/cdf.toml

@@ -22,7 +22,7 @@ data = 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.7.11"
+version = "0.7.12"
 
 
 [library.toolkit-data]

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/cognite_toolkit/_cdf.py

@@ -36,6 +36,7 @@ from cognite_toolkit._cdf_tk.apps import (
 )
 from cognite_toolkit._cdf_tk.cdf_toml import CDFToml
 from cognite_toolkit._cdf_tk.commands import (
+    AboutCommand,
     CollectCommand,
 )
 from cognite_toolkit._cdf_tk.constants import HINT_LEAD_TEXT, URL, USE_SENTRY
@@ -115,6 +116,13 @@ _app.add_typer(ModulesApp(**default_typer_kws), name="modules")
 _app.command("init")(landing_app.main_init)
 
 
+@_app.command("about")
+def about() -> None:
+    """Display information about the Toolkit installation and configuration."""
+    cmd = AboutCommand()
+    cmd.run(lambda: cmd.execute(Path.cwd()))
+
+
 def app() -> NoReturn:
     # --- Main entry point ---
     # Users run 'app()' directly, but that doesn't allow us to control excepton handling:

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/cognite_toolkit/_cdf_tk/commands/__init__.py

@@ -6,13 +6,13 @@ from ._migrate import (
 from ._profile import ProfileAssetCentricCommand, ProfileAssetCommand, ProfileRawCommand, ProfileTransformationCommand
 from ._purge import PurgeCommand
 from ._upload import UploadCommand
+from .about import AboutCommand
 from .auth import AuthCommand
 from .build_cmd import BuildCommand
 from .clean import CleanCommand
 from .collect import CollectCommand
 from .deploy import DeployCommand
 from .dump_resource import DumpResourceCommand
-from .featureflag import FeatureFlagCommand
 from .init import InitCommand
 from .modules import ModulesCommand
 from .pull import PullCommand
@@ -21,6 +21,7 @@ from .resources import ResourcesCommand
 from .run import RunFunctionCommand, RunTransformationCommand, RunWorkflowCommand
 
 __all__ = [
+    "AboutCommand",
     "AuthCommand",
     "BuildCommand",
     "CleanCommand",
@@ -28,7 +29,6 @@ __all__ = [
     "DeployCommand",
     "DownloadCommand",
     "DumpResourceCommand",
-    "FeatureFlagCommand",
     "InitCommand",
     "MigrationCanvasCommand",
     "MigrationPrepareCommand",

cognite_toolkit-0.7.12/cognite_toolkit/_cdf_tk/commands/about.py

@@ -0,0 +1,221 @@
+import platform
+import sys
+from pathlib import Path
+
+from rich import print
+from rich.table import Table
+
+from cognite_toolkit._cdf_tk.cdf_toml import CDFToml, _read_toml
+from cognite_toolkit._cdf_tk.commands._base import ToolkitCommand
+from cognite_toolkit._cdf_tk.constants import clean_name
+from cognite_toolkit._cdf_tk.feature_flags import Flags
+from cognite_toolkit._cdf_tk.plugins import Plugins
+from cognite_toolkit._cdf_tk.tk_warnings import LowSeverityWarning, MediumSeverityWarning
+from cognite_toolkit._version import __version__
+
+
+class AboutCommand(ToolkitCommand):
+    def execute(self, cwd: Path) -> None:
+        # Version information
+        print(f"\n[bold cyan]Cognite Toolkit[/bold cyan] version: [yellow]{__version__}[/yellow]")
+        print(f"Python version: {sys.version.split()[0]}")
+        print(f"Platform: {platform.system()} {platform.release()}")
+
+        # Check for cdf.toml in the current directory
+        cdf_toml_path = cwd / CDFToml.file_name
+
+        if cdf_toml_path.exists():
+            print(f"\n[bold green]Configuration file found:[/bold green] {cdf_toml_path}")
+
+            cdf_toml = CDFToml.load(cwd)
+
+            # We need to read the raw TOML to get original key names for plugins and alpha flags
+            raw_toml = _read_toml(cdf_toml_path)
+
+            self._check_unrecognized_sections(raw_toml)
+            self._display_plugins(cdf_toml, raw_toml)
+            self._display_alpha_flags(cdf_toml, raw_toml)
+            self._display_additional_config(cdf_toml)
+
+        else:
+            # Search for cdf.toml in subdirectories
+            found_files = self._search_cdf_toml(cwd)
+
+            if found_files:
+                print(f"\n[bold yellow]No cdf.toml found in current directory:[/bold yellow] {cwd}")
+                print("\n[bold]Found cdf.toml files in subdirectories:[/bold]")
+                for file in found_files:
+                    rel_path = file.relative_to(cwd)
+                    print(f"  • {rel_path}")
+                print(f"\n[bold cyan]Hint:[/bold cyan] Move one of these files to {cwd} or navigate to its directory.")
+            else:
+                print("\n[bold yellow]No cdf.toml found[/bold yellow] in current directory or subdirectories.")
+                print(f"Current directory: {cwd}")
+                print("\n[bold cyan]Hint:[/bold cyan] Run [yellow]cdf init[/yellow] to create a new project.")
+
+    def _check_unrecognized_sections(self, raw_toml: dict) -> None:
+        """Check for unrecognized tables in cdf.toml and warn about them."""
+        # Valid top-level tables in cdf.toml
+        valid_tables = {"cdf", "modules", "alpha_flags", "feature_flags", "plugins", "library"}
+
+        # Filter out empty keys, whitespace-only keys, and check for unrecognized tables
+        unrecognized_tables = [key for key in raw_toml.keys() if key and key.strip() and key not in valid_tables]
+
+        if unrecognized_tables:
+            print()
+
+        for table in unrecognized_tables:
+            # Try to find a matching valid table by stripping non-alphabetical characters
+            suggestion = self._find_similar_table(table, valid_tables)
+
+            message = f"Table '{table}' in cdf.toml is not recognized and will have no effect."
+            if suggestion:
+                message += f" Did you mean '{suggestion}'?"
+
+            self.warn(MediumSeverityWarning(message))
+
+    @staticmethod
+    def _find_similar_table(unrecognized: str, valid_tables: set[str]) -> str | None:
+        """Find a similar valid table by comparing alphabetical characters only.
+
+        Returns None if the unrecognized table is already valid or if no similar match is found.
+        """
+        # If it's already a valid table, return None (no suggestion needed)
+        if unrecognized in valid_tables:
+            return None
+
+        # Keep only alphabetical characters and lowercase
+        normalized_unrecognized = "".join(c for c in unrecognized if c.isalpha()).lower()
+
+        # First, try exact match (after normalization)
+        for valid in valid_tables:
+            normalized_valid = "".join(c for c in valid if c.isalpha()).lower()
+            if normalized_unrecognized == normalized_valid:
+                return valid
+
+        # If no match, check for singular/plural variations (missing 's')
+        for valid in valid_tables:
+            normalized_valid = "".join(c for c in valid if c.isalpha()).lower()
+
+            # Check if adding 's' to unrecognized matches valid (e.g., "plugin" -> "plugins")
+            if normalized_unrecognized + "s" == normalized_valid:
+                return valid
+
+        return None
+
+    def _display_plugins(self, cdf_toml: CDFToml, raw_toml: dict) -> None:
+        """Display all available plugins and their status."""
+        table = Table(title="Plugins", show_header=True)
+        table.add_column("Plugin", justify="left", style="cyan")
+        table.add_column("Status", justify="center")
+        table.add_column("Description", justify="left")
+
+        # Track which plugins we've seen
+        seen_plugins = set()
+
+        # Show all plugins from the enum
+        for plugin in Plugins:
+            plugin_name = plugin.value.name
+            cleaned_key = clean_name(plugin_name)
+            seen_plugins.add(cleaned_key)
+
+            is_enabled = cdf_toml.plugins.get(cleaned_key, False)
+            if is_enabled:
+                status = "[green]✓ enabled[/green]"
+            else:
+                status = "[dim]○ disabled[/dim]"
+
+            table.add_row(plugin_name, status, plugin.value.description)
+
+        print()
+        print(table)
+
+        # Show any unrecognized plugins from cdf.toml using original key names
+        raw_plugins = raw_toml.get("plugins", {})
+        unrecognized = []
+        for original_key, value in raw_plugins.items():
+            cleaned_key = clean_name(original_key)
+            if cleaned_key not in seen_plugins:
+                unrecognized.append((original_key, value))
+
+        for original_key, is_enabled in unrecognized:
+            status = "enabled" if is_enabled else "disabled"
+            self.warn(
+                LowSeverityWarning(f"Plugin '{original_key}' in cdf.toml is not recognized and will have no effect.")
+            )
+
+    def _display_alpha_flags(self, cdf_toml: CDFToml, raw_toml: dict) -> None:
+        """Display available alpha flags and their status."""
+        table = Table(title="Alpha Flags", show_header=True)
+        table.add_column("Flag", justify="left", style="yellow")
+        table.add_column("Status", justify="center")
+        table.add_column("Description", justify="left")
+
+        # Track which flags we've seen
+        seen_flags = set()
+
+        # Show flags from the enum that are either enabled or visible
+        for flag in Flags:
+            cleaned_key = clean_name(flag.name)
+            seen_flags.add(cleaned_key)
+
+            is_enabled = cdf_toml.alpha_flags.get(cleaned_key, False)
+
+            # Only show if enabled or visible
+            if is_enabled or flag.value.visible:
+                # Convert enum name to kebab-case for display
+                display_name = flag.name.lower().replace("_", "-")
+
+                if is_enabled:
+                    status = "[green]✓ enabled[/green]"
+                else:
+                    status = "[dim]○ disabled[/dim]"
+
+                table.add_row(display_name, status, flag.value.description)
+
+        print()
+        print(table)
+
+        # Show any unrecognized flags from cdf.toml using original key names
+        raw_flags = raw_toml.get("alpha_flags", {})
+        unrecognized = []
+        for original_key, value in raw_flags.items():
+            cleaned_key = clean_name(original_key)
+            if cleaned_key not in seen_flags:
+                unrecognized.append((original_key, value))
+
+        for original_key, is_enabled in unrecognized:
+            status = "enabled" if is_enabled else "disabled"
+            self.warn(
+                LowSeverityWarning(
+                    f"Alpha flag '{original_key}' in cdf.toml is not recognized and will have no effect."
+                )
+            )
+
+    def _display_additional_config(self, cdf_toml: CDFToml) -> None:
+        """Display additional configuration information."""
+        print("\n[bold]Additional Configuration:[/bold]")
+
+        print(f"  Default environment: [cyan]{cdf_toml.cdf.default_env}[/cyan]")
+
+        if cdf_toml.cdf.has_user_set_default_org:
+            print(f"  Default organization dir: [cyan]{cdf_toml.cdf.default_organization_dir}[/cyan]")
+
+        if cdf_toml.cdf.file_encoding:
+            print(f"  File encoding: [cyan]{cdf_toml.cdf.file_encoding}[/cyan]")
+
+        print(f"  Modules version: [cyan]{cdf_toml.modules.version}[/cyan]")
+
+        if cdf_toml.libraries:
+            print(f"  Configured libraries: [cyan]{len(cdf_toml.libraries)}[/cyan]")
+            for lib_name, lib_config in cdf_toml.libraries.items():
+                print(f"    • {lib_name}: [dim]{lib_config.url}[/dim]")
+
+    def _search_cdf_toml(self, cwd: Path) -> list[Path]:
+        """Search for cdf.toml files in immediate subdirectories (one level down)."""
+        try:
+            return sorted(
+                [potential_file for potential_file in cwd.glob(f"*/{CDFToml.file_name}") if potential_file.is_file()]
+            )
+        except PermissionError:
+            return []

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/cognite_toolkit/_cdf_tk/feature_flags.py

@@ -22,7 +22,7 @@ class Flags(Enum):
         description="Enables the import sub application",
     )
     GRAPHQL = FlagMetadata(
-        visible=True,
+        visible=False,
         description="Enables the support for deploying data models as GraphQL schemas",
     )
     MODULE_REPEAT = FlagMetadata(

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/cognite_toolkit/_repo_files/GitHub/.github/workflows/deploy.yaml

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

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/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.7.11
+      image: cognite/toolkit:0.7.12
       env:
         CDF_CLUSTER: ${{ vars.CDF_CLUSTER }}
         CDF_PROJECT: ${{ vars.CDF_PROJECT }}

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/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.7.11"
+version = "0.7.12"
 
 
 [plugins]

cognite_toolkit-0.7.12/cognite_toolkit/_version.py

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

cognite_toolkit-0.7.12/last_changelog_entry.md

@@ -0,0 +1,6 @@
+## Changelog 
+
+### Added
+
+- Added the `cdf about` command to give an overview of current toolkit
+configuration and simplify debugging issues.

cognite_toolkit-0.7.12/last_git_message.txt

@@ -0,0 +1,28 @@
+[CDF-25804] Add about command (#2251)
+
+# Description
+
+Adding a new command, `cdf about` to help users get an overview of their
+current toolkit configuration and to simplify debugging configuration
+problems, like `cdf.toml` being placed in the wrong working directory
+and spelling mistakes in the TOML file itself.
+
+Also deleted FeatureFlagsCommand and set alpha_flag for graphql=False,
+not including this in the changelog since they are hidden components.
+
+## Bump
+
+- [x] Patch
+- [ ] Skip
+
+## Changelog
+
+### Added
+
+- Added the `cdf about` command to give an overview of current toolkit
+configuration and simplify debugging issues.
+
+---------
+
+Co-authored-by: Magnus Schjølberg <magnus.schjolberg@cognitedata.com>
+Co-authored-by: Anders Albert <60234212+doctrino@users.noreply.github.com>

cognite_toolkit-0.7.12/last_version.txt

@@ -0,0 +1 @@
+0.7.11

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/pyproject.toml

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

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/tests/data/build_group_with_unknown_acl/_build_environment.yaml

@@ -4,4 +4,4 @@ project: pytest-project
 type: dev
 selected:
 - modules
-cdf_toolkit_version: 0.7.11
+cdf_toolkit_version: 0.7.12

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/tests/data/cdf_toml_data/cdf.toml

@@ -1,7 +1,7 @@
 [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.7.11"
+version = "0.7.12"
 
 [plugins]
 graphql = true

{cognite_toolkit-0.7.11/tests/data/complete_org_alpha_flags → cognite_toolkit-0.7.12/tests/data/complete_org}/cdf.toml

@@ -1,4 +1,4 @@
 [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.7.11"
+version = "0.7.12"

{cognite_toolkit-0.7.11/tests/data/complete_org_only_identifier → cognite_toolkit-0.7.12/tests/data/complete_org_alpha_flags}/cdf.toml

@@ -1,4 +1,4 @@
 [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.7.11"
+version = "0.7.12"

{cognite_toolkit-0.7.11/tests/data/naughty_project → cognite_toolkit-0.7.12/tests/data/complete_org_only_identifier}/cdf.toml

@@ -1,4 +1,4 @@
 [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.7.11"
+version = "0.7.12"

{cognite_toolkit-0.7.11/tests/data/complete_org → cognite_toolkit-0.7.12/tests/data/naughty_project}/cdf.toml

@@ -1,4 +1,4 @@
 [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.7.11"
+version = "0.7.12"

cognite_toolkit-0.7.12/tests/data/project_no_cognite_modules/cdf.toml

@@ -0,0 +1,4 @@
+[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.7.12"

cognite_toolkit-0.7.12/tests/data/project_with_bad_modules/cdf.toml

@@ -0,0 +1,4 @@
+[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.7.12"

cognite_toolkit-0.7.12/tests/data/project_with_duplicates/cdf.toml

@@ -0,0 +1,4 @@
+[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.7.12"

{cognite_toolkit-0.7.11 → cognite_toolkit-0.7.12}/tests/data/run_data/cdf.toml

@@ -1,7 +1,7 @@
 [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.7.11"
+version = "0.7.12"
 
 [modules.packages]
 cdf_infield = [

cognite_toolkit-0.7.12/tests/test_unit/test_cdf_tk/conftest.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+import pytest
+
+from cognite_toolkit import _cdf
+from cognite_toolkit._cdf_tk import cdf_toml
+from cognite_toolkit._cdf_tk.feature_flags import FeatureFlag
+
+
+@pytest.fixture
+def reset_cdf_toml_singleton():
+    """Reset CDFToml singleton before and after each test to ensure test isolation.
+
+    Use this fixture in tests that need to load cdf.toml from a test directory
+    to avoid conflicts with the repo's cdf.toml singleton.
+    """
+    cdf_toml._CDF_TOML = None
+    _cdf.CDF_TOML = None  # Also reset the module-level instance in _cdf.py
+    FeatureFlag.flush()  # Also clear the feature flag cache
+    yield
+    cdf_toml._CDF_TOML = None
+    _cdf.CDF_TOML = None
+    FeatureFlag.flush()