Add test case for multiple image tags in build-docker-create

Author: agrasth

docker_test.go

@@ -179,104 +179,113 @@ func runPushTest(containerManager container.ContainerManagerType, imageName, mod
 	validateContainerBuild(tests.DockerBuildName, buildNumber, imagePath, module, 7, 5, 7, t)
 }
 
-// This test validate the collect build-info flow for fat-manifest images.
-// The way we build the fat manifest and push it to Artifactory is not important.
-// Therefore, this test runs only with docker.
-func TestPushFatManifestImage(t *testing.T) {
-	if !*tests.TestDocker {
-		t.Skip("Skipping test. To run it, add the '-test.docker=true' option.")
-	}
-	buildName := "push-fat-manifest" + tests.DockerBuildName
+// Common Methods
 
-	// Create temp test dir.
+func setupWorkspace(t *testing.T) (string, error) {
 	workspace, err := filepath.Abs(tests.Out)
-	assert.NoError(t, err)
-	assert.NoError(t, fileutils.CreateDirIfNotExist(workspace))
+	if err != nil {
+		return "", err
+	}
+	err = fileutils.CreateDirIfNotExist(workspace)
+	if err != nil {
+		return "", err
+	}
 	testDataDir := filepath.Join(filepath.FromSlash(tests.GetTestResourcesPath()), "docker")
 	files, err := os.ReadDir(testDataDir)
-
-	assert.NoError(t, err)
+	if err != nil {
+		return "", err
+	}
 	for _, file := range files {
 		if !file.IsDir() {
 			_, err := tests.ReplaceTemplateVariables(filepath.Join(testDataDir, file.Name()), tests.Out)
-			assert.NoError(t, err)
+			if err != nil {
+				return "", err
+			}
 		}
 	}
-	// Build the builder image locally.
+	return workspace, nil
+}
+
+func setupContainer(workspace, containerName string) (*tests.ContainerRequest, error) {
 	ctx := context.Background()
-	testContainer, err := tests.NewContainerRequest().
+	testContainerRequest, _ := tests.NewContainerRequest().
 		SetDockerfile(workspace, "Dockerfile.Buildx.Fatmanifest", nil).
 		Privileged().
 		Networks(rtNetwork).
-		Name("buildx_container").
+		Name(containerName).
 		Mount(mount.Mount{Type: mount.TypeBind, Source: workspace, Target: "/workspace", ReadOnly: false}).
 		Cmd("--insecure-registry", tests.RtContainerHostName).
-		// Docker daemon take times to load. In order to check if it's available we wait for a log message to indications that the Docker daemon has finished initializing.
 		WaitFor(wait.ForLog("API listen on /var/run/docker.sock").WithStartupTimeout(5*time.Minute)).
 		Remove().
 		Build(ctx, true)
-	assert.NoError(t, err, "Couldn't run create buildx image.")
-	defer func() { assert.NoError(t, testContainer.Terminate(ctx)) }()
-
-	// Enable the builder util in the container.
-	err = testContainer.Exec(ctx, "sh", "script.sh")
-	assert.NoError(t, err)
+	_, err := testContainerRequest.Start(ctx)
+	if err != nil {
+		log.Error(err)
+		return nil, err
+	}
+	return testContainerRequest, nil
+}
 
-	// login from the builder container toward the Artifactory.
+func loginToArtifactory(container *tests.ContainerRequest) error {
 	password := *tests.JfrogPassword
 	user := *tests.JfrogUser
 	if *tests.JfrogAccessToken != "" {
 		user = auth.ExtractUsernameFromAccessToken(*tests.JfrogAccessToken)
 		password = *tests.JfrogAccessToken
 	}
-	assert.NoError(t, testContainer.Exec(
-		ctx,
-		"docker",
-		"login",
+	return container.Exec(
+		context.Background(),
+		"docker", "login",
 		tests.RtContainerHostName,
 		"--username="+user,
-		"--password="+password))
+		"--password="+password,
+	)
+}
+
+// This test validate the collect build-info flow for fat-manifest images.
+// The way we build the fat manifest and push it to Artifactory is not important.
+// Therefore, this test runs only with docker.
+func TestPushFatManifestImage(t *testing.T) {
+	if !*tests.TestDocker {
+		t.Skip("Skipping test. To run it, add the '-test.docker=true' option.")
+	}
+
+	buildName := "push-fat-manifest" + tests.DockerBuildName
+	buildNumber := "1"
+
+	workspace, err := setupWorkspace(t)
+	assert.NoError(t, err)
+
+	testContainer, err := setupContainer(workspace, "buildx_container")
+	assert.NoError(t, err, "Couldn't create buildx image.")
+	defer func() { assert.NoError(t, testContainer.Terminate(context.Background())) }()
+
+	err = testContainer.Exec(context.Background(), "sh", "script.sh")
+	assert.NoError(t, err)
+
+	err = loginToArtifactory(testContainer)
+	assert.NoError(t, err)
+
 	buildxOutputFile := "buildmetadata"
+	err = testContainer.Exec(context.Background(),
+		"docker", "buildx", "build",
+		"--platform", "linux/amd64,linux/arm64,linux/arm/v7",
+		"--tag", path.Join(tests.RtContainerHostName, tests.DockerLocalRepo, tests.DockerImageName+"-multiarch-image"),
+		"-f", "Dockerfile.Fatmanifest",
+		"--metadata-file", "/workspace/"+buildxOutputFile,
+		"--push", ".",
+	)
+	assert.NoError(t, err)
 
-	// Run the builder in the container and push the fat-manifest image to artifactory
-	assert.NoError(t, testContainer.Exec(
-		ctx,
-		"docker",
-		"buildx",
-		"build",
-		"--platform",
-		"linux/amd64,linux/arm64,linux/arm/v7",
-		"--tag", path.Join(tests.RtContainerHostName,
-			tests.DockerLocalRepo,
-			tests.DockerImageName+"-multiarch-image"),
-		"-f",
-		"Dockerfile.Fatmanifest",
-		"--metadata-file",
-		"/workspace/"+buildxOutputFile,
-		"--push",
-		".",
-	))
-
-	// Run 'build-docker-create' & publish the results to Artifactory.
 	buildxOutput := filepath.Join(workspace, buildxOutputFile)
-	buildNumber := "1"
 	assert.NoError(t, artifactoryCli.Exec("build-docker-create", tests.DockerLocalRepo, "--image-file="+buildxOutput, "--build-name="+buildName, "--build-number="+buildNumber))
 	assert.NoError(t, artifactoryCli.Exec("build-publish", buildName, buildNumber))
 
-	// Validate the published build-info exits
 	publishedBuildInfo, found, err := tests.GetBuildInfo(serverDetails, buildName, buildNumber)
-	if err != nil {
-		assert.NoError(t, err)
-		return
-	}
-	if !found {
-		assert.True(t, found, "build info was expected to be found")
-		return
-	}
-
+	assert.NoError(t, err)
+	assert.True(t, found, "build info was expected to be found")
 	assert.True(t, len(publishedBuildInfo.BuildInfo.Modules) > 1)
 
-	// Validate build-name & build-number properties in all image layers
 	searchSpec := spec.NewBuilder().Pattern(tests.DockerLocalRepo + "/*").Build(buildName).Recursive(true).BuildSpec()
 	searchCmd := generic.NewSearchCommand()
 	searchCmd.SetServerDetails(serverDetails).SetSpec(searchSpec)
@@ -295,80 +304,42 @@ func TestPushMultiTaggedImage(t *testing.T) {
 	buildName := "push-multi-tagged" + tests.DockerBuildName
 	buildNumber := "1"
 
-	// Setup workspace
-	workspace, err := filepath.Abs(tests.Out)
-	assert.NoError(t, err)
-	assert.NoError(t, fileutils.CreateDirIfNotExist(workspace))
-	testDataDir := filepath.Join(filepath.FromSlash(tests.GetTestResourcesPath()), "docker")
-	files, err := os.ReadDir(testDataDir)
+	workspace, err := setupWorkspace(t)
 	assert.NoError(t, err)
-	for _, file := range files {
-		if !file.IsDir() {
-			_, err := tests.ReplaceTemplateVariables(filepath.Join(testDataDir, file.Name()), tests.Out)
-			assert.NoError(t, err)
-		}
-	}
 
-	// Build the builder image locally
-	ctx := context.Background()
-	testContainer, err := tests.NewContainerRequest().
-		SetDockerfile(workspace, "Dockerfile.Buildx.Fatmanifest", nil).
-		Privileged().
-		Networks(rtNetwork).
-		Name("buildx_multi_tag_container").
-		Mount(mount.Mount{Type: mount.TypeBind, Source: workspace, Target: "/workspace", ReadOnly: false}).
-		Cmd("--insecure-registry", tests.RtContainerHostName).
-		WaitFor(wait.ForLog("API listen on /var/run/docker.sock").WithStartupTimeout(5*time.Minute)).
-		Remove().
-		Build(ctx, true)
+	testContainer, err := setupContainer(workspace, "buildx_multi_tag_container")
 	assert.NoError(t, err, "Couldn't create buildx container.")
-	defer func() { assert.NoError(t, testContainer.Terminate(ctx)) }()
+	defer func() { assert.NoError(t, testContainer.Terminate(context.Background())) }()
 
-	// Enable builder
-	assert.NoError(t, testContainer.Exec(ctx, "sh", "script.sh"))
+	err = testContainer.Exec(context.Background(), "sh", "script.sh")
+	assert.NoError(t, err)
 
-	// Login to Artifactory
-	password := *tests.JfrogPassword
-	user := *tests.JfrogUser
-	if *tests.JfrogAccessToken != "" {
-		user = auth.ExtractUsernameFromAccessToken(*tests.JfrogAccessToken)
-		password = *tests.JfrogAccessToken
-	}
-	assert.NoError(t, testContainer.Exec(
-		ctx,
-		"docker", "login",
-		tests.RtContainerHostName,
-		"--username="+user,
-		"--password="+password))
+	err = loginToArtifactory(testContainer)
+	assert.NoError(t, err)
 
-	// Build & push image with multiple tags
 	imageName1 := path.Join(tests.RtContainerHostName, tests.DockerLocalRepo, tests.DockerImageName+"-multi:v1")
 	imageName2 := path.Join(tests.RtContainerHostName, tests.DockerLocalRepo, tests.DockerImageName+"-multi:latest")
 	buildxOutputFile := "multi-build-metadata"
-
-	assert.NoError(t, testContainer.Exec(
-		ctx,
+	err = testContainer.Exec(context.Background(),
 		"docker", "buildx", "build",
 		"--platform", "linux/amd64,linux/arm64",
 		"-t", imageName1,
 		"-t", imageName2,
 		"-f", "Dockerfile.Fatmanifest",
 		"--metadata-file", "/workspace/"+buildxOutputFile,
 		"--push", ".",
-	))
+	)
+	assert.NoError(t, err)
 
-	// Run build-docker-create & publish
 	buildxOutput := filepath.Join(workspace, buildxOutputFile)
 	assert.NoError(t, artifactoryCli.Exec("build-docker-create", tests.DockerLocalRepo, "--image-file="+buildxOutput, "--build-name="+buildName, "--build-number="+buildNumber))
 	assert.NoError(t, artifactoryCli.Exec("build-publish", buildName, buildNumber))
 
-	// Validate build-info is published
 	publishedBuildInfo, found, err := tests.GetBuildInfo(serverDetails, buildName, buildNumber)
 	assert.NoError(t, err)
 	assert.True(t, found, "build info was expected to be found")
 	assert.True(t, len(publishedBuildInfo.BuildInfo.Modules) >= 1)
 
-	// Validate build-name & build-number properties in all layers
 	searchSpec := spec.NewBuilder().Pattern(tests.DockerLocalRepo + "/*").Build(buildName).Recursive(true).BuildSpec()
 	searchCmd := generic.NewSearchCommand()
 	searchCmd.SetServerDetails(serverDetails).SetSpec(searchSpec)