Merge pull request #4439 from Ericsson/whisperity-refactor/script/lab…

…el-generator-tooling

Whisperity refactor/script/label generator tooling

scripts/labels/__init__.py

@@ -5,3 +5,31 @@
 #  SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #
 # -------------------------------------------------------------------------
+"""
+This library ships reusable components and user-facing tools to verify,
+generate, and adapt the checker labels in the CodeChecker configuration
+structure.
+"""
+# Load the interpreter injection first.
+from . import codechecker
+
+from . import \
+    checker_labels, \
+    exception, \
+    http_, \
+    output, \
+    projects, \
+    transformer, \
+    util
+
+
+__all__ = [
+    "checker_labels",
+    "codechecker",
+    "exception",
+    "http_",
+    "output",
+    "projects",
+    "transformer",
+    "util",
+]

scripts/labels/label_tool/__main__.py → scripts/labels/__main__.py

@@ -12,7 +12,9 @@
 
 
 try:
+    from .doc_url.generate_tool import __main__ as doc_url_generate
     from .doc_url.verify_tool import __main__ as doc_url_verify
+    from .severity.generate_tool import __main__ as severity_generate
 except ModuleNotFoundError as e:
     import traceback
     traceback.print_exc()
@@ -41,18 +43,20 @@ def args() -> argparse.ArgumentParser:
         dest="subcommand",
         required=True)
 
-    def add_subparser(command: str, package):
+    def add_subparser(package):
         subparser = subparsers.add_parser(
-            command,
+            list(globals().keys())[list(globals().values()).index(package)],
             prog=package.__package__,
             help=package.short_help,
             description=package.description,
             epilog=package.epilogue,
             formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-        subparser = package.args(subparser)
+        subparser = package.arg_parser(subparser)
         subparser.set_defaults(__main=package.main)
 
-    add_subparser("doc_url_verify", doc_url_verify)
+    add_subparser(doc_url_generate)
+    add_subparser(doc_url_verify)
+    add_subparser(severity_generate)
 
     return parser
 

scripts/labels/label_tool/checker_labels.py → scripts/labels/checker_labels.py

@@ -43,7 +43,7 @@ def _load_json(path: pathlib.Path) -> Dict:
 def _save_json(path: pathlib.Path, data: Dict):
     try:
         with path.open("w") as file:
-            json.dump(data, file, indent=2)
+            json.dump(data, file, indent=2, sort_keys=True)
             file.write('\n')
     except OSError:
         import traceback
@@ -128,7 +128,14 @@ def update_checker_labels(analyser: str,
     label_indices = {checker: indices[0] if len(indices) == 1 else None
                      for checker, indices in label_indices.items()}
     for checker, new_label in updates.items():
-        checker_labels = label_cfg[checker]
+        try:
+            checker_labels = label_cfg[checker]
+        except KeyError:
+            label_cfg[checker] = []
+            label_indices[checker] = None
+
+            checker_labels = label_cfg[checker]
+
         idx = label_indices[checker]
         e = f"{key}:{new_label}"
         if idx is not None:

scripts/labels/label_tool/codechecker.py → scripts/labels/codechecker.py

@@ -21,22 +21,28 @@ def codechecker_src_root() -> Optional[pathlib.Path]:
     """
     try:
         this_file = pathlib.Path(__file__).resolve(strict=True)
-        labels_idx = find_if(this_file.parents,
-                             lambda p: p.stem == "labels")
-        if not labels_idx:
+        scripts_idx = find_if(this_file.parents,
+                              lambda p: p.stem == "scripts")
+        if not scripts_idx:
             return None
-
-        if this_file.parents[labels_idx + 1].stem == "scripts":
-            return this_file.parents[labels_idx + 2]
-
-        return None
+        return this_file.parents[scripts_idx + 1]
     except Exception:
         import traceback
         traceback.print_exc()
 
         return None
 
 
+def default_checker_label_dir() -> Optional[pathlib.Path]:
+    """
+    Returns the directory where the configuration labels for checkers are
+    stored.
+    """
+    codechecker_root = codechecker_src_root()
+    return codechecker_root / "config" / "labels" / "analyzers" \
+        if codechecker_root else None
+
+
 def inject_codechecker_to_interpreter():
     """
     Adds the built CodeChecker package relative to the root of the working

scripts/labels/label_tool/doc_url/__init__.py → scripts/labels/doc_url/__init__.py

@@ -10,11 +10,13 @@
 configuration.
 """
 from . import \
+    generators, \
     output, \
     verifiers
 
 
 __all__ = [
+    "generators",
     "output",
     "verifiers",
 ]

scripts/labels/doc_url/generate_tool/__init__.py

@@ -0,0 +1,17 @@
+#
+#  Part of the CodeChecker project, under the Apache License v2.0 with
+#  LLVM Exceptions. See LICENSE for license information.
+#  SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+#
+# -------------------------------------------------------------------------
+"""
+This subpackage implements logic that is primarily user-facing, as opposed to
+reusable library-like components.
+"""
+from . import \
+    tool
+
+
+__all__ = [
+    "tool",
+]