Rework model defaults get, set & unset per new spec

Refs: juju-model-config-collapse
Refs: juju-model-defaults-collapse

cmd/juju/commands/main.go

@@ -302,9 +302,7 @@ func registerCommands(r commandRegistry, ctx *cmd.Context) {
 
 	// Manage model
 	r.Register(model.NewConfigCommand())
-	r.Register(model.NewModelDefaultsCommand())
-	r.Register(model.NewSetModelDefaultsCommand())
-	r.Register(model.NewUnsetModelDefaultsCommand())
+	r.Register(model.NewDefaultsCommand())
 	r.Register(model.NewRetryProvisioningCommand())
 	r.Register(model.NewDestroyCommand())
 	r.Register(model.NewUsersCommand())

cmd/juju/commands/main_test.go

@@ -491,7 +491,6 @@ var commandNames = []string{
 	"set-default-region",
 	"set-meter-status",
 	"set-model-constraints",
-	"set-model-default",
 	"set-plan",
 	"shares",
 	"show-action-output",
@@ -519,7 +518,6 @@ var commandNames = []string{
 	"update-allocation",
 	"upload-backup",
 	"unregister",
-	"unset-model-default",
 	"update-clouds",
 	"upgrade-charm",
 	"upgrade-gui",

cmd/juju/model/defaultscommand.go

@@ -0,0 +1,289 @@
+// Copyright 2016 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+package model
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+	"sort"
+	"strings"
+
+	"github.com/juju/cmd"
+	"github.com/juju/errors"
+	"github.com/juju/gnuflag"
+	"github.com/juju/juju/api/modelconfig"
+	"github.com/juju/juju/cmd/juju/block"
+	"github.com/juju/juju/cmd/modelcmd"
+	"github.com/juju/juju/cmd/output"
+	"github.com/juju/juju/environs/config"
+	"github.com/juju/utils/keyvalues"
+)
+
+const (
+	agentVersionKey      = "agent-version"
+	modelDefaultsSummary = `Displays or sets default configuration settings for a model.`
+	modelDefaultsHelpDoc = `
+By default, all default configuration (keys and values) are
+displayed if a key is not specified. Supplying key=value will set the 
+supplied key to the supplied value. This can be repeated for multiple keys.
+By default, the model is the current model.
+
+
+Examples:
+    juju model-defaults 
+    juju model-defaults http-proxy
+    juju model-defaults -m mymodel type
+    juju model-defaults ftp-proxy=10.0.0.1:8000
+    juju model-defaults -m othercontroller:mymodel default-series=yakkety test-mode=false
+    juju model-defaults --reset default-series test-mode
+
+See also:
+    models
+    model-config
+`
+)
+
+// NewDefaultsCommand wraps defaultsCommand with sane model settings.
+func NewDefaultsCommand() cmd.Command {
+	return modelcmd.Wrap(&defaultsCommand{})
+}
+
+// defaultsCommand is compound command for accessing and setting attributes
+// related to default model configuration.
+type defaultsCommand struct {
+	modelcmd.ModelCommandBase
+	api defaultsCommandAPI
+	out cmd.Output
+
+	action func(*cmd.Context) error // The function handling the input, set in Init.
+	keys   []string
+	reset  bool // Flag indicating if we are resetting the keys provided.
+	values attributes
+}
+
+// defaultsCommandAPI defines an API to be used during testing.
+type defaultsCommandAPI interface {
+	// Close closes the api connection.
+	Close() error
+
+	// ModelDefaults returns the default config values used when creating a new model.
+	ModelDefaults() (config.ModelDefaultAttributes, error)
+
+	// SetModelDefaults sets the default config values to use
+	// when creating new models.
+	SetModelDefaults(cloud, region string, config map[string]interface{}) error
+
+	// UnsetModelDefaults clears the default model
+	// configuration values.
+	UnsetModelDefaults(cloud, region string, keys ...string) error
+}
+
+// Info implements part of the cmd.Command interface.
+func (c *defaultsCommand) Info() *cmd.Info {
+	return &cmd.Info{
+		Args:    "[<model-key>[<=value>] ...]",
+		Doc:     modelDefaultsHelpDoc,
+		Name:    "model-defaults",
+		Purpose: modelDefaultsSummary,
+	}
+}
+
+// SetFlags implements part of the cmd.Command interface.
+func (c *defaultsCommand) SetFlags(f *gnuflag.FlagSet) {
+	c.ModelCommandBase.SetFlags(f)
+
+	c.out.AddFlags(f, "tabular", map[string]cmd.Formatter{
+		"yaml":    cmd.FormatYaml,
+		"json":    cmd.FormatJson,
+		"tabular": formatDefaultConfigTabular,
+	})
+	f.BoolVar(&c.reset, "reset", false, "Reset the provided keys to be empty")
+}
+
+// Init implements part of the cmd.Command interface.
+func (c *defaultsCommand) Init(args []string) error {
+	if c.reset {
+		// We're resetting defaults.
+		if len(args) == 0 {
+			return errors.New("no keys specified")
+		}
+		for _, k := range args {
+			if k == agentVersionKey {
+				return errors.Errorf("%q cannot be reset", agentVersionKey)
+			}
+		}
+		c.keys = args
+
+		for _, key := range c.keys {
+			// check if the key exists in the known config
+			// and warn the user if the key is not defined
+			if _, exists := config.ConfigDefaults()[key]; !exists {
+				logger.Warningf(
+					"key %q is not defined in the known model configuration: possible misspelling", key)
+			}
+		}
+		c.action = c.resetDefaults
+		return nil
+	}
+
+	if len(args) > 0 && strings.Contains(args[0], "=") {
+		// We're setting defaults.
+		options, err := keyvalues.Parse(args, true)
+		if err != nil {
+			return errors.Trace(err)
+		}
+		c.values = make(attributes)
+		for k, v := range options {
+			if k == agentVersionKey {
+				return errors.Errorf(`%q must be set via "upgrade-juju"`, agentVersionKey)
+			}
+			c.values[k] = v
+		}
+
+		for key := range c.values {
+			// check if the key exists in the known config
+			// and warn the user if the key is not defined
+			if _, exists := config.ConfigDefaults()[key]; !exists {
+				logger.Warningf(
+					"key %q is not defined in the known model configuration: possible misspelling", key)
+			}
+		}
+
+		c.action = c.setDefaults
+		return nil
+
+	}
+	// We're getting defaults.
+	val, err := cmd.ZeroOrOneArgs(args)
+	if err != nil {
+		return errors.Trace(err)
+	}
+	if val != "" {
+		c.keys = []string{val}
+	}
+	c.action = c.getDefaults
+	return nil
+}
+
+// getAPI sets the api on the command. This allows passing in a test
+// ModelDefaultsAPI implementation.
+func (c *defaultsCommand) getAPI() (func(), error) {
+	if c.api != nil {
+		return func() { c.api.Close() }, nil
+	}
+
+	api, err := c.NewAPIRoot()
+	if err != nil {
+		return nil, errors.Annotate(err, "opening API connection")
+	}
+	c.api = modelconfig.NewClient(api)
+
+	return func() { c.api.Close() }, nil
+}
+
+// Run implements part of the cmd.Command interface.
+func (c *defaultsCommand) Run(ctx *cmd.Context) error {
+	apiCloser, err := c.getAPI()
+	if err != nil {
+		return errors.Trace(err)
+	}
+	defer apiCloser()
+
+	return c.action(ctx)
+}
+
+func (c *defaultsCommand) getDefaults(ctx *cmd.Context) error {
+	attrs, err := c.api.ModelDefaults()
+	if err != nil {
+		return err
+	}
+
+	if len(c.keys) == 1 {
+		key := c.keys[0]
+		if value, ok := attrs[key]; ok {
+			attrs = config.ModelDefaultAttributes{
+				key: value,
+			}
+		} else {
+			return errors.Errorf("key %q not found in %q model defaults.", key, attrs["name"])
+		}
+	}
+	// If c.keys is empty, write out the whole lot.
+	return c.out.Write(ctx, attrs)
+}
+
+func (c *defaultsCommand) setDefaults(ctx *cmd.Context) error {
+	// ctx unused in this method.
+
+	// TODO(wallyworld) - call with cloud and region when that bit is done
+	return block.ProcessBlockedError(c.api.SetModelDefaults("", "", c.values), block.BlockChange)
+}
+
+func (c *defaultsCommand) resetDefaults(ctx *cmd.Context) error {
+	// ctx unused in this method.
+
+	// TODO(wallyworld) - call with cloud and region when that bit is done
+	return block.ProcessBlockedError(c.api.UnsetModelDefaults("", "", c.keys...), block.BlockChange)
+
+}
+
+// formatConfigTabular writes a tabular summary of default config information.
+func formatDefaultConfigTabular(writer io.Writer, value interface{}) error {
+	defaultValues, ok := value.(config.ModelDefaultAttributes)
+	if !ok {
+		return errors.Errorf("expected value of type %T, got %T", defaultValues, value)
+	}
+
+	tw := output.TabWriter(writer)
+
+	ph := func(values ...string) {
+		text := strings.Join(values, "\t")
+		fmt.Fprintln(tw, text)
+	}
+
+	p := func(name string, value config.AttributeDefaultValues) {
+		var c, d interface{}
+		switch value.Default {
+		case nil:
+			d = "-"
+		case "":
+			d = `""`
+		default:
+			d = value.Default
+		}
+		switch value.Controller {
+		case nil:
+			c = "-"
+		case "":
+			c = `""`
+		default:
+			c = value.Controller
+		}
+		row := fmt.Sprintf("%s\t%v\t%v", name, d, c)
+		fmt.Fprintln(tw, row)
+		for _, region := range value.Regions {
+			row := fmt.Sprintf("  %s\t%v\t-", region.Name, region.Value)
+			fmt.Fprintln(tw, row)
+		}
+	}
+	var valueNames []string
+	for name := range defaultValues {
+		valueNames = append(valueNames, name)
+	}
+	sort.Strings(valueNames)
+	ph("ATTRIBUTE\tDEFAULT\tCONTROLLER")
+
+	for _, name := range valueNames {
+		info := defaultValues[name]
+		out := &bytes.Buffer{}
+		err := cmd.FormatYaml(out, info)
+		if err != nil {
+			return errors.Annotatef(err, "formatting value for %q", name)
+		}
+		p(name, info)
+	}
+
+	tw.Flush()
+	return nil
+}