Merge pull request #447 from databacker/simplify-integration-tests

Simplify integration tests

Author: deitch

.github/workflows/ci.yaml

@@ -84,5 +84,3 @@ jobs:
         platforms: linux/amd64,linux/arm64
         tags: |
           ${{env.IMAGE_NAME}}:${{github.sha}}
-    - name: test
-      run: make test

Makefile

@@ -35,10 +35,10 @@ push: build
 	docker push $(TARGET)
 
 integration_test:
-	go test -v ./test --tags=integration
+	TEST_INTEGRATION=true go test -v ./test
 
 integration_test_debug:
-	dlv --wd=./test test ./test --build-flags="-tags=integration"
+	TEST_INTEGRATION=true dlv --wd=./test test ./test
 
 vet:
 	go vet --tags=integration ./...

test/backup_log_containers.go

@@ -1,4 +1,4 @@
-//go:build integration && !logs
+//go:build !logs
 
 package test
 

test/backup_nolog_containers.go

@@ -1,4 +1,4 @@
-//go:build integration && logs
+//go:build logs
 
 package test
 

test/backup_teardown_test.go

@@ -1,5 +1,3 @@
-//go:build integration
-
 package test
 
 import "fmt"

test/backup_test.go

@@ -1,5 +1,3 @@
-//go:build integration
-
 package test
 
 import (
@@ -33,6 +31,7 @@ import (
 
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
+	imagetypes "github.com/docker/docker/api/types/image"
 	"github.com/docker/docker/client"
 	"github.com/docker/docker/pkg/stdcopy"
 	"github.com/docker/go-connections/nat"
@@ -84,11 +83,11 @@ type backupTarget struct {
 }
 
 type testOptions struct {
-	compact      bool
+	compact      bool //nolint:unused // used in the future
 	targets      []string
 	dc           *dockerContext
 	base         string
-	prePost      bool
+	prePost      bool //nolint:unused // used in the future
 	backupData   []byte
 	mysql        containerPort
 	smb          containerPort
@@ -335,8 +334,8 @@ func (d *dockerContext) makeSMB(smbImage string) error {
 	if err != nil {
 		return fmt.Errorf("failed to build smb image: %w", err)
 	}
-	io.Copy(os.Stdout, resp.Body)
-	resp.Body.Close()
+	_, _ = io.Copy(os.Stdout, resp.Body)
+	_ = resp.Body.Close()
 
 	return nil
 }
@@ -442,7 +441,9 @@ DELIMITER ;
 	if err != nil {
 		return err
 	}
-	defer fCompact.Close()
+	defer func() {
+		_ = fCompact.Close()
+	}()
 
 	_, _ = stdcopy.StdCopy(fCompact, &bufe, attachResp.Reader)
 
@@ -463,12 +464,15 @@ DELIMITER ;
 	if err != nil {
 		return err
 	}
-	defer f.Close()
+	defer func() {
+		_ = f.Close()
+	}()
 
 	_, _ = stdcopy.StdCopy(f, &bufe, attachResp.Reader)
 	return err
 }
 
+//nolint:unused // useful in the future
 func (d *dockerContext) logContainers(cids ...string) error {
 	ctx := context.Background()
 	for _, cid := range cids {
@@ -480,7 +484,9 @@ func (d *dockerContext) logContainers(cids ...string) error {
 		if err != nil {
 			return fmt.Errorf("failed to get logs for container %s: %w", cid, err)
 		}
-		defer logs.Close()
+		defer func() {
+			_ = logs.Close()
+		}()
 
 		if _, err := io.Copy(os.Stdout, logs); err != nil {
 			return fmt.Errorf("failed to stream logs for container %s: %w", cid, err)
@@ -560,12 +566,12 @@ log_queries_not_using_indexes = 1
 		return mysql, smb, s3url, s3backend, fmt.Errorf("failed to create mysql log directory: %v", err)
 	}
 	// ensure we have mysql image
-	resp, err := dc.cli.ImagePull(context.Background(), mysqlImage, types.ImagePullOptions{})
+	resp, err := dc.cli.ImagePull(context.Background(), mysqlImage, imagetypes.PullOptions{})
 	if err != nil {
 		return mysql, smb, s3url, s3backend, fmt.Errorf("failed to pull mysql image: %v", err)
 	}
-	io.Copy(os.Stdout, resp)
-	resp.Close()
+	_, _ = io.Copy(os.Stdout, resp)
+	_ = resp.Close()
 	mysqlCID, mysqlPort, err := dc.startContainer(mysqlImage, "mysql", "3306/tcp", []string{fmt.Sprintf("%s:/etc/mysql/conf.d/log.conf:ro", confFile), fmt.Sprintf("%s:/var/log/mysql", logDir)}, nil, []string{
 		fmt.Sprintf("MYSQL_ROOT_PASSWORD=%s", mysqlRootPass),
 		"MYSQL_DATABASE=tester",
@@ -594,8 +600,7 @@ func backupTargetsToStorage(targets []backupTarget, base, s3 string) ([]storage.
 	var targetVals []storage.Storage
 	// all targets should have the same sequence, with varying subsequence, so take any one
 	for _, tgt := range targets {
-		tg := tgt.String()
-		tg = tgt.WithPrefix(base)
+		tg := tgt.WithPrefix(base)
 		localPath := tgt.LocalPath()
 		if err := os.MkdirAll(localPath, 0o755); err != nil {
 			return nil, fmt.Errorf("failed to create local path %s: %v", localPath, err)
@@ -753,13 +758,13 @@ func checkDumpTest(t *testing.T, base string, expected []byte, s3backend gofakes
 			if _, err := os.Stat(postBackupOutFile); err != nil {
 				t.Errorf("%s script didn't run, output file doesn't exist", msg)
 			}
-			os.RemoveAll(postBackupOutFile)
+			_ = os.RemoveAll(postBackupOutFile)
 
 			msg = fmt.Sprintf("%s %s pre-backup", id, target.String())
 			if _, err := os.Stat(preBackupOutFile); err != nil {
 				t.Errorf("%s script didn't run, output file doesn't exist", msg)
 			}
-			os.RemoveAll(preBackupOutFile)
+			_ = os.RemoveAll(preBackupOutFile)
 		}
 		p := target.Path()
 		if p == "" {
@@ -805,8 +810,6 @@ func checkDumpTest(t *testing.T, base string, expected []byte, s3backend gofakes
 		// to each format
 		assert.Equal(t, expectedFiltered, string(b), "%s tar contents do not match actual dump", id)
 	}
-
-	return
 }
 
 // gunzipUntarScanFilter is a helper function to extract the actual data from a backup
@@ -817,7 +820,9 @@ func gunzipUntarScanFilter(r io.Reader) (b []byte, err error) {
 	if err != nil {
 		return nil, err
 	}
-	defer gr.Close()
+	defer func() {
+		_ = gr.Close()
+	}()
 	tr := tar.NewReader(gr)
 	if _, err := tr.Next(); err != nil {
 		return nil, err
@@ -886,12 +891,12 @@ func populatePrePost(base string, targets []backupTarget) (err error) {
 }
 
 func startDatabase(dc *dockerContext, baseDir, image, name string) (containerPort, error) {
-	resp, err := dc.cli.ImagePull(context.Background(), image, types.ImagePullOptions{})
+	resp, err := dc.cli.ImagePull(context.Background(), image, imagetypes.PullOptions{})
 	if err != nil {
 		return containerPort{}, fmt.Errorf("failed to pull mysql image: %v", err)
 	}
-	io.Copy(os.Stdout, resp)
-	resp.Close()
+	_, _ = io.Copy(os.Stdout, resp)
+	_ = resp.Close()
 
 	// start the mysql container; configure it for lots of debug logging, in case we need it
 	mysqlConf := `
@@ -931,6 +936,7 @@ log_queries_not_using_indexes = 1
 }
 
 func TestIntegration(t *testing.T) {
+	CheckSkipIntegration(t, "integration")
 	syscall.Umask(0)
 	dc, err := getDockerContext()
 	if err != nil {

test/package_noteardown_test.go

@@ -1,9 +1,7 @@
-//go:build integration && keepcontainers
+//go:build keepcontainers
 
 package test
 
-import "fmt"
-
 func teardown(dc *dockerContext, cids ...string) error {
 	return nil
 }

test/util_test.go

@@ -0,0 +1,21 @@
+package test
+
+import (
+	"os"
+	"testing"
+)
+
+const (
+	integrationTestEnvVar = "TEST_INTEGRATION"
+)
+
+func IsIntegration() bool {
+	val, isIntegration := os.LookupEnv(integrationTestEnvVar)
+	return isIntegration && val != "false" && val != ""
+}
+
+func CheckSkipIntegration(t *testing.T, name string) {
+	if !IsIntegration() {
+		t.Skipf("Skipping integration test %s, set %s to run", integrationTestEnvVar, name)
+	}
+}