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
|
package main
import (
"bytes"
"encoding/json"
"errors"
"flag"
"fmt"
"go/format"
"go/parser"
"go/token"
"io/fs"
"os"
"os/exec"
"path/filepath"
"strconv"
"strings"
)
var skipDirs = map[string]bool{
".git": true,
".gitlab": true,
"_build": true,
"_support": true,
"changelogs": true,
"danger": true,
"doc": true,
"proto/go/gitalypb": true,
"scripts": true,
"tools/protoc-gen-gitaly-lint/testdata": true,
"unreleased": true,
}
func main() {
if err := changeModuleVersion(); err != nil {
fmt.Println(err.Error())
os.Exit(1)
}
}
func changeModuleVersion() error {
dirLocation, fromVersion, toVersion, err := getInput()
if err != nil {
return err
}
moduleAbsRootPath, err := filepath.Abs(dirLocation)
if err != nil {
return fmt.Errorf("define absolute module path: %w", err)
}
if err := verifyModulePath(moduleAbsRootPath); err != nil {
return err
}
module, err := getModule(moduleAbsRootPath)
if err != nil {
return fmt.Errorf("define module path: %w", err)
}
prev, next, err := normaliseDesiredImportReplacement(module, fromVersion, toVersion)
if err != nil {
return err
}
if err := rewriteImports(moduleAbsRootPath, prev, next); err != nil {
return fmt.Errorf("re-write go imports: %w", err)
}
if err := rewriteProto(moduleAbsRootPath, prev, next); err != nil {
return fmt.Errorf("re-write .proto files: %w", err)
}
if err := rewriteGoMod(moduleAbsRootPath, next); err != nil {
return fmt.Errorf("re-write go.mod file: %w", err)
}
return nil
}
func getInput() (dirLocation string, fromVersion string, toVersion string, err error) {
flag.StringVar(&dirLocation, "dir", ".", "directory of the module with the go.mod file")
flag.StringVar(&fromVersion, "from", "", "module version to upgrade from")
flag.StringVar(&toVersion, "to", "", "module version to upgrade to")
flag.Parse()
return
}
func isModuleVersion(input string) error {
if input == "" {
return errors.New("empty module version")
}
if !strings.HasPrefix(input, "v") {
return fmt.Errorf("module version should start with 'v': %s", input)
}
rawVersion, err := strconv.ParseInt(input[1:], 10, 64)
if err != nil {
return err
}
if rawVersion < 1 {
return fmt.Errorf("version number should be positive: %d", rawVersion)
}
return nil
}
func getModule(modDir string) (string, error) {
cmd := exec.Command("go", "mod", "edit", "-json")
cmd.Dir = modDir
data, err := cmd.Output()
if err != nil {
var exitErr *exec.ExitError
if errors.As(err, &exitErr) {
return "", fmt.Errorf("command %q: %v", strings.Join(cmd.Args, " "), exitErr.Stderr)
}
return "", fmt.Errorf("command %q: %w", strings.Join(cmd.Args, " "), err)
}
modInfo := struct{ Module struct{ Path string } }{}
if err := json.Unmarshal(data, &modInfo); err != nil {
return "", err
}
return modInfo.Module.Path, nil
}
// rewriteImports rewrites go source files by replacing old import path for the module with the new one.
func rewriteImports(moduleAbsRootPath, prev, next string) error {
fileSet := token.NewFileSet()
if err := filepath.Walk(moduleAbsRootPath, func(path string, info fs.FileInfo, err error) error {
if err != nil {
return err
}
if info.IsDir() {
relPath := strings.TrimPrefix(path, moduleAbsRootPath)
relPath = strings.TrimPrefix(relPath, "/")
if skipDirs[relPath] {
return fs.SkipDir
}
return nil
}
if filepath.Ext(info.Name()) == ".go" {
fileSet.AddFile(path, fileSet.Base(), 0)
}
return nil
}); err != nil {
return fmt.Errorf("scan directory for go source files: %w", err)
}
seen := map[string]struct{}{}
var rerr error
fileSet.Iterate(func(file *token.File) bool {
if _, found := seen[file.Name()]; found {
return false
}
seen[file.Name()] = struct{}{}
if err := rewriteFileImports(fileSet, file.Name(), prev, next); err != nil {
rerr = err
return false
}
return true
})
return rerr
}
func rewriteFileImports(fileSet *token.FileSet, filename, prev, next string) (retErr error) {
astFile, err := parser.ParseFile(fileSet, filename, nil, parser.ParseComments)
if err != nil {
return err
}
for _, imprt := range astFile.Imports {
oldImport, err := strconv.Unquote(imprt.Path.Value)
if err != nil {
return fmt.Errorf("unquote import: %s :%w", imprt.Path.Value, err)
}
if newImport := strings.Replace(oldImport, prev, next, 1); newImport != oldImport {
imprt.EndPos = imprt.End()
imprt.Path.Value = strconv.Quote(newImport)
}
}
f, err := os.Create(filename)
if err != nil {
return fmt.Errorf("open file %q: %w", filename, err)
}
defer func() {
if err := f.Close(); retErr == nil && err != nil {
retErr = fmt.Errorf("close file %q: %w", filename, err)
}
}()
if err := format.Node(f, fileSet, astFile); err != nil {
return fmt.Errorf("rewrite file %q: %w", filename, err)
}
return nil
}
func normaliseDesiredImportReplacement(module, from, to string) (string, string, error) {
if err := isModuleVersion(from); err != nil {
return "", "", fmt.Errorf("invalid 'from' version: %w", err)
}
if err := isModuleVersion(to); err != nil {
return "", "", fmt.Errorf("invalid 'to' version: %w", err)
}
prev := module
next := filepath.Join(filepath.Dir(module), to)
current := filepath.Base(module)
if err := isModuleVersion(current); err == nil {
if current != from {
return "", "", fmt.Errorf("existing module version is %q, but 'from' specified as %q", current, from)
}
} else {
next = filepath.Join(module, to)
}
return prev, next, nil
}
func verifyModulePath(moduleRootPath string) error {
st, err := os.Stat(moduleRootPath)
if err != nil {
return fmt.Errorf("inspect module root path: %w", err)
}
if !st.IsDir() {
return fmt.Errorf("provided module root path is not a directory: %s", moduleRootPath)
}
entries, err := os.ReadDir(moduleRootPath)
if err != nil {
return fmt.Errorf("inspect module root path: %w", err)
}
var modExists bool
for _, entry := range entries {
if entry.Name() == "go.mod" {
modExists = true
break
}
}
if !modExists {
return fmt.Errorf("provided module root path doesn't contain go.mod file: %s", moduleRootPath)
}
return nil
}
// rewriteProto re-write proto files by changing the go_package option declaration:
// 1. option go_package = "gitlab.com/gitlab-org/gitaly/proto/go/gitalypb";
// 2. option go_package = "gitlab.com/gitlab-org/gitaly/v15/proto/go/gitalypb";
// 4. option go_package = "gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb";
func rewriteProto(moduleAbsRootPath, prev, next string) error {
protoDirPath := filepath.Join(moduleAbsRootPath, "proto")
if err := filepath.Walk(protoDirPath, func(path string, info fs.FileInfo, err error) error {
if err != nil {
return err
}
if info.IsDir() {
if info.Name() == "go" {
return fs.SkipDir
}
return nil
}
if filepath.Ext(info.Name()) != ".proto" {
return nil
}
data, err := os.ReadFile(path)
if err != nil {
return err
}
var modified [][]byte
lines := bytes.Split(data, []byte{'\n'})
for _, line := range lines {
tokens := bytes.Fields(line)
pckg := bytes.Join(tokens, []byte{'~'})
if !bytes.HasPrefix(pckg, []byte(`option~go_package~=~"`+prev+`/proto/`)) {
modified = append(modified, line)
continue
}
modified = append(modified, bytes.ReplaceAll(line, []byte(prev), []byte(next)))
}
if len(modified) == 0 {
return nil
}
modifiedData := bytes.Join(modified, []byte{'\n'})
if err := os.WriteFile(path, modifiedData, info.Mode()); err != nil {
return fmt.Errorf("write modified file content: %s, %w", info.Name(), err)
}
return nil
}); err != nil {
return err
}
return nil
}
// rewriteGoMod modifies name of the module in the go.mod file.
func rewriteGoMod(moduleAbsRootPath, next string) error {
cmd := exec.Command("go", "mod", "edit", "-module", next)
cmd.Dir = moduleAbsRootPath
if err := cmd.Run(); err != nil {
return fmt.Errorf("command %q: %w", strings.Join(cmd.Args, " "), err)
}
return nil
}
|