feat(CLI): Unify CLI style about env and image (#550)

* unify cli style Signed-off-by: Jinjing.Zhou <allenzhou@tensorchord.ai> * fix style Signed-off-by: Jinjing.Zhou <allenzhou@tensorchord.ai> * fix test Signed-off-by: Jinjing.Zhou <allenzhou@tensorchord.ai> * fix test Signed-off-by: Jinjing.Zhou <allenzhou@tensorchord.ai> * address comment Signed-off-by: Jinjing.Zhou <allenzhou@tensorchord.ai>
tensorchord · Jul 5, 2022 · f71cd7f · f71cd7f
1 parent 50bf248
commit f71cd7f
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 50 deletions.
diff --git a/pkg/app/app.go b/pkg/app/app.go
@@ -55,7 +55,8 @@ func New() EnvdApp {
  CommandBuild,
  CommandContext,
  CommandDestroy,
- CommandGet,
+ CommandEnvironment,
+ CommandImage,
  CommandInit,
  CommandPause,
  CommandPrune,

diff --git a/pkg/app/get_env.go → pkg/app/env.go b/pkg/app/get_env.go → pkg/app/env.go
@@ -29,15 +29,22 @@ import (
  "github.com/tensorchord/envd/pkg/types"
 )
 
-var CommandGetEnvironment = &cli.Command{
+var CommandEnvironment = &cli.Command{
  Name: "envs",
  Aliases: []string{"env", "e"},
- Usage: "List envd environments",
+ Usage: "Manage envd environments",
 
  Subcommands: []*cli.Command{
- CommandGetEnvironmentDependency,
+ CommandDescribeEnvironment,
+ CommandListEnv,
  },
- Action: getEnvironment,
+}
+
+var CommandListEnv = &cli.Command{
+ Name: "list",
+ Aliases: []string{"ls", "l"},
+ Usage: "List envd environments",
+ Action: getEnvironment,
 }
 
 func getEnvironment(clicontext *cli.Context) error {

diff --git a/pkg/app/get_env_dep.go → pkg/app/env_describe.go b/pkg/app/get_env_dep.go → pkg/app/env_describe.go
@@ -27,10 +27,10 @@ import (
  "github.com/tensorchord/envd/pkg/types"
 )
 
-var CommandGetEnvironmentDependency = &cli.Command{
- Name: "deps",
- Aliases: []string{"dep", "d"},
- Usage: "List all dependencies",
+var CommandDescribeEnvironment = &cli.Command{
+ Name: "describe",
+ Aliases: []string{"d"},
+ Usage: "Show details about environments, including dependencies",
  Flags: []cli.Flag{
  &cli.StringFlag{
  Name: "env",

diff --git a/pkg/app/get.go b/pkg/app/get.go
diff --git a/pkg/app/get_env_test.go b/pkg/app/get_env_test.go
@@ -23,7 +23,7 @@ import (
 
 var _ = Describe("get env command", func() {
  args := []string{
- "envd.test", "--debug", "get", "envs",
+ "envd.test", "--debug", "envs", "list",
  }
  BeforeEach(func() {
  Expect(home.Initialize()).NotTo(HaveOccurred())

diff --git a/pkg/app/get_image.go → pkg/app/image.go b/pkg/app/get_image.go → pkg/app/image.go
@@ -29,16 +29,22 @@ import (
  "github.com/tensorchord/envd/pkg/types"
 )
 
-var CommandGetImage = &cli.Command{
+var CommandImage = &cli.Command{
  Name: "images",
  Aliases: []string{"image", "i"},
- Usage: "List envd images",
+ Usage: "Manage envd images",
 
  Subcommands: []*cli.Command{
- CommandGetImageDependency,
+ CommandDescribeImage,
+ CommandListImage,
  },
+}
 
- Action: getImage,
+var CommandListImage = &cli.Command{
+ Name: "list",
+ Aliases: []string{"ls", "l"},
+ Usage: "List envd images",
+ Action: getImage,
 }
 
 func getImage(clicontext *cli.Context) error {

diff --git a/pkg/app/get_image_dep.go → pkg/app/image_describe.go b/pkg/app/get_image_dep.go → pkg/app/image_describe.go
@@ -23,10 +23,10 @@ import (
  "github.com/tensorchord/envd/pkg/envd"
 )
 
-var CommandGetImageDependency = &cli.Command{
- Name: "deps",
- Aliases: []string{"dep", "d"},
- Usage: "List all dependencies in the image",
+var CommandDescribeImage = &cli.Command{
+ Name: "describe",
+ Aliases: []string{"d"},
+ Usage: "Show details about image, including dependencies",
  Flags: []cli.Flag{
  &cli.StringFlag{
  Name: "image",

diff --git a/pkg/app/up_test.go b/pkg/app/up_test.go
@@ -50,7 +50,7 @@ var _ = Describe("up command", func() {
  Expect(err).NotTo(HaveOccurred())
 
  depsArgs := append(baseArgs, []string{
- "get", "envs", "deps", "--env", env,
+ "envs", "describe", "--env", env,
  }...)
 
  err = app.Run(depsArgs)

diff --git a/pkg/shell/zsh_test.go b/pkg/shell/zsh_test.go
@@ -25,7 +25,7 @@ import (
  "github.com/tensorchord/envd/pkg/util/fileutil"
 )
 
-var _ = Describe("zsh manager", func() {
+var _ = Describe("zsh manager", Serial, func() {
  zshManager := NewManager()
  BeforeEach(func() {
  Expect(home.Initialize()).NotTo(HaveOccurred())