Manual Analysis Tooling (#147)

* Introduce CC toolchain

Without specifying a cc toolchain bazel autodetects the host toolchain.
This toolchain is not hermetic.
Using it is very unreliable.

* Introduce tooling for manual analysis

Introduces a tooling for guided manual analysis runs.

A manual analysis is scoped by a context.
Context are injected via providers.
We supply two providers that cover basic use cases.
Users may create their own providers for additional use cases.

The rule provides two targets, one to update and one to test.
If either the context or the analysis is modified the test will fail.
This prompts a user to update the analysis.
The analysis steps are defined in a yaml file.
Updating the analysis will interactively lead the user through the steps.

* Ignore JetBrains configs in VCS

* Integrate lobster

* Add justification support to decision and assertion steps

* Update analysis example

* Simplify path resolution

* Remove fallback Console UI

TTYs are common on all modern systems. No need to carry around legacy non-TTY support.

Removes the non-TTY support.

* Add infrastructure to test lobster provider

* Fix lobster status flip on results modification

* Fix typo and inconsistencies in example analysis

* Simplify import of Runfiles

* Update analysis example

* Fix path resolution for update step

Hardcoding _main leads to problems if used in submodules.

* Fix import

Match import pattern to other modules.

* Improve import of lobster

Using repository_rule makes the import more modern and supports bzlmod better.

* Harden results reader against malformed JSON

When results cannot be read, fail gracefully.

* Forward kwargs to internal rules

* Add readme for manual analysis tooling

* Fix documentation of context provider

* Add tool requirements

* Add architectural design

* Set codeowners for manual_analysis

* Fix copyright header in manual_analysis example

* Fix formatting in manual_analysis

* Add lobster dependency to integration tests

Dependencies are not available in the BCR.
Therefore, we use git_override to fetch them.

git_override only works in the root repository.
So we must duplicate it in the integration tests.

Author: LittleHuba

.bazelrc

@@ -5,6 +5,8 @@
 common --registry=https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/
 common --registry=https://bcr.bazel.build
 
+common --extra_toolchains=@score_gcc_x86_64_toolchain//:x86_64-linux
+
 build --java_language_version=17
 build --tool_java_language_version=17
 build --java_runtime_version=remotejdk_17

.github/CODEOWNERS

@@ -17,5 +17,6 @@
 # Syntax: https://help.github.com/articles/about-codeowners/
 
 /bazel/rules/rules_score/ @castler @hoe-jo @LittleHuba @limdor @ramceb
+/manual_analysis/ @castler @hoe-jo @LittleHuba @limdor @ramceb
 /plantuml/ @castler @hoe-jo @LittleHuba @limdor @ramceb
 /validation/ @castler @hoe-jo @LittleHuba @limdor @ramceb

.gitignore

@@ -6,5 +6,6 @@ bazel-*
 MODULE.bazel.lock
 external
 .vscode/
+.clwb/
 
 __pycache__

MODULE.bazel

@@ -34,6 +34,35 @@ bazel_dep(name = "bazel_skylib", version = "1.7.1")
 bazel_dep(name = "buildifier_prebuilt", version = "8.2.0.2")
 bazel_dep(name = "flatbuffers", version = "25.9.23")
 
+###############################################################################
+# CC Toolchain
+###############################################################################
+
+bazel_dep(name = "score_bazel_cpp_toolchains", version = "0.3.1", dev_dependency = True)
+
+score_gcc = use_extension("@score_bazel_cpp_toolchains//extensions:gcc.bzl", "gcc", dev_dependency = True)
+score_gcc.toolchain(
+    name = "score_gcc_x86_64_toolchain",
+    target_cpu = "x86_64",
+    target_os = "linux",
+    use_base_constraints_only = True,
+    use_default_package = True,
+    version = "12.2.0",
+)
+score_gcc.toolchain(
+    name = "score_qcc_x86_64_toolchain",
+    sdp_version = "8.0.0",
+    target_cpu = "x86_64",
+    target_os = "qnx",
+    use_default_package = True,
+    version = "12.2.0",
+)
+use_repo(
+    score_gcc,
+    "score_gcc_x86_64_toolchain",
+    "score_qcc_x86_64_toolchain",
+)
+
 ###############################################################################
 # Rust Toolchain
 ###############################################################################
@@ -167,3 +196,27 @@ register_toolchains(
 # Dev Dependencies (for testing)
 ###############################################################################
 bazel_dep(name = "score_docs_as_code", version = "3.0.1", dev_dependency = True)
+
+###############################################################################
+# Dependencies for Manual Analysis
+###############################################################################
+pip.parse(
+    hub_name = "manual_analysis_deps",
+    python_version = PYTHON_VERSION,
+    requirements_lock = "//manual_analysis:requirements.txt",
+)
+use_repo(pip, "manual_analysis_deps")
+
+bazel_dep(name = "trlc", version = "0.0.0")
+git_override(
+    module_name = "trlc",
+    commit = "c7750ebd0520996e05b9a9bc91eb6a4f62030f22",
+    remote = "https://github.com/bmw-software-engineering/trlc.git",
+)
+
+bazel_dep(name = "lobster", version = "0.0.0")
+git_override(
+    module_name = "lobster",
+    commit = "56881461f9d3fde2918d1731aa5937aaf64cd67c",
+    remote = "https://github.com/bmw-software-engineering/lobster.git",
+)

bazel/rules/rules_score/test/MODULE.bazel

@@ -67,3 +67,17 @@ local_path_override(
 register_toolchains(
     "//:score_toolchain",
 )
+
+bazel_dep(name = "trlc", version = "0.0.0")
+git_override(
+    module_name = "trlc",
+    commit = "c7750ebd0520996e05b9a9bc91eb6a4f62030f22",
+    remote = "https://github.com/bmw-software-engineering/trlc.git",
+)
+
+bazel_dep(name = "lobster", version = "0.0.0")
+git_override(
+    module_name = "lobster",
+    commit = "56881461f9d3fde2918d1731aa5937aaf64cd67c",
+    remote = "https://github.com/bmw-software-engineering/lobster.git",
+)

cr_checker/tests/MODULE.bazel

@@ -46,4 +46,18 @@ local_path_override(
     path = "../../",
 )
 
+bazel_dep(name = "trlc", version = "0.0.0")
+git_override(
+    module_name = "trlc",
+    commit = "c7750ebd0520996e05b9a9bc91eb6a4f62030f22",
+    remote = "https://github.com/bmw-software-engineering/trlc.git",
+)
+
+bazel_dep(name = "lobster", version = "0.0.0")
+git_override(
+    module_name = "lobster",
+    commit = "56881461f9d3fde2918d1731aa5937aaf64cd67c",
+    remote = "https://github.com/bmw-software-engineering/lobster.git",
+)
+
 # end Tests