Rename Metadata.Ls to Metadata.Keys (#736)

* rename Metadata.Ls to Metadata.Keys

Signed-off-by: David Chung <david.chung@docker.com>

* rename RPC method Metadata.List -> Metadata.Keys

Signed-off-by: David Chung <david.chung@docker.com>

* fix tests

Signed-off-by: David Chung <david.chung@docker.com>

Author: David Chung

cmd/infrakit/manager/manager.go

@@ -22,7 +22,6 @@ import (
 	"github.com/docker/infrakit/pkg/spi/group"
 	"github.com/docker/infrakit/pkg/spi/metadata"
 	"github.com/docker/infrakit/pkg/types"
-	"github.com/sergi/go-diff/diffmatchpatch"
 	"github.com/spf13/cobra"
 )
 
@@ -237,111 +236,6 @@ func Command(plugins func() discovery.Plugins) *cobra.Command {
 		},
 	}
 
-	///////////////////////////////////////////////////////////////////////////////////
-	// change
-	change := &cobra.Command{
-		Use:   "change",
-		Short: "Change returns the plugin configurations known by the manager",
-	}
-	vars := change.Flags().StringSlice("var", []string{}, "key=value pairs")
-	commitChange := change.Flags().BoolP("commit", "c", false, "Commit changes")
-
-	// This is the only interactive command.  We want to show the user the proposal, with the diff
-	// and when the user accepts the change, call a commit.
-	change.RunE = func(cmd *cobra.Command, args []string) error {
-
-		if len(args) != 0 {
-			cmd.Usage()
-			os.Exit(1)
-		}
-
-		// get the changes
-		changes, err := changeSet(*vars)
-		if err != nil {
-			return err
-		}
-		current, proposed, cas, err := updatablePlugin.Changes(changes)
-		if err != nil {
-			return err
-		}
-		currentBuff, err := current.MarshalYAML()
-		if err != nil {
-			return err
-		}
-
-		proposedBuff, err := proposed.MarshalYAML()
-		if err != nil {
-			return err
-		}
-
-		if *commitChange {
-			fmt.Printf("Committing changes, hash=%s\n", cas)
-		} else {
-			fmt.Printf("Proposed changes, hash=%s\n", cas)
-		}
-
-		// Render the delta
-		dmp := diffmatchpatch.New()
-		diffs := dmp.DiffMain(string(currentBuff), string(proposedBuff), false)
-		fmt.Println(dmp.DiffPrettyText(diffs))
-
-		if *commitChange {
-			return updatablePlugin.Commit(proposed, cas)
-		}
-
-		return nil
-	}
-	change.Flags().AddFlagSet(templateFlags)
-
-	///////////////////////////////////////////////////////////////////////////////////
-	// change-list
-	changeList := &cobra.Command{
-		Use:   "ls",
-		Short: "Lists all the changeable paths",
-		RunE: func(cmd *cobra.Command, args []string) error {
-
-			if len(args) != 0 {
-				cmd.Usage()
-				os.Exit(1)
-			}
-
-			all, err := types.ListAll(updatablePlugin, types.PathFromString("."))
-			if err != nil {
-				return err
-			}
-
-			types.SortPaths(all)
-			for _, p := range all {
-				fmt.Println(p.String())
-			}
-			return nil
-		},
-	}
-	///////////////////////////////////////////////////////////////////////////////////
-	// change-cat
-	changeGet := &cobra.Command{
-		Use:   "cat",
-		Short: "Cat returns the current value at given path",
-		RunE: func(cmd *cobra.Command, args []string) error {
-
-			if len(args) != 1 {
-				cmd.Usage()
-				os.Exit(1)
-			}
-
-			path := types.PathFromString(args[0])
-			any, err := updatablePlugin.Get(path)
-			if err != nil {
-				return err
-			}
-
-			fmt.Println(any.String())
-
-			return nil
-		},
-	}
-	change.AddCommand(changeList, changeGet)
-
 	cmd.AddCommand(commit, inspect, leader)
 
 	return cmd

docs/plugin/metadata/vars/README.md

@@ -64,7 +64,7 @@ variable `INFRAKIT_VARS_TEMPLATE` as a way to set it.
 
 Corresponding to the SPI methods, there are new commands / verbs as `metadata`:
 
