internal: refactor namespaces to be profiles

Author: shoenig

README.md

@@ -68,19 +68,19 @@ GLOBALS:
 --help/-h   boolean - print help message
 ```
 
-#### set a namespace
+#### create/update a profile
 
 ```bash
 $ envy set example FOO=1 BAR=2 BAZ=3
 ```
 
-#### update existing variable in a namespace
+#### update existing variable in a profile
 
 ```bash
 $ envy set example FOO=4
 ```
 
-#### remove variable from namespace
+#### remove variable from profile
 
 ```bash
 $ envy set example -FOO
@@ -112,7 +112,7 @@ BAR=2
 BAZ-3
 ```
 
-#### list namespaces
+#### list available profiles
 
 ```bash
 $ envy list
@@ -122,27 +122,27 @@ nomad/e2e
 test
 ```
 
-#### show namespace
+#### show variables in a profile
 
 ```bash
 $ envy show test
 AWS_ACCESS_KEY_ID
 AWS_SECRET_ACCESS_KEY
 ```
 
-#### show namespace w/ values
+#### show profile variables w/ values
 
 ```bash
 $ envy show -decrypt test
 AWS_ACCESS_KEY_ID=aaabbbccc
 AWS_SECRET_ACCESS_KEY=233kjsdf309jfsd
 ```
 
-#### remove namespace
+#### delete profile
 
 ```bash
 $ envy purge test
