Support skipping stages by path pattern or commit message prefix #4922
There are no files selected for viewing
This file contains 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 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 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 |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| // Copyright 2024 The PipeCD Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package controller | ||
|
|
||
| import ( | ||
| "context" | ||
| "strings" | ||
|
|
||
| "github.com/pipe-cd/pipecd/pkg/app/piped/executor" | ||
| "github.com/pipe-cd/pipecd/pkg/config" | ||
| "github.com/pipe-cd/pipecd/pkg/filematcher" | ||
| "github.com/pipe-cd/pipecd/pkg/git" | ||
| ) | ||
|
|
||
| // checkSkipStage checks whether the stage should be skipped or not. | ||
| func checkSkipStage(ctx context.Context, in executor.Input, opt config.SkipOptions) (skip bool, err error) { | ||
| if len(opt.Paths) == 0 && len(opt.CommitMessagePrefixes) == 0 { | ||
| // When no condition is specified. | ||
| return false, nil | ||
| } | ||
|
There was a problem hiding this comment. [imo] It might not be a func, just put it in the There was a problem hiding this comment. Thanks, I did it here 8a96a8c |
||
|
|
||
| repoCfg := in.Application.GitPath.Repo | ||
| repo, err := in.GitClient.Clone(ctx, repoCfg.Id, repoCfg.Remote, repoCfg.Branch, "") | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
|
|
||
| // Check by path pattern | ||
| skip, err = skipByPathPattern(ctx, opt, repo, in.RunningDSP.Revision(), in.TargetDSP.Revision()) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
| if skip { | ||
| return true, nil | ||
| } | ||
|
|
||
| // Check by prefix of commit message | ||
| skip, err = skipByCommitMessagePrefixes(ctx, opt, repo, in.TargetDSP.Revision()) | ||
| return skip, err | ||
| } | ||
|
|
||
| func skipByCommitMessagePrefixes(ctx context.Context, opt config.SkipOptions, repo git.Repo, targetRev string) (skip bool, err error) { | ||
| if len(opt.CommitMessagePrefixes) == 0 { | ||
| return false, nil | ||
| } | ||
|
|
||
| commit, err := repo.GetCommitForRev(ctx, targetRev) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
|
|
||
| return commitMessageHasAnyPrefix(commit.Message, opt.CommitMessagePrefixes), nil | ||
| } | ||
|
|
||
| func commitMessageHasAnyPrefix(commitMessage string, prefixes []string) bool { | ||
| for _, prefix := range prefixes { | ||
| if strings.HasPrefix(commitMessage, prefix) { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
There was a problem hiding this comment. [imo] It might not be a func, just put it in the There was a problem hiding this comment. You mean we need to mock There was a problem hiding this comment. I feel
When testing, we might need to mock as you said. There was a problem hiding this comment. @ffjlabo thanks, I merged the func and used mock in tests. |
||
|
|
||
| func skipByPathPattern(ctx context.Context, opt config.SkipOptions, repo git.Repo, runningRev, targetRev string) (skip bool, err error) { | ||
| if len(opt.Paths) == 0 { | ||
| return false, nil | ||
| } | ||
|
|
||
| changedFiles, err := repo.ChangedFiles(ctx, runningRev, targetRev) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
| return hasOnlyPathsToSkip(opt.Paths, changedFiles) | ||
| } | ||
|
|
||
| // hasOnlyPathsToSkip returns true if and only if all changed files are included in `skipPatterns`. | ||
| // If any changed file does not match all `skipPatterns`, it returns false. | ||
| func hasOnlyPathsToSkip(skipPatterns []string, changedFiles []string) (bool, error) { | ||
| matcher, err := filematcher.NewPatternMatcher(skipPatterns) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
|
|
||
| for _, changedFile := range changedFiles { | ||
| if !matcher.Matches(changedFile) { | ||
| return false, nil | ||
| } | ||
| } | ||
|
|
||
| return true, nil | ||
| } | ||
|
There was a problem hiding this comment. [imo] It might not be a func, just put it in the There was a problem hiding this comment. @ffjlabo thanks, I merged the func and used mock in tests. |
||
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| // Copyright 2024 The PipeCD Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package controller | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestCommitMessageHasAnyPrefix(t *testing.T) { | ||
| t.Parallel() | ||
| testcases := []struct { | ||
| name string | ||
| commitMessage string | ||
| prefixes []string | ||
| skip bool | ||
| }{ | ||
| { | ||
| name: "no prefixes", | ||
| commitMessage: "test message", | ||
| prefixes: []string{}, | ||
| skip: false, | ||
| }, | ||
| { | ||
| name: "no commit message", | ||
| commitMessage: "", | ||
| prefixes: []string{"to-skip"}, | ||
| skip: false, | ||
| }, | ||
| { | ||
| name: "prefix matches", | ||
| commitMessage: "to-skip: test message", | ||
| prefixes: []string{"to-skip"}, | ||
| skip: true, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testcases { | ||
| tc := tc | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| skip := commitMessageHasAnyPrefix(tc.commitMessage, tc.prefixes) | ||
| assert.Equal(t, tc.skip, skip) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestHasOnlyPathsToSkip(t *testing.T) { | ||
| t.Parallel() | ||
| testcases := []struct { | ||
| name string | ||
| skipPatterns []string | ||
| changedFiles []string | ||
| skip bool | ||
| }{ | ||
| { | ||
| name: "no skip patterns", | ||
| skipPatterns: nil, | ||
| changedFiles: []string{"file1"}, | ||
| skip: false, | ||
| }, | ||
| { | ||
| name: "no changed files", | ||
| skipPatterns: []string{"file1"}, | ||
| changedFiles: nil, | ||
| skip: true, | ||
| }, | ||
| { | ||
| name: "no skip patterns and no changed files", | ||
| skipPatterns: nil, | ||
| changedFiles: nil, | ||
| skip: true, | ||
| }, | ||
| { | ||
| name: "skip pattern matches all changed files", | ||
| skipPatterns: []string{"file1", "file2"}, | ||
| changedFiles: []string{"file1", "file2"}, | ||
| skip: true, | ||
| }, | ||
| { | ||
| name: "skip pattern does not match changed files", | ||
| skipPatterns: []string{"file1", "file2"}, | ||
| changedFiles: []string{"file1", "file3"}, | ||
| skip: false, | ||
| }, | ||
| { | ||
| name: "skip files of a directory", | ||
| skipPatterns: []string{"dir1/*"}, | ||
| changedFiles: []string{"dir1/file1", "dir1/file2"}, | ||
| skip: true, | ||
| }, | ||
| { | ||
| name: "skip files recursively", | ||
| skipPatterns: []string{"dir1/**"}, | ||
| changedFiles: []string{"dir1/file1", "dir1/sub/file2"}, | ||
| skip: true, | ||
| }, | ||
| { | ||
| name: "skip files with the extension recursively", | ||
| skipPatterns: []string{"dir1/**/*.yaml"}, | ||
| changedFiles: []string{"dir1/file1.yaml", "dir1/sub1/file2.yaml", "dir1/sub1/sub2/file3.yaml"}, | ||
| skip: true, | ||
| }, | ||
| { | ||
| name: "skip files not recursively", | ||
| skipPatterns: []string{"*.yaml"}, | ||
| changedFiles: []string{"dir1/file1.yaml"}, | ||
| skip: false, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testcases { | ||
| tc := tc | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| // We do not use t.Parallel() here due to https://pkg.go.dev/github.com/pipe-cd/pipecd/pkg/filematcher#PatternMatcher.Matches. | ||
| actual, err := hasOnlyPathsToSkip(tc.skipPatterns, tc.changedFiles) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, tc.skip, actual) | ||
| }) | ||
| } | ||
| } |
This file contains 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 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
Oops, something went wrong.
Oops, something went wrong.
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.
[imo] How about adding the func
StageConfig.GetSkipConfig()in the config package?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.
I think the current one is enough because
StageConfig.GetSkipConfig()will be used only inskipstagepackageWDYT?
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.
OK, I got it 👍