-  + `ls` lists the metadata paths
+  + `keys` lists the metadata paths
   + `cat` reads metadata values
   + `change` updates metadata values, provided the plugin implements the updatable SPI (not readonly)
 
@@ -130,15 +130,15 @@ Usage:
 Available Commands:
   cat         Get metadata entry by path
   change      Update metadata where args are key=value pairs and keys are within namespace of the plugin.
-  vars        List metadata
+  keys        List metadata
 ```
 
 ### Listing, Reading
 
 Listing metadata values:
 
 ```shell
-$ infrakit vars vars -al
+$ infrakit vars keys -al
 total 6:
 cluster/name
 cluster/size
@@ -151,7 +151,7 @@ zones/west/cidr
 or
 
 ```shell
-$ infrakit vars vars -al zones
+$ infrakit vars keys -al zones
 total 2:
 east/cidr
 west/cidr
@@ -363,7 +363,7 @@ Committing 2 changes, hash=ad861ded7a0742f9662c2b78354c89f6
 Now querying:
 
 ```shell
-$ infrakit vars vars -al
+$ infrakit vars keys -al
 total 2:
 cluster/name
 cluster/workers/size

pkg/cli/v0/metadata/cmd.go

@@ -13,22 +13,14 @@ import (
 var log = logutil.New("module", "cli/v1/metadata")
 
 func init() {
-	// cli.Register(metadata.InterfaceSpec,
-	// 	[]cli.CmdBuilder{
-	// 		Metadata,
-	// 	})
-	// cli.Register(metadata.UpdatableInterfaceSpec,
-	// 	[]cli.CmdBuilder{
-	// 		Updatable,
-	// 	})
 	cli.Register(metadata.InterfaceSpec,
 		[]cli.CmdBuilder{
-			Ls,
+			Keys,
 			Cat,
 		})
 	cli.Register(metadata.UpdatableInterfaceSpec,
 		[]cli.CmdBuilder{
-			Ls,
+			Keys,
 			Cat,
 			Change,
 		})
@@ -63,7 +55,7 @@ func Metadata(name string, services *cli.Services) *cobra.Command {
 	}
 
 	cmd.AddCommand(
-		Ls(name, services),
+		Keys(name, services),
 		Cat(name, services),
 	)
 
@@ -79,7 +71,7 @@ func Updatable(name string, services *cli.Services) *cobra.Command {
 	}
 
 	cmd.AddCommand(
-		Ls(name, services),
+		Keys(name, services),
 		Cat(name, services),
 		Change(name, services),
 	)

pkg/cli/v0/metadata/ls.go renamed to pkg/cli/v0/metadata/keys.go

@@ -9,19 +9,19 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// Ls returns the Ls command
-func Ls(name string, services *cli.Services) *cobra.Command {
+// Keys returns the Keys command
+func Keys(name string, services *cli.Services) *cobra.Command {
 
-	ls := &cobra.Command{
-		Use:   "ls",
+	keys := &cobra.Command{
+		Use:   "keys",
 		Short: "List metadata",
 	}
 
-	long := ls.Flags().BoolP("long", "l", false, "Print full path")
-	all := ls.Flags().BoolP("all", "a", false, "Find all under the paths given")
-	quick := ls.Flags().BoolP("quick", "q", false, "True to turn off headers, etc.")
+	long := keys.Flags().BoolP("long", "l", false, "Print full path")
+	all := keys.Flags().BoolP("all", "a", false, "Find all under the paths given")
+	quick := keys.Flags().BoolP("quick", "q", false, "True to turn off headers, etc.")
 
-	ls.RunE = func(cmd *cobra.Command, args []string) error {
+	keys.RunE = func(cmd *cobra.Command, args []string) error {
 
 		metadataPlugin, err := loadPlugin(services.Plugins(), name)
 		if err != nil {
@@ -59,7 +59,7 @@ func Ls(name string, services *cli.Services) *cobra.Command {
 					nodes = append(nodes, c)
 				}
 			} else {
-				children, err := metadataPlugin.List(path)
+				children, err := metadataPlugin.Keys(path)
 				if err != nil {
 					log.Warn("Cannot metadata ls on plugin", "name", name, "err", err)
 				}
@@ -89,15 +89,15 @@ func Ls(name string, services *cli.Services) *cobra.Command {
 		}
 		return nil
 	}
-	return ls
+	return keys
 }
 
 func listAll(m metadata.Plugin, path types.Path) ([]types.Path, error) {
 	if m == nil {
 		return nil, fmt.Errorf("no plugin")
 	}
 	result := []types.Path{}
-	nodes, err := m.List(path)
+	nodes, err := m.Keys(path)
 	if err != nil {
 		return nil, err
 	}

pkg/plugin/flavor/kubernetes/flavor.go

@@ -209,12 +209,12 @@ func (s *baseFlavor) Healthy(flavorProperties *types.Any, inst instance.Descript
 	return flavor.Healthy, nil
 }
 
-// List implements the metadata.Plugin SPI's List method
-func (s *baseFlavor) List(path types.Path) ([]string, error) {
+// Keys implements the metadata.Plugin SPI's Keys method
+func (s *baseFlavor) Keys(path types.Path) ([]string, error) {
 	return nil, nil
 }
 
-// Get implements the metadata.Plugin SPI's List method
+// Get implements the metadata.Plugin SPI's Get method
 func (s *baseFlavor) Get(path types.Path) (*types.Any, error) {
 	if s.metadataPlugin != nil {
 		return s.metadataPlugin.Get(path)

pkg/plugin/flavor/swarm/flavor.go

@@ -113,15 +113,15 @@ func (s *baseFlavor) runMetadataSnapshot(stopSnapshot <-chan struct{}) chan func
 	return updateSnapshot
 }
 
-// List implements the metadata.Plugin SPI's List method
-func (s *baseFlavor) List(path types.Path) ([]string, error) {
+// Keys implements the metadata.Plugin SPI's Keys method
+func (s *baseFlavor) Keys(path types.Path) ([]string, error) {
 	if s.metadataPlugin != nil {
-		return s.metadataPlugin.List(path)
+		return s.metadataPlugin.Keys(path)
 	}
 	return nil, nil
 }
 
-// Get implements the metadata.Plugin SPI's List method
+// Get implements the metadata.Plugin SPI's Get method
 func (s *baseFlavor) Get(path types.Path) (*types.Any, error) {
 	if s.metadataPlugin != nil {
 		return s.metadataPlugin.Get(path)

pkg/plugin/metadata/lazy.go

@@ -88,9 +88,9 @@ func (c *lazyConnect) do(f func(p metadata.Plugin) error) (err error) {
 	return f(c.client)
 }
 
-func (c *lazyConnect) List(path types.Path) (child []string, err error) {
+func (c *lazyConnect) Keys(path types.Path) (child []string, err error) {
 	err = c.do(func(p metadata.Plugin) error {
-		child, err = p.List(path)
+		child, err = p.Keys(path)
 		return err
 	})
 	return

pkg/plugin/metadata/lazy_test.go

@@ -54,7 +54,7 @@ func TestLazyNoBlock(t *testing.T) {
 
 type fake chan int
 
-func (f fake) List(path types.Path) (child []string, err error) {
+func (f fake) Keys(path types.Path) (child []string, err error) {
 	f <- 1
 	return
 }

pkg/plugin/metadata/plugin.go

@@ -52,9 +52,9 @@ type plugin struct {
 	reads chan func(data map[string]interface{})
 }
 
-// List returns a list of *child nodes* given a path, which is specified as a slice
+// Keys returns a list of *child nodes* given a path, which is specified as a slice
 // where for i > j path[i] is the parent of path[j]
-func (p *plugin) List(path types.Path) ([]string, error) {
+func (p *plugin) Keys(path types.Path) ([]string, error) {
 	if p.reads == nil && p.data != nil {
 		return types.List(path, p.data), nil
 	}

pkg/plugin/metadata/plugin_test.go

@@ -23,7 +23,7 @@ func TestPluginUnserializedReadWrites(t *testing.T) {
 
 	p := NewPluginFromData(m)
 
-	require.Equal(t, []string{"us-west-1", "us-west-2"}, first(p.List(types.PathFromString("/"))))
+	require.Equal(t, []string{"us-west-1", "us-west-2"}, first(p.Keys(types.PathFromString("/"))))
 	require.Nil(t, first(p.Get(types.PathFromString("us-west-1/metrics/instances/foo"))))
 	require.Equal(t, "2000", first(p.Get(types.PathFromString("us-west-1/metrics/instances/count"))).(*types.Any).String())