forked from siderolabs/conform
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add checks interface (siderolabs#127)
Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
- Loading branch information
1 parent
0af31f8
commit 6f8751c
Showing
16 changed files
with
583 additions
and
220 deletions.
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
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
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,113 @@ | ||
| /* This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| package commit | ||
|
|
||
| import ( | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| "github.com/autonomy/conform/internal/policy" | ||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| // Conventional implements the policy.Policy interface and enforces commit | ||
| // messages to conform the Conventional Commit standard. | ||
| type Conventional struct { | ||
| Types []string `mapstructure:"types"` | ||
| Scopes []string `mapstructure:"scopes"` | ||
| } | ||
|
|
||
| // HeaderRegex is the regular expression used for Conventional Commits | ||
| // 1.0.0-beta.1. | ||
| var HeaderRegex = regexp.MustCompile(`^(\w*)(\(([^)]+)\))?:\s{1}(.*)($|\n{2})`) | ||
|
|
||
| const ( | ||
| // TypeFeat is a commit of the type fix patches a bug in your codebase | ||
| // (this correlates with PATCH in semantic versioning). | ||
| TypeFeat = "feat" | ||
|
|
||
| // TypeFix is a commit of the type feat introduces a new feature to the | ||
| // codebase (this correlates with MINOR in semantic versioning). | ||
| TypeFix = "fix" | ||
| ) | ||
|
|
||
| // ConventionalCommitCheck ensures that the commit message is a valid | ||
| // conventional commit. | ||
| type ConventionalCommitCheck struct { | ||
| errors []error | ||
| } | ||
|
|
||
| // Name returns the name of the check. | ||
| func (c ConventionalCommitCheck) Name() string { | ||
| return "Conventional Commit" | ||
| } | ||
|
|
||
| // Message returns to check message. | ||
| func (c ConventionalCommitCheck) Message() string { | ||
| if len(c.errors) != 0 { | ||
| return c.errors[0].Error() | ||
| } | ||
| return "Commit message is a valid conventional commit" | ||
| } | ||
|
|
||
| // Errors returns any violations of the check. | ||
| func (c ConventionalCommitCheck) Errors() []error { | ||
| return c.errors | ||
| } | ||
|
|
||
| // ValidateConventionalCommit returns the commit type. | ||
| // nolint: gocyclo | ||
| func (c Commit) ValidateConventionalCommit() policy.Check { | ||
| check := &ConventionalCommitCheck{} | ||
| groups := parseHeader(c.msg) | ||
| if len(groups) != 6 { | ||
| check.errors = append(check.errors, errors.Errorf("Invalid conventional commits format: %q", c.msg)) | ||
| return check | ||
| } | ||
|
|
||
| c.Conventional.Types = append(c.Conventional.Types, TypeFeat, TypeFix) | ||
| typeIsValid := false | ||
| for _, t := range c.Conventional.Types { | ||
| if t == groups[1] { | ||
| typeIsValid = true | ||
| } | ||
| } | ||
| if !typeIsValid { | ||
| check.errors = append(check.errors, errors.Errorf("Invalid type %q: allowed types are %v", groups[1], c.Conventional.Types)) | ||
| return check | ||
| } | ||
|
|
||
| // Scope is optional. | ||
| if groups[3] != "" { | ||
| scopeIsValid := false | ||
| for _, scope := range c.Conventional.Scopes { | ||
| if scope == groups[3] { | ||
| scopeIsValid = true | ||
| break | ||
| } | ||
| } | ||
| if !scopeIsValid { | ||
| check.errors = append(check.errors, errors.Errorf("Invalid scope %q: allowed scopes are %v", groups[3], c.Conventional.Scopes)) | ||
| return check | ||
| } | ||
| } | ||
|
|
||
| if len(groups[4]) <= 72 && len(groups[4]) != 0 { | ||
| return check | ||
| } | ||
| check.errors = append(check.errors, errors.Errorf("Invalid description: %s", groups[4])) | ||
|
|
||
| return check | ||
| } | ||
|
|
||
| func parseHeader(msg string) []string { | ||
| // To circumvent any policy violation due to the leading \n that GitHub | ||
| // prefixes to the commit message on a squash merge, we remove it from the | ||
| // message. | ||
| header := strings.Split(strings.TrimPrefix(msg, "\n"), "\n")[0] | ||
| groups := HeaderRegex.FindStringSubmatch(header) | ||
|
|
||
| return groups | ||
| } |
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,54 @@ | ||
| /* This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| package commit | ||
|
|
||
| import ( | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| "github.com/autonomy/conform/internal/policy" | ||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| // DCORegex is the regular expression used for Developer Certificate of Origin. | ||
| var DCORegex = regexp.MustCompile(`^Signed-off-by: ([^<]+) <([^<>@]+@[^<>]+)>$`) | ||
|
|
||
| // DCOCheck ensures that the commit message contains a | ||
| // Developer Certificate of Origin. | ||
| type DCOCheck struct { | ||
| errors []error | ||
| } | ||
|
|
||
| // Name returns the name of the check. | ||
| func (d DCOCheck) Name() string { | ||
| return "DCO" | ||
| } | ||
|
|
||
| // Message returns to check message. | ||
| func (d DCOCheck) Message() string { | ||
| if len(d.errors) != 0 { | ||
| return d.errors[0].Error() | ||
| } | ||
| return "Developer Certificate of Origin was found" | ||
| } | ||
|
|
||
| // Errors returns any violations of the check. | ||
| func (d DCOCheck) Errors() []error { | ||
| return d.errors | ||
| } | ||
|
|
||
| // ValidateDCO checks the commit message for a Developer Certificate of Origin. | ||
| func (c Commit) ValidateDCO() policy.Check { | ||
| check := &DCOCheck{} | ||
| for _, line := range strings.Split(c.msg, "\n") { | ||
| if DCORegex.MatchString(strings.TrimSpace(line)) { | ||
| return check | ||
| } | ||
| } | ||
|
|
||
| check.errors = append(check.errors, errors.Errorf("Commit does not have a DCO")) | ||
|
|
||
| return check | ||
| } |
Oops, something went wrong.