Skip to content

feat: #811 Add tracebility comments in Effective Set#1317

Open
KamalArya wants to merge 15 commits into
mainfrom
feature/es-trace-new
Open

feat: #811 Add tracebility comments in Effective Set#1317
KamalArya wants to merge 15 commits into
mainfrom
feature/es-trace-new

Conversation

@KamalArya
Copy link
Copy Markdown
Collaborator

@KamalArya KamalArya commented May 11, 2026

Pull Request

Summary

To make it clear where each parameter in the Effective Set comes from, comments should be added next to every value showing its source.

Issue

Fixes #811

Breaking Change?

  • Yes
  • No

If yes, describe the breaking change and its impact (e.g., API changes, behavior changes, or required updates for users).

Scope / Project

effective set

Implementation Notes

This change is aimed at adding traceability support in the effective set:
Issue: #811
Documentation: https://github.com/Netcracker/qubership-envgene/blob/main/docs/features/calculator-cli.md#version-20-traceability-comments
Approach:

The Parameter object passed during YAML dumping is unwrapped, and origin details are added as comments based on conditions.

Implemented custom representer for Parameter class.

Tests / Evidence

Describe how the changes were verified, including:

  • Tests added or updated (e.g., unit, integration, end-to-end)
  • Manual testing steps or results
  • Screenshots, logs, or other evidence (if applicable)

Additional Notes

As comments are added to generated credentials.yaml file as well inside effective set, the comment were getting encrypted during SOPS encryption.

Applied fix: switch effective-set credential files only to --encrypted-regex='.*'.
Concretely, surgical change in sops_handler.py and the pre-commit crypt.py:

function get_sops_scope_flag(file_path):
if file_path matches "/effective-set/<...>/credentials.ya?ml"
and filename != "external-credentials.ya?ml":
scope = '--encrypted-regex "."'
else:
scope = '--unencrypted-regex "^type$"' # current behavior, unchanged

function encrypt(file_path, age_public_key):
scope_flag = get_sops_scope_flag(file_path)
run: sops --encrypt --age <age_public_key> <scope_flag> <file_path>

There are changes in internal envgene repository as well

@KamalArya KamalArya changed the title Feature/es trace new feat: #811 Add tracebility comments in Effective Set #1087 May 11, 2026
@KamalArya KamalArya force-pushed the feature/es-trace-new branch 4 times, most recently from 47c7e7f to f85e46b Compare May 12, 2026 09:47
@KamalArya KamalArya marked this pull request as ready for review May 12, 2026 12:42
@KamalArya KamalArya changed the title feat: #811 Add tracebility comments in Effective Set #1087 feat: #811 Add tracebility comments in Effective Set May 13, 2026
@KamalArya KamalArya force-pushed the feature/es-trace-new branch 13 times, most recently from 2303461 to c9188ae Compare May 21, 2026 11:19
@KamalArya KamalArya force-pushed the feature/es-trace-new branch 5 times, most recently from 161e13c to f3a8bee Compare May 21, 2026 13:16
@KamalArya KamalArya force-pushed the feature/es-trace-new branch 11 times, most recently from b8155d0 to be79103 Compare May 25, 2026 06:22
@KamalArya KamalArya marked this pull request as ready for review May 25, 2026 06:23
@KamalArya KamalArya force-pushed the feature/es-trace-new branch 2 times, most recently from dac7fa5 to 2c387b7 Compare May 25, 2026 12:34
@KamalArya KamalArya force-pushed the feature/es-trace-new branch from 2c387b7 to f3ab24a Compare May 25, 2026 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant