Allow configuring jib plugin type
#2964
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,11 +57,13 @@ func upgradeOnePipeline(oldPipeline, newPipeline interface{}) error { | |
| newBuild.Artifacts[i].JibArtifact = &next.JibArtifact{ | ||
| Project: a.JibMavenArtifact.Module, | ||
| Flags: flags, | ||
| Type: "maven", | ||
| } | ||
| case a.JibGradleArtifact != nil: | ||
| newBuild.Artifacts[i].JibArtifact = &next.JibArtifact{ | ||
| Project: a.JibGradleArtifact.Project, | ||
| Flags: a.JibGradleArtifact.Flags, | ||
| Type: "gradle", | ||
| } | ||
| } | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -100,9 +100,11 @@ build: | |
| jib: | ||
| args: ['-v', '--activate-profiles', 'prof'] | ||
| project: dir | ||
| type: maven | ||
| - image: gcr.io/k8s-skaffold/jib-gradle | ||
| jib: | ||
| args: ['-v'] | ||
| type: gradle | ||
| googleCloudBuild: | ||
| projectId: test-project | ||
| test: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -771,5 +771,5 @@ type JibArtifact struct { | |
| Flags []string `yaml:"args,omitempty"` | ||
|
|
||
| // Type the Jib builder type (internal: see jib.PluginType) | ||
| Type string `yaml:"type,omitempty"` | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,6 +39,7 @@ func Process(config *latest.SkaffoldConfig) error { | |
| errs = append(errs, validateCustomDependencies(config.Build.Artifacts)...) | ||
| errs = append(errs, validateSyncRules(config.Build.Artifacts)...) | ||
| errs = append(errs, validatePortForwardResources(config.PortForward)...) | ||
| errs = append(errs, validateJibPluginTypes(config.Build.Artifacts)...) | ||
|
|
||
| if len(errs) == 0 { | ||
| return nil | ||
|
|
@@ -187,3 +188,18 @@ func validatePortForwardResources(pfrs []*latest.PortForwardResource) []error { | |
| } | ||
| return errs | ||
| } | ||
|
|
||
| // validateJibPluginTypes makes sure that jib type is one of `maven`, or `gradle` if set. | ||
| func validateJibPluginTypes(artifacts []*latest.Artifact) (errs []error) { | ||
| for _, a := range artifacts { | ||
| if a.JibArtifact == nil || a.JibArtifact.Type == "" { | ||
| continue | ||
| } | ||
| t := strings.ToLower(a.JibArtifact.Type) | ||
| if t == "maven" || t == "gradle" { | ||
| continue | ||
| } | ||
| errs = append(errs, fmt.Errorf("artifact %s has invalid plugin type '%s'", a.ImageName, t)) | ||
chanseokoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| return | ||
chanseokoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -613,3 +613,106 @@ func TestValidateImageNames(t *testing.T) { | |
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestValidateJibPluginType(t *testing.T) { | ||
| tests := []struct { | ||
| description string | ||
| artifacts []*latest.Artifact | ||
| shouldErr bool | ||
| }{ | ||
| { | ||
| description: "no type", | ||
| artifacts: []*latest.Artifact{ | ||
| { | ||
| ImageName: "image/jib", | ||
| ArtifactType: latest.ArtifactType{ | ||
| JibArtifact: &latest.JibArtifact{}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| description: "maven", | ||
| artifacts: []*latest.Artifact{ | ||
| { | ||
| ImageName: "image/jib", | ||
| ArtifactType: latest.ArtifactType{ | ||
| JibArtifact: &latest.JibArtifact{ | ||
| Type: "maven", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| description: "gradle", | ||
| artifacts: []*latest.Artifact{ | ||
| { | ||
| ImageName: "image/jib", | ||
| ArtifactType: latest.ArtifactType{ | ||
| JibArtifact: &latest.JibArtifact{ | ||
| Type: "gradle", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| description: "empty", | ||
| artifacts: []*latest.Artifact{ | ||
| { | ||
| ImageName: "image/jib", | ||
| ArtifactType: latest.ArtifactType{ | ||
| JibArtifact: &latest.JibArtifact{ | ||
| Type: "", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| description: "cAsE inSenSiTiVe", | ||
| artifacts: []*latest.Artifact{ | ||
| { | ||
| ImageName: "image/jib", | ||
| ArtifactType: latest.ArtifactType{ | ||
| JibArtifact: &latest.JibArtifact{ | ||
| Type: "gRaDlE", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| description: "invalid type", | ||
| shouldErr: true, | ||
| artifacts: []*latest.Artifact{ | ||
| { | ||
| ImageName: "image/jib", | ||
| ArtifactType: latest.ArtifactType{ | ||
| JibArtifact: &latest.JibArtifact{ | ||
| Type: "invalid", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| for _, test := range tests { | ||
| testutil.Run(t, test.description, func(t *testutil.T) { | ||
| // disable yamltags validation | ||
| t.Override(&validateYamltags, func(interface{}) error { return nil }) | ||
|
|
||
| err := Process( | ||
| &latest.SkaffoldConfig{ | ||
| Pipeline: latest.Pipeline{ | ||
| Build: latest.BuildConfig{ | ||
| Artifacts: test.artifacts, | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| t.CheckError(test.shouldErr, err) | ||
| }) | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be fine as it actually helps making the upgrade process to not break when the detection mechanism doesn't work. It is a conservative change. I will use admin rights to merge this PR.