Skip to content

Remove roxcurl from roxie - #336

Merged
AlexVulaj merged 2 commits into
mainfrom
AlexVulaj/use-workflow-roxcurl
Nov 4, 2026
Merged

AlexVulaj merged 2 commits into
mainfrom
AlexVulaj/use-workflow-roxcurl

Conversation

@AlexVulaj

@AlexVulaj AlexVulaj commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Remove the legacy scripts/roxcurl helper and its container wrapper.
  • Remove the workflow downloads, extra packages, and Dockerfile setup used to bundle roxcurl.
  • Remove roxcurl references from the subshell banner and README.

Rationale

The roxie container targets users who want to deploy development versions of StackRox; roxcurl is an ACS engineering utility available from the stackrox/workflow repository. Bundling it added dependencies and maintenance without being an important container use case.

Verification

  • go test ./... - passed.

  • go test ./cmd - passed after the banner cleanup.

  • make docker-build - passed after removing roxcurl from the image.

  • Confirmed the built image retains roxctl and omits roxcurl:

    podman run --rm --entrypoint /bin/bash localhost/roxie:latest \
      -c 'command -v roxctl; if command -v roxcurl >/dev/null 2>&1; then echo "unexpected: roxcurl is installed"; exit 1; else echo "roxcurl is not installed"; fi'
    /usr/local/bin/roxctl
    roxcurl is not installed

@AlexVulaj AlexVulaj self-assigned this Nov 3, 2026
@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • Resume reviews
  • Trigger review

No actionable comments were generated in the recent review.

Walkthrough

The Docker image now downloads roxcurl and supporting files from a pinned StackRox workflow revision and installs a container-specific wrapper. The local helper script is removed. The README and shell banner identify the workflow source.

Changes: Workflow-provided roxcurl

Layer / File(s) Summary
Container helper installation and execution
Dockerfile, scripts/roxcurl, scripts/roxcurl-wrapper
The Docker image downloads the workflow helper and supporting files from a pinned revision. It installs a wrapper as /usr/local/bin/roxcurl and adds ncurses and which to the runtime packages. The wrapper checks terminal capabilities, supplies a password fallback under the specified conditions, and executes the downloaded helper. The local helper script is removed.
Workflow source guidance
README.md, cmd/subshell.go
The README describes native and container setup. The shell banner identifies the workflow repository as the source of the /v1/clusters example.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Refactor

Merge Risk: Minimal · previous review 1115a

No actionable merge-blocking risk was found in the workflow helper integration.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Title check Passed The title refers to the removal of roxie’s local roxcurl script, which is a real part of the change. It does not clearly state that the script is replaced by the StackRox workflow helper.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 1 functions across 1 files. (1 skipped: 1 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: stackrox/roxie
  • Branch: main
  • File: .coderabbit.yml
  • Commit: b5aa8ed
  • Layers: Repository YAML
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 8ffe4b13-7996-414d-a286-bdb868b96827
Commits

Reviewing files that changed from the base of the PR and between 51f190b and 1115aa0.

Files selected for processing: 1
  • scripts/roxcurl-wrapper

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 9 remain after this review.

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread Dockerfile Resolved
Comment thread Dockerfile Resolved

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread Dockerfile Resolved

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread scripts/roxcurl-wrapper Resolved
@AlexVulaj
AlexVulaj force-pushed the AlexVulaj/use-workflow-roxcurl branch from 1f8dc83 to 51f190b Compare November 3, 2026 19:21
@mclasmeier

Copy link
Copy Markdown
Collaborator

@AlexVulaj,
I know that I have suggested to use workflow's roxcurl, but I wasn't aware of how much it would take to integrate it (dependencies in the docker image, a custom wrapper). This is quite a lot IMHO for maybe little gain -- only for the docker image.
The idea behind the roxie docker image has been to enable non-engineers (e.g. product) to quickly spin up clusters with some dev versions of stackrox. I would actually expect that for this audience it would not be a particularly important use-case to have roxcurl available.

I am wondering, what do you think about just getting rid of roxcurl in the image? roxctl should stay, of course. But roxcurl seems like a dev-tool. Maybe it wouldn't be worth to jump through these loops.

@AlexVulaj
AlexVulaj force-pushed the AlexVulaj/use-workflow-roxcurl branch from 1ed711c to d8d1931 Compare November 4, 2026 14:27
@AlexVulaj AlexVulaj changed the title Use workflow roxcurl in the container image Remove roxcurl from roxie Nov 4, 2026
@AlexVulaj

Copy link
Copy Markdown
Contributor Author

@mclasmeier fully agree with that take, and I'm glad we went through the full song and dance of seeing what effort would be involved. I've reworked this entire PR to just remove roxcurl from roxie.

Comment thread cmd/subshell.go Resolved
@AlexVulaj
AlexVulaj enabled auto-merge (squash) November 4, 2026 14:50
@AlexVulaj
AlexVulaj merged commit bd7184a into main Nov 4, 2026
12 checks passed
@AlexVulaj
AlexVulaj deleted the AlexVulaj/use-workflow-roxcurl branch November 4, 2026 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants