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.

Sign up for GitHub

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

Jump to bottom

Error if no Dockerfiles are found for skaffold init --analyze #1810

Merged
merged 3 commits into from
Mar 18, 2019
Merged

Error if no Dockerfiles are found for skaffold init --analyze #1810

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0211c2c
Error out if no Dockerfiles are found
Mar 15, 2019
c20091d
Merge branch 'master' of github.com:GoogleContainerTools/skaffold int…
Mar 18, 2019
9d652dd
updated error message, don't error if skipping build
Mar 18, 2019
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
3 changes: 3 additions & 0 deletions pkg/skaffold/initializer/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,9 @@ func generateSkaffoldPipeline(k Initializer, dockerfilePairs []dockerfilePair) (
}

func printAnalyzeJSON(out io.Writer, dockerfiles, images []string) error {
if len(dockerfiles) == 0 {
Copy link
Member

Choose a reason for hiding this comment

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

This condition is used here as well.

skaffold/pkg/skaffold/initializer/init.go

Line 124 in 0211c2c

if len(dockerfiles) == 0 {

@dgageot and @priyawadhwa should we consider failing skaffold init if no docker files are present?
AFAIK, analyze is used by IDE? What is it used for?

Copy link
Member

Choose a reason for hiding this comment

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

Can we get some more context around why skaffold init should fail when there are no docker files?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

skaffold init currently fails if there are no Dockerfiles or Kubernetes manifests found, this PR adds the same functionality to skaffold init --analyze.

I'm guessing skaffold init fails if either is not present because then there is nothing to match either an image or a k8s manifest with when generating the skaffold.yaml. The --analyze flag was recently added so that IDEs could support skaffold init (ref #1710)

Copy link
Member

@tejal29 tejal29 Mar 18, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

It does not right now. Can we move this check to L112
And then remove it from if c.SkipBuild flow as well as the --analyze flow.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, I thought we only want to see this error if !c.skipBuild as written? Because if we're skipping the build section of the skaffold.yaml, it shouldn't matter if there are any Dockerfiles?

In this case, should I check if !c.SkipBuild for --analyze as well?

Copy link
Member

Choose a reason for hiding this comment

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

yes makes sense. I think we should also change the error message. Technically you don't need a Dockerfile for running skaffold. You can't "create" skaffold config file with sane config without docker files.

return errors.New("one or more valid Dockerfiles must be present to run skaffold; please provide at least one Dockerfile and try again")
}
a := struct {
Dockerfiles []string `json:"dockerfiles,omitempty"`
Images []string `json:"images,omitempty"`
Expand Down
18 changes: 7 additions & 11 deletions pkg/skaffold/initializer/init_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ func TestPrintAnalyzeJSON(t *testing.T) {
name string
dockerfiles []string
images []string
shouldErr bool
expected string
}{
{
Expand All @@ -37,25 +38,20 @@ func TestPrintAnalyzeJSON(t *testing.T) {
expected: "{\"dockerfiles\":[\"Dockerfile\",\"Dockerfile_2\"],\"images\":[\"image1\",\"image2\"]}",
},
{
name: "no dockerfile",
images: []string{"image1", "image2"},
expected: "{\"images\":[\"image1\",\"image2\"]}",
name: "no dockerfile",
images: []string{"image1", "image2"},
shouldErr: true,
},
{
name: "no images",
dockerfiles: []string{"Dockerfile", "Dockerfile_2"},
expected: "{\"dockerfiles\":[\"Dockerfile\",\"Dockerfile_2\"]}",
},
{
name: "no dockerfiles or images",
expected: "{}",
name: "no dockerfiles or images",
shouldErr: true,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
out := bytes.NewBuffer([]byte{})
err := printAnalyzeJSON(out, test.dockerfiles, test.images)
testutil.CheckErrorAndDeepEqual(t, false, err, test.expected, out.String())
testutil.CheckErrorAndDeepEqual(t, test.shouldErr, err, test.expected, out.String())
})
}
}