✨ feat: --dry-run

cmd/iaas_test.go

@@ -401,5 +401,11 @@ func TestReadConsumptionAggregate(t *testing.T) {
 }
 
 func TestFilterNullValues(t *testing.T) {
-	run(t, []string{"iaas", "image", "ls", "--filter", "AccountAlias:Outscale"}, nil)
+	_ = run(t, []string{"iaas", "image", "ls", "--filter", "AccountAlias:Outscale"}, nil)
+}
+
+func TestDryRun(t *testing.T) {
+	var req osc.ReadVmsRequest
+	runJSON(t, []string{"iaas", "vm", "ls", "--subregion", "foo", "--dry-run", "-o", "json"}, nil, &req)
+	assert.Equal(t, osc.ReadVmsRequest{Filters: &osc.FiltersVm{SubregionNames: &[]string{"foo"}}}, req)
 }

cmd/root.go

@@ -76,6 +76,7 @@ func init() {
 	rootCmd.PersistentFlags().String("payload", "", "JSON content for query body")
 	rootCmd.PersistentFlags().String("root", "", "the root attribute for the template or payload")
 	_ = rootCmd.PersistentFlags().MarkHidden("root")
+	rootCmd.PersistentFlags().Bool("dry-run", false, "Display the request payload that would be sent to the API without sending it")
 
 	rootCmd.PersistentFlags().String("jq", "", "jq filter")
 	rootCmd.PersistentFlags().StringSlice("filter", nil, `comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'`)

docs/reference/octl.md

@@ -25,6 +25,7 @@ octl [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
   -h, --help                        help for octl
       --jq string                   jq filter

docs/reference/octl_iaas.md

@@ -13,6 +13,7 @@ OUTSCALE IaaS management
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_accesskey.md

@@ -13,6 +13,7 @@ accesskey commands
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_accesskey_create.md

@@ -28,6 +28,7 @@ octl iaas accesskey create [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_accesskey_delete.md

@@ -26,6 +26,7 @@ octl iaas accesskey delete access_key_id [access_key_id]... [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_accesskey_describe.md

@@ -23,6 +23,7 @@ octl iaas accesskey describe access_key_id [access_key_id]... [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_accesskey_list.md

@@ -27,6 +27,7 @@ octl iaas accesskey list [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_accesskey_update.md

@@ -31,6 +31,7 @@ octl iaas accesskey update access_key_id [access_key_id]... [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_account.md

@@ -13,6 +13,7 @@ account commands
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_account_create.md

@@ -45,6 +45,7 @@ octl iaas account create [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_account_list.md

@@ -23,6 +23,7 @@ octl iaas account list [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_adminpassword.md

@@ -13,6 +13,7 @@ adminpassword commands
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_adminpassword_list.md

@@ -32,6 +32,7 @@ octl iaas adminpassword list [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api.md

@@ -13,6 +13,7 @@ iaas api calls
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_AcceptNetPeering.md

@@ -29,6 +29,7 @@ octl iaas api AcceptNetPeering [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_AddUserToUserGroup.md

@@ -26,6 +26,7 @@ octl iaas api AddUserToUserGroup [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CheckAuthentication.md

@@ -24,6 +24,7 @@ octl iaas api CheckAuthentication [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateAccessKey.md

@@ -27,6 +27,7 @@ octl iaas api CreateAccessKey [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateAccount.md

@@ -44,6 +44,7 @@ octl iaas api CreateAccount [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateApiAccessRule.md

@@ -34,6 +34,7 @@ octl iaas api CreateApiAccessRule [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateCa.md

@@ -26,6 +26,7 @@ octl iaas api CreateCa [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateClientGateway.md

@@ -31,6 +31,7 @@ octl iaas api CreateClientGateway [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateDedicatedGroup.md

@@ -27,6 +27,7 @@ octl iaas api CreateDedicatedGroup [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateDhcpOptions.md

@@ -28,6 +28,7 @@ octl iaas api CreateDhcpOptions [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateDirectLink.md

@@ -27,6 +27,7 @@ octl iaas api CreateDirectLink [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateDirectLinkInterface.md

@@ -34,6 +34,7 @@ octl iaas api CreateDirectLinkInterface [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateFlexibleGpu.md

@@ -30,6 +30,7 @@ octl iaas api CreateFlexibleGpu [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions

docs/reference/octl_iaas_api_CreateImage.md

@@ -53,6 +53,7 @@ octl iaas api CreateImage [flags]
 ```
   -c, --columns string              columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
       --config string               Path of profile file (by default, ~/.osc/config.json)
+      --dry-run                     Display the request payload that would be sent to the API without sending it
       --filter strings              comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
       --jq string                   jq filter
       --no-upgrade                  do not check for new versions