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

Blueapi should not be a valid target for checking out to the scratch repository #723

Open
DiamondJoseph opened this issue Nov 18, 2024 · 1 comment
Labels
bug Something isn't working good first issue Good for newcomers
Milestone

Comments

@DiamondJoseph
Copy link
Contributor

DiamondJoseph commented Nov 18, 2024

Blueapi should be a robust, tested and stable platform for developing beamline code. It should be running a known, versioned, release, for reasons including security (reduce attack surface to only what can be run as a plan, not executing all arbitrary code), debugging.

Acceptance Criteria

  • If blueapi is in the scratch repositories configuration field, an error message is displayed to the user
  • If the scratch init code attempts to install a package named blueapi, it errors gracefully
  • There are tests for both of these cases
@DiamondJoseph DiamondJoseph added the bug Something isn't working label Nov 18, 2024
@callumforrester
Copy link
Contributor

callumforrester commented Nov 18, 2024

I think this is a fairly simple addition to the scratch code, when pip installing we can fail if the package is called blueapi and display a sensible error message to the user. We should also forbid the URL for this Github repo in the scratch configuration via pydantic validation.

@callumforrester callumforrester added the good first issue Good for newcomers label Nov 18, 2024
@callumforrester callumforrester added this to the 1.0.0 milestone Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants