-
Notifications
You must be signed in to change notification settings - Fork 889
chore(coderd): extract api version validation to util package #11407
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| package apiversion | ||
|
|
||
| import ( | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "golang.org/x/xerrors" | ||
| ) | ||
|
|
||
| // New returns an *APIVersion with the given major.minor and | ||
| // additional supported major versions. | ||
| func New(maj, min int) *APIVersion { | ||
| v := &APIVersion{ | ||
| supportedMajor: maj, | ||
| supportedMinor: min, | ||
| additionalMajors: make([]int, 0), | ||
| } | ||
| return v | ||
| } | ||
|
|
||
| type APIVersion struct { | ||
| supportedMajor int | ||
| supportedMinor int | ||
| additionalMajors []int | ||
| } | ||
|
|
||
| func (v *APIVersion) WithBackwardCompat(majs ...int) *APIVersion { | ||
| v.additionalMajors = append(v.additionalMajors, majs[:]...) | ||
| return v | ||
| } | ||
|
|
||
| // Validate validates the given version against the given constraints: | ||
| // A given major.minor version is valid iff: | ||
| // 1. The requested major version is contained within v.supportedMajors | ||
| // 2. If the requested major version is the 'current major', then | ||
| // the requested minor version must be less than or equal to the supported | ||
| // minor version. | ||
| // | ||
| // For example, given majors {1, 2} and minor 2, then: | ||
| // - 0.x is not supported, | ||
| // - 1.x is supported, | ||
| // - 2.0, 2.1, and 2.2 are supported, | ||
| // - 2.3+ is not supported. | ||
| func (v *APIVersion) Validate(version string) error { | ||
| major, minor, err := Parse(version) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if major > v.supportedMajor { | ||
| return xerrors.Errorf("server is at version %d.%d, behind requested major version %s", | ||
| v.supportedMajor, v.supportedMinor, version) | ||
| } | ||
| if major == v.supportedMajor { | ||
| if minor > v.supportedMinor { | ||
| return xerrors.Errorf("server is at version %d.%d, behind requested minor version %s", | ||
| v.supportedMajor, v.supportedMinor, version) | ||
| } | ||
| return nil | ||
| } | ||
| for _, mjr := range v.additionalMajors { | ||
| if major == mjr { | ||
| return nil | ||
| } | ||
| } | ||
| return xerrors.Errorf("version %s is no longer supported", version) | ||
| } | ||
|
|
||
| // Parse parses a valid major.minor version string into (major, minor). | ||
| // Both major and minor must be valid integers separated by a period '.'. | ||
| func Parse(version string) (major int, minor int, err error) { | ||
| parts := strings.Split(version, ".") | ||
| if len(parts) != 2 { | ||
| return 0, 0, xerrors.Errorf("invalid version string: %s", version) | ||
| } | ||
| major, err = strconv.Atoi(parts[0]) | ||
| if err != nil { | ||
| return 0, 0, xerrors.Errorf("invalid major version: %s", version) | ||
| } | ||
| minor, err = strconv.Atoi(parts[1]) | ||
| if err != nil { | ||
| return 0, 0, xerrors.Errorf("invalid minor version: %s", version) | ||
| } | ||
| return major, minor, nil | ||
| } | ||
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 |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| package apiversion_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/coder/coder/v2/coderd/util/apiversion" | ||
| ) | ||
|
|
||
| func TestAPIVersionValidate(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| // Given | ||
| v := apiversion.New(2, 1).WithBackwardCompat(1) | ||
|
|
||
| for _, tc := range []struct { | ||
| name string | ||
| version string | ||
| expectedError string | ||
| }{ | ||
| { | ||
| name: "OK", | ||
| version: "2.1", | ||
| }, | ||
| { | ||
| name: "MinorOK", | ||
| version: "2.0", | ||
| }, | ||
| { | ||
| name: "MajorOK", | ||
| version: "1.0", | ||
| }, | ||
| { | ||
| name: "TooNewMinor", | ||
| version: "2.2", | ||
| expectedError: "behind requested minor version", | ||
| }, | ||
| { | ||
| name: "TooNewMajor", | ||
| version: "3.1", | ||
| expectedError: "behind requested major version", | ||
| }, | ||
| { | ||
| name: "Malformed0", | ||
| version: "cats", | ||
| expectedError: "invalid version string", | ||
| }, | ||
| { | ||
| name: "Malformed1", | ||
| version: "cats.dogs", | ||
| expectedError: "invalid major version", | ||
| }, | ||
| { | ||
| name: "Malformed2", | ||
| version: "1.dogs", | ||
| expectedError: "invalid minor version", | ||
| }, | ||
| { | ||
| name: "Malformed3", | ||
| version: "1.0.1", | ||
| expectedError: "invalid version string", | ||
| }, | ||
| { | ||
| name: "Malformed4", | ||
| version: "11", | ||
| expectedError: "invalid version string", | ||
| }, | ||
| { | ||
| name: "TooOld", | ||
| version: "0.8", | ||
| expectedError: "no longer supported", | ||
| }, | ||
| } { | ||
| tc := tc | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| // When | ||
| err := v.Validate(tc.version) | ||
|
|
||
| // Then | ||
| if tc.expectedError == "" { | ||
| require.NoError(t, err) | ||
| } else { | ||
| require.ErrorContains(t, err, tc.expectedError) | ||
| } | ||
| }) | ||
| } | ||
| } |
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
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.
Love this.