[wip] cli: Add info command by aequitas · Pull Request #363 · purpleidea/mgmt

aequitas · 2018-02-27T14:06:38Z

For now just lists resources and functions, more to be added soon.

$ ./mgmt info funcs -t
answer			answer() int
contains
datetime		datetime() int
datetime_print		datetime_print(int) str
defaultenv		defaultenv(str, str) str
env			env() {str: str}
example_errorbool	example_errorbool(bool) str
exchange		exchange(str, str) {str: str}
flipflop		flipflop() bool
getenv			getenv(str) str
hasenv			hasenv(str) bool
hostname		hostname() str
int2str			int2str(int) str
kvlookup		kvlookup(str) {str: str}
len
load			load() struct{x1 float; x5 float; x15 float}
maplookup
pow			pow(float, float) float
printf
random1			random1(int) str
schedule
structlookup
template
vumeter			vumeter(str, int, float) str

$ ./mgmt info resources
augeas
aws:ec2
exec
file
graph
group
hostname
kv
msg
noop
nspawn
password
pkg
print
svc
test
timer
user
virt

aequitas · 2018-02-27T14:11:04Z

fixes #312

aequitas · 2018-02-27T16:25:25Z

Now also with a little bit of resource types:

./mgmt info r -t
augeas    file (string), lens (string), sets ([]resources.AugeasSet)
aws:ec2   state (string), region (string), type (string), imageid (string), watchendpoint (string), watchlistenaddr (string), erroronmalformedpost (bool), userdata (string), publicipv4 (string), privateipv4 (string), instanceid (string)
exec      cmd (string), shell (string), timeout (int), watchcmd (string), watchshell (string), ifcmd (string), ifshell (string), user (string), group (string), output (*string), stdout (*string), stderr (*string)
file      path (string), dirname (string), basename (string), content (*string), source (string), state (string), owner (string), group (string), mode (string), recurse (bool), force (bool)
graph     graph (*pgraph.Graph)
group     state (string), gid (*uint32)
hostname  hostname (string), prettyhostname (string), statichostname (string), transienthostname (string)
kv        key (string), value (*string), skiplessthan (bool), skipcmpstyle (resources.KVResSkipCmpStyle)
msg       body (string), priority (string), fields (map[string]string), journal (bool), syslog (bool)
noop      comment (string)
nspawn    state (string)
password  length (uint16), saved (bool), checkrecovery (bool), password (*string)
pkg       state (string), allowuntrusted (bool), allownonfree (bool), allowunsupported (bool)
print     msg (string)
svc       state (string), startup (string), session (bool)
timer     interval (uint32)
user      state (string), uid (*uint32), gid (*uint32), group (*string), groups ([]string), homedir (*string), allowduplicateuid (bool)
virt      uri (string), state (string), transient (bool), cpus (uint), maxcpus (uint), memory (uint64), osinit (string), boot ([]string), disk ([]resources.diskDevice), cdrom ([]resources.cdRomDevice), network ([]resources.networkDevice), filesystem ([]resources.filesystemDevice), auth (*resources.VirtAuth), hotcpus (bool), restartondiverge (string), restartonrefresh (bool)

It's ugly atm, eg: no proper indicator for readonly types.

purpleidea

Sweet! Two broad design questions:

Shouldn't resource output contain the types in our type system equivalent instead of what they actually are?
Can we add a --xml flag to produce machine readable output too? We can postpone for a later patch though.

purpleidea · 2018-02-27T20:01:19Z

lib/info.go

+	if err != nil {
+		return err
+	}
+	w := tabwriter.NewWriter(os.Stdout, 0, 8, 2, ' ', 0)


Can we have these vars be const (at the top), if only to improve readability please?

purpleidea · 2018-02-27T20:01:33Z

lib/info.go

+	"github.com/urfave/cli"
+)
+
+var myPrintln = fmt.Printf


what's this?

leftover from the wrong approach to capture test output

purpleidea · 2018-02-27T20:02:28Z

lib/info.go

