384 lines
11 KiB
Go
384 lines
11 KiB
Go
package build
|
|
|
|
import (
|
|
"archive/tar"
|
|
"bytes"
|
|
"io"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"runtime"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/docker/docker/pkg/archive"
|
|
)
|
|
|
|
const dockerfileContents = "FROM busybox"
|
|
|
|
var prepareEmpty = func(t *testing.T) (string, func()) {
|
|
return "", func() {}
|
|
}
|
|
|
|
var prepareNoFiles = func(t *testing.T) (string, func()) {
|
|
return createTestTempDir(t, "", "builder-context-test")
|
|
}
|
|
|
|
var prepareOneFile = func(t *testing.T) (string, func()) {
|
|
contextDir, cleanup := createTestTempDir(t, "", "builder-context-test")
|
|
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents, 0777)
|
|
return contextDir, cleanup
|
|
}
|
|
|
|
func testValidateContextDirectory(t *testing.T, prepare func(t *testing.T) (string, func()), excludes []string) {
|
|
contextDir, cleanup := prepare(t)
|
|
defer cleanup()
|
|
|
|
err := ValidateContextDirectory(contextDir, excludes)
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error should be nil, got: %s", err)
|
|
}
|
|
}
|
|
|
|
func TestGetContextFromLocalDirNoDockerfile(t *testing.T) {
|
|
contextDir, cleanup := createTestTempDir(t, "", "builder-context-test")
|
|
defer cleanup()
|
|
|
|
absContextDir, relDockerfile, err := GetContextFromLocalDir(contextDir, "")
|
|
|
|
if err == nil {
|
|
t.Fatalf("Error should not be nil")
|
|
}
|
|
|
|
if absContextDir != "" {
|
|
t.Fatalf("Absolute directory path should be empty, got: %s", absContextDir)
|
|
}
|
|
|
|
if relDockerfile != "" {
|
|
t.Fatalf("Relative path to Dockerfile should be empty, got: %s", relDockerfile)
|
|
}
|
|
}
|
|
|
|
func TestGetContextFromLocalDirNotExistingDir(t *testing.T) {
|
|
contextDir, cleanup := createTestTempDir(t, "", "builder-context-test")
|
|
defer cleanup()
|
|
|
|
fakePath := filepath.Join(contextDir, "fake")
|
|
|
|
absContextDir, relDockerfile, err := GetContextFromLocalDir(fakePath, "")
|
|
|
|
if err == nil {
|
|
t.Fatalf("Error should not be nil")
|
|
}
|
|
|
|
if absContextDir != "" {
|
|
t.Fatalf("Absolute directory path should be empty, got: %s", absContextDir)
|
|
}
|
|
|
|
if relDockerfile != "" {
|
|
t.Fatalf("Relative path to Dockerfile should be empty, got: %s", relDockerfile)
|
|
}
|
|
}
|
|
|
|
func TestGetContextFromLocalDirNotExistingDockerfile(t *testing.T) {
|
|
contextDir, cleanup := createTestTempDir(t, "", "builder-context-test")
|
|
defer cleanup()
|
|
|
|
fakePath := filepath.Join(contextDir, "fake")
|
|
|
|
absContextDir, relDockerfile, err := GetContextFromLocalDir(contextDir, fakePath)
|
|
|
|
if err == nil {
|
|
t.Fatalf("Error should not be nil")
|
|
}
|
|
|
|
if absContextDir != "" {
|
|
t.Fatalf("Absolute directory path should be empty, got: %s", absContextDir)
|
|
}
|
|
|
|
if relDockerfile != "" {
|
|
t.Fatalf("Relative path to Dockerfile should be empty, got: %s", relDockerfile)
|
|
}
|
|
}
|
|
|
|
func TestGetContextFromLocalDirWithNoDirectory(t *testing.T) {
|
|
contextDir, dirCleanup := createTestTempDir(t, "", "builder-context-test")
|
|
defer dirCleanup()
|
|
|
|
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents, 0777)
|
|
|
|
chdirCleanup := chdir(t, contextDir)
|
|
defer chdirCleanup()
|
|
|
|
absContextDir, relDockerfile, err := GetContextFromLocalDir(contextDir, "")
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when getting context from local dir: %s", err)
|
|
}
|
|
|
|
if absContextDir != contextDir {
|
|
t.Fatalf("Absolute directory path should be equal to %s, got: %s", contextDir, absContextDir)
|
|
}
|
|
|
|
if relDockerfile != DefaultDockerfileName {
|
|
t.Fatalf("Relative path to dockerfile should be equal to %s, got: %s", DefaultDockerfileName, relDockerfile)
|
|
}
|
|
}
|
|
|
|
func TestGetContextFromLocalDirWithDockerfile(t *testing.T) {
|
|
contextDir, cleanup := createTestTempDir(t, "", "builder-context-test")
|
|
defer cleanup()
|
|
|
|
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents, 0777)
|
|
|
|
absContextDir, relDockerfile, err := GetContextFromLocalDir(contextDir, "")
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when getting context from local dir: %s", err)
|
|
}
|
|
|
|
if absContextDir != contextDir {
|
|
t.Fatalf("Absolute directory path should be equal to %s, got: %s", contextDir, absContextDir)
|
|
}
|
|
|
|
if relDockerfile != DefaultDockerfileName {
|
|
t.Fatalf("Relative path to dockerfile should be equal to %s, got: %s", DefaultDockerfileName, relDockerfile)
|
|
}
|
|
}
|
|
|
|
func TestGetContextFromLocalDirLocalFile(t *testing.T) {
|
|
contextDir, cleanup := createTestTempDir(t, "", "builder-context-test")
|
|
defer cleanup()
|
|
|
|
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents, 0777)
|
|
testFilename := createTestTempFile(t, contextDir, "tmpTest", "test", 0777)
|
|
|
|
absContextDir, relDockerfile, err := GetContextFromLocalDir(testFilename, "")
|
|
|
|
if err == nil {
|
|
t.Fatalf("Error should not be nil")
|
|
}
|
|
|
|
if absContextDir != "" {
|
|
t.Fatalf("Absolute directory path should be empty, got: %s", absContextDir)
|
|
}
|
|
|
|
if relDockerfile != "" {
|
|
t.Fatalf("Relative path to Dockerfile should be empty, got: %s", relDockerfile)
|
|
}
|
|
}
|
|
|
|
func TestGetContextFromLocalDirWithCustomDockerfile(t *testing.T) {
|
|
contextDir, cleanup := createTestTempDir(t, "", "builder-context-test")
|
|
defer cleanup()
|
|
|
|
chdirCleanup := chdir(t, contextDir)
|
|
defer chdirCleanup()
|
|
|
|
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents, 0777)
|
|
|
|
absContextDir, relDockerfile, err := GetContextFromLocalDir(contextDir, DefaultDockerfileName)
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when getting context from local dir: %s", err)
|
|
}
|
|
|
|
if absContextDir != contextDir {
|
|
t.Fatalf("Absolute directory path should be equal to %s, got: %s", contextDir, absContextDir)
|
|
}
|
|
|
|
if relDockerfile != DefaultDockerfileName {
|
|
t.Fatalf("Relative path to dockerfile should be equal to %s, got: %s", DefaultDockerfileName, relDockerfile)
|
|
}
|
|
|
|
}
|
|
|
|
func TestGetContextFromReaderString(t *testing.T) {
|
|
tarArchive, relDockerfile, err := GetContextFromReader(ioutil.NopCloser(strings.NewReader(dockerfileContents)), "")
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when executing GetContextFromReader: %s", err)
|
|
}
|
|
|
|
tarReader := tar.NewReader(tarArchive)
|
|
|
|
_, err = tarReader.Next()
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when reading tar archive: %s", err)
|
|
}
|
|
|
|
buff := new(bytes.Buffer)
|
|
buff.ReadFrom(tarReader)
|
|
contents := buff.String()
|
|
|
|
_, err = tarReader.Next()
|
|
|
|
if err != io.EOF {
|
|
t.Fatalf("Tar stream too long: %s", err)
|
|
}
|
|
|
|
if err = tarArchive.Close(); err != nil {
|
|
t.Fatalf("Error when closing tar stream: %s", err)
|
|
}
|
|
|
|
if dockerfileContents != contents {
|
|
t.Fatalf("Uncompressed tar archive does not equal: %s, got: %s", dockerfileContents, contents)
|
|
}
|
|
|
|
if relDockerfile != DefaultDockerfileName {
|
|
t.Fatalf("Relative path not equals %s, got: %s", DefaultDockerfileName, relDockerfile)
|
|
}
|
|
}
|
|
|
|
func TestGetContextFromReaderTar(t *testing.T) {
|
|
contextDir, cleanup := createTestTempDir(t, "", "builder-context-test")
|
|
defer cleanup()
|
|
|
|
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents, 0777)
|
|
|
|
tarStream, err := archive.Tar(contextDir, archive.Uncompressed)
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when creating tar: %s", err)
|
|
}
|
|
|
|
tarArchive, relDockerfile, err := GetContextFromReader(tarStream, DefaultDockerfileName)
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when executing GetContextFromReader: %s", err)
|
|
}
|
|
|
|
tarReader := tar.NewReader(tarArchive)
|
|
|
|
header, err := tarReader.Next()
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when reading tar archive: %s", err)
|
|
}
|
|
|
|
if header.Name != DefaultDockerfileName {
|
|
t.Fatalf("Dockerfile name should be: %s, got: %s", DefaultDockerfileName, header.Name)
|
|
}
|
|
|
|
buff := new(bytes.Buffer)
|
|
buff.ReadFrom(tarReader)
|
|
contents := buff.String()
|
|
|
|
_, err = tarReader.Next()
|
|
|
|
if err != io.EOF {
|
|
t.Fatalf("Tar stream too long: %s", err)
|
|
}
|
|
|
|
if err = tarArchive.Close(); err != nil {
|
|
t.Fatalf("Error when closing tar stream: %s", err)
|
|
}
|
|
|
|
if dockerfileContents != contents {
|
|
t.Fatalf("Uncompressed tar archive does not equal: %s, got: %s", dockerfileContents, contents)
|
|
}
|
|
|
|
if relDockerfile != DefaultDockerfileName {
|
|
t.Fatalf("Relative path not equals %s, got: %s", DefaultDockerfileName, relDockerfile)
|
|
}
|
|
}
|
|
|
|
func TestValidateContextDirectoryEmptyContext(t *testing.T) {
|
|
// This isn't a valid test on Windows. See https://play.golang.org/p/RR6z6jxR81.
|
|
// The test will ultimately end up calling filepath.Abs(""). On Windows,
|
|
// golang will error. On Linux, golang will return /. Due to there being
|
|
// drive letters on Windows, this is probably the correct behaviour for
|
|
// Windows.
|
|
if runtime.GOOS == "windows" {
|
|
t.Skip("Invalid test on Windows")
|
|
}
|
|
testValidateContextDirectory(t, prepareEmpty, []string{})
|
|
}
|
|
|
|
func TestValidateContextDirectoryContextWithNoFiles(t *testing.T) {
|
|
testValidateContextDirectory(t, prepareNoFiles, []string{})
|
|
}
|
|
|
|
func TestValidateContextDirectoryWithOneFile(t *testing.T) {
|
|
testValidateContextDirectory(t, prepareOneFile, []string{})
|
|
}
|
|
|
|
func TestValidateContextDirectoryWithOneFileExcludes(t *testing.T) {
|
|
testValidateContextDirectory(t, prepareOneFile, []string{DefaultDockerfileName})
|
|
}
|
|
|
|
// createTestTempDir creates a temporary directory for testing.
|
|
// It returns the created path and a cleanup function which is meant to be used as deferred call.
|
|
// When an error occurs, it terminates the test.
|
|
func createTestTempDir(t *testing.T, dir, prefix string) (string, func()) {
|
|
path, err := ioutil.TempDir(dir, prefix)
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when creating directory %s with prefix %s: %s", dir, prefix, err)
|
|
}
|
|
|
|
return path, func() {
|
|
err = os.RemoveAll(path)
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when removing directory %s: %s", path, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
// createTestTempSubdir creates a temporary directory for testing.
|
|
// It returns the created path but doesn't provide a cleanup function,
|
|
// so createTestTempSubdir should be used only for creating temporary subdirectories
|
|
// whose parent directories are properly cleaned up.
|
|
// When an error occurs, it terminates the test.
|
|
func createTestTempSubdir(t *testing.T, dir, prefix string) string {
|
|
path, err := ioutil.TempDir(dir, prefix)
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when creating directory %s with prefix %s: %s", dir, prefix, err)
|
|
}
|
|
|
|
return path
|
|
}
|
|
|
|
// createTestTempFile creates a temporary file within dir with specific contents and permissions.
|
|
// When an error occurs, it terminates the test
|
|
func createTestTempFile(t *testing.T, dir, filename, contents string, perm os.FileMode) string {
|
|
filePath := filepath.Join(dir, filename)
|
|
err := ioutil.WriteFile(filePath, []byte(contents), perm)
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when creating %s file: %s", filename, err)
|
|
}
|
|
|
|
return filePath
|
|
}
|
|
|
|
// chdir changes current working directory to dir.
|
|
// It returns a function which changes working directory back to the previous one.
|
|
// This function is meant to be executed as a deferred call.
|
|
// When an error occurs, it terminates the test.
|
|
func chdir(t *testing.T, dir string) func() {
|
|
workingDirectory, err := os.Getwd()
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when retrieving working directory: %s", err)
|
|
}
|
|
|
|
err = os.Chdir(dir)
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when changing directory to %s: %s", dir, err)
|
|
}
|
|
|
|
return func() {
|
|
err = os.Chdir(workingDirectory)
|
|
|
|
if err != nil {
|
|
t.Fatalf("Error when changing back to working directory (%s): %s", workingDirectory, err)
|
|
}
|
|
}
|
|
}
|