-purged namespace "test"
+purged profile "test"
 ```
 
 # Contributing

internal/commands/common.go

@@ -18,8 +18,8 @@ import (
 )
 
 var (
-	argRe       = regexp.MustCompile(`^(?P<key>\w+)=(?P<secret>.+)$`)
-	namespaceRe = regexp.MustCompile(`^[-:/\w]+$`)
+	argRe     = regexp.MustCompile(`^(?P<key>\w+)=(?P<secret>.+)$`)
+	profileRe = regexp.MustCompile(`^[-:/\w]+$`)
 )
 
 const (
@@ -53,16 +53,16 @@ func invoke(args []string, tool *setup.Tool) babycli.Code {
 	return r.Run()
 }
 
-func checkName(namespace string) error {
-	if !namespaceRe.MatchString(namespace) {
-		return errors.New("namespace uses non-word characters")
+func checkName(profile string) error {
+	if !profileRe.MatchString(profile) {
+		return errors.New("name uses non-word characters")
 	}
 	return nil
 }
 
 type Extractor interface {
-	PreProcess(args []string) (string, *set.Set[string], *set.HashSet[*conceal.Text, int], error)
-	Namespace(vars *set.HashSet[*conceal.Text, int]) (*safe.Namespace, error)
+	Process(args []string) (string, *set.Set[string], *set.HashSet[*conceal.Text, int], error)
+	Profile(vars *set.HashSet[*conceal.Text, int]) (*safe.Profile, error)
 }
 
 type extractor struct {
@@ -75,14 +75,14 @@ func newExtractor(ring keyring.Ring) Extractor {
 	}
 }
 
-// PreProcess returns
-// - the namespace
+// Process returns
+// - the profile
 // - the set of keys to be removed
 // - the set of key/values to be added
 // - any error
-func (e *extractor) PreProcess(args []string) (string, *set.Set[string], *set.HashSet[*conceal.Text, int], error) {
+func (e *extractor) Process(args []string) (string, *set.Set[string], *set.HashSet[*conceal.Text, int], error) {
 	if len(args) < 2 {
-		return "", nil, nil, errors.New("requires at least 2 arguments (namespace, <key,...>)")
+		return "", nil, nil, errors.New("requires at least 2 arguments (profile, <key,...>)")
 	}
 	ns := args[0]
 	rm := set.New[string](4)
@@ -101,12 +101,12 @@ func (e *extractor) PreProcess(args []string) (string, *set.Set[string], *set.Ha
 	return ns, rm, add, nil
 }
 
-func (e *extractor) Namespace(vars *set.HashSet[*conceal.Text, int]) (*safe.Namespace, error) {
+func (e *extractor) Profile(vars *set.HashSet[*conceal.Text, int]) (*safe.Profile, error) {
 	content, err := e.process(vars.Slice())
 	if err != nil {
 		return nil, err
 	}
-	return &safe.Namespace{
+	return &safe.Profile{
 		Name:    "",
 		Content: content,
 	}, nil

internal/commands/exec.go

@@ -57,8 +57,8 @@ func newExecCmd(tool *setup.Tool) *babycli.Component {
 		},
 	}
 }
-func env(tool *setup.Tool, ns *safe.Namespace, environment []string) []string {
-	for key, value := range ns.Content {
+func env(tool *setup.Tool, pr *safe.Profile, environment []string) []string {
+	for key, value := range pr.Content {
 		secret := tool.Ring.Decrypt(value).Unveil()
 		environment = append(environment, fmt.Sprintf(
 			"%s=%s", key, secret,
@@ -74,13 +74,13 @@ func envContext(insulate bool) []string {
 	return os.Environ()
 }
 
-func newCmd(tool *setup.Tool, ns *safe.Namespace, insulate bool, argVars []string, command string, args []string) *exec.Cmd {
+func newCmd(tool *setup.Tool, ns *safe.Profile, insulate bool, argVars []string, command string, args []string) *exec.Cmd {
 	ctx := context.Background()
 	cmd := exec.CommandContext(ctx, command, args...)
 
 	// Environment variables are injected in the following order:
 	// 1. OS variables if insulate is false
-	// 2. envy namespace vars
+	// 2. envy profile vars
 	// 3. Variables in input args
 	cmd.Env = append(env(tool, ns, envContext(insulate)), argVars...)
 	cmd.Stdout = os.Stdout

internal/commands/exec_test.go

@@ -43,7 +43,7 @@ func TestExecCmd_ok(t *testing.T) {
 		Box:    box,
 	}
 
-	box.GetMock.Expect("myNS").Return(&safe.Namespace{
+	box.GetMock.Expect("myNS").Return(&safe.Profile{
 		Name: "myNS",
 		Content: map[string]safe.Encrypted{
 			"a": {0x1},
@@ -100,7 +100,7 @@ func TestExecCmd_bad_command(t *testing.T) {
 		Box:    box,
 	}
 
-	box.GetMock.Expect("myNS").Return(&safe.Namespace{
+	box.GetMock.Expect("myNS").Return(&safe.Profile{
 		Name: "myNS",
 		Content: map[string]safe.Encrypted{
 			"a": {0x1},

internal/commands/list.go

@@ -17,14 +17,14 @@ func newListCmd(tool *setup.Tool) *babycli.Component {
 				tool.Writer.Errorf("list command expects no args")
 				return babycli.Failure
 			}
-			namespaces, err := tool.Box.List()
+			profiles, err := tool.Box.List()
 			if err != nil {
-				tool.Writer.Errorf("unable to list namespaces: %v", err)
+				tool.Writer.Errorf("unable to list profiles: %v", err)
 				return babycli.Failure
 			}
 
-			for _, ns := range namespaces {
-				tool.Writer.Printf("%s", ns)
+			for _, profile := range profiles {
+				tool.Writer.Printf("%s", profile)
 			}
 			return babycli.Success
 		},

internal/commands/list_test.go

@@ -53,7 +53,7 @@ func TestListCmd_list_fails(t *testing.T) {
 
 	must.One(t, rc)
 	must.Eq(t, "", a.String())
-	must.Eq(t, "envy: unable to list namespaces: io error\n", b.String())
+	must.Eq(t, "envy: unable to list profiles: io error\n", b.String())
 }
 
 func TestListCmd_extra_args(t *testing.T) {

internal/commands/purge_test.go

@@ -79,12 +79,12 @@ func TestPurgeCmd_bad_profile(t *testing.T) {
 		Box:    box,
 	}
 
-	// namespace must be valid
+	// profile must be valid
 	rc := invoke([]string{"purge", "foo=bar"}, tool)
 
 	must.One(t, rc)
 	must.Eq(t, "", a.String())
-	must.Eq(t, "envy: unable to purge profile: namespace uses non-word characters\n", b.String())
+	must.Eq(t, "envy: unable to purge profile: name uses non-word characters\n", b.String())
 }
 
 func TestPurgeCmd_two_arg(t *testing.T) {

internal/commands/set.go

@@ -15,30 +15,30 @@ func newSetCmd(tool *setup.Tool) *babycli.Component {
 		Function: func(c *babycli.Component) babycli.Code {
 			args := c.Arguments()
 			extractor := newExtractor(tool.Ring)
-			namespace, remove, add, err := extractor.PreProcess(args)
+			profile, remove, add, err := extractor.Process(args)
 			if err != nil {
 				tool.Writer.Errorf("unable to parse args: %v", err)
 				return babycli.Failure
 			}
 
-			if err = checkName(namespace); err != nil {
-				tool.Writer.Errorf("could not set namespace: %v", err)
+			if err = checkName(profile); err != nil {
+				tool.Writer.Errorf("could not set profile: %v", err)
 				return babycli.Failure
 			}
 
 			if !remove.Empty() {
-				if err := tool.Box.Delete(namespace, remove); err != nil {
+				if err := tool.Box.Delete(profile, remove); err != nil {
 					tool.Writer.Errorf("coult not remove variables: %v", err)
 					return babycli.Failure
 				}
 			}
 
-			n, err := extractor.Namespace(add)
+			n, err := extractor.Profile(add)
 			if err != nil {
 				tool.Writer.Errorf("unable to parse args: %v", err)
 				return babycli.Failure
 			}
-			n.Name = namespace
+			n.Name = profile
 
 			if err = tool.Box.Set(n); err != nil {
 				tool.Writer.Errorf("unable to set variables: %v", err)

internal/commands/set_test.go

@@ -26,7 +26,7 @@ func TestSetCmd_ok(t *testing.T) {
 	ring.EncryptMock.When(conceal.New("abc123")).Then(safe.Encrypted{8, 8, 8, 8, 8, 8})
 	ring.EncryptMock.When(conceal.New("1234")).Then(safe.Encrypted{9, 9, 9, 9})
 
-	box.SetMock.Expect(&safe.Namespace{
+	box.SetMock.Expect(&safe.Profile{
 		Name: "myNS",
 		Content: map[string]safe.Encrypted{
 			"foo": {8, 8, 8, 8, 8, 8},
@@ -56,7 +56,7 @@ func TestSetCmd_io_error(t *testing.T) {
 
 	a, b, w := newWriter()
 
-	box.SetMock.Expect(&safe.Namespace{
+	box.SetMock.Expect(&safe.Profile{
 		Name: "myNS",
 		Content: map[string]safe.Encrypted{
 			"foo": {8, 8, 8, 8, 8, 8},
@@ -95,12 +95,12 @@ func TestSetCmd_bad_ns(t *testing.T) {
 		Box:    box,
 	}
 
-	// e.g. forgot to specify namespace
+	// e.g. forgot to specify profile
 	rc := invoke([]string{"set", "foo=abc123", "bar=1234"}, tool)
 
 	must.One(t, rc)
 	must.Eq(t, "", a.String())
-	must.Eq(t, "envy: could not set namespace: namespace uses non-word characters\n", b.String())
+	must.Eq(t, "envy: could not set profile: name uses non-word characters\n", b.String())
 }
 
 func TestSetCmd_no_vars(t *testing.T) {
@@ -118,10 +118,10 @@ func TestSetCmd_no_vars(t *testing.T) {
 		Box:    box,
 	}
 
-	// e.g. reminder to use purge to remove namespace
+	// e.g. reminder to use purge to remove profile
 	rc := invoke([]string{"set", "ns1"}, tool)
 
 	must.One(t, rc)
 	must.Eq(t, "", a.String())
-	must.Eq(t, "envy: unable to parse args: requires at least 2 arguments (namespace, <key,...>)\n", b.String())
+	must.Eq(t, "envy: unable to parse args: requires at least 2 arguments (profile, <key,...>)\n", b.String())
 }

internal/commands/show_test.go

@@ -28,7 +28,7 @@ func TestShowCmd_Execute(t *testing.T) {
 		Box:    box,
 	}
 
-	box.GetMock.Expect("myNS").Return(&safe.Namespace{
+	box.GetMock.Expect("myNS").Return(&safe.Profile{
 		Name: "myNS",
 		Content: map[string]safe.Encrypted{
 			"foo": {1, 1, 1},
@@ -58,7 +58,7 @@ func TestShowCmd_Execute_unveil(t *testing.T) {
 		Box:    box,
 	}
 
-	box.GetMock.Expect("myNS").Return(&safe.Namespace{
+	box.GetMock.Expect("myNS").Return(&safe.Profile{
 		Name: "myNS",
 		Content: map[string]safe.Encrypted{
 			"foo": {1, 1, 1},