Options: Do not assume defaults for ACTION and --grafana_label args

Author: amotl

.github/workflows/tests.yml

@@ -24,6 +24,14 @@ jobs:
         python-version: ["3.6", "3.13"]
       fail-fast: false
 
+    services:
+      grafana:
+        image: grafana/grafana:latest
+        ports:
+          - 3000:3000
+        env:
+          GF_SECURITY_ADMIN_PASSWORD: admin
+
     env:
       OS: ${{ matrix.os }}
       PYTHON: ${{ matrix.python-version }}

HISTORY.md

@@ -7,6 +7,7 @@
   by respecting the `credential` keyword argument
 - Added basic example program about how to import a dashboard
 - Options: Permitted usage without authentication credentials or token
+- Options: Do not assume defaults for `ACTION` and `--grafana_label` args
 
 ## 0.4.0 (2024-10-16)
 - Fixed folder argument issue

grafana_import/cli.py

@@ -117,7 +117,6 @@ def main():
         "-g",
         "--grafana_label",
         help="label in the config file that represents the grafana to connect to.",
-        default="default",
     )
 
     parser.add_argument("-f", "--grafana_folder", help="the folder name where to import into Grafana.")
@@ -159,7 +158,6 @@ def main():
         metavar="ACTION",
         nargs="?",
         choices=["import", "export", "remove"],
-        default="import",
         help="action to perform. Is one of 'export', 'import' (default), or 'remove'.\n"
         "export: lookup for dashboard name in Grafana and dump it to local file.\n"
         "import: import a local dashboard file (previously exported) to Grafana.\n"
@@ -332,7 +330,7 @@ def process_dashboard(file_path):
             sys.exit(1)
 
     # Export
-    else:
+    elif args.action == "export":
         dashboard_name = config["general"]["dashboard_name"]
         try:
             dash = grafana_api.export_dashboard(dashboard_name)
@@ -347,6 +345,10 @@ def process_dashboard(file_path):
             save_dashboard(config, args, base_path, dashboard_name, dash, "exported")
             sys.exit(0)
 
+    else:
+        logger.error(f"Unknown action: {args.action}. Use one of: {parser._actions[-2].choices}")
+        sys.exit(1)
+
 
 if __name__ == "__main__":
     main()

tests/test_cli.py

@@ -19,6 +19,17 @@ def get_settings_arg(use_settings: bool = True):
     return "--grafana_url http://localhost:3000"
 
 
+def test_no_action_failure(caplog):
+    """
+    Verify the program fails when invoked without positional `action` argument.
+    """
+    sys.argv = ["grafana-import"]
+    with pytest.raises(SystemExit) as ex:
+        main()
+    assert ex.match("1")
+    assert "Unknown action: None. Use one of: ['import', 'export', 'remove']" in caplog.messages
+
+
 @pytest.mark.parametrize("use_settings", [True, False], ids=["config-yes", "config-no"])
 def test_import_dashboard_success(mocked_grafana, mocked_responses, tmp_path, caplog, use_settings):
     """