[module api] Initial version by ramceb · Pull Request #95 · eclipse-score/tooling

ramceb · 2025-12-17T10:53:46Z

This commit introduces the initial implementation of the score_module
Bazel rules for handling SEOOC (Safety Element Out Of Context) modules.

Key additions:

Core rules in score_module.bzl and private/seooc.bzl
Test infrastructure with fixtures covering architecture design,
assumptions of use, component requirements, and safety analysis

masc2023

Why not follow process description, that will cover also other standards, Safety is based on Quality, and defined folder structures?

bazel/rules/score_module/docs/index.rst

bazel/rules/score_module/test/fixtures/architecture_design.rst

ramceb · 2025-12-18T16:23:57Z

Why not follow process description, that will cover also other standards, Safety is based on Quality, and defined folder structures?

The concept behind the module API is to enforce that modules follow the score processes.

AlexanderLanin

Very good start! I feel using baselibs as an example is not ideal. We should try to apply this to a component that has existing documentation.

AlexanderLanin · 2025-12-18T20:19:56Z

bazel/rules/score_module/docs/index.rst

+   safety_element_out_of_context(
+       name = "my_module",
+       assumptions_of_use = ":assumptions",
+       component_requirements = ":requirements",


That would be seooc_requirements... but since seeoc is redundant we can also just say requirements? But that again is confusing. Is it maybe assumed requirements? Or what is it? Probably a question for the process experts :)

IMHO, we have feature requirements and component requirements. Conceptually, its important that these requirements are verified with the targets from tests. So that we can compute a meaningful requirements coverage.

That would be seooc_requirements... but since seeoc is redundant we can also just say requirements? But that again is confusing. Is it maybe assumed requirements? Or what is it? Probably a question for the process experts :)

Process defines assumptions of use and requirementes, e.g.Platform
https://eclipse-score.github.io/score/main/requirements/index.html

AlexanderLanin · 2025-12-18T20:20:26Z

bazel/rules/score_module/docs/index.rst

+
+- ``name``: The name of the safety element module. Used as the base name
+  for all generated targets.
+- ``assumptions_of_use``: Label to a ``.rst`` or ``.md`` file containing the


I imagine that this may not be a single file. And what exactly is a file here? filegroup?

Valid point. Technically it can be anything which returns a SphinxDocsLibraryProvider, which of course can contain rst, md, svg files etc.

AlexanderLanin · 2025-12-18T20:21:40Z

bazel/rules/score_module/docs/index.rst

+  safety analysis, including FMEA, FMEDA, FTA, or other safety analysis
+  results as required by ISO 26262-9 clause 8. Documents hazard analysis and
+  safety measures.
+- ``implementations``: List of labels to Bazel targets representing the actual


bazel targets would be treated as transitive?! So why do we even need multiple labels here?

You are right. We could hide this behind a single target. But this is what the rule already does. The idea was a different one: Behind each of these targets is an api, provided to the user. E.g. the hdrs attribute of a cc_library provide the header files published by that library. We should also use this information to enhance the documentation with API docs generated from the code.

AlexanderLanin · 2025-12-18T20:22:28Z

bazel/rules/score_module/docs/index.rst

+  software implementation (cc_library, cc_binary, etc.) that realizes the
+  component requirements. This is the source code that implements the safety
+  functions as required by ISO 26262-6 clause 8.
+- ``tests``: List of labels to Bazel test targets (cc_test, py_test, etc.)


Remark for the future: we'll need to split this to slow tests and fast tests, or the old unit test and integration test split.

I agree. But then we should differentiate between "integration tests" and "unit tests" according to the test lavels.

AlexanderLanin · 2025-12-18T20:23:53Z

bazel/rules/score_module/docs/index.rst

+
+**Generated Targets:**
+
+This macro creates multiple targets automatically:


These are all docu related. Where are implementation and tests?

AlexanderLanin · 2025-12-18T20:40:20Z

