Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tools/update-go-azure-sdk: updating both the Base Layer and Resource Manager submodules #24602

Merged
merged 1 commit into from
Jan 25, 2024
Merged

tools/update-go-azure-sdk: updating both the Base Layer and Resource Manager submodules #24602

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 62 additions & 36 deletions internal/tools/update-go-azure-sdk/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ import (

var logger = hclog.New(hclog.DefaultOptions)

var goModulesToUpdate = []goModuleType{
baseLayerGoModule,
resourceManagerGoModule,
}

func main() {
// NOTE: this tool has a number of assumptions both about the environment this is being run in, and
// about the design of this repository - namely that an `internal` folder exists and that Git is configured.
Expand Down Expand Up @@ -133,9 +138,11 @@ func run(ctx context.Context, input config) error {
}

// 3. Update the version of `hashicorp/go-azure-sdk` used in `terraform-provider-azurerm`
logger.Info("Updating `hashicorp/go-azure-sdk`..")
if err := updateVersionOfGoAzureSDK(ctx, input.azurermRepoPath, input.newSdkVersion); err != nil {
return fmt.Errorf("updating the version of go-azure-sdk: %+v", err)
for _, moduleType := range goModulesToUpdate {
logger.Info(fmt.Sprintf("Updating the %q Go module within `hashicorp/go-azure-sdk`..", string(moduleType)))
if err := updateVersionOfGoAzureSDK(ctx, input.azurermRepoPath, moduleType, input.newSdkVersion); err != nil {
return fmt.Errorf("updating the version of the %q Go Module within `hashicorp/go-azure-sdk`: %+v", string(moduleType), err)
}
}

// 4. Then for each new Service/API Version:
Expand Down Expand Up @@ -271,12 +278,14 @@ func determineCurrentVersionOfGoAzureSDK(workingDirectory string) (*string, erro
continue
}

if strings.EqualFold(v.Mod.Path, "github.com/hashicorp/go-azure-sdk") {
// Since each of the Nested Go Modules within `hashicorp/go-azure-sdk` are versioned the same with a different
// prefix, checking the base layer Go Module should be sufficient.
if strings.EqualFold(v.Mod.Path, "github.com/hashicorp/go-azure-sdk/sdk") {
return pointer.To(v.Mod.Version), nil
}
}

return nil, fmt.Errorf("couldn't find the go module version for `github.com/hashicorp/go-azure-sdk` in %q", filePath)
return nil, fmt.Errorf("couldn't find the go module version for `github.com/hashicorp/go-azure-sdk/sdk` in %q", filePath)
}

func resetWorkingDirectory(ctx context.Context, workingDirectory string) error {
Expand Down Expand Up @@ -473,35 +482,40 @@ func determineChangesBetweenVersionsOfGoAzureSDK(ctx context.Context, oldSDKVers
_ = cmd.Wait()
}

// Obtain the file paths which have changed
// For now this should be sufficient to pull any changes and iterate over those e.g.:
// > git diff --name-only v0.20220711.1181406...v0.20220712.1062733
//
// There's probably a performance enhancement here using the additional flags on
// `--diff-filter` which supports Added (A) - but there's also Changed (C), Deleted (D)
// and Renamed (R) - and can be used like so:
// > git diff --name-only --diff-filter=A v0.20220711.1181406...v0.20220712.1062733
// however doing so will come with edge-cases, so it's simplest to pull all changes for now.
logger.Debug(fmt.Sprintf("Determining the changes between %q and %q..", oldSDKVersion, newSDKVersion))
diffArgs := []string{
"diff",
"--name-only",
fmt.Sprintf("%s...%s", oldSDKVersion, newSDKVersion),
}
var stdout bytes.Buffer
var stderr bytes.Buffer
diffCmd := exec.CommandContext(ctx, "git", diffArgs...)
diffCmd.Dir = workingDirectory
diffCmd.Stderr = &stderr
diffCmd.Stdout = &stdout
_ = diffCmd.Start()
_ = diffCmd.Wait()
if stderr.Len() > 0 {
return nil, fmt.Errorf("determining the changes between `hashicorp/go-azure-sdk` version %q and %q: %s", oldSDKVersion, newSDKVersion, stderr.String())
lines := make([]string, 0)
for _, moduleType := range goModulesToUpdate {
// Obtain the file paths which have changed
// For now this should be sufficient to pull any changes and iterate over those e.g.:
// > git diff --name-only v0.20220711.1181406...v0.20220712.1062733
//
// There's probably a performance enhancement here using the additional flags on
// `--diff-filter` which supports Added (A) - but there's also Changed (C), Deleted (D)
// and Renamed (R) - and can be used like so:
// > git diff --name-only --diff-filter=A v0.20220711.1181406...v0.20220712.1062733
// however doing so will come with edge-cases, so it's simplest to pull all changes for now.
logger.Debug(fmt.Sprintf("Determining the changes between %q and %q for %q..", oldSDKVersion, newSDKVersion, string(moduleType)))
diffArgs := []string{
"diff",
"--name-only",
fmt.Sprintf("%[1]s/%[2]s...%[1]s/%[3]s", string(moduleType), oldSDKVersion, newSDKVersion),
}
var stdout bytes.Buffer
var stderr bytes.Buffer
diffCmd := exec.CommandContext(ctx, "git", diffArgs...)
diffCmd.Dir = workingDirectory
diffCmd.Stderr = &stderr
diffCmd.Stdout = &stdout
_ = diffCmd.Start()
_ = diffCmd.Wait()
if stderr.Len() > 0 {
return nil, fmt.Errorf("determining the changes between `hashicorp/go-azure-sdk` version %q and %q: %s", oldSDKVersion, newSDKVersion, stderr.String())
}

logger.Debug("Parsing changes from the Git Diff..")
linesWithChanges := strings.Split(stdout.String(), "\n")
lines = append(lines, linesWithChanges...)
}

logger.Debug("Parsing changes from the Git Diff..")
lines := strings.Split(stdout.String(), "\n")
parsed := parseChangesFromGitDiff(lines)
return &parsed, nil
}
Expand Down Expand Up @@ -553,11 +567,23 @@ func parseChangesFromGitDiff(lines []string) changes {
return out
}

func updateVersionOfGoAzureSDK(ctx context.Context, workingDirectory, newApiVersion string) error {
logger.Debug(fmt.Sprintf("Updating the version of `go-azure-sdk` to %q", newApiVersion))
type goModuleType string

const (
// baseLayerGoModule represents the Go Module containing the base layer in `hashicorp/go-azure-sdk`
// this is the Go Module `github.com/hashicorp/go-azure-sdk/sdk`
baseLayerGoModule goModuleType = "sdk"

// resourceManagerGoModule represents the Go Module containing the Resource Manager SDK in
// `hashicorp/go-azure-sdk` - which is the Go Module `github.com/hashicorp/go-azure-sdk/resource-manager`
resourceManagerGoModule goModuleType = "resource-manager"
)

func updateVersionOfGoAzureSDK(ctx context.Context, workingDirectory string, moduleType goModuleType, newApiVersion string) error {
logger.Debug(fmt.Sprintf("Updating the version of `go-azure-sdk`'s %q Go Module to %q", string(moduleType), newApiVersion))
args := []string{
"get",
fmt.Sprintf("github.com/hashicorp/go-azure-sdk@%s", newApiVersion),
fmt.Sprintf("github.com/hashicorp/go-azure-sdk/%s@%s", string(moduleType), newApiVersion),
}
cmd := exec.CommandContext(ctx, "go", args...)
cmd.Dir = workingDirectory
Expand All @@ -569,7 +595,7 @@ func updateVersionOfGoAzureSDK(ctx context.Context, workingDirectory, newApiVers
goModTidyAndVendor(ctx, workingDirectory)

logger.Debug("Committing the changes..")
message := fmt.Sprintf("dependencies: updating to version `%s` of `github.com/hashicorp/go-azure-sdk`", newApiVersion)
message := fmt.Sprintf("dependencies: updating to version `%s` of `github.com/hashicorp/go-azure-sdk/%s`", newApiVersion, string(moduleType))
if err := stageAndCommitChanges(workingDirectory, message); err != nil {
return fmt.Errorf("staging/committing changes to %q: %+v", workingDirectory, err)
}
Expand Down
Loading