Fix tests

Author: luciasanchezbella01

ddev/src/ddev/cli/size/create_dashboard.py

@@ -13,7 +13,7 @@
     "--dd-org",
     type=str,
     required=True,
-    help="Datadog organization name taken from your config file.",
+    help="Datadog organization name taken from your config file e.g. 'default'",
 )
 @click.pass_obj
 def create_dashboard(
@@ -25,6 +25,12 @@ def create_dashboard(
     """
     try:
         config_file_info = get_org(app, dd_org)
+        if 'api_key' not in config_file_info:
+            raise RuntimeError("No API key found in config file")
+        if 'app_key' not in config_file_info:
+            raise RuntimeError("No APP key found in config file")
+        if 'site' not in config_file_info:
+            raise RuntimeError("No site found in config file")
         headers = {
             "DD-API-KEY": config_file_info["api_key"],
             "DD-APPLICATION-KEY": config_file_info["app_key"],
@@ -46,7 +52,6 @@ def create_dashboard(
         resp_json = response.json()
         if "Forbidden" in str(resp_json.get("errors", [])):
             raise PermissionError("Access denied: your APP key doesn't have permission to create dashboards.")
-
         print(f"Dashboard URL: https://app.{config_file_info['site']}{resp_json['url']}")
     except Exception as e:
         app.abort(str(e))
@@ -55,8 +60,10 @@ def create_dashboard(
 def create_json(app: Application) -> list[dict[str, Any]]:
     valid_platforms = get_valid_platforms(app.repo.path)
     widgets: list[dict[str, Any]] = []
+
     for size_type in ["compressed", "uncompressed"]:
         for platform in valid_platforms:
+            # Treemap widget
             widgets.append(
                 {
                     "definition": {
@@ -91,5 +98,45 @@ def create_json(app: Application) -> list[dict[str, Any]]:
                     }
                 }
             )
+            # Timeseries widget
+            widgets.append(
+                {
+                    "definition": {
+                        "title": f"Timeline of {size_type} sizes in {platform}",
+                        "type": "timeseries",
+                        "requests": [
+                            {
+                                "response_format": "timeseries",
+                                "queries": [
+                                    {
+                                        "name": "query1",
+                                        "data_source": "metrics",
+                                        "query": f"sum:datadog.agent_integrations.size_analyzer.{size_type}"
+                                        f"{{platform:{platform}}}",
+                                    }
+                                ],
+                                "formulas": [
+                                    {
+                                        "formula": "query1",
+                                        "number_format": {
+                                            "unit": {
+                                                "type": "canonical_unit",
+                                                "unit_name": "byte_in_binary_bytes_family",
+                                            }
+                                        },
+                                    }
+                                ],
+                                "style": {
+                                    "palette": "dog_classic",
+                                    "order_by": "values",
+                                    "line_type": "solid",
+                                    "line_width": "normal",
+                                },
+                                "display_type": "line",
+                            }
+                        ],
+                    }
+                }
+            )
 
     return widgets

ddev/src/ddev/cli/size/utils/common_funcs.py

@@ -55,33 +55,33 @@ class CommitEntryPlatformWithDelta(CommitEntryWithDelta):
 
 
 class CLIParameters(TypedDict):
-    app: Application
-    platform: str
-    version: str
-    compressed: bool
-    format: Optional[list[str]]
-    show_gui: bool
+    app: Application  # Main application instance for CLI operations
+    platform: str  # Target platform for analysis (e.g. linux-aarch64)
+    version: str  # Target Python version for analysis
+    compressed: bool  # Whether to analyze compressed file sizes
+    format: Optional[list[str]]  # Output format options (png, csv, markdown, json)
+    show_gui: bool  # Whether to display interactive visualization
 
 
 class CLIParametersTimeline(TypedDict):
-    app: Application
-    module: str
-    threshold: Optional[int]
-    compressed: bool
-    format: Optional[list[str]]
-    show_gui: bool
+    app: Application  # Main application instance for CLI operations
+    module: str  # Name of module to analyze
+    threshold: Optional[int]  # Minimum size threshold for filtering
+    compressed: bool  # Whether to analyze compressed file sizes
+    format: Optional[list[str]]  # Output format options (png, csv, markdown, json)
+    show_gui: bool  # Whether to display interactive visualization
 
 
 class InitialParametersTimelineIntegration(CLIParametersTimeline):
-    type: Literal["integration"]
-    first_commit: str
-    platform: None
+    type: Literal["integration"]  # Specifies this is for integration analysis
+    first_commit: str  # Starting commit hash for timeline analysis
+    platform: None  # Platform not needed for integration analysis
 
 
 class InitialParametersTimelineDependency(CLIParametersTimeline):
-    type: Literal["dependency"]
-    first_commit: None
-    platform: str
+    type: Literal["dependency"]  # Specifies this is for dependency analysis
+    first_commit: None  # No commit needed for dependency analysis
+    platform: str  # Target platform for dependency analysis
 
 
 def get_valid_platforms(repo_path: Path | str) -> set[str]:
@@ -503,7 +503,7 @@ def plot_treemap(
     modules: list[FileDataEntryPlatformVersion],
     title: str,
     show: bool,
-    mode: Literal["status", "diff"] = "status",
+    mode: Literal["status", "diff"],
     path: Optional[str] = None,
 ) -> None:
     if not any(str(value).strip() not in ("", "0") for value in modules[0].values()):
@@ -778,23 +778,6 @@ def get_org(app: Application, org: str) -> dict[str, str]:
     return org_data
 
 
-# def get_org(app: Application, org: Optional[str] = "default") -> dict[str, str]:
-#     config_path = app.config_file.path
-
-#     with config_path.open(mode="rb") as f:
-#         data = tomllib.load(f)
-
-#     org_config = data.get("orgs", {}).get(org)
-#     if not org_config:
-#         raise ValueError(f"Organization '{org}' not found in config")
-
-#     return {
-#         "api_key": org_config["api_key"],
-#         "app_key": org_config["app_key"],
-#         "site": org_config.get("site"),
-#     }
-
-
 def is_everything_committed() -> bool:
     result = subprocess.run(["git", "status", "--porcelain"], capture_output=True, text=True)
     return result.stdout.strip() == ""

ddev/tests/cli/size/test_create_dashboard.py

@@ -0,0 +1,63 @@
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+
+@pytest.fixture
+def app():
+    mock_app = MagicMock()
+    mock_app.repo.path = "/fake/repo"
+    mock_app.abort = MagicMock()
+    return mock_app
+
+
+@pytest.fixture()
+def mock_dashboard_env():
+    with (
+        patch("ddev.cli.size.create_dashboard.get_org") as mock_get_org,
+        patch("ddev.cli.size.create_dashboard.get_valid_platforms") as mock_get_valid_platforms,
+        patch("ddev.cli.size.create_dashboard.requests.post") as mock_post,
+    ):
+        mock_get_org.return_value = {"api_key": "fake-api-key", "app_key": "fake-app-key", "site": "datadoghq.com"}
+        mock_get_valid_platforms.return_value = ["linux"]
+        mock_response = MagicMock()
+        mock_response.json.return_value = {"url": "/dashboard/abc123"}
+        mock_post.return_value = mock_response
+
+        yield
+
+
+def test_create_dashboard_success(ddev, app, mock_dashboard_env):
+    result = ddev("size", "create-dashboard", "--dd-org", "default", obj=app)
+    assert result.exit_code == 0
+    assert "Dashboard URL: https://app.datadoghq.com/dashboard/abc123" in result.output
+
+
+def test_create_dashboard_missing_api_key(ddev, app):
+    with patch("ddev.cli.size.create_dashboard.get_org") as mock_get_org:
+        mock_get_org.return_value = {"app_key": "fake-app-key", "site": "datadoghq.com"}
+
+        result = ddev("size", "create-dashboard", "--dd-org", "default", obj=app)
+
+        assert result.exit_code != 0
+        assert "No API key found in config file" in result.output
+
+
+def test_create_dashboard_missing_app_key(ddev, app):
+    with patch("ddev.cli.size.create_dashboard.get_org") as mock_get_org:
+        mock_get_org.return_value = {"api_key": "fake-api-key", "site": "datadoghq.com"}
+
+        result = ddev("size", "create-dashboard", "--dd-org", "default", obj=app)
+
+        assert result.exit_code != 0
+        assert "No APP key found in config file" in result.output
+
+
+def test_create_dashboard_missing_site(ddev, app):
+    with patch("ddev.cli.size.create_dashboard.get_org") as mock_get_org:
+        mock_get_org.return_value = {"api_key": "fake-api-key", "app_key": "fake-app-key"}
+
+        result = ddev("size", "create-dashboard", "--dd-org", "default", obj=app)
+
+        assert result.exit_code != 0
+        assert "No site found in config file" in result.output