+	switch c.Command.Name {
+	case "resources":
+		for _, name := range resources.RegisteredResourcesNames() {
+			if name == "test" {


why skip it? It's real :)

purpleidea · 2018-02-27T20:03:18Z

lib/info.go

+			s := reflect.ValueOf(res).Elem()
+			typeOfT := s.Type()
+
+			var fields []string


use, improve, or add to one of the functions in resources/util.go please,

if anything wouldn't we want the info sub commands to be separate functions?

purpleidea · 2018-02-27T20:03:55Z

lib/info.go

+			if err != nil {
+				continue
+			}
+			switch fn.(type) {


_, ok := fn.(interfaces.PolyFunc)

purpleidea · 2018-02-27T20:04:41Z

lib/info_test.go

+	assert.Contains(t, out.String(), "load() struct{x1 float; x5 float; x15 float}")
+}
+
+// func TestPolyFunctionsWithTypes(t *testing.T) {


add or delete?

scratchpad until i have polyfuncs figured out or for a 2.0 patch of this feature

purpleidea · 2018-02-27T20:05:20Z

resources/resources.go

 //	return nil
 //}
+
+// Lookup returns a pointer to the resource's struct.


Not sure why we need a helper function for this.

Just mirroring funcs Lookup here

also registeredResources is private :)

I didn't realize this was in resources.go :P

purpleidea · 2018-02-27T20:06:41Z

lib/info.go

+	return nil
+}
+
+// infocmd takes the cli context and returns the requested output


golang style says InfoCmd or infoCmd please, but not sure why this is a separate function altogether

to allow unit testing the output without jumping through hoops to capture it (eg: rerouting stdout, etc)

aequitas · 2018-02-27T20:22:54Z

@purpleidea

1: the resource rending is more a hack than a preferred implementation, if you know of a way to get the right output i'm all ears

2: if there is an easy library which can write this to XML in a open format suitable for this kind of data I will add it in, otherwise next patch.

purpleidea · 2018-02-27T20:30:23Z

@aequitas Indeed, there is already such an XML lib as seen in yamlgraph2/ being used.

aequitas · 2018-02-27T20:35:44Z

@purpleidea I don't see any xml reference in yamlgraph2? Can you point me to where it is?

purpleidea · 2018-02-27T20:39:36Z

@aequitas Sorry, by brain accidentally some letters. Yaml*:

https://github.com/purpleidea/mgmt/blob/master/yamlgraph2/gconfig.go#L31

aequitas · 2018-02-27T20:53:37Z

@purpleidea so you want xml output or yaml output? :) Why not both? We could maybe use YAML as an intermediate format for XML (and JSON for that matter :D)

purpleidea · 2018-02-27T20:54:41Z

@aequitas Just yaml is sufficient :)

purpleidea · 2018-02-27T20:57:14Z

lib/info.go

+	"github.com/urfave/cli"
+)
+
+const (


https://golang.org/doc/effective_go.html#mixed-caps

probably these could be public if you want.

i know, i'm following the names set by the tabwriter package, let me know if you prefer proper go names instead

oh gosh. Another inconsistency in their own style guide? Gah. Sorry. Do the right thing. If golangv2 fixes these things, we'll be ahead of the curve.

aequitas · 2018-03-13T11:53:54Z

#368 (comment)

aequitas force-pushed the info branch 6 times, most recently from bb91bd3 to 0e96031 Compare February 27, 2018 15:39

aequitas force-pushed the info branch from 0e96031 to 3b25610 Compare February 27, 2018 16:25

purpleidea requested changes Feb 27, 2018

View reviewed changes

aequitas force-pushed the info branch 2 times, most recently from 69d190a to 281e7b0 Compare February 27, 2018 20:52

purpleidea reviewed Feb 27, 2018

View reviewed changes

aequitas force-pushed the info branch 5 times, most recently from 8144f05 to c855607 Compare March 5, 2018 13:47

aequitas added 2 commits March 5, 2018 17:16

test: Go integrationtests

1457ba6

cli: Add info command

8b4f51c

aequitas force-pushed the info branch from c855607 to 8b4f51c Compare March 5, 2018 16:18

aequitas closed this Mar 13, 2018

Uh oh!

Conversation

aequitas commented Feb 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aequitas commented Feb 27, 2018

Uh oh!

aequitas commented Feb 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

purpleidea left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aequitas Feb 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aequitas commented Feb 27, 2018

Uh oh!

purpleidea commented Feb 27, 2018

Uh oh!

aequitas commented Feb 27, 2018

Uh oh!

purpleidea commented Feb 27, 2018

Uh oh!

aequitas commented Feb 27, 2018

Uh oh!

purpleidea commented Feb 27, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aequitas commented Mar 13, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

aequitas commented Feb 27, 2018 •

edited

Loading

aequitas commented Feb 27, 2018 •

edited

Loading

aequitas Feb 27, 2018 •

edited

Loading