bazel/rules/score_module/docs/index.rst

+- ``assumptions_of_use``: Label to a ``.rst`` or ``.md`` file containing the
+  Assumptions of Use, which define the safety-relevant operating conditions
+  and constraints for the SEooC as required by ISO 26262-10 clause 5.4.4.
+- ``component_requirements``: Label to a ``.rst`` or ``.md`` file containing


SEOOC would contain only safety requirements AFAIK. Do we want to include all requirements here?

Yes. A limitation to safety requirements does not make sense. The safety_element_out_of_context shall be a self contained unit.

Just to avoid here misunderstanding, Process covers NOT only Safety, also QM and Security, and we define here Modules, containing everything, Module can be seen as SEooC, but compare Handbook and Safety Plan, we do not deliver SEooC, there will be no safey argumentation, integrator can take it to make a SEooC out it.

https://eclipse-score.github.io/process_description/main/general_concepts/score_building_blocks_concept.html
https://eclipse-score.github.io/process_description/main/general_concepts/score_building_blocks_concept.html
https://eclipse-score.github.io/process_description/main/process_areas/safety_management/safety_management_workproducts.html#wp__platform_safety_package

So the basic naming is wrong here? It should not be "safety_element_out_of_context" but just "score_module"?

AlexanderLanin · 2025-12-18T20:45:53Z

bazel/rules/score_module/private/seooc.bzl

+    "assumptions_of_use": attr.label(
+        providers = [SphinxDocsLibraryInfo],
+        mandatory = True,
+        doc = "Label to a sphinx_docs_library target containing the Assumptions of Use, which define the safety-relevant operating conditions and constraints for the SEooC as required by ISO 26262-10 clause 5.4.4.",


Ah, this doesn't quite match docu where it says this needs to point to an rst/md file.

Fair. the documentation needs to be updated.

AlexanderLanin · 2025-12-18T20:47:38Z

bazel/rules/score_module/private/seooc.bzl

+    all_files = []
+    for artifact in seooc_artifacts:
+        dep = getattr(ctx.attr, artifact)
+        for t in dep[SphinxDocsLibraryInfo].transitive.to_list():


This assembles all the artifacts into a standard file structure. So I have wo wonder, whether it would be easier to collect only a single SphinxDocsLibraryInfo, instead of collecting multiple and internally assembling a single one.

yes. This is intenionally like this. The rule shall provide an abstract api, which always provides you a valid SpinxDocsLibrary.

AlexanderLanin · 2025-12-18T20:59:40Z

bazel/rules/score_module/private/seooc.bzl

+        mandatory = True,
+        doc = "Label to a sphinx_docs_library target containing the safety analysis, including FMEA, FMEDA, FTA, or other safety analysis results as required by ISO 26262-9 clause 8. Documents hazard analysis and safety measures.",
+    ),
+}


Having everything in separate SphinxDocsLibraryInfo targets means the generated index file will differ from the original index file. So module docu will look different than seeoc docu of the same module. Correct?

AlexanderLanin · 2025-12-18T21:07:26Z

bazel/rules/score_module/test/BUILD

