Added --root-user flag to devbox generate #1359
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mikeland73
requested changes
Aug 9, 2023
devbox.go
Outdated
Comment on lines
28
to
29
| GenerateDevcontainer(ctx context.Context, force bool, rootUser bool) error | ||
| GenerateDockerfile(ctx context.Context, force bool, rootUser bool) error |
There was a problem hiding this comment.
bool params are bad. Consider using struct. Could even be part of devopt.Opts
devopt.Opts{
GenerateOpts: devopt.GenerateOpts{
Force: force,
RootUser: rootUser,
}
}
internal/boxcli/generate.go
Outdated
| @@ -63,6 +64,8 @@ func devcontainerCmd() *cobra.Command { | |||
| } | |||
| command.Flags().BoolVarP( | |||
| &flags.force, "force", "f", false, "force overwrite on existing files") | |||
| command.Flags().BoolVarP( | |||
| &flags.rootUser, "root-user", "r", false, "Use root as default user inside the container") | |||
There was a problem hiding this comment.
I don't think we should use a short flag for this (so no -r). It's not a super common flag and we may want to use -r for something else in the future. (when in doubt, it's a bit better not to add short flag)
internal/boxcli/generate.go
Outdated
| @@ -80,6 +83,8 @@ func dockerfileCmd() *cobra.Command { | |||
| } | |||
| command.Flags().BoolVarP( | |||
| &flags.force, "force", "f", false, "force overwrite existing files") | |||
| command.Flags().BoolVarP( | |||
| &flags.rootUser, "root-user", "r", false, "Use root as default user inside the container") | |||
internal/impl/devbox.go
Outdated
| @@ -394,15 +394,21 @@ func (d *Devbox) GenerateDevcontainer(ctx context.Context, force bool) error { | |||
| return redact.Errorf("error creating dev container directory in <project>/%s: %w", | |||
| redact.Safe(filepath.Base(devContainerPath)), err) | |||
| } | |||
| isDevcontainer := true | |||
There was a problem hiding this comment.
generally prefer comments to local variable that is only used once, but even better would be to use struct to simulate named params.
Comment on lines
26
to
34
| type Generate struct { | ||
| Ctx context.Context | ||
| Path string | ||
| RootUser bool | ||
| IsDevcontainer bool | ||
| Pkgs []string | ||
| LocalFlakeDirs []string | ||
| } |
There was a problem hiding this comment.
A few issues:
- Not sure about the name (
generate.Generateis repetitive and doesn't convey what it does). - As currently used it does not need to be exported.
- It should not contain context. (In general context should never be saved in a struct).
Proposal:
- Name it
Optionsinstead. - Remove context.
- Remove Open
Code would look like:
g := &generate.Options{...}
g.CreateDockerfile(ctx)| @@ -128,7 +158,10 @@ func getDevcontainerContent(pkgs []string) *devcontainerObject { | |||
| }, | |||
| }, | |||
| // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. | |||
There was a problem hiding this comment.
is this comment still relevant?
mohsenari
added a commit
that referenced
this pull request
Aug 11, 2023
## Summary Follow up for #1359 Updates docs for newly added flag for `devbox generate dockerfile` and `devbox generate devcontainer` ## How was it tested? N/A --------- Co-authored-by: Lucille Hua <[email protected]>
mohsenari
force-pushed
the
mohsen--single-user-flag
branch
from
424dd8b to
3266546
Compare
|
@mikeland73 I updated the PR based on the feedback. PTAL |
mikeland73
approved these changes
Aug 11, 2023
| @@ -139,13 +144,17 @@ func runGenerateCmd(cmd *cobra.Command, flags *generateCmdFlags) error { | |||
| if err != nil { | |||
| return errors.WithStack(err) | |||
| } | |||
| generateOpts := devopt.GenerateOpts{ | |||
There was a problem hiding this comment.
Hack, if you embed devopt.GenerateOpts to the flag struct you can pass flags.GenerateOpts into the functions below.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
follow up for #1325
This also potentially fixes an issue reported for users having permission issues with
.devbox/directory inside devcontainer because ofrootuser inside the container.Added a
--root-userflag to allow both single user installation and multi user installation for nix as well as setup for Dockerfile and devcontainer.json.This allows users to choose either
devboxas a user in the container environment (default) orrootas a user in the container environment (passing--root-userflag).How was it tested?
devbox generate dockerfile -f -rcompare content of Dockerfile with
devbox generate dockerfile -f