Skip to content

Require explicit scope for bakery update files #753

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.

Sign up for GitHub

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

Open
bschwedler wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Require explicit scope for bakery update files #753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions posit-bakery/posit_bakery/cli/update.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ def files(
rich_help_panel=RichHelpPanelEnum.FILTERS,
),
] = None,
all_images: Annotated[
bool,
typer.Option(
"--all",
help="Render every image and version in the project. Required when no --image-name or "
"--image-version filter is given.",
rich_help_panel=RichHelpPanelEnum.FILTERS,
),
] = False,
) -> None:
"""Renders templates to version files matching the given filters

Expand All @@ -71,7 +80,19 @@ def files(

\b
Existing files will not be removed, but may be overwritten during template rendering.

\b
At least one of --image-name or --image-version is required to scope the render. Pass --all to
explicitly render every image and version in the project.
"""
if image_name is None and image_version is None and not all_images:
stderr_console.print(
"❌ No scope specified. Pass --image-name and/or --image-version to scope the render, "
"or --all to intentionally render every image and version.",
style="error",
)
raise typer.Exit(code=1)

_filter = BakeryConfigFilter(
image_name=image_name,
image_version=image_version,
Expand Down
22 changes: 22 additions & 0 deletions posit-bakery/test/features/cli/update/files.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,25 @@ Feature: update files
* the default matrix rendered templates exist
* the stderr output includes:
| Files updated successfully |

Scenario: Updating files without a scope fails
Given I call bakery update files
* in a temp with-macros context
When I execute the command
Then The command fails
* the stderr output includes:
| No scope specified |

Scenario: Updating all files with --all
Given I call bakery update files
* in a temp with-macros context
* with the 'test-image/1.0.0' path removed
* with the arguments:
| --all |
When I execute the command
Then The command succeeds
* the image "test-image" exists
* the version "1.0.0" exists
* the default rendered templates exist
* the stderr output includes:
| Files updated successfully |
Loading