feature/add region to model defaults cli #6308

reedobrien · 2016-09-23T00:47:04Z

Also changes --reset to be a stringvar. All tests pass at this point but
it needs more tests for the new features. It also adds a lot of command
arg scrutiny and tests

This was originally part of #6269 but has been split from the backend
bits here. Addtionally per review in pr #6269, updates the reset variable
so we can specify it repeatedly and reset all the keys set in all the
reset flags.

Ensure the cloud is always set, even if we only get the region on the
CLI. Finally, create new region settings if they weren't created at
bootstrap.

Refs: config command collapse spec https://goo.gl/yqrrPI
Refs: model-config-tree

QA:

Run all unit tests and all pass.
juju bootstrap reed/aws/us-west-1 --build-agent
bootstrap a controller with settings similar to

http://paste.ubuntu.com/23080517/
juju model-defaults --reset no-proxy
verify the controller val was reset
juju model-defaults --reset no-proxy us-east-1
verify it was reset in us-east-1.
juju model-defaults us-west-2 no-proxy=west-2 agent-stream=foobar
verify both items were set on us-west-2
juju model-defaults us-west-2 no-proxy=west-updated --reset agent-stream
verify no-proxy was changed and agent-stream reset
juju model-defaults awstest/us-east-1 no-proxy=https://foo-east
verify us-east-1 is set again
juju model-defaults no-proxy=https://local
be sure the controller default was set again.
juju model-defaults us-east-2 no-proxy=foo
error: invalid region specified: "us-east-2" # verify this error.
... Do other things to try breaking it.

Also changes --reset to be a stringvar. All tests pass at this point but it needs more tests for the new features. It also adds a lot of command arg scrutiny and tests This was originally part of juju#6269 but has been split from the backend bits here. Addtionally per review in pr juju#6269, updates the reset variable so we can specify it repeatedly and reset all the keys set in all the reset flags. Ensure the cloud is always set, even if we only get the region on the CLI. Finally, create new region settings if they weren't created at bootstrap. Refs: config command collapse spec https://goo.gl/yqrrPI Refs: model-config-tree

axw

The documentation text for model-defaults needs updating.

I feel like the logic for Init could be simplified, e.g. moving some of the validation for mixed positional args earlier, so we can get consistent error messages. The tests are fairly comprehensive, so I could live with that coming later.

axw · 2016-09-23T00:51:50Z

cmd/juju/model/defaultscommand.go

@@ -8,12 +8,18 @@ import (
 	"sort"
 	"strings"

+	"gopkg.in/juju/names.v2"
+


delete (the blank) line

axw · 2016-09-23T01:03:31Z

cmd/juju/model/defaultscommand.go

+	key                   string
+	resetKeys             []string
+	cloudName, regionName string
+	// reset holds the contents of the reset flag. It contains a list of comma


This comment is misleading. It's only true until after Init is called, when we call parseResetKeys.

I'll modify it. I am fine with removing many of the comments. I mostly wrote them out to rubber duck the logistics. Maybe they're useful to future readers or maybe confusing.

axw · 2016-09-23T01:08:51Z

cmd/juju/model/defaultscommand.go

 }

 // Init implements part of the cmd.Command interface.
+// Abandon all hope ye who enter here....
+// This needs to parse the a command line invocation as defined in
+// https://goo.gl/yqrrPI.


I think you should drop the doc reference. It's Canonical-only at the moment, though doesn't seem like it needs to be. It's not really adding anything beyond what you've described here AFAICT.

axw · 2016-09-23T01:13:28Z

cmd/juju/model/defaultscommand.go

+// Abandon all hope ye who enter here....
+// This needs to parse the a command line invocation as defined in
+// https://goo.gl/yqrrPI.
+// So the following 3 lines are all equivalent:


Can we just state that flags may be interspersed, and leave it at that? You've stated "are equivalent" in numerous examples below, where I think saying it once would be sufficient.

done. And reduced the number of examples.

axw · 2016-09-23T01:14:52Z

cmd/juju/model/defaultscommand.go

+// This needs to parse the a command line invocation as defined in
+// https://goo.gl/yqrrPI.
+// So the following 3 lines are all equivalent:
+// juju model-defaults aws/us-east-1 foo=baz --reset bar


maybe also indent the examples to clearly separate from the prose?

axw · 2016-09-23T02:04:38Z

cmd/juju/model/defaultscommand.go

-		}
+	// allKeys gets the all the set and reset keys to validate. This should get
+	// caught in Init so maybe we don't need it here too.
+	// TODO(reviewer) Should we keep this and the init check?


it's still necessary to check that they're known, but not that they're duplicated. also, the functional literal seems unnecessary? wouldn't the following suffice?

