Merge pull request #2464 from blacklanternsecurity/update-docs-script

Update automatic docs generation

Author: TheTechromancer

bbot/scanner/preset/path.py

@@ -18,7 +18,7 @@ def __init__(self):
         self.paths = [DEFAULT_PRESET_PATH]
 
     def find(self, filename):
-        filename_path = Path(filename).expanduser().resolve()
+        filename_path = Path(filename).expanduser()
         extension = filename_path.suffix.lower()
         file_candidates = set()
         extension_candidates = {".yaml", ".yml"}
@@ -39,7 +39,7 @@ def find(self, filename):
                     if file.is_file():
                         log.verbose(f'Found preset matching "{filename}" at {file}')
                         self.add_path(file.parent)
-                        return file.resolve()
+                        return file
         raise ValidationError(
             f'Could not find preset at "{filename}" - file does not exist. Use -lp to list available presets'
         )
@@ -61,7 +61,7 @@ def add_path(self, path):
             return
         # preemptively remove any paths that are subdirectories of the new path
         self.paths = [p for p in self.paths if not p.is_relative_to(path)]
-        self.paths.append(path)
+        self.paths.insert(0, path)
 
     def __iter__(self):
         yield from self.paths

bbot/scripts/docs.py

@@ -199,14 +199,16 @@ def update_individual_module_options():
 
     # BBOT presets
     for _, (loaded_preset, category, preset_path, original_filename) in DEFAULT_PRESET.all_presets.items():
+        str_category = "" if not category else f"/{category}"
+        filename = f"~/.bbot/presets{str_category}/{original_filename.name}"
         preset_yaml = f"""
-```yaml title={preset_path.name}
+```yaml title={filename}
 {loaded_preset._yaml_str}
 ```
 """
         preset_yaml_expandable = f"""
 <details>
-<summary><b><code>{preset_path.name}</code></b></summary>
+<summary><b><code>{original_filename.name}</code></b></summary>
 
 ```yaml
 {loaded_preset._yaml_str}
@@ -222,7 +224,8 @@ def update_individual_module_options():
         yaml_str = loaded_preset._yaml_str
         indent = " " * 4
         yaml_str = f"\n{indent}".join(yaml_str.splitlines())
-        filename = homedir_collapseuser(preset_path)
+        str_category = "" if not category else f"/{category}"
+        filename = f"~/.bbot/presets{str_category}/{original_filename.name}"
 
         num_modules = len(loaded_preset.scan_modules)
         modules = ", ".join(sorted([f"`{m}`" for m in loaded_preset.scan_modules]))
@@ -233,7 +236,7 @@ def update_individual_module_options():
 
 {loaded_preset.description}
 
-??? note "`{filename.name}`"
+??? note "`{original_filename.name}`"
     ```yaml title="{filename}"
     {yaml_str}
     ```