From a5a1c5f2f139883ab1514012224dc6e38a26b2d4 Mon Sep 17 00:00:00 2001 From: Ulysses Souza Date: Tue, 14 Dec 2021 10:48:57 +0100 Subject: [PATCH 1/2] Add ddev's e2e test Signed-off-by: Ulysses Souza --- .github/workflows/ci.yml | 4 +- Makefile | 4 ++ pkg/e2e/ddev_test.go | 90 ++++++++++++++++++++++++++++++++++++++++ pkg/e2e/framework.go | 11 +++++ 4 files changed, 107 insertions(+), 2 deletions(-) create mode 100644 pkg/e2e/ddev_test.go diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 57fe3dad..500aeceb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -90,7 +90,7 @@ jobs: - name: Build for local E2E env: BUILD_TAGS: e2e - run: make -f builder.Makefile compose-plugin + run: make GIT_TAG=e2e-PR-${{ github.event.pull_request.number }}-${{ github.event.pull_request.head.sha }} -f builder.Makefile compose-plugin - name: E2E Test in plugin mode run: make e2e-compose @@ -123,7 +123,7 @@ jobs: - name: Build for local E2E env: BUILD_TAGS: e2e - run: make -f builder.Makefile compose-plugin + run: make GIT_TAG=e2e-PR-${{ github.event.pull_request.number }}-${{ github.event.pull_request.head.sha }} -f builder.Makefile compose-plugin - name: E2E Test in standalone mode run: make e2e-compose-standalone diff --git a/Makefile b/Makefile index 93febc4b..feffbe31 100644 --- a/Makefile +++ b/Makefile @@ -43,10 +43,14 @@ compose-plugin: ## Compile the compose cli-plugin .PHONY: e2e-compose e2e-compose: ## Run end to end local tests in plugin mode. Set E2E_TEST=TestName to run a single test + docker compose version go test $(TEST_FLAGS) -count=1 ./pkg/e2e .PHONY: e2e-compose-standalone e2e-compose-standalone: ## Run End to end local tests in standalone mode. Set E2E_TEST=TestName to run a single test + rm -f /usr/local/bin/docker-compose + cp bin/docker-compose /usr/local/bin + docker-compose version go test $(TEST_FLAGS) -count=1 --tags=standalone ./pkg/e2e .PHONY: mocks diff --git a/pkg/e2e/ddev_test.go b/pkg/e2e/ddev_test.go new file mode 100644 index 00000000..7f92b74f --- /dev/null +++ b/pkg/e2e/ddev_test.go @@ -0,0 +1,90 @@ +/* + Copyright 2020 Docker Compose CLI 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 e2e + +import ( + "fmt" + "os" + "path/filepath" + "runtime" + "strings" + "testing" + + "gotest.tools/v3/assert" +) + +const ddevVersion = "v1.18.2" + +func TestComposeRunDdev(t *testing.T) { + if !composeStandaloneMode { + t.Skip("Not running on standalone mode.") + } + if runtime.GOOS == "windows" { + t.Skip("Running on Windows. Skipping...") + } + c := NewParallelE2eCLI(t, binDir) + dir, err := os.MkdirTemp("", t.Name()+"-") + assert.NilError(t, err) + + siteName := filepath.Base(dir) + + t.Cleanup(func() { + _ = c.RunCmdInDir(dir, "./ddev", "delete", "-Oy") + _ = c.RunCmdInDir(dir, "./ddev", "poweroff") + _ = os.RemoveAll(dir) + }) + + osName := "linux" + if runtime.GOOS == "darwin" { + osName = "macos" + } + + compressedFilename := fmt.Sprintf("ddev_%s-%s.%s.tar.gz", osName, runtime.GOARCH, ddevVersion) + c.RunCmdInDir(dir, "curl", "-LO", + fmt.Sprintf("https://github.com/drud/ddev/releases/download/%s/%s", + ddevVersion, + compressedFilename)) + + c.RunCmdInDir(dir, "tar", "-xzf", compressedFilename) + c.RunDockerCmd("pull", "drud/ddev-ssh-agent:v1.18.0") + c.RunDockerCmd("pull", "busybox:stable") + c.RunDockerCmd("pull", "phpmyadmin:5") + + c.RunDockerCmd("pull", tagged("drud/ddev-router")) + c.RunDockerCmd("pull", tagged("drud/ddev-dbserver-mariadb-10.3")) + c.RunDockerCmd("pull", tagged("drud/ddev-webserver")) + + // Create a simple index.php we can test against. + c.RunCmdInDir(dir, "sh", "-c", "echo 'index.php") + + c.RunCmdInDir(dir, "./ddev", "config", "--auto") + c.RunCmdInDir(dir, "./ddev", "config", "global", "--use-docker-compose-from-path") + + c.RunCmdInDir(dir, "./ddev", "poweroff") + + startRes := c.RunCmdInDir(dir, "./ddev", "start", "-y") + assert.Equal(c.test, startRes.ExitCode, 0, "Could not start project") + + curlRes := c.RunCmdInDir(dir, "curl", "-sSL", fmt.Sprintf("http://%s.ddev.site", siteName)) + out := curlRes.Stdout() + fmt.Println(out) + assert.Assert(c.test, strings.Contains(out, "ddev is working"), "Could not start project") +} + +func tagged(img string) string { + return fmt.Sprintf("%s:%s", img, ddevVersion) +} diff --git a/pkg/e2e/framework.go b/pkg/e2e/framework.go index d093fda3..fe2e17cb 100644 --- a/pkg/e2e/framework.go +++ b/pkg/e2e/framework.go @@ -192,6 +192,17 @@ func (c *E2eCLI) RunCmd(args ...string) *icmd.Result { return res } +// RunCmdInDir runs a command in a given dir, expects no error and returns a result +func (c *E2eCLI) RunCmdInDir(dir string, args ...string) *icmd.Result { + fmt.Printf("\t[%s] %s\n", c.test.Name(), strings.Join(args, " ")) + assert.Assert(c.test, len(args) >= 1, "require at least one command in parameters") + cmd := c.NewCmd(args[0], args[1:]...) + cmd.Dir = dir + res := icmd.RunCmd(cmd) + res.Assert(c.test, icmd.Success) + return res +} + // RunDockerCmd runs a docker command, expects no error and returns a result func (c *E2eCLI) RunDockerCmd(args ...string) *icmd.Result { if len(args) > 0 && args[0] == compose.PluginName { From 97d46a14eff5e0dc60bd5f81c8bac8280fe74ec6 Mon Sep 17 00:00:00 2001 From: Randy Fay Date: Mon, 28 Mar 2022 06:38:27 -0600 Subject: [PATCH 2/2] Fix problems with ddev e2e test and minor cleanup, add tmate (#27) * Add tmate for debugging * Use -parallel=1 for standaone tests Signed-off-by: Randy Fay --- .github/workflows/ci.yml | 13 +++++++++++++ Makefile | 2 +- pkg/e2e/ddev_test.go | 26 +++++++++++--------------- 3 files changed, 25 insertions(+), 16 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 500aeceb..72d46e31 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,6 +5,12 @@ on: branches: - v2 pull_request: + workflow_dispatch: + inputs: + debug_enabled: + description: 'To run with tmate enter "debug_enabled"' + required: false + default: "false" jobs: lint: @@ -125,5 +131,12 @@ jobs: BUILD_TAGS: e2e run: make GIT_TAG=e2e-PR-${{ github.event.pull_request.number }}-${{ github.event.pull_request.head.sha }} -f builder.Makefile compose-plugin + - name: Setup tmate session + uses: mxschmitt/action-tmate@v3 + with: + limit-access-to-actor: true + github-token: ${{ secrets.GITHUB_TOKEN }} + if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled }} + - name: E2E Test in standalone mode run: make e2e-compose-standalone diff --git a/Makefile b/Makefile index feffbe31..be593999 100644 --- a/Makefile +++ b/Makefile @@ -51,7 +51,7 @@ e2e-compose-standalone: ## Run End to end local tests in standalone mode. Set E2 rm -f /usr/local/bin/docker-compose cp bin/docker-compose /usr/local/bin docker-compose version - go test $(TEST_FLAGS) -count=1 --tags=standalone ./pkg/e2e + go test $(TEST_FLAGS) -v -count=1 -parallel=1 --tags=standalone ./pkg/e2e .PHONY: mocks mocks: diff --git a/pkg/e2e/ddev_test.go b/pkg/e2e/ddev_test.go index 7f92b74f..bb1eaeeb 100644 --- a/pkg/e2e/ddev_test.go +++ b/pkg/e2e/ddev_test.go @@ -27,7 +27,7 @@ import ( "gotest.tools/v3/assert" ) -const ddevVersion = "v1.18.2" +const ddevVersion = "v1.19.1" func TestComposeRunDdev(t *testing.T) { if !composeStandaloneMode { @@ -36,10 +36,15 @@ func TestComposeRunDdev(t *testing.T) { if runtime.GOOS == "windows" { t.Skip("Running on Windows. Skipping...") } + _ = os.Setenv("DDEV_DEBUG", "true") + c := NewParallelE2eCLI(t, binDir) dir, err := os.MkdirTemp("", t.Name()+"-") assert.NilError(t, err) + // ddev needs to be able to find mkcert to figure out where certs are. + _ = os.Setenv("PATH", fmt.Sprintf("%s:%s", os.Getenv("PATH"), dir)) + siteName := filepath.Base(dir) t.Cleanup(func() { @@ -60,31 +65,22 @@ func TestComposeRunDdev(t *testing.T) { compressedFilename)) c.RunCmdInDir(dir, "tar", "-xzf", compressedFilename) - c.RunDockerCmd("pull", "drud/ddev-ssh-agent:v1.18.0") - c.RunDockerCmd("pull", "busybox:stable") - c.RunDockerCmd("pull", "phpmyadmin:5") - - c.RunDockerCmd("pull", tagged("drud/ddev-router")) - c.RunDockerCmd("pull", tagged("drud/ddev-dbserver-mariadb-10.3")) - c.RunDockerCmd("pull", tagged("drud/ddev-webserver")) // Create a simple index.php we can test against. c.RunCmdInDir(dir, "sh", "-c", "echo 'index.php") c.RunCmdInDir(dir, "./ddev", "config", "--auto") c.RunCmdInDir(dir, "./ddev", "config", "global", "--use-docker-compose-from-path") + vRes := c.RunCmdInDir(dir, "./ddev", "version") + out := vRes.Stdout() + fmt.Printf("ddev version: %s\n", out) c.RunCmdInDir(dir, "./ddev", "poweroff") - startRes := c.RunCmdInDir(dir, "./ddev", "start", "-y") - assert.Equal(c.test, startRes.ExitCode, 0, "Could not start project") + c.RunCmdInDir(dir, "./ddev", "start", "-y") curlRes := c.RunCmdInDir(dir, "curl", "-sSL", fmt.Sprintf("http://%s.ddev.site", siteName)) - out := curlRes.Stdout() + out = curlRes.Stdout() fmt.Println(out) assert.Assert(c.test, strings.Contains(out, "ddev is working"), "Could not start project") } - -func tagged(img string) string { - return fmt.Sprintf("%s:%s", img, ddevVersion) -}