feat: Move cmd to pkg/app (#250)

* feat: Move cmd to pkg/app

Signed-off-by: Ce Gao <cegao@tensorchord.ai>

* fix: Fix test failures

Signed-off-by: Ce Gao <cegao@tensorchord.ai>

* fix: Fix test failure

Signed-off-by: Ce Gao <cegao@tensorchord.ai>

* fix: Fix govet

Signed-off-by: Ce Gao <cegao@tensorchord.ai>

cmd/envd/main.go

@@ -19,17 +19,11 @@ import (
  "os"
 
  "github.com/cockroachdb/errors"
- _ "github.com/moby/buildkit/client/connhelper/dockercontainer"
- _ "github.com/moby/buildkit/client/connhelper/kubepod"
- _ "github.com/moby/buildkit/client/connhelper/podmancontainer"
- "github.com/sirupsen/logrus"
- "github.com/spf13/viper"
  cli "github.com/urfave/cli/v2"
  "go.starlark.net/starlark"
  "go.starlark.net/syntax"
 
- "github.com/tensorchord/envd/pkg/flag"
- "github.com/tensorchord/envd/pkg/home"
+ "github.com/tensorchord/envd/pkg/app"
  "github.com/tensorchord/envd/pkg/version"
 )
 
@@ -38,61 +32,8 @@ func run(args []string) (bool, error) {
  fmt.Println(c.App.Name, version.Package, c.App.Version, version.Revision)
  }
 
- // TODO(gaocegege): Enclose the app, maybe create the struct envdApp.
- app := cli.NewApp()
- app.EnableBashCompletion = true
- app.Name = "envd"
- app.Usage = "Build tools for data scientists"
- app.Version = version.GetVersion().String()
- app.Flags = []cli.Flag{
- &cli.BoolFlag{
- Name: "debug",
- Usage: "enable debug output in logs",
- },
- &cli.StringFlag{
- Name: flag.FlagBuildkitdImage,
- Usage: "docker image to use for buildkitd",
- Value: "docker.io/moby/buildkit:v0.10.3",
- },
- &cli.StringFlag{
- Name: flag.FlagBuildkitdContainer,
- Usage: "buildkitd container to use for buildkitd",
- Value: "envd_buildkitd",
- },
- }
-
- app.Commands = []*cli.Command{
- CommandBootstrap,
- CommandBuild,
- CommandDestroy,
- CommandGet,
- CommandPause,
- CommandResume,
- CommandUp,
- CommandVersion,
- }
-
- // Deal with debug flag.
- var debugEnabled bool
-
- app.Before = func(context *cli.Context) error {
- debugEnabled = context.Bool("debug")
-
- logrus.SetFormatter(&logrus.TextFormatter{FullTimestamp: true})
- if debugEnabled {
- logrus.SetLevel(logrus.DebugLevel)
- }
-
- if err := home.Initialize(); err != nil {
- return errors.Wrap(err, "failed to initialize home manager")
- }
-
- // TODO(gaocegege): Add a config struct to keep them.
- viper.Set(flag.FlagBuildkitdContainer, context.String(flag.FlagBuildkitdContainer))
- viper.Set(flag.FlagBuildkitdImage, context.String(flag.FlagBuildkitdImage))
- return nil
- }
- return debugEnabled, app.Run(args)
+ app := app.New()
+ return app.Debug, app.Run(args)
 }
 
 func handleErr(debug bool, err error) {

pkg/app/app.go

@@ -0,0 +1,95 @@
+// Copyright 2022 The envd Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package app
+
+import (
+ "github.com/cockroachdb/errors"
+ _ "github.com/moby/buildkit/client/connhelper/dockercontainer"
+ _ "github.com/moby/buildkit/client/connhelper/kubepod"
+ _ "github.com/moby/buildkit/client/connhelper/podmancontainer"
+ "github.com/sirupsen/logrus"
+ "github.com/spf13/viper"
+ cli "github.com/urfave/cli/v2"
+
+ "github.com/tensorchord/envd/pkg/flag"
+ "github.com/tensorchord/envd/pkg/home"
+ "github.com/tensorchord/envd/pkg/version"
+)
+
+type EnvdApp struct {
+ cli.App
+ Debug bool
+}
+
+func New() EnvdApp {
+ internalApp := cli.NewApp()
+ internalApp.EnableBashCompletion = true
+ internalApp.Name = "envd"
+ internalApp.Usage = "Build tools for data scientists"
+ internalApp.Version = version.GetVersion().String()
+ internalApp.Flags = []cli.Flag{
+ &cli.BoolFlag{
+ Name: "debug",
+ Usage: "enable debug output in logs",
+ },
+ &cli.StringFlag{
+ Name: flag.FlagBuildkitdImage,
+ Usage: "docker image to use for buildkitd",
+ Value: "docker.io/moby/buildkit:v0.10.3",
+ },
+ &cli.StringFlag{
+ Name: flag.FlagBuildkitdContainer,
+ Usage: "buildkitd container to use for buildkitd",
+ Value: "envd_buildkitd",
+ },
+ }
+
+ internalApp.Commands = []*cli.Command{
+ CommandBootstrap,
+ CommandBuild,
+ CommandDestroy,
+ CommandGet,
+ CommandPause,
+ CommandResume,
+ CommandUp,
+ CommandVersion,
+ }
+
+ // Deal with debug flag.
+ var debugEnabled bool
+
+ internalApp.Before = func(context *cli.Context) error {
+ debugEnabled = context.Bool("debug")
+
+ logrus.SetFormatter(&logrus.TextFormatter{FullTimestamp: true})
+ if debugEnabled {
+ logrus.SetLevel(logrus.DebugLevel)
+ }
+
+ if err := home.Initialize(); err != nil {
+ return errors.Wrap(err, "failed to initialize home manager")
+ }
+
+ // TODO(gaocegege): Add a config struct to keep them.
+ viper.Set(flag.FlagBuildkitdContainer, context.String(flag.FlagBuildkitdContainer))
+ viper.Set(flag.FlagBuildkitdImage, context.String(flag.FlagBuildkitdImage))
+ return nil
+ }
+
+ return EnvdApp{
+ App: *internalApp,
+ Debug: debugEnabled,
+ }
+}

cmd/envd/bootstrap.go → pkg/app/bootstrap.go

@@ -11,7 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-package main
+package app
 
 import (
  "github.com/cockroachdb/errors"

cmd/envd/build.go → pkg/app/build.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "path/filepath"

cmd/envd/build_test.go → pkg/app/build_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "context"
@@ -31,14 +31,18 @@ var _ = Describe("build command", func() {
  }
  BeforeEach(func() {
  Expect(home.Initialize()).NotTo(HaveOccurred())
+ app := New()
+ err := app.Run([]string{"envd.test", "--debug", "bootstrap"})
+ Expect(err).NotTo(HaveOccurred())
  cli, err := docker.NewClient(context.TODO())
  Expect(err).NotTo(HaveOccurred())
  _, err = cli.Destroy(context.TODO(), buildContext)
  Expect(err).NotTo(HaveOccurred())
  })
  When("given the right arguments", func() {
  It("should build successfully", func() {
- _, err := run(args)
+ app := New()
+ err := app.Run(args)
  Expect(err).NotTo(HaveOccurred())
  })
  })

cmd/envd/destroy.go → pkg/app/destroy.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "path/filepath"

cmd/envd/get.go → pkg/app/get.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  cli "github.com/urfave/cli/v2"

cmd/envd/get_env.go → pkg/app/get_env.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "fmt"

cmd/envd/get_env_dep.go → pkg/app/get_env_dep.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "io"

cmd/envd/get_image.go → pkg/app/get_image.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "io"

cmd/envd/get_image_dep.go → pkg/app/get_image_dep.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "os"

cmd/envd/pause.go → pkg/app/pause.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "github.com/cockroachdb/errors"

cmd/envd/resume.go → pkg/app/resume.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "github.com/cockroachdb/errors"

cmd/envd/suite_test.go → pkg/app/suite_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "testing"

cmd/envd/up.go → pkg/app/up.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "fmt"

cmd/envd/up_test.go → pkg/app/up_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "context"
@@ -31,19 +31,23 @@ var _ = Describe("up command", func() {
  }
  BeforeEach(func() {
  Expect(home.Initialize()).NotTo(HaveOccurred())
+ app := New()
+ err := app.Run([]string{"envd.test", "--debug", "bootstrap"})
+ Expect(err).NotTo(HaveOccurred())
  cli, err := docker.NewClient(context.TODO())
  Expect(err).NotTo(HaveOccurred())
  _, err = cli.Destroy(context.TODO(), buildContext)
  Expect(err).NotTo(HaveOccurred())
  })
  When("given the right arguments", func() {
  It("should up and destroy successfully", func() {
- _, err := run(args)
+ app := New()
+ err := app.Run(args)
  Expect(err).NotTo(HaveOccurred())
  destroyArgs := []string{
  "envd.test", "--debug", "destroy", "--path", buildContext,
  }
- _, err = run(destroyArgs)
+ err = app.Run(destroyArgs)
  Expect(err).NotTo(HaveOccurred())
  })
  })

cmd/envd/version.go → pkg/app/version.go

@@ -12,10 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package app
 
 import (
  "fmt"
+
  "github.com/tensorchord/envd/pkg/version"
  "github.com/urfave/cli/v2"
 )

pkg/buildkitd/buildkitd.go

@@ -112,7 +112,7 @@ func (c *generalClient) maybeStart(ctx context.Context,
  return "", err
  }
  }
- c.logger.Debug("container is running, check if it's ready...")
+ c.logger.Debugf("container is running, check if it's ready at %s...", c.BuildkitdAddr())
 
  if err := c.waitUntilConnected(ctx, connectingTimeout); err != nil {
  return "", errors.Wrap(err, "failed to connect to buildkitd")
@@ -133,7 +133,7 @@ func (c generalClient) waitUntilConnected(
  case <-time.After(interval):
  connected, err := c.connected(ctxTimeout)
  if err != nil {
- logrus.Debug("failed to connect to buildkitd")
+ logrus.Debugf("failed to connect to buildkitd: %s", err.Error())
  continue
  }
  if !connected {