Add bats test to cover docker-compose in serve

[abhibongale]

During #1839 review we decided that having bats test will be very helpful. This PR adds docker-compose bats tests.

Also fixes the issue of generating compose file with static name.

Fixes: #1873

Summary by Sourcery

Enable and verify Docker Compose file generation in the serve command by supporting a 'compose' format, fixing the file naming bug, and adding system tests to validate the output

Bug Fixes:

• Use dynamic file naming for generated Docker Compose YAML instead of static filename

Enhancements:

• Add 'compose' as a supported format for the serve --generate option

Tests:

• Add bats tests covering serve --generate=compose and serve --generate=compose:DIR to verify file generation, content, port mappings, and environment variables

[gemini-code-assist]

Summary of Changes

Hello @abhibongale, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the ramalama tool by adding robust BATS tests for its serve --generate=compose feature. It ensures that Docker Compose files are generated with correct configurations, including dynamic naming, proper port mappings, and environment variable handling. This change also addresses a previous limitation where generated compose files had a static name, enhancing flexibility and preventing potential naming conflicts.

Highlights

• New BATS Tests for Docker Compose Generation: Introduces comprehensive BATS tests to validate the ramalama serve --generate=compose functionality, ensuring that generated Docker Compose files correctly handle port mappings, environment variables, and custom output paths.
• Dynamic Docker Compose Filenames: Resolves an issue by making the generated Docker Compose filenames dynamic, using the provided name argument (e.g., name.yaml) instead of a static docker-compose.yaml.
• Expanded CLI Generate Options: Adds 'compose' to the list of valid GENERATE_OPTIONS in ramalama/cli.py, officially enabling docker-compose as a generation target via the command-line interface.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds support for generating Docker Compose files via ramalama serve --generate=compose. The changes include updating the CLI options, modifying the file generation logic to use dynamic names, and adding new BATS tests to cover this functionality. The changes are well-implemented. My review includes a couple of suggestions to enhance the new tests for better robustness and coverage.

[sourcery-ai]

Reviewer's Guide

This PR implements a new ‘compose’ output mode for the ‘serve’ command by extending CLI options, updating the compose file generator to use dynamic filenames, and adding BATS tests to verify compose file generation and contents.

Class diagram for updated CLI options

classDiagram
    class ParsedGenerateInput {
    }
    class Shortnames {
    }
    class CLI {
        -GENERATE_OPTIONS: list
    }
    CLI --> ParsedGenerateInput
    CLI --> Shortnames

Loading

File-Level Changes

Change	Details	Files
Add BATS tests for docker-compose generation in ‘serve’	Introduce tests for --generate=compose with default output directory Assert presence of command, ports mapping, and environment variables Add tests for --generate=compose:/tmp path handling	test/system/040-serve.bats
Make compose file name dynamic and update log message	Change genfile to name output file as .yaml instead of static name Update print statement to reference ‘Docker Compose YAML file’	ramalama/compose.py
Support ‘compose’ option in CLI generate modes	Add 'compose' to GENERATE_OPTIONS list in CLI parser	ramalama/cli.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes and found some issues that need to be addressed.

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `ramalama/compose.py:186` </location>
<code_context>
 def genfile(name: str, content: str) -> PlainFile:
-    file_name = "docker-compose.yaml"
-    print(f"Generating Docker Compose file: {file_name}")
+    file_name = f"{name}.yaml"
+    print(f"Generating Docker Compose YAML file: {file_name}")

</code_context>

<issue_to_address>
**🚨 suggestion (security):** Consider validating 'name' to avoid unintended file names.

Sanitize 'name' to prevent path traversal or overwriting files due to unsafe characters.
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[abhibongale]

/recheck

[engelmi]

Small comment (see below), otherwise LGTM

[rhatdan]

LGTM