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.

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

dry-run added #127

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

dry-run added #127

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ad1451
dry-run added
Feb 13, 2024
0881507
dry-run is bool & create SimplePrint
Feb 13, 2024
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
11 changes: 11 additions & 0 deletions pkg/genericcli/cmds.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,14 @@ func NewCmds[C any, U any, R any](c *CmdsConfig[C, U, R], additionalCmds ...*cob
return err
}

if viper.GetString("dry-run") == "client" {
fmt.Println("Create request as client:", rq)
return nil
} else if viper.GetString("dry-run") == "server" {
fmt.Println("Create request as server:", rq)
return nil
}
Copy link
Contributor

Choose a reason for hiding this comment

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

We should probably error out when this flag is used in combination with the -f flag as otherwise we run a request against the API and the --dry-run flag is ignored, which is kind of dangerous.

Also fmt.Println cannot be used as this does not produce serialized output, see:

❯ metalctl partition create --name test --description "i am a partition" --imageurl https://foo-image --kernelurl https://kernel-image --cmdline "1 2 3 4 5" --dry-run=client
Create request as client: &{0xc00026e450 i am a partition 0xc000233690 map[]  test 0}

The expected result should look something like this:

❯ metalctl partition create --id test --name test --description "i am a partition" --imageurl https://foo-image --kernelurl https://kernel-image --cmdline "1 2 3 4 5" --dry-run=client
---
bootconfig:
  commandline: "1 2 3 4 5"
  imageurl: https://foo-image
  kernelurl: https://kernel-image
changed: "2024-02-12T15:26:25.664Z"
created: "2020-03-11T14:29:12.446Z"
description: i am a partition
mgmtserviceaddress: fra-equ01.bmc-proxy.metal-stack.dev:3333
name: test
id: test

Ideally, you use the DescribePrinter to achieve this kind of output (in this case a user could also do -o json to print the manifest in JSON and not YAML).

In general, the output should be able to be used as input as well, like: metalctl partition create --dry-run --id test [...] | metalctl partition create -f -. So no additional text should be outputted, just valid YAML or JSON.


return c.GenericCLI.CreateAndPrint(rq, c.DescribePrinter())
}

Expand All @@ -182,6 +190,9 @@ func NewCmds[C any, U any, R any](c *CmdsConfig[C, U, R], additionalCmds ...*cob
},
}

//Adding dry-run flas to the command
cmd.Flags().String("dry-run", "", "Ser dry-run mode. Values: client, server")
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be a bool flag, there is no need for us to distinguish between client / server.


c.addFileFlags(cmd)

if c.CreateCmdMutateFn != nil {
Expand Down
Loading