Skip to content

SREP-1107: Added a new 'managed-scripts' subcommand to osdctl promote#855

Draft
Nikokolas3270 wants to merge 1 commit intoopenshift:masterfrom
Nikokolas3270:SREP-1107
Draft

SREP-1107: Added a new 'managed-scripts' subcommand to osdctl promote#855
Nikokolas3270 wants to merge 1 commit intoopenshift:masterfrom
Nikokolas3270:SREP-1107

Conversation

@Nikokolas3270
Copy link
Contributor

@Nikokolas3270 Nikokolas3270 commented Feb 25, 2026

This also contains the following changes:

  • 'pko' promote subcommand removed as it was no longer applying to any saas file
  • '--osd' and '--hcp' options removed as a there is no service which could be both hcp and osd
  • Now exclusively using 'sigs.k8s.io/kustomize/kyaml' as both a YAML parser & marshaller as 'gopkg.in/yaml.v3' is no longer supported
  • Now interacting with Git repo with 'github.com/go-git/go-git/v6' lib rather than running shell commands
  • Code has been factorized

Summary by CodeRabbit

Release Notes

  • New Features

    • Added new osdctl promote managedscripts command for promoting managed-scripts repository commits
  • Improvements

    • Refactored promotion system to use registry-based service discovery for more reliable configuration lookup
    • Enhanced commit messages with monitoring links and test log references
    • Improved error handling and control flow across promotion workflows
  • Removed

    • Removed osdctl promote package command
    • Consolidated OSD/HCP flag behavior into unified promotion flow

This also contains the following changes:
- 'pko' promote subcommand removed as it was no longer applying to any saas file
- '--osd' and '--hcp' options removed as a there is no service which could be both hcp and osd
- Now exclusively using 'sigs.k8s.io/kustomize/kyaml' as both a YAML parser & marshaller as  'gopkg.in/yaml.v3' is no longer supported
- Now interacting with Git repo with 'github.com/go-git/go-git/v6' lib rather than running shell commands
- Code has been factorized
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Feb 25, 2026
@openshift-ci-robot
Copy link

openshift-ci-robot commented Feb 25, 2026

@Nikokolas3270: This pull request references SREP-1107 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

This also contains the following changes:

  • 'pko' promote subcommand removed as it was no longer applying to any saas file
  • '--osd' and '--hcp' options removed as a there is no service which could be both hcp and osd
  • Now exclusively using 'sigs.k8s.io/kustomize/kyaml' as both a YAML parser & marshaller as 'gopkg.in/yaml.v3' is no longer supported
  • Now interacting with Git repo with 'github.com/go-git/go-git/v6' lib rather than running shell commands
  • Code has been factorized

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@coderabbitai
Copy link

coderabbitai bot commented Feb 25, 2026

Walkthrough

The promote command is refactored to replace git-based app-interface operations with a registry-driven service discovery approach. The PKO subcommand is removed and replaced with ManagedScripts. New utility packages provide callback-based service promotion workflows via YAML-based configurations. Related Dynatrace, SaaS, and path utilities are updated or removed accordingly.

Changes

