Skip to content

Always use absolute path for --store option #1637

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

Merged
merged 1 commit into from
Jul 3, 2025

Conversation

rhatdan
Copy link
Member

@rhatdan rhatdan commented Jul 1, 2025

Fixes: #1634

Summary by Sourcery

Use absolute paths for the --store option to ensure consistent store directory resolution

Bug Fixes:

  • Normalize relative paths supplied to --store by converting them to absolute paths

Enhancements:

  • Introduce an abspath function and set it as the type converter for the --store argument in the CLI

Tests:

  • Add a system test for ramalama info --store to verify relative paths are translated to their absolute equivalents

Copy link
Contributor

sourcery-ai bot commented Jul 1, 2025

Reviewer's Guide

This PR ensures the CLI always resolves the --store path to an absolute path by introducing an abspath converter and updating tests to validate the behavior.

Class diagram for abspath integration in CLI argument parsing

classDiagram
    class ArgumentParserWithDefaults {
        +add_argument()
    }
    class abspath {
        +__call__(astring)
    }
    ArgumentParserWithDefaults <.. abspath : uses
Loading

File-Level Changes

Change Details Files
Add helper to normalize store paths to absolute
  • Define abspath function wrapping os.path.abspath
  • Use abspath as type converter for --store argument
ramalama/cli.py
Add system test verifying absolute path conversion
  • Introduce a Bats test running ramalama info with a relative path
  • Assert the output Store value is the resolved absolute path
test/system/060-info.bats

Possibly linked issues


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

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @rhatdan, I'm Gemini Code Assist1! 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 addresses an issue where the --store option might not consistently resolve paths to their absolute form. The changes introduce a new utility function and integrate it into the command-line argument parsing, ensuring that all paths provided via --store are automatically converted to absolute paths. A new system test has also been added to verify this behavior, improving the robustness and predictability of path handling for the store option.

Highlights

  • Path Handling: Introduced a new abspath helper function in ramalama/cli.py (lines 151-152) to consistently convert paths to their absolute form using os.path.abspath.
  • CLI Argument Processing: Configured the --store command-line argument in ramalama/cli.py (line 229) to automatically use the new abspath function as its type converter, ensuring that any provided store path is always absolute.
  • Testing: Added a new system test case in test/system/060-info.bats (lines 62-65) to validate that the --store option correctly resolves relative paths (e.g., /tmp/../tmp/store) to their absolute counterparts (/tmp/store).
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @rhatdan - I've reviewed your changes - here's some feedback:

  • The abspath helper doesn’t expand user home (~) patterns – consider using os.path.expanduser or pathlib.Path(p).expanduser().resolve() to handle tilde before making it absolute.
  • Currently only CLI‐provided --store values get normalized; consider normalizing CONFIG.store in your configuration loader as well so that default or env‐set values are always absolute.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The abspath helper doesn’t expand user home (~) patterns – consider using os.path.expanduser or pathlib.Path(p).expanduser().resolve() to handle tilde before making it absolute.
- Currently only CLI‐provided --store values get normalized; consider normalizing CONFIG.store in your configuration loader as well so that default or env‐set values are always absolute.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces an abspath function and applies it to the --store argument in the CLI to ensure consistent store directory resolution. The changes include a new test case to verify the correct translation of relative paths to absolute paths.

Comment on lines 63 to 65
run_ramalama --store /tmp/../tmp/store info
actual=$(echo "$output" | jq -r ".Store")
is "$actual" "/tmp/store" "Verify relative paths translated to absolute path"
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The test uses /tmp/../tmp/store, which is an absolute path. To properly test the conversion of relative paths to absolute paths, use a relative path instead.

run_ramalama --store ./tmp/store info
actual=$(echo "$output" | jq -r ".Store")
is "$actual" "$(pwd)/tmp/store" "Verify relative paths translated to absolute path"

Copy link
Member

@engelmi engelmi left a comment

Choose a reason for hiding this comment

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

LGTM

It seems there are currently some infra issues for CentOS Stream 10, so nothing related to or blocking the PR.

@ericcurtin ericcurtin merged commit 06488b4 into containers:main Jul 3, 2025
15 of 25 checks passed
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.

ramalama pull fails when --store flag is used
3 participants