1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
|
package core
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"io/fs"
"os"
"os/exec"
"path/filepath"
"sort"
"strings"
"time"
"github.com/Masterminds/semver/v3"
shellquote "github.com/kballard/go-shellquote"
)
// TimeNow is a func type for time.Now
type TimeNow func() time.Time
type EditorRunner interface {
Run() error
}
var (
ErrBadVersionOrPart = errors.New("part string is not a supported version or version increment")
ErrMissingAutoLevel = errors.New("kind config missing auto level value for auto bumping")
ErrNoChangesFoundForAuto = errors.New("no unreleased changes found for automatic bumping")
ErrKindNotFound = errors.New("kind not found but configuration expects one")
)
var (
bom = []byte{0xef, 0xbb, 0xbf}
)
func AppendFile(rootFile io.Writer, path string) error {
otherFile, err := os.Open(path)
if err != nil {
return err
}
defer otherFile.Close()
_, err = io.Copy(rootFile, otherFile)
return err
}
func GetAllVersions(
config *Config,
skipPrereleases bool,
projectKey string,
) ([]*semver.Version, error) {
allVersions := make([]*semver.Version, 0)
versionsPath := config.ChangesDir
if len(projectKey) > 0 {
versionsPath = filepath.Join(versionsPath, projectKey)
}
fileInfos, err := os.ReadDir(versionsPath)
if err != nil && errors.Is(err, fs.ErrNotExist) {
return allVersions, nil
}
if err != nil {
return allVersions, fmt.Errorf("reading files from '%s': %w", versionsPath, err)
}
for _, file := range fileInfos {
if file.Name() == config.HeaderPath || file.IsDir() {
continue
}
versionString := strings.TrimSuffix(file.Name(), filepath.Ext(file.Name()))
v, err := semver.NewVersion(versionString)
if err != nil {
continue
}
if skipPrereleases && v.Prerelease() != "" {
continue
}
allVersions = append(allVersions, v)
}
sort.Sort(sort.Reverse(semver.Collection(allVersions)))
return allVersions, nil
}
func GetLatestVersion(
config *Config,
skipPrereleases bool,
projectKey string,
) (*semver.Version, error) {
allVersions, err := GetAllVersions(config, skipPrereleases, projectKey)
if err != nil {
return nil, err
}
// if no versions exist default to v0.0.0
if len(allVersions) == 0 {
return semver.MustParse("v0.0.0"), nil
}
return allVersions[0], nil
}
func ValidBumpLevel(level string) bool {
return level == MajorLevel ||
level == MinorLevel ||
level == PatchLevel ||
level == AutoLevel
}
func HighestAutoLevel(config *Config, allChanges []Change) (string, error) {
if len(allChanges) == 0 {
return "", ErrNoChangesFoundForAuto
}
highestLevel := EmptyLevel
err := ErrNoChangesFoundForAuto
for _, change := range allChanges {
for _, kc := range config.Kinds {
if kc.KeyOrLabel() != change.Kind {
continue
}
switch kc.AutoLevel {
case MajorLevel:
// major is the highest one, so we can just return it
return MajorLevel, nil
case PatchLevel:
if highestLevel == EmptyLevel {
highestLevel = PatchLevel
err = nil
}
case MinorLevel:
// bump to minor if we have a minor level
if highestLevel == PatchLevel || highestLevel == EmptyLevel {
highestLevel = MinorLevel
err = nil
}
case EmptyLevel:
return EmptyLevel, ErrMissingAutoLevel
}
}
}
return highestLevel, err
}
func GetNextVersion(
config *Config,
partOrVersion string,
prerelease, meta []string,
allChanges []Change,
projectKey string,
) (*semver.Version, error) {
var (
err error
next *semver.Version
ver semver.Version
)
// if part or version is a valid version, then return it
next, err = semver.NewVersion(partOrVersion)
if err != nil {
if !ValidBumpLevel(partOrVersion) {
return nil, ErrBadVersionOrPart
}
// otherwise use a bump type command
next, err = GetLatestVersion(config, false, projectKey)
if err != nil {
return nil, err
}
if partOrVersion == AutoLevel {
partOrVersion, err = HighestAutoLevel(config, allChanges)
if err != nil {
return nil, err
}
}
switch partOrVersion {
case MajorLevel:
ver = next.IncMajor()
case MinorLevel:
ver = next.IncMinor()
case PatchLevel:
ver = next.IncPatch()
}
next = &ver
}
if len(prerelease) > 0 {
ver, err = next.SetPrerelease(strings.Join(prerelease, "."))
if err != nil {
return nil, err
}
next = &ver
}
if len(meta) > 0 {
ver, err = next.SetMetadata(strings.Join(meta, "."))
if err != nil {
return nil, err
}
next = &ver
}
return next, nil
}
func FindChangeFiles(
config *Config,
searchPaths []string,
) ([]string, error) {
var yamlFiles []string
// add the unreleased path to any search paths included
searchPaths = append(searchPaths, config.UnreleasedDir)
// read all yaml files from our search paths
for _, searchPath := range searchPaths {
rootPath := filepath.Join(config.ChangesDir, searchPath)
fileInfos, err := os.ReadDir(rootPath)
if err != nil {
return yamlFiles, err
}
for _, file := range fileInfos {
if filepath.Ext(file.Name()) != ".yaml" {
continue
}
path := filepath.Join(rootPath, file.Name())
yamlFiles = append(yamlFiles, path)
}
}
return yamlFiles, nil
}
func WriteNewlines(writer io.Writer, lines int) error {
if lines == 0 {
return nil
}
_, err := writer.Write([]byte(strings.Repeat("\n", lines)))
return err
}
func EnvVarMap(environ []string) map[string]string {
ret := make(map[string]string)
for _, env := range environ {
split := strings.SplitN(env, "=", 2)
ret[split[0]] = split[1]
}
return ret
}
func LoadEnvVars(config *Config, envs []string) map[string]string {
ret := make(map[string]string)
if config.EnvPrefix == "" {
return ret
}
for k, v := range EnvVarMap(envs) {
key, found := strings.CutPrefix(k, config.EnvPrefix)
if found {
ret[key] = v
}
}
return ret
}
func GetChanges(
cfg *Config,
searchPaths []string,
projectKey string,
) ([]Change, error) {
var changes []Change
changeFiles, err := FindChangeFiles(cfg, searchPaths)
if err != nil {
return changes, err
}
for _, cf := range changeFiles {
c, err := LoadChange(cf)
if err != nil {
return changes, err
}
if len(projectKey) > 0 && c.Project != projectKey {
continue
}
c.Env = cfg.EnvVars()
kc := cfg.KindFromKeyOrLabel(c.KindKey)
if kc != nil {
c.KindLabel = kc.Label
} else if len(cfg.Kinds) > 0 {
return nil, fmt.Errorf("%w: '%s'", ErrKindNotFound, c.KindKey)
}
changes = append(changes, c)
}
sort.Slice(changes, ChangeLess(cfg, changes))
return changes, nil
}
func FileExists(path string) (bool, error) {
fi, err := os.Stat(path)
if err == nil {
return !fi.IsDir(), nil
}
if os.IsNotExist(err) {
return false, nil
}
return false, err
}
// createTempFile will create a new temporary file, writing a BOM header if we need to.
// It will return the path to that file or an error.
func createTempFile(runtime string, ext string) (string, error) {
file, err := os.CreateTemp("", "changie-body-txt-*."+ext)
if err != nil {
return "", err
}
defer file.Close()
// The reason why we do this is because notepad.exe on Windows determines the
// encoding of an "empty" text file by the locale, for example, GBK in China,
// while golang string only handles utf8 well. However, a text file with utf8
// BOM header is not considered "empty" on Windows, and the encoding will then
// be determined utf8 by notepad.exe, instead of GBK or other encodings.
// This could be enhanced in the future by doing this only when a non-utf8
// locale is in use, and possibly doing that for any OS, not just windows.
if runtime == "windows" {
if _, err = file.Write(bom); err != nil {
return "", err
}
}
return file.Name(), nil
}
// BuildCommand will create an exec command to run our editor.
func BuildCommand(editorFilePath string) (EditorRunner, error) {
editor := os.Getenv("EDITOR")
if editor == "" {
return nil, errors.New("'EDITOR' env variable not set")
}
args, err := shellquote.Split(editor)
if err != nil {
return nil, err
}
args = append(args, editorFilePath)
// #nosec G204
cmd := exec.CommandContext(context.Background(), args[0], args[1:]...)
// Set the stdin and stdout of the command to the current process's stdin and stdout
cmd.Stdin = os.Stdin
cmd.Stdout = os.Stdout
return cmd, nil
}
// getBodyTextWithEditor will run the provided editor runner and read the final file.
func getBodyTextWithEditor(runner EditorRunner, editorFile string) (string, error) {
if err := runner.Run(); err != nil {
return "", fmt.Errorf("opening the editor: %w", err)
}
buf, err := os.ReadFile(editorFile)
if err != nil {
return "", err
}
return strings.TrimSpace(string(bytes.TrimPrefix(buf, bom))), nil
}
|