Fix issue where run command fails when runner workload has ENV but original workload does not

[rafaelgomesxyz]

New spec is passing.

Summary by CodeRabbit

• Bug Fixes

  • Resolved an issue with the run command failing when environment variables differ between workloads, enhancing command robustness.

• Tests

  • Expanded test coverage for the command-line runner to validate behavior when environment variables are set for the runner workload but not for the original workload.

[coderabbitai]

Walkthrough

The changes introduce a fix for the run command functionality, enhancing error handling and completion logic in the base.rb file. The update ensures better management of environment variables in the run.rb file, while the test suite in run_spec.rb expands coverage for scenarios with mismatched environment settings. The modifications streamline control flow and increase robustness during command execution.

Changes

File	Change Summary
CHANGELOG.md	Added entry documenting a fix for run command related to environment variables.
lib/.../base.rb	Removed step_error and integrated logic into step_finish, which now includes an abort_on_error parameter.
lib/.../run.rb	Updated update_runner_workload to assign container_spec["env"] with a fallback to an empty array if nil.
spec/.../run_spec.rb	Introduced new test context for scenarios with environment variables in runner workloads; enhanced coverage and validation.

Sequence Diagram(s)

sequenceDiagram
    participant Runner
    participant Command
    participant Base

    Runner->>Command: Execute run command
    Command->>Base: Call step_finish(success, abort_on_error)
    Base-->>Runner: Return success or error
    Note over Base: Handle error based on abort_on_error

Loading

Hop along, let's celebrate,
With fixes that truly elevate.
In commands where environments play,
We’ve made them sturdy in every way.
Oh, happy bugs, now far away,
With leaps and bounds, we'll greet the day! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3de0445 and e3517e2.

Files selected for processing (4)

• CHANGELOG.md (1 hunks)
• lib/command/base.rb (2 hunks)
• lib/command/run.rb (1 hunks)
• spec/command/run_spec.rb (1 hunks)

Additional context used

LanguageTool

CHANGELOG.md

[uncategorized] ~19-~19: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...mmand fails when runner workload has ENV but original workload does not. [PR 227](ht...

(COMMA_COMPOUND_SENTENCE_2)

Additional comments not posted (4)

spec/command/run_spec.rb (1)

256-276: Good addition of test coverage for environment variable scenarios.

The new context block effectively tests the scenario where the runner workload has environment variables while the original workload does not. This enhances the robustness of the test suite.

lib/command/base.rb (2)

468-473: Streamlined error handling in step_finish.

The addition of the abort_on_error parameter provides better control over error handling, allowing the process to exit conditionally. This change improves code cohesion by integrating error handling into the completion step.

---

493-496: Direct error message handling in step.

Writing the error message directly to temporary stderr instead of using a separate method simplifies the error handling process and reduces unnecessary method calls.

lib/command/run.rb (1)

210-210: Robust handling of environment variables in update_runner_workload.

Ensuring container_spec["env"] is always an array prevents potential nil assignments and enhances the robustness of the code by avoiding unexpected behavior.