feat(cli): add --json flag to status command (#825)

Add JSON output option to vunnel status command for structured data consumption.
The existing tree output remains the default, ensuring backward compatibility.

- Add --json flag to status subcommand
- Include root path and provider details in JSON response
- Add test coverage for JSON output format

Signed-off-by: James Gardner <[email protected]>

Author: jamestexas

src/vunnel/cli/cli.py

@@ -2,6 +2,7 @@
 
 import dataclasses
 import enum
+import json
 import logging
 import sys
 from dataclasses import dataclass
@@ -182,8 +183,9 @@ def clear_provider(cfg: config.Application, provider_names: str, _input: bool, r
 @cli.command(name="status", help="describe current provider state")
 @click.argument("provider_names", metavar="PROVIDER", nargs=-1)
 @click.option("--show-empty", default=False, is_flag=True, help="show providers with no state")
+@click.option("--json", "output_json", default=False, is_flag=True, help="output as JSON")
 @click.pass_obj
-def status_provider(cfg: config.Application, provider_names: str, show_empty: bool) -> None:  # noqa: C901
+def status_provider(cfg: config.Application, provider_names: str, show_empty: bool, output_json: bool) -> None:  # noqa: C901
     print(cfg.root)
     selected_names = provider_names if provider_names else providers.names()
 
@@ -207,6 +209,14 @@ def format(self, fill: str) -> str:
 {fill}      results: {self.count}
 {fill}      from:    {self.date}"""
 
+        def to_dict(self) -> dict:
+            return {
+                'count': self.count,
+                'date': self.date,
+                'error': self.error,
+                'enabled': self.enabled
+            }
+
     # first pass: find the results that exist (which may be fewer than what is selected)
     results = {}
     for _idx, name in enumerate(selected_names):
@@ -227,17 +237,30 @@ def format(self, fill: str) -> str:
         except Exception as e:
             results[name] = CurrentState(enabled=False, error=str(e))
 
-    # second pass: show the state
-    for idx, (name, result) in enumerate(sorted(results.items())):
-        branch = "├──"
-        fill = "│"
-        if idx == len(results) - 1:
-            branch = "└──"
-            fill = " "
-
-        node = result.format(fill)
-
-        print(f"""{branch} {name}\n{node}""")
+    # if --json is requested, output as JSON
+    if output_json:
+        json_output = {
+            "root": cfg.root,
+            "providers": [
+                {"name": name, **result.to_dict()}  # unpack to a dict
+                for name, result in sorted(results.items())
+            ]
+        }
+        print(json.dumps(json_output, indent=2))
+    # otherwise, output as a tree structure
+    else:
+        # existing tree output
+        print(cfg.root)
+        for idx, (name, result) in enumerate(sorted(results.items())):
+            branch = "├──"
+            fill = "│"
+            if idx == len(results) - 1:
+                branch = "└──"
+                fill = " "
+
+            node = result.format(fill)
+
+            print(f"""{branch} {name}\n{node}""")
 
 
 @cli.command(name="list", help="list available providers")

tests/unit/cli/test_cli.py

@@ -45,6 +45,42 @@ def test_status(helpers, tmpdir, monkeypatch) -> None:
     assert expected_output.strip() == res.output.strip()
 
 
+def test_status_json(helpers, tmpdir, monkeypatch) -> None:
+    import json
+
+    data_path = helpers.local_dir("test-fixtures/data-1")
+
+    envs = {
+        "NVD_API_KEY": "secret",
+        "GITHUB_TOKEN": "secret",
+    }
+    monkeypatch.setattr(os, "environ", envs)
+
+    config = tmpdir.join("vunnel.yaml")
+    config.write(f"root: {data_path}")
+
+    runner = CliRunner()
+    res = runner.invoke(cli.cli, ["-c", str(config), "status", "--json"])
+    assert res.exit_code == 0
+
+    # Parse and verify JSON output
+    output_data = json.loads(res.output)
+
+    expected_output = {
+        "root": data_path,
+        "providers": [
+            {
+                "name": "wolfi",
+                "count": 56,
+                "date": "2023-01-17 14:58:13",
+                "error": None,
+                "enabled": True
+            }
+        ]
+    }
+
+    assert output_data == expected_output
+
 def test_run(mocker, monkeypatch) -> None:
     populate_mock = MagicMock()
     create_mock = MagicMock(return_value=populate_mock)