-
Notifications
You must be signed in to change notification settings - Fork 23
[rules schore] refactor requirements #202
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
bazel/rules/rules_score/private/assumed_system_requirements.bzl
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| """ | ||
| Assumed System Requirements build rules for S-CORE projects. | ||
|
|
||
| Assumed System Requirements (ASR) are system-level requirements that represent | ||
| the assumptions a Safety Element out of Context (SEooC) makes about the system | ||
| it will be integrated into. Feature requirements are derived from them. | ||
| """ | ||
|
|
||
| load("@trlc//:trlc.bzl", "trlc_requirements_test") | ||
| load("//bazel/rules/rules_score/private:requirements.bzl", "score_requirements_rule") | ||
|
|
||
| # ============================================================================ | ||
| # Public Macro | ||
| # ============================================================================ | ||
|
|
||
| def assumed_system_requirements( | ||
| name, | ||
| srcs, | ||
| deps = [], | ||
| spec = Label("//bazel/rules/rules_score/trlc/config:score_requirements_model"), | ||
| ref_package = "", | ||
| visibility = None): | ||
| """Define Assumed System Requirements following S-CORE process guidelines. | ||
|
|
||
| Creates a target providing AssumedSystemRequirementsInfo, TrlcProviderInfo, | ||
| and SphinxSourcesInfo, plus a validation test target ``<name>_test``. | ||
|
|
||
| Because this target emits TrlcProviderInfo, downstream requirement targets | ||
| (e.g. feature_requirements) can reference it directly in their ``deps`` | ||
| without any intermediate trlc_requirements wrapper. | ||
|
|
||
| Args: | ||
| name: The name of the target. | ||
| srcs: List of .trlc source files containing AssumedSystemReq records as | ||
| defined in the S-CORE requirements model. | ||
| deps: Optional list of requirement targets whose TRLC records are needed | ||
| for cross-reference parsing. These targets must provide | ||
| TrlcProviderInfo. Typically empty for top-level system requirements. | ||
| spec: Optional TRLC specification target providing RSL type definitions. | ||
| Defaults to the S-CORE requirements model | ||
| (``@score_tooling//bazel/rules/rules_score/trlc/config:score_requirements_model``). | ||
| Override this when using a custom requirements model. | ||
| visibility: Bazel visibility specification for the generated targets. | ||
|
|
||
| Generated Targets: | ||
| <name>: Main target providing AssumedSystemRequirementsInfo, | ||
| TrlcProviderInfo, and SphinxSourcesInfo. | ||
| <name>_test: TRLC validation test (runs ``trlc --verify``). | ||
|
|
||
| Example: | ||
| ```starlark | ||
| assumed_system_requirements( | ||
| name = "asr", | ||
| srcs = ["assumed_system_requirements.trlc"], | ||
| ) | ||
|
|
||
| feature_requirements( | ||
| name = "feat_req", | ||
| srcs = ["feature_requirements.trlc"], | ||
| deps = [":asr"], | ||
| ) | ||
| ``` | ||
| """ | ||
| score_requirements_rule( | ||
| name = name, | ||
| srcs = srcs, | ||
| deps = deps, | ||
| req_kind = "assumed_system", | ||
| lobster_config = Label("//bazel/rules/rules_score/lobster/config:assumed_system_requirement"), | ||
| spec = spec, | ||
| ref_package = ref_package, | ||
| visibility = visibility, | ||
| ) | ||
| trlc_requirements_test( | ||
| name = name + "_test", | ||
| reqs = [":" + name], | ||
| visibility = visibility, | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should use **kwargs for these things...