fixed tests, updated docs image

blacklanternsecurity · Sep 18, 2023 · 9c6c490 · 9c6c490
1 parent 5847e2b
commit 9c6c490
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/bbot/modules/output/json.py b/bbot/modules/output/json.py
@@ -6,7 +6,7 @@
 
 class JSON(BaseOutputModule):
     watched_events = ["*"]
-    meta = {"description": "Output to NDJSON"}
+    meta = {"description": "Output to Newline-Delimited JSON (NDJSON)"}
     options = {"output_file": "", "console": False}
     options_desc = {"output_file": "Output to file", "console": "Output to console"}
 
@@ -29,4 +29,4 @@ async def cleanup(self):
 
     async def report(self):
         if self._file is not None:
-            self.info(f"Saved NDJSON output to {self.output_file}")
+            self.info(f"Saved JSON output to {self.output_file}")
diff --git a/bbot/test/test_step_1/test_python_api.py b/bbot/test/test_step_1/test_python_api.py
@@ -31,7 +31,7 @@ async def test_python_api(bbot_config):
     assert "scan_logging_test" not in open(debug_log).read()
 
     scan_home = scan3.helpers.scans_dir / "scan_logging_test"
-    out_file = scan_home / "output.json"
+    out_file = scan_home / "output.ndjson"
     assert list(scan3.helpers.read_file(out_file))
     scan_log = scan_home / "scan.log"
     debug_log = scan_home / "debug.log"

diff --git a/docs/scanning/output.md b/docs/scanning/output.md
@@ -1,7 +1,7 @@
 # Output
 
 By default, BBOT saves its output in TXT, JSON, and CSV formats:
-![image](https://github.com/blacklanternsecurity/bbot/assets/20261699/779207f4-1c2f-4f65-a132-794ca8bd2f8a)
+![bbot output](https://github.com/blacklanternsecurity/bbot/assets/20261699/bb3da441-2682-408f-b955-19b268823b82)
 
 Every BBOT scan gets a unique and mildly-entertaining name like **`demonic_jimmy`**. Output for that scan, including scan stats and any web screenshots, etc., are saved to a folder by that name in `~/.bbot/scans`. The most recent 20 scans are kept, and older ones are removed. You can change the location of BBOT's output with `--output`, and you can also pick a custom scan name with `--name`.