+package(default_visibility = ["//visibility:public"])
+
+# Test fixtures for seooc tests
+sphinx_docs_library(


This would currently only provide the raw .rst files? Specifically no prebuild json data?

ramceb

Very good start! I feel using baselibs as an example is not ideal. We should try to apply this to a component that has existing documentation.

Thx. Baselibs was chosen on purpose as it provides several seoocs. Anyhow, we can also use any other module, which comes with more documentation in the module repository. Any suggestions?

masc2023 · 2025-12-19T07:13:32Z

Very good start! I feel using baselibs as an example is not ideal. We should try to apply this to a component that has existing documentation.

Thx. Baselibs was chosen on purpose as it provides several seoocs. Anyhow, we can also use any other module, which comes with more documentation in the module repository. Any suggestions?

Persistency?

ramceb · 2026-01-19T12:20:34Z

@AlexanderLanin and @masc2023 Sorry for the delay. I (force) pushed a second commit and took most of you comments into account. Main change is that we are now able to do modular sphinx builds. So when you build a score_module bazel will cache the generated html files of dependent modules and merge the files later into the html tree of the root module. This way link resolution works and you get always a complete set of html files with all submodules.

So there is now a generic score_module and a more specific safety_element_out_of_context, which enforces a common format for documenation. We can discuss if we want to enforce this or not.
Hope we can iterate faster now.

bazel/rules/score_module/private/score_component.bzl

bazel/rules/rules_score/test/fixtures/seooc_test/architectural_design.rst

bazel/rules/rules_score/test/fixtures/seooc_test/assumptions_of_use.rst

bazel/rules/rules_score/test/fixtures/seooc_test/dependability_analysis.rst

MODULE.bazel

ramceb

Example based on persistency is here: eclipse-score/persistency#235

attifunel · 2026-01-29T08:47:39Z

bazel/rules/rules_score/private/dependability_analysis.bzl

+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
+"""


I suggest to change into "Safety analyses" as both DFA & FMEAs fall into this naming in ISO 26262. FMEA is not (only) a dependability analysis.

Propose to keep it, later with add also security analyses, so dependable is the abstraction of both

FScholPer

blocked by eclipse-score/score#2346

This commit introduces the initial implementation of the score_module Bazel rules for handling SEOOC (Safety Element Out Of Context) modules. Key additions: - Core rules in score_module.bzl and private/seooc.bzl - Test infrastructure with fixtures covering architecture design, assumptions of use, component requirements, and safety analysis

Incorporated first feedback. Introduced a modular sphinx-build.

Parameter renaming

ramceb · 2026-02-03T08:58:58Z

blocked by eclipse-score/score#2346

@FScholPer Is this really a blocker. For the implementation it doesn't matter if in which repos the features live in.

hoe-jo · 2026-02-04T06:04:59Z

@FScholPer The PR was discussed in the process community and accepted for merge: https://github.com/orgs/eclipse-score/discussions/407#discussioncomment-15605348

Also the PR you mentioned was discussed but no blocker was identified here!

masc2023

As discussed initial version, fine for now, updates and fine tuning to be done in further PRs

masc2023 · 2026-02-04T06:12:25Z

bazel/rules/rules_score/private/dependability_analysis.bzl

+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
+"""


Propose to keep it, later with add also security analyses, so dependable is the abstraction of both

github-project-automation bot added this to INF - Infrastructure Community Dec 17, 2025

github-project-automation bot moved this to Draft in INF - Infrastructure Community Dec 17, 2025

ramceb force-pushed the mb_module_api branch from 9088c76 to a455217 Compare December 17, 2025 11:00

masc2023 requested changes Dec 17, 2025

View reviewed changes

bazel/rules/score_module/docs/index.rst Outdated Show resolved Hide resolved

bazel/rules/score_module/docs/index.rst Outdated Show resolved Hide resolved

masc2023 reviewed Dec 17, 2025

View reviewed changes

bazel/rules/score_module/test/fixtures/architecture_design.rst Outdated Show resolved Hide resolved

ramceb force-pushed the mb_module_api branch 2 times, most recently from 0f3a3f4 to 74365d5 Compare December 17, 2025 13:24

ramceb marked this pull request as draft December 17, 2025 13:24

ramceb force-pushed the mb_module_api branch 3 times, most recently from 8421a28 to ae85726 Compare December 17, 2025 13:54

ramceb force-pushed the mb_module_api branch from 1744747 to 04fe3f6 Compare December 18, 2025 16:25

AlexanderLanin reviewed Dec 18, 2025

View reviewed changes

ramceb commented Dec 19, 2025

View reviewed changes

ramceb force-pushed the mb_module_api branch 3 times, most recently from 3485763 to 267ddf8 Compare January 19, 2026 12:14

ramceb force-pushed the mb_module_api branch 3 times, most recently from a02bb9d to ebb600e Compare January 19, 2026 17:21

masc2023 reviewed Jan 20, 2026

View reviewed changes

bazel/rules/score_module/private/score_component.bzl Outdated Show resolved Hide resolved

masc2023 reviewed Jan 20, 2026

View reviewed changes

bazel/rules/rules_score/test/fixtures/seooc_test/architectural_design.rst Show resolved Hide resolved

masc2023 reviewed Jan 20, 2026

View reviewed changes

bazel/rules/rules_score/test/fixtures/seooc_test/assumptions_of_use.rst Show resolved Hide resolved

masc2023 reviewed Jan 20, 2026

View reviewed changes

bazel/rules/rules_score/test/fixtures/seooc_test/dependability_analysis.rst Show resolved Hide resolved

masc2023 reviewed Jan 20, 2026

View reviewed changes

bazel/rules/rules_score/test/fixtures/seooc_test/dependability_analysis.rst Show resolved Hide resolved

masc2023 reviewed Jan 20, 2026

View reviewed changes

MODULE.bazel Show resolved Hide resolved

masc2023 reviewed Jan 20, 2026

View reviewed changes

MODULE.bazel Show resolved Hide resolved

ramceb commented Jan 28, 2026

View reviewed changes

attifunel reviewed Jan 29, 2026

View reviewed changes

FScholPer requested changes Jan 30, 2026

View reviewed changes

anmittag mentioned this pull request Feb 2, 2026

Establish API documentation and live-cycle management: Additions to Stakeholder Requirements eclipse-score/score#876

Open

ramceb added 12 commits February 3, 2026 09:55

[Module API] Introduce build per module

640ee29

Incorporated first feedback. Introduced a modular sphinx-build.

Fix integration tests

da2cc72

Added artefact specific rules

1059f79

Add functionality to filter sphinx output

20e4558

switched from print to logger

159e742

Add fmea as attribute for dependability

978eede

Bugfix for relative references

ee3fe5b

Fixed formating issues

53db74a

Add links to submodule to index

a42a50c

refactoring acc. to naming convention.

7326dcd

Parameter renaming

Renamed to rules_score

e6aabb1

ramceb force-pushed the mb_module_api branch from 4797a28 to e6aabb1 Compare February 3, 2026 08:55

hoe-jo self-requested a review February 3, 2026 08:57

ramceb added 3 commits February 3, 2026 10:34

Updated documentation

9c34028

Removed backward compatible parameter

c34e061

Remove feature_requirements from ComponentRequirementsInfo

ffbd6ae

hoe-jo requested a review from FScholPer February 4, 2026 05:59

masc2023 approved these changes Feb 4, 2026

View reviewed changes

FScholPer approved these changes Feb 4, 2026

View reviewed changes

FScholPer merged commit e3b4f65 into main Feb 4, 2026
4 checks passed

FScholPer deleted the mb_module_api branch February 4, 2026 11:39

github-project-automation bot moved this from Draft to Done in INF - Infrastructure Community Feb 4, 2026

aschemmel-tech mentioned this pull request Feb 5, 2026

process: add DR-005 for independent feature delivery eclipse-score/score#2346

Open


		Generated Targets:

		This macro creates multiple targets automatically:

Conversation

ramceb commented Dec 17, 2025

Uh oh!

masc2023 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ramceb commented Dec 18, 2025

Uh oh!

AlexanderLanin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ramceb left a comment

Choose a reason for hiding this comment

Uh oh!

masc2023 commented Dec 19, 2025

Uh oh!

ramceb commented Jan 19, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ramceb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FScholPer left a comment

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Dec 18, 2025 •

edited

Loading

ramceb commented Feb 3, 2026 •

edited

Loading