| // Copyright Istio 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 version |
| |
| import ( |
| "fmt" |
| "strconv" |
| "strings" |
| ) |
| |
| import ( |
| goversion "github.com/hashicorp/go-version" |
| "gopkg.in/yaml.v2" |
| ) |
| |
| const ( |
| // releasePrefix is the prefix we used in http://gcr.io/istio-release for releases |
| releasePrefix = "release-" |
| ) |
| |
| // NewVersionFromString creates a new Version from the provided SemVer formatted string and returns a pointer to it. |
| func NewVersionFromString(s string) (*Version, error) { |
| ver, err := goversion.NewVersion(s) |
| if err != nil { |
| return nil, err |
| } |
| |
| newVer := &Version{} |
| vv := ver.Segments() |
| if len(vv) > 0 { |
| newVer.Major = uint32(vv[0]) |
| } |
| if len(vv) > 1 { |
| newVer.Minor = uint32(vv[1]) |
| } |
| if len(vv) > 2 { |
| newVer.Patch = uint32(vv[2]) |
| } |
| |
| sv := strings.Split(s, "-") |
| if len(sv) > 0 { |
| newVer.Suffix = strings.Join(sv[1:], "-") |
| } |
| |
| return newVer, nil |
| } |
| |
| // IsVersionString checks whether the given string is a version string |
| func IsVersionString(path string) bool { |
| _, err := goversion.NewSemver(path) |
| if err != nil { |
| return false |
| } |
| vs := Version{} |
| return yaml.Unmarshal([]byte(path), &vs) == nil |
| } |
| |
| // TagToVersionString converts an istio container tag into a version string |
| func TagToVersionString(path string) (string, error) { |
| path = strings.TrimPrefix(path, releasePrefix) |
| ver, err := goversion.NewSemver(path) |
| if err != nil { |
| return "", err |
| } |
| segments := ver.Segments() |
| fmtParts := make([]string, len(segments)) |
| for i, s := range segments { |
| str := strconv.Itoa(s) |
| fmtParts[i] = str |
| } |
| return strings.Join(fmtParts, "."), nil |
| } |
| |
| // TagToVersionString converts an istio container tag into a version string, |
| // if any error, fallback to use the original tag. |
| func TagToVersionStringGrace(path string) string { |
| v, err := TagToVersionString(path) |
| if err != nil { |
| return path |
| } |
| return v |
| } |
| |
| // MajorVersion represents a major version. |
| type MajorVersion struct { |
| Major uint32 |
| } |
| |
| // MinorVersion represents a minor version. |
| type MinorVersion struct { |
| MajorVersion |
| Minor uint32 |
| } |
| |
| // PatchVersion represents a patch version. |
| type PatchVersion struct { |
| MinorVersion |
| Patch uint32 |
| } |
| |
| // Version represents a version with an optional suffix. |
| type Version struct { |
| PatchVersion |
| Suffix string |
| } |
| |
| // NewMajorVersion creates an initialized MajorVersion struct. |
| func NewMajorVersion(major uint32) MajorVersion { |
| return MajorVersion{ |
| Major: major, |
| } |
| } |
| |
| // NewMinorVersion creates an initialized MinorVersion struct. |
| func NewMinorVersion(major, minor uint32) MinorVersion { |
| return MinorVersion{ |
| MajorVersion: NewMajorVersion(major), |
| Minor: minor, |
| } |
| } |
| |
| // NewPatchVersion creates an initialized PatchVersion struct. |
| func NewPatchVersion(major, minor, patch uint32) PatchVersion { |
| return PatchVersion{ |
| MinorVersion: NewMinorVersion(major, minor), |
| Patch: patch, |
| } |
| } |
| |
| // NewVersion creates an initialized Version struct. |
| func NewVersion(major, minor, patch uint32, suffix string) Version { |
| return Version{ |
| PatchVersion: NewPatchVersion(major, minor, patch), |
| Suffix: suffix, |
| } |
| } |
| |
| // String implements the Stringer interface. |
| func (v MajorVersion) String() string { |
| return fmt.Sprintf("%d", v.Major) |
| } |
| |
| // String implements the Stringer interface. |
| func (v MinorVersion) String() string { |
| return fmt.Sprintf("%s.%d", v.MajorVersion, v.Minor) |
| } |
| |
| // String implements the Stringer interface. |
| func (v PatchVersion) String() string { |
| return fmt.Sprintf("%s.%d", v.MinorVersion, v.Patch) |
| } |
| |
| // String implements the Stringer interface. |
| func (v *Version) String() string { |
| if v.Suffix == "" { |
| return v.PatchVersion.String() |
| } |
| return fmt.Sprintf("%s-%s", v.PatchVersion, v.Suffix) |
| } |
| |
| // UnmarshalYAML implements the Unmarshaler interface. |
| func (v *Version) UnmarshalYAML(unmarshal func(interface{}) error) error { |
| s := "" |
| if err := unmarshal(&s); err != nil { |
| return err |
| } |
| out, err := NewVersionFromString(s) |
| if err != nil { |
| return err |
| } |
| *v = *out |
| return nil |
| } |