|
| 1 | +package version |
| 2 | + |
| 3 | +import ( |
| 4 | + "encoding/json" |
| 5 | + "fmt" |
| 6 | + "net/http" |
| 7 | + "runtime/debug" |
| 8 | + "strings" |
| 9 | + "time" |
| 10 | +) |
| 11 | + |
| 12 | +var ( |
| 13 | + // Default version values; can be overridden via ldflags |
| 14 | + version = "dev" |
| 15 | + commit = "unknown" |
| 16 | + date = "unknown" |
| 17 | +) |
| 18 | + |
| 19 | +type ComponentInfo struct { |
| 20 | + Version string `json:"version"` |
| 21 | + CommitDate string `json:"commit_date"` |
| 22 | + CommitSHA string `json:"commit_sha"` |
| 23 | +} |
| 24 | + |
| 25 | +type VersionInfo struct { |
| 26 | + ScyllaBench ComponentInfo `json:"scylla-bench"` |
| 27 | + Driver ComponentInfo `json:"scylla-driver"` |
| 28 | +} |
| 29 | + |
| 30 | +type githubRelease struct { |
| 31 | + TagName string `json:"tag_name"` |
| 32 | + CreatedAt time.Time `json:"created_at"` |
| 33 | +} |
| 34 | + |
| 35 | +type githubTag struct { |
| 36 | + Object struct { |
| 37 | + SHA string `json:"sha"` |
| 38 | + } `json:"object"` |
| 39 | +} |
| 40 | + |
| 41 | +const ( |
| 42 | + gocqlPackage = "github.com/gocql/gocql" |
| 43 | + githubTimeout = 5 * time.Second |
| 44 | + userAgent = "scylla-bench (github.com/scylladb/scylla-bench)" |
| 45 | +) |
| 46 | + |
| 47 | +var githubAPIBaseURL = "https://api.github.com" |
| 48 | + |
| 49 | +// Performs an HTTP GET request to fetch release data in JSON format from GitHub |
| 50 | +func getJSON(client *http.Client, url string, target interface{}) error { |
| 51 | + req, err := http.NewRequest("GET", url, nil) |
| 52 | + if err != nil { |
| 53 | + return fmt.Errorf("failed to create request: %w", err) |
| 54 | + } |
| 55 | + req.Header.Set("User-Agent", userAgent) |
| 56 | + resp, err := client.Do(req) |
| 57 | + if err != nil { |
| 58 | + return fmt.Errorf("request failed: %w", err) |
| 59 | + } |
| 60 | + defer resp.Body.Close() |
| 61 | + if resp.StatusCode != http.StatusOK { |
| 62 | + return fmt.Errorf("unexpected status %d", resp.StatusCode) |
| 63 | + } |
| 64 | + if err := json.NewDecoder(resp.Body).Decode(target); err != nil { |
| 65 | + return fmt.Errorf("failed to decode JSON: %w", err) |
| 66 | + } |
| 67 | + return nil |
| 68 | +} |
| 69 | + |
| 70 | +// Retrieves the release date and commit SHA for a given scylladb repository and version from GitHub |
| 71 | +func getReleaseInfo(repo, version string) (date, sha string, err error) { |
| 72 | + client := &http.Client{Timeout: githubTimeout} |
| 73 | + |
| 74 | + // Fetch releases |
| 75 | + releasesURL := fmt.Sprintf("%s/repos/scylladb/%s/releases", githubAPIBaseURL, repo) |
| 76 | + var releases []githubRelease |
| 77 | + if err := getJSON(client, releasesURL, &releases); err != nil { |
| 78 | + return "", "", fmt.Errorf("failed to fetch releases: %w", err) |
| 79 | + } |
| 80 | + |
| 81 | + // Find matching release |
| 82 | + cleanVersion := strings.TrimPrefix(version, "v") |
| 83 | + var releaseDate, tagName string |
| 84 | + for _, release := range releases { |
| 85 | + if strings.TrimPrefix(release.TagName, "v") == cleanVersion { |
| 86 | + releaseDate = release.CreatedAt.Format(time.RFC3339) |
| 87 | + tagName = release.TagName |
| 88 | + break |
| 89 | + } |
| 90 | + } |
| 91 | + if tagName == "" { |
| 92 | + return "", "", fmt.Errorf("release %s not found", version) |
| 93 | + } |
| 94 | + |
| 95 | + // Fetch tag info to get the commit SHA |
| 96 | + tagURL := fmt.Sprintf("%s/repos/scylladb/%s/git/refs/tags/%s", githubAPIBaseURL, repo, tagName) |
| 97 | + var tag githubTag |
| 98 | + if err := getJSON(client, tagURL, &tag); err != nil { |
| 99 | + return releaseDate, "", fmt.Errorf("failed to fetch tag info: %w", err) |
| 100 | + } |
| 101 | + |
| 102 | + return releaseDate, tag.Object.SHA, nil |
| 103 | +} |
| 104 | + |
| 105 | +// Retrieves scylla-bench version info from build info |
| 106 | +func readMainBuildInfo() (ver, sha, buildDate string) { |
| 107 | + ver = version |
| 108 | + sha = commit |
| 109 | + buildDate = date |
| 110 | + if info, ok := debug.ReadBuildInfo(); ok { |
| 111 | + for _, setting := range info.Settings { |
| 112 | + switch setting.Key { |
| 113 | + case "vcs.revision": |
| 114 | + if sha == "unknown" { |
| 115 | + sha = setting.Value |
| 116 | + } |
| 117 | + case "vcs.time": |
| 118 | + if buildDate == "unknown" { |
| 119 | + buildDate = setting.Value |
| 120 | + } |
| 121 | + } |
| 122 | + } |
| 123 | + if ver == "dev" { |
| 124 | + if info.Main.Version != "" { |
| 125 | + ver = info.Main.Version |
| 126 | + } else { |
| 127 | + ver = "(devel)" |
| 128 | + } |
| 129 | + } |
| 130 | + } |
| 131 | + return |
| 132 | +} |
| 133 | + |
| 134 | +// Retrieves scylla-gocql-driver version info from build info |
| 135 | +func getDriverInfo() ComponentInfo { |
| 136 | + comp := ComponentInfo{ |
| 137 | + Version: "unknown", |
| 138 | + CommitSHA: "unknown", |
| 139 | + CommitDate: "unknown", |
| 140 | + } |
| 141 | + if info, ok := debug.ReadBuildInfo(); ok { |
| 142 | + for _, d := range info.Deps { |
| 143 | + if d.Path == gocqlPackage { |
| 144 | + comp.Version = d.Version |
| 145 | + if d.Replace != nil { |
| 146 | + comp.Version = d.Replace.Version |
| 147 | + if dDate, dSHA, err := getReleaseInfo("gocql", comp.Version); err == nil { |
| 148 | + comp.CommitDate = dDate |
| 149 | + comp.CommitSHA = dSHA |
| 150 | + } else { |
| 151 | + comp.CommitSHA = "unknown" |
| 152 | + comp.CommitDate = "unknown" |
| 153 | + } |
| 154 | + } else { |
| 155 | + comp.CommitSHA = "upstream release" |
| 156 | + comp.CommitDate = "unknown" |
| 157 | + } |
| 158 | + break |
| 159 | + } |
| 160 | + } |
| 161 | + } |
| 162 | + return comp |
| 163 | +} |
| 164 | + |
| 165 | +// Returns the version info for scylla-bench and scylla-gocql-driver |
| 166 | +func GetVersionInfo() VersionInfo { |
| 167 | + ver, sha, buildDate := readMainBuildInfo() |
| 168 | + driverInfo := getDriverInfo() |
| 169 | + return VersionInfo{ |
| 170 | + ScyllaBench: ComponentInfo{ |
| 171 | + Version: ver, |
| 172 | + CommitDate: buildDate, |
| 173 | + CommitSHA: sha, |
| 174 | + }, |
| 175 | + Driver: driverInfo, |
| 176 | + } |
| 177 | +} |
| 178 | + |
| 179 | +// Returns a human-readable string with version info |
| 180 | +func (v VersionInfo) FormatHuman() string { |
| 181 | + return fmt.Sprintf(`scylla-bench: |
| 182 | + version: %s |
| 183 | + commit sha: %s |
| 184 | + commit date: %s |
| 185 | +scylla-gocql-driver: |
| 186 | + version: %s |
| 187 | + commit sha: %s |
| 188 | + commit date: %s`, |
| 189 | + v.ScyllaBench.Version, |
| 190 | + v.ScyllaBench.CommitSHA, |
| 191 | + v.ScyllaBench.CommitDate, |
| 192 | + v.Driver.Version, |
| 193 | + v.Driver.CommitSHA, |
| 194 | + v.Driver.CommitDate, |
| 195 | + ) |
| 196 | +} |
| 197 | + |
| 198 | +// Returns a JSON-formatted string with version info |
| 199 | +func (v VersionInfo) FormatJSON() (string, error) { |
| 200 | + data, err := json.MarshalIndent(v, "", " ") |
| 201 | + if err != nil { |
| 202 | + return "", fmt.Errorf("failed to marshal version info to JSON: %w", err) |
| 203 | + } |
| 204 | + return string(data), nil |
| 205 | +} |
0 commit comments