Display clouds integration test

Gopkg.toml

@@ -285,7 +285,7 @@
 
 [[constraint]]
   name = "github.com/juju/cmd"
-  revision = "74922f23f6436a661dacd8c5fdf9cb15641e7a2e"
+  revision = "8e43f3faa5c9b0463c9b1fffd89dcdbf1f7ed620"
 
 [[constraint]]
   name = "github.com/juju/collections"

cmd/juju/application/show.go

@@ -86,7 +86,7 @@ func (c *showApplicationCommand) Init(args []string) error {
 // SetFlags implements Command.SetFlags.
 func (c *showApplicationCommand) SetFlags(f *gnuflag.FlagSet) {
 	c.ModelCommandBase.SetFlags(f)
-	c.out.AddFlags(f, "yaml", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "yaml", cmd.DefaultFormatters.Formatters())
 }
 
 // ApplicationsInfoAPI defines the API methods that show-application command uses.

cmd/juju/cloud/list.go

@@ -175,9 +175,20 @@ func (c *listCloudsCommand) getCloudList(ctxt *cmd.Context) (*cloudList, error)
 }
 
 func (c *listCloudsCommand) Run(ctxt *cmd.Context) error {
+	// TODO (stickupkid): IsSerial states that its machine is serialisable, we
+	// shouldn't prompt in those situations. This is a general clean up of how
+	// we handle formatting directives the user has requested.
+	// The aim is to provide a more holistic approach at the CLI, rather than
+	// magic string checking.
+	// In an ideal world we would move this into MaybePrompt, but the changes
+	// may have unintended consequences without proper understanding.
+	// See: https://discourse.jujucharms.com/t/cli-serialisable-output-formats/2490
+	// Should fix this for Juju 3.0
+	c.ReadOnly = ctxt.IsSerial()
 	if err := c.MaybePrompt(ctxt, "list clouds from"); err != nil {
 		return errors.Trace(err)
 	}
+
 	details, err := c.getCloudList(ctxt)
 	if err != nil {
 		return errors.Trace(err)

tests/suites/cli/clouds/public-clouds.yaml

@@ -0,0 +1,9 @@
+clouds:
+  ec2-test:
+    type: ec2
+    auth-types: [userpass]
+    regions:
+      us-east-1:
+        endpoint: https://ec2.us-east-1.amazonaws.com
+      us-east-2:
+        endpoint: https://ec2.us-east-2.amazonaws.com

tests/suites/cli/display_clouds.sh

@@ -0,0 +1,60 @@
+run_show_clouds() {
+  echo
+
+  mkdir -p "${TEST_DIR}/juju"
+  echo "" >> "${TEST_DIR}/juju/public-clouds.yaml"
+  echo "" >> "${TEST_DIR}/juju/credentials.yaml"
+
+  OUT=$(XDG_DATA_HOME="${TEST_DIR}" juju clouds --local --format=json 2>/dev/null | jq ".[] | select(.defined != \"built-in\")")
+  if [ -n "${OUT}" ]; then
+    echo "expected empty, got ${OUT}"
+    exit 1
+  fi
+
+  cp ./tests/suites/cli/clouds/public-clouds.yaml "${TEST_DIR}"/juju/public-clouds.yaml
+  OUT=$(XDG_DATA_HOME="${TEST_DIR}" juju clouds --local --format=json 2>/dev/null | jq ".[] | select(.defined != \"built-in\")")
+  if [ -n "${OUT}" ]; then
+    echo "expected empty, got ${OUT}"
+    exit 1
+  fi
+
+  EXPECTED=$(cat <<'EOF'
+{
+  "defined": "public",
+  "type": "ec2",
+  "auth-types": [
+    "userpass"
+  ],
+  "regions": {
+    "us-east-1": {
+      "endpoint": "https://ec2.us-east-1.amazonaws.com"
+    },
+    "us-east-2": {
+      "endpoint": "https://ec2.us-east-2.amazonaws.com"
+    }
+  }
+}
+EOF
+  )
+
+  OUT=$(XDG_DATA_HOME="${TEST_DIR}" juju clouds --all --format=json 2>/dev/null | jq ".[] | select(.defined != \"built-in\")")
+  if [ "${OUT}" != "${EXPECTED}" ]; then
+    echo "expected ${EXPECTED}, got ${OUT}"
+    exit 1
+  fi
+}
+
+test_display_clouds() {
+  if [ "$(skip 'test_display_clouds')" ]; then
+    echo "==> TEST SKIPPED: display clouds"
+    return
+  fi
+
+  (
+    set_verbosity
+
+    cd .. || exit
+
+    run "run_show_clouds"
+  )
+}

tests/suites/cli/task.sh

@@ -9,11 +9,12 @@ test_cli() {
     echo "==> Checking for dependencies"
     check_dependencies juju
 
-    file="${TEST_DIR}/test-local-charms.txt"
+    file="${TEST_DIR}/test-cli.txt"
 
-    bootstrap "test-local-charms" "${file}"
+    bootstrap "test-cli" "${file}"
 
+    test_display_clouds
     test_local_charms
 
-    destroy_controller "test-local-charms"
+    destroy_controller "test-cli"
 }

worker/uniter/runner/jujuc/action-get.go

@@ -47,7 +47,7 @@ map as needed.
 // SetFlags handles known option flags; in this case, [--output={json|yaml}]
 // and --help.
 func (c *ActionGetCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 }
 
 // Init makes sure there are no additional unknown arguments to action-get.

worker/uniter/runner/jujuc/config-get.go

@@ -40,7 +40,7 @@ reported as null. <key> and --all are mutually exclusive.
 }
 
 func (c *ConfigGetCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 	f.BoolVar(&c.All, "a", false, "print all keys")
 	f.BoolVar(&c.All, "all", false, "")
 }

worker/uniter/runner/jujuc/credential-get.go

@@ -38,7 +38,7 @@ credential-get returns the cloud specification used by the unit's model.
 
 // SetFlags is part of the cmd.Command interface.
 func (c *CredentialGetCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 }
 
 // Init is part of the cmd.Command interface.

worker/uniter/runner/jujuc/is-leader.go

@@ -39,7 +39,7 @@ there is no such guarantee.
 
 // SetFlags is part of the cmd.Command interface.
 func (c *isLeaderCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 }
 
 // Run is part of the cmd.Command interface.

worker/uniter/runner/jujuc/leader-get.go

@@ -42,7 +42,7 @@ is given, or if the key is "-", all keys and values will be printed.
 
 // SetFlags is part of the cmd.Command interface.
 func (c *leaderGetCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 }
 
 // Init is part of the cmd.Command interface.

worker/uniter/runner/jujuc/network-get.go

@@ -75,7 +75,7 @@ If more than one flag is specified, a map of values is returned.
 
 // SetFlags is part of the cmd.Command interface.
 func (c *NetworkGetCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 	f.BoolVar(&c.primaryAddress, "primary-address", false, "(deprecated) get the primary address for the binding")
 	f.BoolVar(&c.bindAddress, "bind-address", false, "get the address for the binding on which the unit should listen")
 	f.BoolVar(&c.ingressAddress, "ingress-address", false, "get the ingress address for the binding")

worker/uniter/runner/jujuc/opened-ports.go

@@ -32,7 +32,7 @@ func (c *OpenedPortsCommand) Info() *cmd.Info {
 }
 
 func (c *OpenedPortsCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 }
 
 func (c *OpenedPortsCommand) Init(args []string) error {

worker/uniter/runner/jujuc/relation-get.go

@@ -71,7 +71,7 @@ leader.
 
 // SetFlags is part of the cmd.Command interface.
 func (c *RelationGetCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 	f.Var(c.relationIdProxy, "r", "Specify a relation by id")
 	f.Var(c.relationIdProxy, "relation", "")
 

worker/uniter/runner/jujuc/relation-ids.go

@@ -52,7 +52,7 @@ func (c *RelationIdsCommand) Info() *cmd.Info {
 }
 
 func (c *RelationIdsCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 }
 
 func (c *RelationIdsCommand) Init(args []string) error {

worker/uniter/runner/jujuc/relation-list.go

@@ -48,7 +48,7 @@ func (c *RelationListCommand) Info() *cmd.Info {
 }
 
 func (c *RelationListCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 	f.Var(c.relationIdProxy, "r", "specify a relation by id")
 	f.Var(c.relationIdProxy, "relation", "")
 }

worker/uniter/runner/jujuc/status-get.go

@@ -39,7 +39,7 @@ If the --include-data flag is passed, the associated data are printed also.
 }
 
 func (c *StatusGetCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 	f.BoolVar(&c.includeData, "include-data", false, "print all status data")
 	f.BoolVar(&c.applicationWide, "application", false, "print status for all units of this application if this unit is the leader")
 }

worker/uniter/runner/jujuc/storage-get.go

@@ -45,7 +45,7 @@ When no <key> is supplied, all keys values are printed.
 }
 
 func (c *StorageGetCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 	f.Var(c.storageTagProxy, "s", "specify a storage instance by id")
 }
 

worker/uniter/runner/jujuc/storage-list.go

@@ -44,7 +44,7 @@ instances for that named storage will be returned.
 }
 
 func (c *StorageListCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 }
 
 func (c *StorageListCommand) Init(args []string) (err error) {

worker/uniter/runner/jujuc/unit-get.go

@@ -35,7 +35,7 @@ func (c *UnitGetCommand) Info() *cmd.Info {
 }
 
 func (c *UnitGetCommand) SetFlags(f *gnuflag.FlagSet) {
-	c.out.AddFlags(f, "smart", cmd.DefaultFormatters)
+	c.out.AddFlags(f, "smart", cmd.DefaultFormatters.Formatters())
 }
 
 func (c *UnitGetCommand) Init(args []string) error {