scanner-cli 0.1.0rc4__py3-none-any.whl → 0.1.0rc5__py3-none-any.whl

{scanner_cli-0.1.0rc4.dist-info → scanner_cli-0.1.0rc5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scanner-cli
-Version: 0.1.0rc4
+Version: 0.1.0rc5
 Summary: Python command-line interface for Scanner API
 Author: Scanner, Inc.
 Author-email: support@scanner.dev
@@ -26,40 +26,40 @@ pip install scanner-cli
 ```
 
 You will need to provide the API URL of your Scanner instance and an API key. Go
-to *Settings > API Keys* to find your API URL and API key.
+to **Settings > API Keys** to find your API URL and API key.
 
 You can either set these values as environment variables:
 
 ```
-export SCANNER_API_URL=<your API URL>
-export SCANNER_API_KEY=<your API key>
+export SCANNER_API_URL=<Scanner API URL>
+export SCANNER_API_KEY=<Scanner API key>
 ```
 
 or provide them as arguments to the CLI:
 
 ```
-scanner-cli <command> --api-url=<your API url> --api-key=<your API key>
+scanner-cli <command> --api-url=<Scanner API URL> --api-key=<Scanner API key>
 ```
 
-### Commands
+## Commands
 
 Available commands are
 - `run-tests` - run tests on detection rules as code
 - `validate` - validate detection rules as code
 
-To validate or run tests on files
+To validate or run tests on files:
 
 ```
-scanner-cli <command> -f detections/src/errors.yaml -f detections/src/unauthorized_logins.yaml
+scanner-cli <command> -f detections/errors.yaml -f detections/unauthorized_logins.yaml
 ```
 
-To validate or run tests on directories
+To validate or run tests on directories:
 
 ```
-scanner-cli <command> -d detections/src
+scanner-cli <command> -d detections
 ```
 
-This will validate or run tests on all YAML files in the directory that have the correct schema header.
+This will only validate or run tests on YAML files with the correct schema header.
 
 A file or directory must be provided. Multiple files and/or directories can be provided.
 

scanner_cli-0.1.0rc5.dist-info/RECORD

@@ -0,0 +1,6 @@
+src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/cli.py,sha256=EPfmwoCBiSUKGBReXF5PENDFTWKb-eIAWZkiSNwmogY,5035
+scanner_cli-0.1.0rc5.dist-info/METADATA,sha256=Lng5KIO2L5pH2I6giDr_3qTlMfUAXdFPm2NY4Iew7vs,1600
+scanner_cli-0.1.0rc5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+scanner_cli-0.1.0rc5.dist-info/entry_points.txt,sha256=vqXMrIG6N6pY66bNf0y-gbUxbU8v5dXvuL3mV832Fh8,43
+scanner_cli-0.1.0rc5.dist-info/RECORD,,

src/cli.py

@@ -1,5 +1,6 @@
 """ Contains code for Python CLI """
 
+import glob
 import os
 from typing import Any, Callable
 
@@ -33,6 +34,14 @@ _CLICK_OPTIONS = [
         help="Directory to validate. Only .yml or .yaml files with the correct schema header will be validated.",
         multiple=True,
     ),
+    click.option(
+        "-r",
+        "recursive",
+        is_flag=True,
+        show_default=True,
+        default=False,
+        help="Recursively search directory for valid YAML files.",
+    ),
 ]
 
 
@@ -51,7 +60,7 @@ def _is_valid_file(file_path: str) -> bool:
         return False
 
 
-def _get_valid_files_in_directory(directory: str) -> list[str]:
+def _get_valid_files_in_directory(directory: str, recursive: bool) -> list[str]:
     if not os.path.exists(directory):
         raise click.exceptions.ClickException(
             message=(
@@ -59,14 +68,14 @@ def _get_valid_files_in_directory(directory: str) -> list[str]:
             )
         )
 
-    return [f"{directory}/{f}" for f in os.listdir(directory) if _is_valid_file(f"{directory}/{f}")]
+    return [f for f in glob.iglob(f"{directory}/**", recursive=recursive) if _is_valid_file(f)]
 
 
-def _get_valid_files(file_paths: str, directories: str) -> list[str]:
+def _get_valid_files(file_paths: str, directories: str, recursive: bool) -> list[str]:
     files = [f for f in file_paths if _is_valid_file(f)]
 
     for d in directories:
-        files.extend(_get_valid_files_in_directory(d))
+        files.extend(_get_valid_files_in_directory(d, recursive))
 
     return files
 
@@ -101,50 +110,59 @@ def cli():
 
 @cli.command()
 @_click_options
-def validate(api_url: str, api_key: str, file_paths: str, directories: str):
+def validate(api_url: str, api_key: str, file_paths: str, directories: str, recursive: bool):
     """ Validate detection rules """
     _validate_shared_options(api_url, api_key, file_paths, directories)
 
     scanner_client = Scanner(api_url, api_key)
 
-    files = _get_valid_files(file_paths, directories)
+    files = _get_valid_files(file_paths, directories, recursive)
     click.echo(f'Validating {len(files)} {"file" if len(files) == 1 else "files"}')
 
     for file in files:
-        result = scanner_client.detection_rule_yaml.validate(file)
+        try:
+            result = scanner_client.detection_rule_yaml.validate(file)
+
+            if result.is_valid:
+                click.echo(f"{file}: " + click.style("Valid", fg="green"))
+            else:
+                click.echo(f"{file}: " + click.style(f"{result.error}", fg="red"))
+        except Exception as e:
+            click.echo(f"{file}: " + click.style(e, fg="red"))
 
-        if result.is_valid:
-            click.echo(f"{file}: " + click.style("Valid", fg="green"))
-        else:
-            click.echo(f"{file}: " + click.style(f"{result.error}", fg="red"))
 
 
 @cli.command()
 @_click_options
-def run_tests(api_url: str, api_key: str, file_paths: str, directories: str):
+def run_tests(api_url: str, api_key: str, file_paths: str, directories: str, recursive: bool):
     """ Run detection rule tests """
     _validate_shared_options(api_url, api_key, file_paths, directories)
 
     scanner_client = Scanner(api_url, api_key)
 
-    files = _get_valid_files(file_paths, directories)
+    files = _get_valid_files(file_paths, directories, recursive)
     click.echo(f'Running tests on {len(files)} {"file" if len(files) == 1 else "files"}')
 
     for file in files:
-        response = scanner_client.detection_rule_yaml.run_tests(file)
-        results = 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():
-                if status == "Passed":
-                    click.echo(f"{name}: " + click.style("Passed", fg="green"))
-                else:
-                    click.echo(f"{name}: " + click.style("Failed", fg="red"))
-
-        click.echo("")
+        try:
+            response = scanner_client.detection_rule_yaml.run_tests(file)
+            results = 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():
+                    if status == "Passed":
+                        click.echo(f"{name}: " + click.style("Passed", fg="green"))
+                    else:
+                        click.echo(f"{name}: " + click.style("Failed", fg="red"))
+
+            click.echo("")
+        except Exception as e:
+            click.secho(f"{file}", bold=True)
+            click.secho(e, fg="red")
+            click.echo("")
 
 
 if __name__ == "__main__":

scanner_cli-0.1.0rc4.dist-info/RECORD

@@ -1,6 +0,0 @@
-src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/cli.py,sha256=Hv5WA0LfmqgkT-9BRqcyUz2h8uTPEeeLkiPl3iy7saw,4398
-scanner_cli-0.1.0rc4.dist-info/METADATA,sha256=ScPgaZo7ZYQV5Mecdf-eHthhbRtwHyGKJU9Gwk3-WYY,1618
-scanner_cli-0.1.0rc4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-scanner_cli-0.1.0rc4.dist-info/entry_points.txt,sha256=vqXMrIG6N6pY66bNf0y-gbUxbU8v5dXvuL3mV832Fh8,43
-scanner_cli-0.1.0rc4.dist-info/RECORD,,