Skip to content

Commit f24bb4b

Browse files
thaJeztahthaJeztah
committed
cli/command/image/build: deprecate DefaultDockerfileName const
It was only used internal in the package. Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent c599e90 commit f24bb4b

File tree

2 files changed

+30
-25
lines changed

2 files changed

+30
-25
lines changed

‎cli/command/image/build/context.go‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,14 @@ import (
2525
"github.com/moby/patternmatcher"
2626
)
2727

28+
// DefaultDockerfileName is the Default filename with Docker commands, read by docker build
29+
//
30+
// Deprecated: this const is no longer used and will be removed in the next release.
31+
const DefaultDockerfileName string = "Dockerfile"
32+
2833
const (
29-
// DefaultDockerfileName is the Default filename with Docker commands, read by docker build
30-
DefaultDockerfileName string = "Dockerfile"
34+
// defaultDockerfileName is the Default filename with Docker commands, read by docker build
35+
defaultDockerfileName string = "Dockerfile"
3136
// archiveHeaderSize is the number of bytes in an archive header
3237
archiveHeaderSize = 512
3338
)
@@ -112,7 +117,7 @@ func DetectArchiveReader(input io.ReadCloser) (rc io.ReadCloser, ok bool, err er
112117
}
113118

114119
// WriteTempDockerfile writes a Dockerfile stream to a temporary file with a
115-
// name specified by DefaultDockerfileName and returns the path to the
120+
// name specified by defaultDockerfileName and returns the path to the
116121
// temporary directory containing the Dockerfile.
117122
func WriteTempDockerfile(rc io.ReadCloser) (dockerfileDir string, err error) {
118123
// err is a named return value, due to the defer call below.
@@ -126,7 +131,7 @@ func WriteTempDockerfile(rc io.ReadCloser) (dockerfileDir string, err error) {
126131
}
127132
}()
128133

129-
f, err := os.Create(filepath.Join(dockerfileDir, DefaultDockerfileName))
134+
f, err := os.Create(filepath.Join(dockerfileDir, defaultDockerfileName))
130135
if err != nil {
131136
return "", err
132137
}
@@ -173,7 +178,7 @@ func GetContextFromReader(rc io.ReadCloser, dockerfileName string) (out io.ReadC
173178
err := tarArchive.Close()
174179
_ = os.RemoveAll(dockerfileDir)
175180
return err
176-
}), DefaultDockerfileName, nil
181+
}), defaultDockerfileName, nil
177182
}
178183

179184
// IsArchive checks for the magic bytes of a tar or any supported compression
@@ -326,12 +331,12 @@ func getDockerfileRelPath(absContextDir, givenDockerfile string) (string, error)
326331
if absDockerfile == "" {
327332
// No -f/--file was specified so use the default relative to the
328333
// context directory.
329-
absDockerfile = filepath.Join(absContextDir, DefaultDockerfileName)
334+
absDockerfile = filepath.Join(absContextDir, defaultDockerfileName)
330335

331336
// Just to be nice ;-) look for 'dockerfile' too but only
332337
// use it if we found it, otherwise ignore this check
333338
if _, err = os.Lstat(absDockerfile); os.IsNotExist(err) {
334-
altPath := filepath.Join(absContextDir, strings.ToLower(DefaultDockerfileName))
339+
altPath := filepath.Join(absContextDir, strings.ToLower(defaultDockerfileName))
335340
if _, err = os.Lstat(altPath); err == nil {
336341
absDockerfile = altPath
337342
}

‎cli/command/image/build/context_test.go‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func prepareNoFiles(t *testing.T) string {
3131
func prepareOneFile(t *testing.T) string {
3232
t.Helper()
3333
contextDir := createTestTempDir(t)
34-
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents)
34+
createTestTempFile(t, contextDir, defaultDockerfileName, dockerfileContents)
3535
return contextDir
3636
}
3737

@@ -66,31 +66,31 @@ func TestGetContextFromLocalDirNotExistingDockerfile(t *testing.T) {
6666

6767
func TestGetContextFromLocalDirWithNoDirectory(t *testing.T) {
6868
contextDir := createTestTempDir(t)
69-
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents)
69+
createTestTempFile(t, contextDir, defaultDockerfileName, dockerfileContents)
7070

7171
chdir(t, contextDir)
7272

7373
absContextDir, relDockerfile, err := GetContextFromLocalDir(contextDir, "")
7474
assert.NilError(t, err)
7575

7676
assert.Check(t, is.Equal(contextDir, absContextDir))
77-
assert.Check(t, is.Equal(DefaultDockerfileName, relDockerfile))
77+
assert.Check(t, is.Equal(defaultDockerfileName, relDockerfile))
7878
}
7979

8080
func TestGetContextFromLocalDirWithDockerfile(t *testing.T) {
8181
contextDir := createTestTempDir(t)
82-
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents)
82+
createTestTempFile(t, contextDir, defaultDockerfileName, dockerfileContents)
8383

8484
absContextDir, relDockerfile, err := GetContextFromLocalDir(contextDir, "")
8585
assert.NilError(t, err)
8686

8787
assert.Check(t, is.Equal(contextDir, absContextDir))
88-
assert.Check(t, is.Equal(DefaultDockerfileName, relDockerfile))
88+
assert.Check(t, is.Equal(defaultDockerfileName, relDockerfile))
8989
}
9090

9191
func TestGetContextFromLocalDirLocalFile(t *testing.T) {
9292
contextDir := createTestTempDir(t)
93-
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents)
93+
createTestTempFile(t, contextDir, defaultDockerfileName, dockerfileContents)
9494
testFilename := createTestTempFile(t, contextDir, "tmpTest", "test")
9595

9696
absContextDir, relDockerfile, err := GetContextFromLocalDir(testFilename, "")
@@ -112,13 +112,13 @@ func TestGetContextFromLocalDirWithCustomDockerfile(t *testing.T) {
112112
contextDir := createTestTempDir(t)
113113
chdir(t, contextDir)
114114

115-
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents)
115+
createTestTempFile(t, contextDir, defaultDockerfileName, dockerfileContents)
116116

117-
absContextDir, relDockerfile, err := GetContextFromLocalDir(contextDir, DefaultDockerfileName)
117+
absContextDir, relDockerfile, err := GetContextFromLocalDir(contextDir, defaultDockerfileName)
118118
assert.NilError(t, err)
119119

120120
assert.Check(t, is.Equal(contextDir, absContextDir))
121-
assert.Check(t, is.Equal(DefaultDockerfileName, relDockerfile))
121+
assert.Check(t, is.Equal(defaultDockerfileName, relDockerfile))
122122
}
123123

124124
func TestGetContextFromReaderString(t *testing.T) {
@@ -150,8 +150,8 @@ func TestGetContextFromReaderString(t *testing.T) {
150150
t.Fatalf("Uncompressed tar archive does not equal: %s, got: %s", dockerfileContents, contents)
151151
}
152152

153-
if relDockerfile != DefaultDockerfileName {
154-
t.Fatalf("Relative path not equals %s, got: %s", DefaultDockerfileName, relDockerfile)
153+
if relDockerfile != defaultDockerfileName {
154+
t.Fatalf("Relative path not equals %s, got: %s", defaultDockerfileName, relDockerfile)
155155
}
156156
}
157157

@@ -164,21 +164,21 @@ func TestGetContextFromReaderStringConflict(t *testing.T) {
164164

165165
func TestGetContextFromReaderTar(t *testing.T) {
166166
contextDir := createTestTempDir(t)
167-
createTestTempFile(t, contextDir, DefaultDockerfileName, dockerfileContents)
167+
createTestTempFile(t, contextDir, defaultDockerfileName, dockerfileContents)
168168

169169
tarStream, err := archive.Tar(contextDir, compression.None)
170170
assert.NilError(t, err)
171171

172-
tarArchive, relDockerfile, err := GetContextFromReader(tarStream, DefaultDockerfileName)
172+
tarArchive, relDockerfile, err := GetContextFromReader(tarStream, defaultDockerfileName)
173173
assert.NilError(t, err)
174174

175175
tarReader := tar.NewReader(tarArchive)
176176

177177
header, err := tarReader.Next()
178178
assert.NilError(t, err)
179179

180-
if header.Name != DefaultDockerfileName {
181-
t.Fatalf("Dockerfile name should be: %s, got: %s", DefaultDockerfileName, header.Name)
180+
if header.Name != defaultDockerfileName {
181+
t.Fatalf("Dockerfile name should be: %s, got: %s", defaultDockerfileName, header.Name)
182182
}
183183

184184
buff := new(bytes.Buffer)
@@ -197,8 +197,8 @@ func TestGetContextFromReaderTar(t *testing.T) {
197197
t.Fatalf("Uncompressed tar archive does not equal: %s, got: %s", dockerfileContents, contents)
198198
}
199199

200-
if relDockerfile != DefaultDockerfileName {
201-
t.Fatalf("Relative path not equals %s, got: %s", DefaultDockerfileName, relDockerfile)
200+
if relDockerfile != defaultDockerfileName {
201+
t.Fatalf("Relative path not equals %s, got: %s", defaultDockerfileName, relDockerfile)
202202
}
203203
}
204204

@@ -223,7 +223,7 @@ func TestValidateContextDirectoryWithOneFile(t *testing.T) {
223223
}
224224

225225
func TestValidateContextDirectoryWithOneFileExcludes(t *testing.T) {
226-
testValidateContextDirectory(t, prepareOneFile, []string{DefaultDockerfileName})
226+
testValidateContextDirectory(t, prepareOneFile, []string{defaultDockerfileName})
227227
}
228228

229229
// createTestTempDir creates a temporary directory for testing. It returns the

0 commit comments

Comments
 (0)