chore: Add more e2e test cases

.github/workflows/CI.yml

@@ -87,9 +87,6 @@ jobs:
             ${{ runner.OS }}-build-${{ env.cache-name }}-
             ${{ runner.OS }}-build-
             ${{ runner.OS }}-
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2
       - name: Verify mockgen
         run: |
           make generate && git add pkg &&

Makefile

@@ -145,7 +145,7 @@ test-local:
 	@go test -v -race -coverprofile=coverage.out ./...
 
 test: generate 
-	@go test -race -coverprofile=coverage.out ./...
+	@go test -race -coverpkg=./pkg/... -coverprofile=coverage.out ./...
 	@go tool cover -func coverage.out | tail -n 1 | awk '{ print "Total coverage: " $$3 }'
 
 clean:

README.md

@@ -234,8 +234,7 @@ deb https://mirror.sjtu.edu.cn/ubuntu focal-security main restricted universe mu
 """)
 config.pip_index(url = "https://mirror.sjtu.edu.cn/pypi/web/simple")
 install.vscode_extensions([
-    "ms-python.python",
-    "github.copilot"
+    "ms-python.python"
 ])
 ```
 

pkg/app/build_test.go

@@ -25,7 +25,7 @@ import (
 )
 
 var _ = Describe("build command", func() {
-	buildContext := "testdata"
+	buildContext := "testdata/build-test"
 	args := []string{
 		"envd.test", "--debug", "build", "--path", buildContext,
 	}

pkg/app/destroy.go

@@ -19,7 +19,7 @@ import (
 
 	"github.com/cockroachdb/errors"
 	"github.com/sirupsen/logrus"
-	"github.com/urfave/cli/v2"
+	cli "github.com/urfave/cli/v2"
 
 	"github.com/tensorchord/envd/pkg/docker"
 	sshconfig "github.com/tensorchord/envd/pkg/ssh/config"

pkg/app/get_env_test.go

@@ -0,0 +1,41 @@
+// 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/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/tensorchord/envd/pkg/home"
+)
+
+var _ = Describe("get env command", func() {
+	args := []string{
+		"envd.test", "--debug", "get", "envs",
+	}
+	BeforeEach(func() {
+		Expect(home.Initialize()).NotTo(HaveOccurred())
+		app := New()
+		err := app.Run([]string{"envd.test", "--debug", "bootstrap"})
+		Expect(err).NotTo(HaveOccurred())
+	})
+	When("given the right arguments", func() {
+		It("should get the environments successfully", func() {
+			app := New()
+			err := app.Run(args)
+			Expect(err).NotTo(HaveOccurred())
+		})
+	})
+})

pkg/app/testdata/build-test/build.envd

@@ -0,0 +1,2 @@
+def build():
+    base(os="ubuntu20.04", language="python3")

pkg/app/testdata/up-test/build.envd

@@ -0,0 +1,12 @@
+def build():
+    base(os="ubuntu20.04", language="python3")
+    install.python_packages(name = [
+        "ormb",
+    ])
+    install.system_packages(name = ["screenfetch"])
+    shell("zsh")
+    config.pip_index(url = "https://pypi.tuna.tsinghua.edu.cn/simple")
+    git_config(name="envd", email="envd@envd", editor="vim")
+    install.vscode_extensions([
+        "ms-python.python"
+    ])

pkg/app/up_test.go

@@ -25,28 +25,40 @@ import (
 )
 
 var _ = Describe("up command", func() {
-	buildContext := "testdata"
-	args := []string{
-		"envd.test", "--debug", "up", "--path", buildContext, "--detach",
+	buildContext := "testdata/up-test"
+	env := "up-test"
+	baseArgs := []string{
+		"envd.test", "--debug",
 	}
 	BeforeEach(func() {
 		Expect(home.Initialize()).NotTo(HaveOccurred())
 		app := New()
-		err := app.Run([]string{"envd.test", "--debug", "bootstrap"})
+		err := app.Run(append(baseArgs, "bootstrap"))
 		Expect(err).NotTo(HaveOccurred())
 		cli, err := docker.NewClient(context.TODO())
 		Expect(err).NotTo(HaveOccurred())
-		_, err = cli.Destroy(context.TODO(), buildContext)
+		_, err = cli.Destroy(context.TODO(), env)
 		Expect(err).NotTo(HaveOccurred())
 	})
 	When("given the right arguments", func() {
 		It("should up and destroy successfully", func() {
+			args := append(baseArgs, []string{
+				"up", "--path", buildContext, "--detach",
+			}...)
 			app := New()
 			err := app.Run(args)
 			Expect(err).NotTo(HaveOccurred())
-			destroyArgs := []string{
-				"envd.test", "--debug", "destroy", "--path", buildContext,
-			}
+
+			depsArgs := append(baseArgs, []string{
+				"get", "envs", "deps", "--env", env,
+			}...)
+
+			err = app.Run(depsArgs)
+			Expect(err).NotTo(HaveOccurred())
+
+			destroyArgs := append(baseArgs, []string{
+				"destroy", "--path", buildContext,
+			}...)
 			err = app.Run(destroyArgs)
 			Expect(err).NotTo(HaveOccurred())
 		})

pkg/editor/vscode/vscode.go

@@ -24,7 +24,7 @@ import (
 	"github.com/sirupsen/logrus"
 
 	"github.com/tensorchord/envd/pkg/home"
-	"github.com/tensorchord/envd/pkg/unzip"
+	"github.com/tensorchord/envd/pkg/util/ziputil"
 )
 
 const (
@@ -134,7 +134,7 @@ func (c generalClient) DownloadOrCache(p Plugin) (bool, error) {
 		return false, err
 	}
 
-	_, err = unzip.Unzip(filename, unzipPath(p))
+	_, err = ziputil.Unzip(filename, unzipPath(p))
 	if err != nil {
 		return false, errors.Wrap(err, "failed to unzip")
 	}

pkg/ssh/config/key.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package sshconfig
+package config
 
 import (
 	"crypto/rand"

pkg/ssh/config/ssh_config.go

@@ -14,7 +14,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package sshconfig
+package config
 
 import (
 	"bufio"

pkg/ssh/config/ssh_config_suite_test.go

@@ -0,0 +1,27 @@
+// 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 config
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestMain(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "ssh config Suite")
+}

pkg/ssh/config/ssh_config_test.go

@@ -0,0 +1,40 @@
+// 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 config
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("ssh config", func() {
+	When("giving a empty ssh config", func() {
+		It("Should add/remove the config successfully", func() {
+			env := "test-ssh-config"
+			iface := "localhost"
+			port := 8888
+			keyPath := "key"
+			err := add(getSSHConfigPath(), buildHostname(env), iface, port, keyPath)
+			Expect(err).NotTo(HaveOccurred())
+
+			actual, err := GetPort(env)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(actual).To(Equal(port))
+
+			err = remove(getSSHConfigPath(), env)
+			Expect(err).NotTo(HaveOccurred())
+		})
+	})
+})

pkg/unzip/unzip.go → pkg/util/ziputil/unzip.go

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package unzip
+package ziputil
 
 import (
 	"archive/zip"