Cohort / File(s) Summary
Command Wiring
cmd/promote/cmd.go
PKO subcommand import and registration replaced with ManagedScripts subcommand.
Core Git/App-Interface Removal
cmd/promote/git/app_interface.go, cmd/promote/git/app_interface_test.go, cmd/promote/git/service_repo.go, cmd/promote/git/service_repo_test.go
Entire git-based app-interface abstraction deleted, including Service, AppInterface types, bootstrap logic, YAML parsing, git operations, and corresponding test suites.
Dynatrace Promotion Refactor
cmd/promote/dynatrace/dynatrace.go, cmd/promote/dynatrace/dt_utils.go, cmd/promote/dynatrace/utils_test.go
Migrated from git-based to registry-driven service discovery. Replaced YAML unmarshalling with kyaml traversal. Added listServiceIds and GetModulesNames (renamed from GeModulesNames). Removed GetServiceNames, GetSaasDir, and related git-dependent functions. Updated command to use RunE with error returns.
SaaS Promotion Refactor
cmd/promote/saas/saas.go, cmd/promote/saas/utils.go, cmd/promote/saas/utils_test.go
Replaced hard-coded flags (osd/hcp) with registry-based service lookup. Removed 372 lines of service enumeration, test log generation, and hotfix utilities. Added promoteCallbacks type, validateSaasServiceFilePath, and E2E service name helpers. Enhanced command wiring to use service registry.
PKO Command Removal
cmd/promote/pko/pko.go
Entire PKO promotion command deleted, including NewCmdPKO, pkoOptions validation, and PromotePackage workflow.
ManagedScripts New Command
cmd/promote/managedscripts/managed_scripts.go
New Cobra-based command for promoting managed-scripts repository with flags for gitHash, namespaceRef, and appInterfaceDir. Implements promoteCallbacks for resource template promotion.
Test Removal
cmd/promote/pathutil/pathutil_test.go
Removed entire test suite for path derivation utilities (DeriveAppYmlPath, deriveFromSaasPath, searchFilesystem).
New Utility Packages
cmd/promote/utils/app_interface_clone.go, cmd/promote/utils/git_repo.go, cmd/promote/utils/service.go, cmd/promote/utils/services_registry.go
Added 729 lines of utilities for registry-driven service discovery and promotion. Includes AppInterfaceClone for local repo management, Repo for in-memory git operations, Service/Application/CodeComponent models for YAML-based promotion, and ServicesRegistry for service enumeration.
Documentation
docs/README.md, docs/osdctl_promote.md, docs/osdctl_promote_managedscripts.md, docs/osdctl_promote_saas.md
Updated promote command documentation: renamed package command to managedscripts with new flags. Updated SaaS documentation to remove --osd/--hcp flags and rename --serviceName to --serviceId. Added new managedscripts command documentation.
Dependency Updates
go.mod
Added github.com/go-git/go-git/v6 and related transitive dependencies for in-memory git operations and repository handling.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Test Structure And Quality ⚠️ Warning Pull request deletes 1,777 lines of tests while adding 824 lines of untested production code across five new files with no corresponding test files. Create comprehensive test files for all new utilities following table-driven test patterns with proper setup/cleanup, error paths, edge cases, and meaningful assertions.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main change: adding a new 'managed-scripts' subcommand to the promote command.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Stable And Deterministic Test Names ✅ Passed No dynamic test names containing generated IDs, timestamps, pod names, UUIDs, or other non-deterministic values were found in any test files. All test cases use static, stable test descriptions.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 25, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Nikokolas3270

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 25, 2026
@Nikokolas3270 Nikokolas3270 marked this pull request as draft February 25, 2026 09:20
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 25, 2026
@openshift-ci-robot
Copy link

openshift-ci-robot commented Feb 25, 2026

@Nikokolas3270: This pull request references SREP-1107 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

This also contains the following changes:

  • 'pko' promote subcommand removed as it was no longer applying to any saas file
  • '--osd' and '--hcp' options removed as a there is no service which could be both hcp and osd
  • Now exclusively using 'sigs.k8s.io/kustomize/kyaml' as both a YAML parser & marshaller as 'gopkg.in/yaml.v3' is no longer supported
  • Now interacting with Git repo with 'github.com/go-git/go-git/v6' lib rather than running shell commands
  • Code has been factorized

Summary by CodeRabbit

Release Notes

  • New Features

  • Added new osdctl promote managedscripts command for promoting managed-scripts repository commits

  • Improvements

  • Refactored promotion system to use registry-based service discovery for more reliable configuration lookup

  • Enhanced commit messages with monitoring links and test log references

  • Improved error handling and control flow across promotion workflows

  • Removed

  • Removed osdctl promote package command

  • Consolidated OSD/HCP flag behavior into unified promotion flow

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 14

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (3)
cmd/promote/dynatrace/dt_utils.go (2)

