scripts: docs: Remove replacement of username

Signed-off-by: John Andersen <[email protected]>

Author: pdxjohnny

docs/contributing/dev_env.rst

@@ -174,7 +174,7 @@ all the packages in development mode.
     $ mkdir -p .venv
     $ export HOME="${PWD}/.venv"
     $ export PATH="${HOME}/.local/bin:${PATH}"
-    $ pip install --user -U setuptools
+    $ pip install --user -U pip setuptools
     $ pip install --prefix=~/.local -e .[dev]
     $ dffml service dev install -user
 

scripts/docs.py

@@ -1,12 +1,13 @@
 # SPDX-License-Identifier: MIT
 # Copyright (c) 2019 Intel Corporation
 import os
-import getpass
+import pwd
 import inspect
 import argparse
 import importlib
-import pkg_resources
 import configparser
+import pkg_resources
+import unittest.mock
 from typing import List, Type
 
 
@@ -65,7 +66,7 @@ def data_type_string(data_type, nargs=None):
 def sanitize_default(default):
     if not isinstance(default, str):
         return sanitize_default(str(default))
-    return default.replace(getpass.getuser(), "user")
+    return default
 
 
 def build_args(config):
@@ -209,6 +210,12 @@ def gen_docs(
     )
 
 
+def fake_getpwuid(uid):
+    return pwd.struct_passwd(
+        ("user", "x", uid, uid, "", "/home/user", "/bin/bash",)
+    )
+
+
 def main():
     parser = argparse.ArgumentParser(description="Generate plugin docs")
     parser.add_argument("--entrypoint", help="Entrypoint to document")
@@ -226,26 +233,32 @@ def main():
     )
     args = parser.parse_args()
 
-    if getattr(args, "entrypoint", False) and getattr(args, "modules", False):
-        print(gen_docs(args.entrypoint, args.modules, args.maintenance))
-        return
-
-    with open(args.care, "rb") as genspec:
-        for line in genspec:
-            entrypoint, modules = line.decode("utf-8").split(maxsplit=1)
-            modules = modules.split()
-            template = entrypoint.replace(".", "_") + ".rst"
-            output = os.path.join("docs", "plugins", template)
-            template = os.path.join("scripts", "docs", "templates", template)
-            with open(template, "rb") as template_fd, open(
-                output, "wb"
-            ) as output_fd:
-                output_fd.write(
-                    (
-                        template_fd.read().decode("utf-8")
-                        + gen_docs(entrypoint, modules)
-                    ).encode("utf-8")
+    with unittest.mock.patch("pwd.getpwuid", new=fake_getpwuid):
+
+        if getattr(args, "entrypoint", False) and getattr(
+            args, "modules", False
+        ):
+            print(gen_docs(args.entrypoint, args.modules, args.maintenance))
+            return
+
+        with open(args.care, "rb") as genspec:
+            for line in genspec:
+                entrypoint, modules = line.decode("utf-8").split(maxsplit=1)
+                modules = modules.split()
+                template = entrypoint.replace(".", "_") + ".rst"
+                output = os.path.join("docs", "plugins", template)
+                template = os.path.join(
+                    "scripts", "docs", "templates", template
                 )
+                with open(template, "rb") as template_fd, open(
+                    output, "wb"
+                ) as output_fd:
+                    output_fd.write(
+                        (
+                            template_fd.read().decode("utf-8")
+                            + gen_docs(entrypoint, modules)
+                        ).encode("utf-8")
+                    )
 
 
 if __name__ == "__main__":