From 70bba18ad357ca449721c1e0eb56ed36a6603d33 Mon Sep 17 00:00:00 2001 From: Kimmo Lehto Date: Mon, 7 Feb 2022 14:09:50 +0200 Subject: [PATCH] Initial commit Signed-off-by: Kimmo Lehto --- .github/workflows/go.yml | 41 ++++++++ LICENSE | 201 +++++++++++++++++++++++++++++++++++++++ README.md | 47 +++++++++ collection.go | 31 ++++++ collection_test.go | 33 +++++++ go.mod | 14 +++ go.sum | 13 +++ release.go | 121 +++++++++++++++++++++++ version.go | 73 ++++++++++++++ version_test.go | 35 +++++++ 10 files changed, 609 insertions(+) create mode 100644 .github/workflows/go.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 collection.go create mode 100644 collection_test.go create mode 100644 go.mod create mode 100644 go.sum create mode 100644 release.go create mode 100644 version.go create mode 100644 version_test.go diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml new file mode 100644 index 0000000..41c2e75 --- /dev/null +++ b/.github/workflows/go.yml @@ -0,0 +1,41 @@ +name: Go + +on: [push, pull_request] + +jobs: + + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Set up Go + uses: actions/setup-go@v2 + if: github.ref != 'refs/heads/main' + with: + go-version: 1.17 + + - name: Go modules cache + uses: actions/cache@v2 + if: github.ref != 'refs/heads/main' + with: + path: ~/go/pkg/mod + key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} + restore-keys: | + ${{ runner.os }}-go- + + - name: Run golangci-lint + if: github.ref != 'refs/heads/main' + uses: golangci/golangci-lint-action@v2.5.0 + with: + version: v1.44.0 + skip-go-installation: true + + - name: Build + if: github.ref != 'refs/heads/main' + run: go build -v ./... + + - name: Test + if: github.ref != 'refs/heads/main' + run: go test -v ./... + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f365815 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021, Mirantis Inc. + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4e6c1b2 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# version + +A go-language package for managing [k0s](https://github.com/k0sproject/k0s) version numbers. It is based on [hashicorp/go-version](https://github.com/hashicorp/go-version) but adds sorting and comparison capabilities for the k0s version numbering scheme. + +## Usage + +### Basic comparison + +```go +import ( + "fmt" + "github.com/k0sproject/version" +) + +func main() { + a := version.NewVersion("1.23.3+k0s.1") + b := version.NewVersion("1.23.3+k0s.2") + fmt.Println("a is greater than b: %t", a.GreaterThan(b)) + fmt.Println("a is less than b: %t", a.LessThan(b)) + fmt.Println("a is equal to b: %t", a.Equal(b)) +} +``` + +Outputs: + +```text +a is greater than b: false +a is less than b: true +a is equal to b: false +``` + +### Check online for latest version + +```go +import ( + "fmt" + "github.com/k0sproject/version" +) + +func main() { + latest, err := version.LatestStableRelease() + if err != nil { + panic(err) + } + fmt.Println("Latest k0s version is: %s", latest) +} +``` diff --git a/collection.go b/collection.go new file mode 100644 index 0000000..b754f15 --- /dev/null +++ b/collection.go @@ -0,0 +1,31 @@ +package version + +import "fmt" + +// Collection is a type that implements the sort.Interface interface +// so that versions can be sorted. +type Collection []*Version + +func NewCollection(versions ...string) (Collection, error) { + c := make(Collection, len(versions), len(versions)) + for i, v := range versions { + nv, err := NewVersion(v) + if err != nil { + return Collection{}, fmt.Errorf("invalid version '%s': %w", v, err) + } + c[i] = nv + } + return c, nil +} + +func (v Collection) Len() int { + return len(v) +} + +func (v Collection) Less(i, j int) bool { + return v[i].Compare(v[j]) < 0 +} + +func (v Collection) Swap(i, j int) { + v[i], v[j] = v[j], v[i] +} diff --git a/collection_test.go b/collection_test.go new file mode 100644 index 0000000..79c02ba --- /dev/null +++ b/collection_test.go @@ -0,0 +1,33 @@ +package version + +import ( + "sort" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestNewCollection(t *testing.T) { + c, err := NewCollection("1.23.3+k0s.1", "1.23.4+k0s.1") + assert.NoError(t, err) + assert.Equal(t, "1.23.3+k0s.1", c[0].String()) + assert.Equal(t, "1.23.4+k0s.1", c[1].String()) + assert.Len(t, c, 2) + _, err = NewCollection("1.23.3+k0s.1", "1.23.b+k0s.1") + assert.Error(t, err) +} + +func TestSorting(t *testing.T) { + c, err := NewCollection( + "1.21.2+k0s.0", + "1.21.1+k0s.1", + "0.13.1", + "1.21.1+k0s.2", + ) + assert.NoError(t, err) + sort.Sort(c) + assert.Equal(t, "0.13.1", c[0].String()) + assert.Equal(t, "1.21.1+k0s.1", c[1].String()) + assert.Equal(t, "1.21.1+k0s.2", c[2].String()) + assert.Equal(t, "1.21.2+k0s.0", c[3].String()) +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..d178e9a --- /dev/null +++ b/go.mod @@ -0,0 +1,14 @@ +module github.com/k0sproject/version + +go 1.17 + +require ( + github.com/hashicorp/go-version v1.4.0 + github.com/stretchr/testify v1.7.0 +) + +require ( + github.com/davecgh/go-spew v1.1.0 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..ebae1e4 --- /dev/null +++ b/go.sum @@ -0,0 +1,13 @@ +github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/hashicorp/go-version v1.4.0 h1:aAQzgqIrRKRa7w75CKpbBxYsmUoPjzVm1W59ca1L0J4= +github.com/hashicorp/go-version v1.4.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/release.go b/release.go new file mode 100644 index 0000000..004c735 --- /dev/null +++ b/release.go @@ -0,0 +1,121 @@ +package version + +import ( + "encoding/json" + "fmt" + "io" + "net/http" + "sort" + "strings" + "time" +) + +var TimeOut = time.Second * 10 +var Repo = "k0sproject/k0s" + +// Release is a k0s release +type Release struct { + URL string `json:"html_url"` + TagName string `json:"tag_name"` + PreRelease bool `json:"prerelease"` + Assets []Asset `json:"assets"` +} + +// Asset describes a release asset +type Asset struct { + Name string `json:"name"` + URL string `json:"browser_download_url"` +} + +// GreaterThan returns true if the version of the Release is greater than the supplied version +func (r *Release) GreaterThan(b fmt.Stringer) bool { + a, err := NewVersion(r.TagName) + if err != nil { + return false + } + other, err := NewVersion(b.String()) + if err != nil { + return false + } + return a.GreaterThan(other) +} + +func (r *Release) Version() (*Version, error) { + return NewVersion(r.TagName) +} + +func (r *Release) String() string { + return strings.TrimPrefix(r.TagName, "v") +} + +func latestRelease(preok bool) (Release, error) { + var releases []Release + if err := unmarshalURLBody(fmt.Sprintf("https://api.github.com/repos/%s/releases?per_page=20&page=1", Repo), &releases); err != nil { + return Release{}, err + } + + var c Collection + for _, v := range releases { + if v.PreRelease && !preok { + continue + } + if version, err := NewVersion(v.TagName); err == nil { + c = append(c, version) + } + } + + if len(c) == 0 { + return Release{}, fmt.Errorf("failed to get the latest version information") + } + + sort.Sort(c) + latest := c[len(c)-1].String() + + for _, v := range releases { + if v.TagName == latest { + return v, nil + } + } + + return Release{}, fmt.Errorf("failed to get the latest version information") +} + +// LatestStableRelease returns the semantically sorted latest non-prerelease version from the online repository +func LatestStableRelease() (Release, error) { + return latestRelease(false) +} + +// LatestStableRelease returns the semantically sorted latest version even if it is a prerelease from the online repository +func LatestRelease() (Release, error) { + return latestRelease(true) +} + +func unmarshalURLBody(url string, o interface{}) error { + client := &http.Client{ + Timeout: TimeOut, + } + + resp, err := client.Get(url) + if err != nil { + return err + } + + if resp.Body == nil { + return fmt.Errorf("nil body") + } + + if resp.StatusCode != 200 { + return fmt.Errorf("backend returned http %d for %s", resp.StatusCode, url) + } + + body, err := io.ReadAll(resp.Body) + if err != nil { + return err + } + + if err := resp.Body.Close(); err != nil { + return err + } + + return json.Unmarshal(body, o) +} diff --git a/version.go b/version.go new file mode 100644 index 0000000..497bc1c --- /dev/null +++ b/version.go @@ -0,0 +1,73 @@ +package version + +import ( + "sort" + + goversion "github.com/hashicorp/go-version" +) + +// Version is a k0s version +type Version struct { + goversion.Version +} + +func pair(a, b *Version) Collection { + return Collection{a, b} +} + +// Equal returns true if the version is equal to the supplied version +func (v *Version) Equal(b *Version) bool { + return v.String() == b.String() +} + +// GreaterThan returns true if the version is greater than the supplied version +func (v *Version) GreaterThan(b *Version) bool { + p := pair(v, b) + sort.Sort(p) + return v.String() == p[1].String() +} + +// LessThan returns true if the version is lower than the supplied version +func (v *Version) LessThan(b *Version) bool { + return !v.GreaterThan(b) +} + +// GreaterThanOrEqual returns true if the version is greater than the supplied version or equal +func (v *Version) GreaterThanOrEqual(b *Version) bool { + return v.Equal(b) || v.GreaterThan(b) +} + +// LessThanOrEqual returns true if the version is lower than the supplied version or equal +func (v *Version) LessThanOrEqual(b *Version) bool { + return v.Equal(b) || v.LessThan(b) +} + +// Compare compares two versions and returns one of the integers: -1, 0 or 1 (less than, equal, greater than) +func (v *Version) Compare(b *Version) int { + c := v.Version.Compare(&b.Version) + if c != 0 { + return c + } + + vA := v.String() + + // go to plain string comparison + s := []string{vA, b.String()} + sort.Strings(s) + + if vA == s[0] { + return -1 + } + + return 1 +} + +// NewVersion returns a new Version created from the supplied string or an error if the string is not a valid version number +func NewVersion(v string) (*Version, error) { + n, err := goversion.NewVersion(v) + if err != nil { + return nil, err + } + + return &Version{Version: *n}, nil +} diff --git a/version_test.go b/version_test.go new file mode 100644 index 0000000..ba0b5e9 --- /dev/null +++ b/version_test.go @@ -0,0 +1,35 @@ +package version + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestNewVersion(t *testing.T) { + v, err := NewVersion("1.23.3+k0s.1") + assert.NoError(t, err) + assert.Equal(t, "1.23.3+k0s.1", v.String()) + v, err = NewVersion("1.23.b+k0s.1") + assert.Error(t, err) +} + +func TestBasicComparison(t *testing.T) { + a, err := NewVersion("1.23.1+k0s.1") + assert.NoError(t, err) + b, err := NewVersion("1.23.2+k0s.1") + assert.NoError(t, err) + assert.True(t, b.GreaterThan(a), "version %s should be greater than %s", b, a) + assert.True(t, a.LessThan(b), "version %s should be less than %s", b, a) + assert.False(t, b.Equal(a), "version %s should not be equal to %s", b, a) +} + +func TestK0sComparison(t *testing.T) { + a, err := NewVersion("1.23.1+k0s.1") + assert.NoError(t, err) + b, err := NewVersion("1.23.1+k0s.2") + assert.NoError(t, err) + assert.True(t, b.GreaterThan(a), "version %s should be greater than %s", b, a) + assert.True(t, a.LessThan(b), "version %s should be less than %s", b, a) + assert.False(t, b.Equal(a), "version %s should not be equal to %s", b, a) +}