allKeys := c.resetKeys[:] for k := range c.values { allKeys = append(allKeys, k) }

This is better thanks.

axw · 2016-09-23T02:07:06Z

cmd/juju/model/defaultscommand_test.go

+		}, {
+			description: "test invalid positional args with set",
+			args:        []string{"a=b", "b", "c=d"},
+			errorMatch:  `expected "key=value", got "b"`,


We really should be getting the same error here and in the test below.

Not sure about that. If the key only is at the end or beginning the user may have thought they were interspersing get and set args, but if the key only is in the middle of set args it's more likely they miss-typed. But that is the problem with many possibilities in a single command:/ The error above IIRC comes from trying to parse the key values with keyvalues.Parse. The error below comes because we knew it was not part of the key values.

Are you saying we should check for the above error and return the below error?

Are you saying we should check for the above error and return the below error?

I'm thinking we should check for mixed get/set up-front, before we call keyvalues.Parse.

axw · 2016-09-23T02:10:24Z

state/modelconfig.go

+		settings, err = createSettings(st, globalSettingsC, key, attrs)
+		if err != nil {
+			return errors.Trace(err)
+		}


return nil? no point doing an update with the same values

Yeah. Thought about it, thanks for the push. Updated.

axw · 2016-09-23T02:11:19Z

state/modelconfig_test.go

+	err = s.State.UpdateModelConfigDefaultValues(attrs, nil, rspec)
+	c.Assert(err, jc.ErrorIsNil)
+
+	// Then check in another state.


checking in another mongo session seems unnecessary.

Copy and paste testing. Removed.

axw · 2016-09-23T02:13:23Z

cmd/juju/model/defaultscommand_test.go

@@ -95,16 +230,16 @@ func (s *DefaultsCommandSuite) TestDefaultsInit(c *gc.C) {
 }



please also add tests that verify that the correct cloud/region are passed through to the API calls

Good thinking

reedobrien

Can't tell if I've started a new review or am commenting on yours.

reedobrien · 2016-09-23T22:40:48Z

cmd/juju/model/defaultscommand.go

+		return errors.New("specifying a region when retrieving defaults for a setting is invalid")
+	case !regionSpecified && resetSpecified:
+		// It makes no sense to supply a positional arg that isn't a region if
+		// we are resetting a region, so we must have gotten an invalid region.


resetting keys in a region...

reedobrien · 2016-09-23T22:45:30Z

cmd/juju/model/defaultscommand.go

+		// already.
+		return errors.New("cannot retrieve defaults for a key and reset args at the same time")
+	default:
+		// This should be unreachable.


Switched (hah) to ifs.

reedobrien · 2016-09-24T00:27:31Z

cmd/juju/model/defaultscommand.go

+		// It doesn't make sense to specify a region unless we are resetting
+		// values here.
+		return errors.New("specifying a region when retrieving defaults is invalid")
+	case regionSpecified && resetSpecified:


Duh. Thanks.

reedobrien · 2016-09-24T00:31:19Z

cmd/juju/model/defaultscommand.go

+	switch {
+	case numArgs == 2 && !regionSpecified && resetSpecified:
+		// It makes no sense to supply a positional arg that isn't a region if
+		// we are resetting a region, so we must have gotten an invalid region.


resetting keys in a region...

reedobrien · 2016-09-24T00:43:13Z

cmd/juju/model/defaultscommand.go

-		}
+	// allKeys gets the all the set and reset keys to validate. This should get
+	// caught in Init so maybe we don't need it here too.
+	// TODO(reviewer) Should we keep this and the init check?


This is better thanks.

reedobrien · 2016-09-24T00:43:31Z

cmd/juju/model/defaultscommand.go

-	for _, key := range keys() {
+
+	keys := allkeys()
+	repeats := map[string]int{}


reedobrien · 2016-09-24T00:49:56Z

cmd/juju/model/defaultscommand_test.go

@@ -95,16 +230,16 @@ func (s *DefaultsCommandSuite) TestDefaultsInit(c *gc.C) {
 }



Good thinking

reedobrien · 2016-09-24T01:05:16Z

cmd/juju/model/defaultscommand_test.go

+		}, {
+			description: "test invalid positional args with set",
+			args:        []string{"a=b", "b", "c=d"},
+			errorMatch:  `expected "key=value", got "b"`,


Not sure about that. If the key only is at the end or beginning the user may have thought they were interspersing get and set args, but if the key only is in the middle of set args it's more likely they miss-typed. But that is the problem with many possibilities in a single command:/ The error above IIRC comes from trying to parse the key values with keyvalues.Parse. The error below comes because we knew it was not part of the key values.

Are you saying we should check for the above error and return the below error?

reedobrien · 2016-09-24T01:15:47Z

state/modelconfig.go

+		settings, err = createSettings(st, globalSettingsC, key, attrs)
+		if err != nil {
+			return errors.Trace(err)
+		}


Yeah. Thought about it, thanks for the push. Updated.

reedobrien · 2016-09-24T01:23:33Z

state/modelconfig_test.go

+	err = s.State.UpdateModelConfigDefaultValues(attrs, nil, rspec)
+	c.Assert(err, jc.ErrorIsNil)
+
+	// Then check in another state.


Copy and paste testing. Removed.

Refs: config command collapse spec https://goo.gl/yqrrPI

axw

Please add those tests and address new issues, then you'll be good to go.

axw · 2016-09-26T01:52:56Z

cmd/juju/model/defaultscommand.go

-// juju model-defaults aws/us-east-1 foo=baz --reset bar
-// juju model-defaults aws/us-east-1 --reset bar foo=baz
-// juju model-defaults --reset bar aws/us-east-1 foo=baz
+// This needs to parse the a command line invocation to reset and set, or get


axw · 2016-09-26T01:54:29Z

cmd/juju/model/defaultscommand.go

+//     juju model-defaults aws/us-east-1 foo=baz --reset bar
+//
+// If aws is the cloud of the current or specified controller -- specified by
+// -c somecontroller or -m somecontroller:somemodel -- then the following would


you cannot use "-m" on a controller command

axw · 2016-09-26T01:57:45Z

cmd/juju/model/defaultscommand.go

@@ -292,6 +280,12 @@ func (c *defaultsCommand) parseCloudRegion(args []string) ([]string, error) {
 		region = cr
 	}

+	// NB(redir) http://pad.lv/1627162 -- We don't disallow "=" in region


please use the format

// TODO(redir) YYYY-MM-DD #1627162 // We don't disallow "=" in region names, // but probably should.

Added tests to show cloud and region are conveys through the call to the api.

Refs: config command collapse spec https://goo.gl/yqrrPI

reedobrien · 2016-10-06T20:24:38Z

@axw @wallyworld ready for another look.

reedobrien · 2016-10-06T23:55:45Z

$$merge$$

Thanks @axw

jujubot · 2016-10-06T23:56:14Z

Status: merge request accepted. Url: http://juju-ci.vapour.ws:8080/job/github-merge-juju

axw suggested changes Sep 23, 2016

View reviewed changes

reedobrien commented Sep 24, 2016

View reviewed changes

Updates per review on juju#6308.

4c1a55b

Refs: config command collapse spec https://goo.gl/yqrrPI

axw reviewed Sep 26, 2016

View reviewed changes

reedobrien added 2 commits October 6, 2016 12:22

Updates per review on juju#6308.

718994f

Refs: config command collapse spec https://goo.gl/yqrrPI

Update signature with cloud region & --reset desc

d24e25a

Refs: config command collapse spec https://goo.gl/yqrrPI

axw approved these changes Oct 6, 2016

View reviewed changes

jujubot merged commit d7a9d78 into juju:master Oct 7, 2016

reedobrien deleted the feature/add-region-to-model-defaults-cli branch October 7, 2016 00:47

reedobrien restored the feature/add-region-to-model-defaults-cli branch October 12, 2016 23:57

reedobrien deleted the feature/add-region-to-model-defaults-cli branch October 20, 2016 22:48

		@@ -95,16 +230,16 @@ func (s DefaultsCommandSuite) TestDefaultsInit(c gc.C) {
		}

feature/add region to model defaults cli #6308

feature/add region to model defaults cli #6308

Conversation

reedobrien commented Sep 23, 2016

bootstrap a controller with settings similar to

verify the controller val was reset

verify it was reset in us-east-1.

verify both items were set on us-west-2

verify no-proxy was changed and agent-stream reset

verify us-east-1 is set again

be sure the controller default was set again.

axw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

axw Sep 23, 2016 • edited

Choose a reason for hiding this comment

reedobrien Sep 23, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

axw Sep 23, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reedobrien Sep 24, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reedobrien Sep 24, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reedobrien left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reedobrien Sep 23, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reedobrien Sep 24, 2016 • edited

Choose a reason for hiding this comment

reedobrien Sep 24, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

axw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reedobrien commented Oct 6, 2016

reedobrien commented Oct 6, 2016

jujubot commented Oct 6, 2016

axw Sep 23, 2016 •

edited

reedobrien Sep 23, 2016 •

edited

axw Sep 23, 2016 •

edited

reedobrien Sep 24, 2016 •

edited

reedobrien Sep 24, 2016 •

edited

reedobrien Sep 23, 2016 •

edited

reedobrien Sep 24, 2016 •

edited

reedobrien Sep 24, 2016 •

edited