175-178: ⚠️ Potential issue | 🟠 Major

Return immediately when opening the file fails.

The current flow logs the error and continues, which can pass an invalid file handle into downstream processing.

Proposed fix
 	file, err := Open(filename)
 	if err != nil {
-		fmt.Println(err)
+		return fmt.Errorf("failed to open file '%s': %w", filename, err)
 	}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@cmd/promote/dynatrace/dt_utils.go` around lines 175 - 178, The Open(filename)
call currently prints the error and continues, which can pass an invalid file
handle into downstream code; update the error handling at the Open(...) site so
that on err you return the error (or otherwise abort the function) instead of
just fmt.Println(err). Locate the Open(filename) invocation in dt_utils.go and
modify the surrounding function to propagate the error (or call return)
immediately when err != nil, ensuring downstream code does not receive a
nil/invalid file handle.

142-153: ⚠️ Potential issue | 🟠 Major

Propagate os.ReadDir failures instead of discarding them.

Read errors are currently ignored at multiple levels, so the promotion can incorrectly continue as if files were scanned successfully.

Proposed fix
-	items, _ := os.ReadDir(dir)
+	items, err := os.ReadDir(dir)
+	if err != nil {
+		return "", fmt.Errorf("failed to read directory '%s': %w", dir, err)
+	}
...
-			subitems, _ := os.ReadDir(subDir)
+			subitems, err := os.ReadDir(subDir)
+			if err != nil {
+				return "", fmt.Errorf("failed to read directory '%s': %w", subDir, err)
+			}
...
-					subitems2, _ := os.ReadDir(subDir2)
+					subitems2, err := os.ReadDir(subDir2)
+					if err != nil {
+						return "", fmt.Errorf("failed to read directory '%s': %w", subDir2, err)
+					}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@cmd/promote/dynatrace/dt_utils.go` around lines 142 - 153, The os.ReadDir
calls in the nested directory walk (the reads that populate items, subitems and
subitems2) currently ignore their returned errors; change each call to capture
the error (e.g., items, err := os.ReadDir(dir)) and propagate it instead of
discarding it—return the error (or wrap and return) from the enclosing function
(the directory-walking function in dt_utils.go) so failures stop the promotion;
do the same for subitems and subitems2 reads and adjust calling code to handle
the returned error.
cmd/promote/dynatrace/dynatrace.go (1)

73-74: ⚠️ Potential issue | 🟠 Major

Don’t ignore list errors before successful exit.

Both list branches discard the returned error and then exit with success, which can hide real failures from users and automation.

Proposed fix
-					_ = listDynatraceModuleNames(dynatraceConfig)
-					os.Exit(0)
+					if err := listDynatraceModuleNames(dynatraceConfig); err != nil {
+						return fmt.Errorf("failed to list dynatrace modules: %w", err)
+					}
+					return nil
...
-					_ = listServiceIds(servicesRegistry)
-					os.Exit(0)
+					if err := listServiceIds(servicesRegistry); err != nil {
+						return fmt.Errorf("failed to list dynatrace components: %w", err)
+					}
+					return nil

Also applies to: 117-118

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@cmd/promote/dynatrace/dynatrace.go` around lines 73 - 74, The calls to
listDynatraceModuleNames currently discard the returned error and then call
os.Exit(0); change both call sites to capture the error (e.g., err :=
listDynatraceModuleNames(dynatraceConfig)), check if err != nil, print or log
the error to stderr (or use the existing logger) and call os.Exit(1); if no
error, then exit with success. This ensures failures from
listDynatraceModuleNames are surfaced instead of being silently ignored.
🧹 Nitpick comments (5)
cmd/promote/dynatrace/dt_utils.go (1)

108-124: Reset module caches in GetModulesNames before repopulating.

ModulesSlice and ModulesFilesMap are package globals and currently accumulate across repeated calls.

Proposed fix
 func GetModulesNames(baseDir, dir string) ([]string, error) {
+	ModulesSlice = ModulesSlice[:0]
+	ModulesFilesMap = map[string]string{}
+
 	dirGlob := filepath.Join(baseDir, dir)
 	filepaths, err := os.ReadDir(dirGlob)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@cmd/promote/dynatrace/dt_utils.go` around lines 108 - 124, GetModulesNames
