scanner-cli 0.1.0rc7__py3-none-any.whl → 0.1.0rc9__py3-none-any.whl

{scanner_cli-0.1.0rc7.dist-info → scanner_cli-0.1.0rc9.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: scanner-cli
-Version: 0.1.0rc7
+Version: 0.1.0rc9
 Summary: Python command-line interface for Scanner API
 Author: Scanner, Inc.
 Author-email: support@scanner.dev
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: PyYAML (>=6.0.2,<7.0.0)
 Requires-Dist: click (>=8.1.7,<9.0.0)
-Requires-Dist: scanner-client (>=0.1.0rc8,<0.2.0)
+Requires-Dist: scanner-client (>=0.1.0rc10,<0.2.0)
 Description-Content-Type: text/markdown
 
 # scanner-cli

scanner_cli-0.1.0rc9.dist-info/RECORD

@@ -0,0 +1,9 @@
+src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/cli.py,sha256=wk7Dmm0yyBZ7U8nLJSKui4EyGHYg-L53VyLA2Q4bLfs,9421
+src/migrate/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/migrate/elastic.py,sha256=y_cn_3Y_t8NHwYcpAQQLfnCkEBSULoU_vxxGwk47QAc,8681
+src/sync.py,sha256=WABCtvI6fpwXNJKo9lzafw3HkGYljpGjre5ywKnO0yA,7738
+scanner_cli-0.1.0rc9.dist-info/METADATA,sha256=wuTJITM3W5MKe4u9y7HSX6sCwYeekMbXaXJ41gBvWik,5942
+scanner_cli-0.1.0rc9.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+scanner_cli-0.1.0rc9.dist-info/entry_points.txt,sha256=vqXMrIG6N6pY66bNf0y-gbUxbU8v5dXvuL3mV832Fh8,43
+scanner_cli-0.1.0rc9.dist-info/RECORD,,

{scanner_cli-0.1.0rc7.dist-info → scanner_cli-0.1.0rc9.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.1
+Generator: poetry-core 2.1.2
 Root-Is-Purelib: true
 Tag: py3-none-any

src/cli.py

@@ -114,7 +114,7 @@ def cli():
 @cli.command()
 @_default_click_options
 def validate(api_url: str, api_key: str, file_paths: str, directories: str, recursive: bool):
-    """ Validate detection rules """
+    """ Validate detection rule files """
     _validate_default_options(api_url, api_key, file_paths, directories)
 
     scanner_client = Scanner(api_url, api_key)
@@ -129,19 +129,25 @@ def validate(api_url: str, api_key: str, file_paths: str, directories: str, recu
             result = scanner_client.detection_rule_yaml.validate(file)
 
             if result.is_valid:
-                click.echo(f"{file}: " + click.style("Valid", fg="green"))
+                if result.warning:
+                    click.echo(f"{file}: " + click.style("OK. ", fg="green") + click.style(f"Warning: {result.warning}", fg="yellow"))
+                else:
+                    click.echo(f"{file}: " + click.style("OK", fg="green"))
             else:
                 any_failures = True
                 click.echo(f"{file}: " + click.style(f"{result.error}", fg="red"))
         except Exception as e:
             any_failures = True
-            click.echo(f"{file}: " + click.style(e, fg="red"))
+            response = e.args[0]
+            click.echo(f"{file}: " + click.style(f"An exception occurred when attempting to validate file: {response.content}", fg="red"))
 
     if any_failures:
         # To make it so the CLI exits with a non-zero exit code
         raise click.ClickException(
-            "validate failed for one or more files"
+            "`validate` failed for one or more files. See https://docs.scanner.dev/scanner/using-scanner/beta-features/detection-rules-as-code/writing-detection-rules for requirements."
         )
+    else:
+        click.secho("All specified detection rule files are valid. Use `run-tests` to run the detection rule tests.", bold=True)
 
 
 @cli.command()
@@ -155,36 +161,53 @@ def run_tests(api_url: str, api_key: str, file_paths: str, directories: str, rec
     files = _get_valid_files(file_paths, directories, recursive)
     click.echo(f'Running tests on {len(files)} {"file" if len(files) == 1 else "files"}')
 
-    any_failures: bool = False
+    any_validation_errors: bool = False
+    any_test_failures: bool = False
 
     for file in files:
+        click.secho(f"{file}", bold=True)
         try:
-            response = scanner_client.detection_rule_yaml.run_tests(file)
-            results = response.results.to_dict()
+            # Check for validation errors
+            validation_result = scanner_client.detection_rule_yaml.validate(file)
+            if not validation_result.is_valid:
+                any_validation_errors = True
+                click.secho(f"Validation error: {validation_result.error}", fg="red")
+                click.echo("")
+                continue
+
+            if validation_result.warning:
+                click.secho(f"Warning: {validation_result.warning}", fg="yellow")
+
+            # Run detection rule tests
+            run_tests_response = scanner_client.detection_rule_yaml.run_tests(file)
+            results = run_tests_response.results.to_dict()
 
-            click.secho(f"{file}", bold=True)
             if len(results) == 0:
                 click.secho("No tests found", fg="yellow")
             else:
-                for name, status in response.results.to_dict().items():
+                for name, status in results.items():
                     if status == "Passed":
-                        click.echo(f"{name}: " + click.style("Passed", fg="green"))
+                        click.echo(f"{name}: " + click.style("OK", fg="green"))
                     else:
-                        any_failures = True
-                        click.echo(f"{name}: " + click.style("Failed", fg="red"))
-
-            click.echo("")
+                        any_test_failures = True
+                        click.echo(f"{name}: " + click.style("Test failed", fg="red"))
         except Exception as e:
-            any_failures = True
-            click.secho(f"{file}", bold=True)
-            click.secho(e, fg="red")
-            click.echo("")
+            any_test_failures = True
+            response = e.args[0]
+            click.secho(f"An exception occurred when attempting to run tests: {response.content}", fg="red")
 
-    if any_failures:
+        click.echo("")
+
+    error_messages = []
+    if any_validation_errors:
+        error_messages.append("Validation failed for one or more files. See https://docs.scanner.dev/scanner/using-scanner/beta-features/detection-rules-as-code/writing-detection-rules for requirements.")
+
+    if any_test_failures:
+        error_messages.append("`run-tests` failed for one or more files. See https://docs.scanner.dev/scanner/using-scanner/beta-features/detection-rules-as-code/cli#failing-tests for more information.")
+
+    if error_messages:
         # To make it so the CLI exits with a non-zero exit code
-        raise click.ClickException(
-            "run-tests failed for one or more files"
-        )
+        raise click.ClickException("\n".join(error_messages))
 
 
 @cli.command()

scanner_cli-0.1.0rc7.dist-info/RECORD

@@ -1,9 +0,0 @@
-src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/cli.py,sha256=z0MT8XdVjccgfYLhbkl2S4mjMiIqfG-LZzwnfVgJctM,7781
-src/migrate/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/migrate/elastic.py,sha256=y_cn_3Y_t8NHwYcpAQQLfnCkEBSULoU_vxxGwk47QAc,8681
-src/sync.py,sha256=WABCtvI6fpwXNJKo9lzafw3HkGYljpGjre5ywKnO0yA,7738
-scanner_cli-0.1.0rc7.dist-info/METADATA,sha256=bIzAcU3Dg2bt75c77WpdL6c1Y2CB7CgMvAUg7FNSLhY,5941
-scanner_cli-0.1.0rc7.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-scanner_cli-0.1.0rc7.dist-info/entry_points.txt,sha256=vqXMrIG6N6pY66bNf0y-gbUxbU8v5dXvuL3mV832Fh8,43
-scanner_cli-0.1.0rc7.dist-info/RECORD,,