Skip to content
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

Fixed docker compose script so that it fails if any container fails #2330

Merged
merged 1 commit into from
Jun 21, 2024

Conversation

cmnrd
Copy link
Collaborator

@cmnrd cmnrd commented Jun 21, 2024

Addresses #2328 (review)

Summary by CodeRabbit

  • New Features
    • Improved Docker Compose behavior by adding the --abort-on-container-failure flag to ensure that all containers are stopped if one fails.
    • Added --abort-on-container-exit flag to the docker compose up command to ensure the service stops if any container exits.

@cmnrd cmnrd added exclude Exclude from change log docker Issue related to the docker support labels Jun 21, 2024
Copy link

coderabbitai bot commented Jun 21, 2024

Walkthrough

The DockerComposeGenerator.java file has undergone two sequential changes to the createLauncher method. Initially, the docker compose up command integrated the --abort-on-container-exit flag. Subsequently, this flag was replaced by the --abort-on-container-failure flag. These changes aim to modify how the Docker Compose setup reacts when containers exit or fail.

Changes

Files Change Summary
core/src/main/java/org/lflang/generator/docker/DockerComposeGenerator.java Updated the docker compose up command to include the --abort-on-container-exit flag, then further updated to use the --abort-on-container-failure flag.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DockerComposeGenerator
    participant Docker

    User->>DockerComposeGenerator: Invoke createLauncher()
    DockerComposeGenerator->>Docker: docker compose up
    Docker-->>DockerComposeGenerator: Containers start
    Docker->>DockerComposeGenerator: Container failure detection
    DockerComposeGenerator-->>User: Process aborts on container failure
Loading

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
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 Configration 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.

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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3a6cc1b and 558f1fa.

Files selected for processing (1)
  • core/src/main/java/org/lflang/generator/docker/DockerComposeGenerator.java (1 hunks)
Additional comments not posted (1)
core/src/main/java/org/lflang/generator/docker/DockerComposeGenerator.java (1)

141-141: Approved change to Docker Compose command.

The addition of --abort-on-container-exit to the Docker Compose command is a crucial update for ensuring that the script fails if any container exits prematurely, aligning with the PR's objectives.

Verification successful

The verification process indicates that the addition of the --abort-on-container-exit flag in the docker compose up command is isolated to the DockerComposeGenerator.java file. No other instances of the command were found, and there are no related tests or documentation files that need updates.

  • The search for other docker compose up commands in the repository returned only the modified instance.
  • No related tests were found that include Docker Compose commands.
  • The documentation search did not reveal any additional references to Docker Compose commands outside the modified file.

This confirms that the change is localized and does not negatively affect other parts of the codebase.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify if the `--abort-on-container-exit` flag affects other Docker Compose configurations.

# Test: Search for other Docker Compose commands in the repository. Expect: No other configurations should be negatively affected.
rg --type java $'docker compose up'

Length of output: 163



Script:

#!/bin/bash
# Description: Verify if there are any tests related to Docker Compose commands.

# Test: Search for test files that may include Docker Compose commands.
rg --type java --type groovy 'docker compose' --glob '*Test*'

Length of output: 63


Script:

#!/bin/bash
# Description: Verify if there is any documentation related to Docker Compose commands.

# Test: Search for documentation files that may include Docker Compose commands.
rg 'docker compose'

Length of output: 256

@cmnrd cmnrd mentioned this pull request Jun 21, 2024
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 558f1fa and ff1b0fe.

Files selected for processing (1)
  • core/src/main/java/org/lflang/generator/docker/DockerComposeGenerator.java (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • core/src/main/java/org/lflang/generator/docker/DockerComposeGenerator.java

@cmnrd cmnrd enabled auto-merge June 21, 2024 09:37
Copy link
Collaborator

@petervdonovan petervdonovan left a comment

Choose a reason for hiding this comment

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

I tested this change locally and it solves the problem!

FYI, this uses a recently-added Docker feature that did not exist 1 year ago (on Docker Engine 24.0.5). Our users should be advised to upgrade to Docker Engine 26.1.4 or later in order to be sure that the launch script will work.

@cmnrd cmnrd added this pull request to the merge queue Jun 21, 2024
Merged via the queue into master with commit 73e8c8a Jun 21, 2024
26 checks passed
@cmnrd cmnrd deleted the fix-docker-testing-again branch June 21, 2024 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docker Issue related to the docker support exclude Exclude from change log
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants