Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: handle lowercase Dockerfile name as a fallback #444

Merged
merged 1 commit into from
Dec 4, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion build/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -796,12 +796,14 @@ func LoadInputs(inp Inputs, target *client.SolveOpt) (func(), error) {
if dockerfileName == "" {
dockerfileName = "Dockerfile"

This comment was marked as spam.

}
target.FrontendAttrs["filename"] = dockerfileName

if dockerfileDir != "" {
target.LocalDirs["dockerfile"] = dockerfileDir
dockerfileName = handleLowercaseDockerfile(dockerfileDir, dockerfileName)
}

target.FrontendAttrs["filename"] = dockerfileName

release := func() {
for _, dir := range toRemove {
os.RemoveAll(dir)
Expand Down Expand Up @@ -889,3 +891,34 @@ func (w *waitingWriter) Close() error {
}
return err
}

// handle https://github.com/moby/moby/pull/10858
func handleLowercaseDockerfile(dir, p string) string {
if filepath.Base(p) != "Dockerfile" {
return p
}

f, err := os.Open(filepath.Dir(filepath.Join(dir, p)))
if err != nil {
return p
}

names, err := f.Readdirnames(-1)
Copy link
Member

@thaJeztah thaJeztah Nov 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was wondering why you were using f.Readdirnames here, but then realisedos.Stat() returns the name you pass to it, not the actual filename on disk (preserving case) 😞

Wondering, if Readdirnames() would be an issue if there's lots of files in the directory.

Would something like this work?

dockerfiles, err := filepath.Glob(dir + "/[Dd]ockerfile")

I did a quick test on my machine;

package main

import (
	"fmt"
	"path/filepath"
)

func main() {
	dockerfileDir, _ := filepath.Abs(".")
	dockerfileName := "Dockerfile"
	f := handleLowercaseDockerfile(dockerfileDir, dockerfileName)
	fmt.Println("Using:", f)
}

// handle https://github.com/moby/moby/pull/10858
func handleLowercaseDockerfile(dir, p string) string {
	if filepath.Base(p) != "Dockerfile" {
		return p
	}
	dockerfiles, err := filepath.Glob(filepath.Join(dir, "[Dd]ockerfile"))
	if err != nil || len(dockerfiles) != 1 {
		return p
	}
	// either Dockerfile or dockerfile was found; use what's found
	return filepath.Base(dockerfiles[0])
}
rm -f Dockerfile && touch dOckErFILE && go run main.go
rm -f Dockerfile && touch Dockerfile && go run main.go
rm -f Dockerfile && touch dockerfile && go run main.go

Using: Dockerfile
Using: Dockerfile
Using: dockerfile

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Glob is implemented with Readdirnames(-1)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sigh 😔

it really surprised me that os.Stat doesn't return the actual filename

if err != nil {
return p
}

foundLowerCase := false
for _, n := range names {
if n == "Dockerfile" {
return p
}
if n == "dockerfile" {
foundLowerCase = true
}
}
if foundLowerCase {
return filepath.Join(filepath.Dir(p), "dockerfile")
}
return p
}