currently appends to package globals ModulesSlice and ModulesFilesMap on each
call; modify GetModulesNames to reset/clear ModulesSlice and reinitialize or
clear ModulesFilesMap at the start of the function (before reading dir entries)
so repeated calls don't accumulate stale data; locate the function
GetModulesNames and add logic to set ModulesSlice = nil (or empty slice) and
ModulesFilesMap = make(map[string]string) (or clear existing entries) before
populating them.
cmd/promote/utils/service.go (4)

42-44: Inconsistent receiver name on yamlDoc.

GetFilePath (line 38) and Save (line 46) use d, but GetName uses s. Use a consistent receiver name across all methods of the same type.

Proposed fix
-func (s *yamlDoc) GetName() string {
-	return s.name
+func (d *yamlDoc) GetName() string {
+	return d.name
 }
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@cmd/promote/utils/service.go` around lines 42 - 44, The GetName method for
type yamlDoc uses an inconsistent receiver name `s`; change its receiver to `d`
to match the other methods on yamlDoc (e.g., GetFilePath and Save) so all
methods use the same receiver identifier; update the method signature for
GetName to use `d` and keep the body returning d.name.

413-419: Nit: unconventional blank line in error handling.

The blank line between the call on line 414 and the if err != nil on line 416 breaks the standard Go error-handling idiom. Consider removing it for consistency.

Proposed fix
 	if newHash == "" {
 		newHash, err = repo.GetHeadHash()
-
 		if err != nil {
 			return err
 		}
 	}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@cmd/promote/utils/service.go` around lines 413 - 419, Remove the extra blank
line in the error handling after calling repo.GetHeadHash so the idiomatic Go
pattern is preserved; specifically, in the block that assigns newHash (the call
to repo.GetHeadHash) and the subsequent if err != nil block, bring the if
directly under the call (no blank line) to keep the standard newHash, err :=
repo.GetHeadHash / if err != nil style used elsewhere.

296-330: Partial failure leaves committed state in the local branch.

Each resourceTemplatePromotion.promote call saves the YAML and commits independently (lines 307, 318). If a later promotion in the loop (line 428) fails, earlier promotions are already committed to the local branch. This is likely acceptable since the user must manually push, but consider documenting this behavior or logging a warning when a partial failure occurs so users know what's been committed.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@cmd/promote/utils/service.go` around lines 296 - 330, The promote function
(resourceTemplatePromotion.promote) commits each resource independently (uses
callbacks.SetTargetHash, service.Save, service.appInterfaceClone.Commit) which
can leave the local branch partially committed if a later promotion fails;
update the caller that loops over promotions (the code that invokes
resourceTemplatePromotion.promote) to track which promotions succeeded and, on
any subsequent error, emit a clear warning/log that lists the committed resource
relPaths and informs the user that the local branch contains partial commits
requiring manual push/revert; alternatively expose a boolean or error type from
promote indicating "committed" so the caller can build that list before logging
the warning.

21-21: Export the yamlDoc type to match its exported function.

ReadYamlDocFromFile is exported and used externally (e.g., cmd/promote/saas/saas.go:118), but it returns *yamlDoc, which is unexported. This violates Go conventions — external callers cannot declare variables of this type. Export yamlDoc as YamlDoc (or use the lowercase-exported pattern if intentional, but document it).

Additionally, the receiver names for yamlDoc methods are inconsistent: GetFilePath() and Save() use receiver d, while GetName() (line 42) uses receiver s. Standardize on a single receiver name like d.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@cmd/promote/utils/service.go` at line 21, The exported function
ReadYamlDocFromFile returns an unexported type yamlDoc which prevents external
callers from using its value; rename the type to exported YamlDoc (or change the
function to return an exported interface) and update all references accordingly
(including ReadYamlDocFromFile's return type and any uses in
cmd/promote/saas/saas.go). Also standardize method receiver names on that type:
change the GetName receiver from 's' to 'd' to match GetFilePath and Save so all
methods on yamlDoc/YamlDoc use a consistent receiver (d). Ensure you update any
imports/usages and tests to the new exported type name.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@cmd/promote/managedscripts/managed_scripts.go`:
- Around line 30-32: The FilterTargets method currently hardcodes
prodNamespaceRef when calling utils.FilterTargetsContainingNamespaceRef, so the
configured --namespaceRef value is ignored; update
promoteCallbacks.FilterTargets to pass the instance/configured namespace
reference (e.g., c.namespaceRef or the field that holds the CLI flag) into
utils.FilterTargetsContainingNamespaceRef instead of prodNamespaceRef, ensuring
the same change is applied where else prodNamespaceRef is used for target
selection so the runtime flag actually influences filtering.

In `@cmd/promote/saas/saas.go`:
- Line 234: Update the CLI help/example string to use the canonical flag
--serviceId instead of the legacy alias --serviceName: locate the usage text
that currently reads `osdctl promote saas --serviceName <service> --gitHash
<git-hash>` (in the promote command's help/usage output) and replace
`--serviceName` with `--serviceId`; ensure any adjacent help text or examples
referencing the legacy alias are also updated so the example consistently shows
`--serviceId <service>` with `--gitHash <git-hash>`.
- Around line 271-274: Add a fail-fast required check for ops.serviceId before
calling servicesRegistry.GetService to give a clearer error for promote mode:
validate that ops.serviceId is non-empty (e.g., at the start of the promote
handler or before the GetService call), and return a descriptive error if it's
empty (mentioning that --serviceId is required in promote mode). Update the code
path where servicesRegistry.GetService(ops.serviceId) is invoked (reference
ops.serviceId and the promote handler function) to perform this explicit check
and only call GetService when the value is present.
- Around line 38-43: The current logic returns the original filePath when
deploy.yaml is missing, which can register a directory as a service; change the
code to only return valid regular file paths: after checking subFilePath, also
verify that filePath itself is a regular file (use os.Stat(filePath) and
fileInfo.Mode().IsRegular()) before returning it, and if it's a directory or not
a regular file return an empty string (or an error sentinel) so the caller can
skip this SaaS entry; adjust callers of this helper to treat empty string as
"skip invalid entry".

In `@cmd/promote/utils/git_repo.go`:
- Around line 54-89: The code pre-marks commonAncestorCommit.Hash in
visitedHashes before traversal which allows walks that never actually reach
commonAncestorHash to succeed silently; modify the traversal in the function
containing queue, visitedHashes, commit.IsAncestor and the final sb.WriteString
branch so that you either do not pre-populate visitedHashes with
commonAncestorCommit.Hash or (preferably) add a post-traversal check that
verifies visitedHashes contains commonAncestorHash (or that you visited it
during traversal) and return an explicit error if it was not reached; use the
symbols visitedHashes, commonAncestorCommit / commonAncestorHash, queue,
commit.IsAncestor and the final return path to locate where to add the check.

In `@cmd/promote/utils/service.go`:
- Around line 212-229: The function FilterTargetsContainingNamespaceRef
currently uses strings.Contains(visitedNamespaceRef, namespaceRef) which allows
substring matches; change the check to a precise match (e.g., verify the path
ends with the expected segment or exact identifier) by replacing the contains
logic with a more strict comparison such as using strings.HasSuffix or parsing
visitedNamespaceRef into path segments and comparing the final segment to
namespaceRef (operate on visitedNamespaceRef and namespaceRef variables inside
FilterTargetsContainingNamespaceRef so only exact/segment matches are
considered).
- Around line 141-146: The code reads appRelFilePath from
yamlDoc.rootNode.GetString and directly uses
filepath.Join(appInterfaceClone.GetPath(), "data", appRelFilePath) before
calling readApplicationFromFile; sanitize appRelFilePath by running
filepath.Clean, reject absolute paths or any path that resolves outside the
intended base (e.g. contains ".." segments that escape the
appInterfaceClone.GetPath()/data directory), and construct the final path by
joining the cleaned relative path to appInterfaceClone.GetPath()/data then
verifying the resulting path has the base directory as a prefix before calling
readApplicationFromFile.
- Around line 389-394: Iterate deterministically over oldHashToTargetNodes by
collecting its keys into a slice, sorting that slice (using sort.Strings), and
then building resourceTemplatePromotions in the sorted order (instead of ranging
the map directly); update the import block to include "sort". Ensure the same
symbols are used: oldHashToTargetNodes, resourceTemplatePromotions,
resourceTemplatePromotion, and that downstream code that calls promote will now
see a stable commit order.

In `@cmd/promote/utils/services_registry.go`:
- Around line 19-33: The constructor NewServicesRegistry should guard against
nil inputs to avoid panics: at the start of the function check if
appInterfaceClone is nil and if so return a descriptive error (do not call
appInterfaceClone.GetPath()); also check if validateServiceFilePathCallback is
nil and return a descriptive error before invoking it later; update
callers/tests if necessary to pass non-nil values or to handle the returned
error from NewServicesRegistry.
- Around line 36-37: The code silently overwrites existing entries in the
serviceIdToFilePath map (variable serviceId) when scanning files; change the
insertion logic to fail fast on duplicates by checking if serviceId already
exists in serviceIdToFilePath and returning/propagating an error (or logging and
exiting) that includes the conflicting serviceId and both file paths (existing
value and serviceFilePath) so callers of the scanning function can handle the
failure instead of allowing silent overwrite.

In `@docs/osdctl_promote_managedscripts.md`:
- Around line 5-39: Add language identifiers to all fenced code blocks in
docs/osdctl_promote_managedscripts.md to satisfy MD040: mark the command usage
block as "text" (or "bash" if preferred), the example block as "bash", and both
options blocks (Options and Options inherited from parent commands) as "text".
Update the fences surrounding the snippets that contain "osdctl promote
managedscripts [flags]", the example starting with "# Promote managed-scripts
repo", the options list beginning with "--appInterfaceDir", and the inherited
options list beginning with "--as" to include the appropriate language tags.

In `@docs/osdctl_promote_saas.md`:
- Around line 22-30: The fenced code block showing CLI flags in the saas
promotion docs lacks a language identifier which triggers markdownlint MD040;
update the triple-backtick opening fence to include a language (e.g., ```text)
for the block containing the lines starting with "--appInterfaceDir" and ending
with "--serviceId" so the block is treated as plain text and the linter warning
is resolved.
- Line 17: The example for the CLI invocation uses the deprecated alias flag
--serviceName; update the example for the command osdctl promote saas to use the
canonical flag --serviceId instead (replace the --serviceName token with
--serviceId in the example line) so the documentation shows the current,
supported flag.

In `@docs/README.md`:
- Around line 3938-3940: Add a language identifier to the fenced code block that
contains the line "osdctl promote managedscripts [flags]" so markdownlint MD040
is satisfied; modify the opening fence from ``` to ```text (or ```bash) around
the block in README.md so it becomes ```text followed by the command and closing
``` to preserve formatting.

---

Outside diff comments:
In `@cmd/promote/dynatrace/dt_utils.go`:
- Around line 175-178: The Open(filename) call currently prints the error and
continues, which can pass an invalid file handle into downstream code; update
the error handling at the Open(...) site so that on err you return the error (or
otherwise abort the function) instead of just fmt.Println(err). Locate the
Open(filename) invocation in dt_utils.go and modify the surrounding function to
propagate the error (or call return) immediately when err != nil, ensuring
downstream code does not receive a nil/invalid file handle.
- Around line 142-153: The os.ReadDir calls in the nested directory walk (the
reads that populate items, subitems and subitems2) currently ignore their
returned errors; change each call to capture the error (e.g., items, err :=
os.ReadDir(dir)) and propagate it instead of discarding it—return the error (or
wrap and return) from the enclosing function (the directory-walking function in
dt_utils.go) so failures stop the promotion; do the same for subitems and
subitems2 reads and adjust calling code to handle the returned error.

In `@cmd/promote/dynatrace/dynatrace.go`:
- Around line 73-74: The calls to listDynatraceModuleNames currently discard the
returned error and then call os.Exit(0); change both call sites to capture the
error (e.g., err := listDynatraceModuleNames(dynatraceConfig)), check if err !=
nil, print or log the error to stderr (or use the existing logger) and call
os.Exit(1); if no error, then exit with success. This ensures failures from
listDynatraceModuleNames are surfaced instead of being silently ignored.

---

Nitpick comments:
In `@cmd/promote/dynatrace/dt_utils.go`:
- Around line 108-124: GetModulesNames currently appends to package globals
ModulesSlice and ModulesFilesMap on each call; modify GetModulesNames to
reset/clear ModulesSlice and reinitialize or clear ModulesFilesMap at the start
of the function (before reading dir entries) so repeated calls don't accumulate
stale data; locate the function GetModulesNames and add logic to set
ModulesSlice = nil (or empty slice) and ModulesFilesMap =
make(map[string]string) (or clear existing entries) before populating them.

In `@cmd/promote/utils/service.go`:
- Around line 42-44: The GetName method for type yamlDoc uses an inconsistent
receiver name `s`; change its receiver to `d` to match the other methods on
yamlDoc (e.g., GetFilePath and Save) so all methods use the same receiver
identifier; update the method signature for GetName to use `d` and keep the body
returning d.name.
- Around line 413-419: Remove the extra blank line in the error handling after
calling repo.GetHeadHash so the idiomatic Go pattern is preserved; specifically,
in the block that assigns newHash (the call to repo.GetHeadHash) and the
subsequent if err != nil block, bring the if directly under the call (no blank
line) to keep the standard newHash, err := repo.GetHeadHash / if err != nil
style used elsewhere.
- Around line 296-330: The promote function (resourceTemplatePromotion.promote)
commits each resource independently (uses callbacks.SetTargetHash, service.Save,
service.appInterfaceClone.Commit) which can leave the local branch partially
committed if a later promotion fails; update the caller that loops over
promotions (the code that invokes resourceTemplatePromotion.promote) to track
which promotions succeeded and, on any subsequent error, emit a clear
warning/log that lists the committed resource relPaths and informs the user that
the local branch contains partial commits requiring manual push/revert;
alternatively expose a boolean or error type from promote indicating "committed"
so the caller can build that list before logging the warning.
- Line 21: The exported function ReadYamlDocFromFile returns an unexported type
yamlDoc which prevents external callers from using its value; rename the type to
exported YamlDoc (or change the function to return an exported interface) and
update all references accordingly (including ReadYamlDocFromFile's return type
and any uses in cmd/promote/saas/saas.go). Also standardize method receiver
names on that type: change the GetName receiver from 's' to 'd' to match
GetFilePath and Save so all methods on yamlDoc/YamlDoc use a consistent receiver
(d). Ensure you update any imports/usages and tests to the new exported type
name.

ℹ️ Review info

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between ba2de78 and 90a34b6.

⛔ Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
📒 Files selected for processing (23)
  • cmd/promote/cmd.go
  • cmd/promote/dynatrace/dt_utils.go
  • cmd/promote/dynatrace/dynatrace.go
  • cmd/promote/dynatrace/utils_test.go
  • cmd/promote/git/app_interface.go
  • cmd/promote/git/app_interface_test.go
  • cmd/promote/git/service_repo.go
  • cmd/promote/git/service_repo_test.go
  • cmd/promote/managedscripts/managed_scripts.go
  • cmd/promote/pathutil/pathutil_test.go
  • cmd/promote/pko/pko.go
  • cmd/promote/saas/saas.go
  • cmd/promote/saas/utils.go
  • cmd/promote/saas/utils_test.go
  • cmd/promote/utils/app_interface_clone.go
  • cmd/promote/utils/git_repo.go
  • cmd/promote/utils/service.go
  • cmd/promote/utils/services_registry.go
  • docs/README.md
  • docs/osdctl_promote.md
  • docs/osdctl_promote_managedscripts.md
  • docs/osdctl_promote_saas.md
  • go.mod
💤 Files with no reviewable changes (8)
  • cmd/promote/pathutil/pathutil_test.go
  • cmd/promote/pko/pko.go
  • cmd/promote/saas/utils.go
  • cmd/promote/git/app_interface_test.go
  • cmd/promote/git/service_repo.go
  • cmd/promote/git/app_interface.go
  • cmd/promote/git/service_repo_test.go
  • cmd/promote/saas/utils_test.go

Copy link
Member

@MateSaary MateSaary left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The promotion command's code finally looks much better 😄 Added a few comments, aside from that;

  • There was decent test coverage for the command before which is now gone; would be nice to have it back but can also be done as a follow-up, we do already have a card for this in backlog: https://issues.redhat.com/browse/SREP-1278

  • it looks like pathutil/pathutil.go isn't being used anywhere now, so we could remove that orphaned code with this PR too

I tried to go through the coderabbit suggestions as well and commented/reacted to them based on whether or not they make sense 😄

func (a *AppInterfaceClone) Commit(commitMessage string) error {
addPattern := "."
if err := a.workTree.AddGlob(addPattern); err != nil {
return fmt.Errorf("failed to adds file to the git index : %v", err)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return fmt.Errorf("failed to adds file to the git index : %v", err)
return fmt.Errorf("failed to add files to the git index : %v", err)

osdctl promote dynatrace --terraform --module=<module-name>`,

Run: func(cmd *cobra.Command, args []string) {
RunE: func(cmd *cobra.Command, args []string) error {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This predates this refactor, but the os.Exit(1) calls here should probably be replaced with typical error handling otherwise the RunE won't error handle properly anyways

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your comment. I was hesitating between the 2 solutions (use RunE and return errors VS use Run and os.Exit(1)) and yeah I didn't finish to migrate back to the former solution.

} else {
fmt.Printf("%-*s (no specific path)\n", maxLen, service)
}
func validateDynatraceServiceFilePath(filePath string) string {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ServicesSlice and ServicesFilesMap are defined a few lines up, but they're not used anywhere anymore so it's safe to get rid of them 🙂

@Nikokolas3270
Copy link
Contributor Author

Nikokolas3270 commented Feb 26, 2026

The promotion command's code finally looks much better 😄 Added a few comments, aside from that;

Thanks :)

  • There was decent test coverage for the command before which is now gone; would be nice to have it back but can also be done as a follow-up, we do already have a card for this in backlog: https://issues.redhat.com/browse/SREP-1278
  • it looks like pathutil/pathutil.go isn't being used anywhere now, so we could remove that orphaned code with this PR too

True, I am still working on the unit-tests, no worries. I just wanted to have people a first look on that finally quite big change.

I tried to go through the coderabbit suggestions as well and commented/reacted to them based on whether or not they make sense 😄

Thanks! I will TAL as well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants