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
|
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
package automation
import (
"bufio"
"fmt"
"log"
"os"
"path/filepath"
"sort"
"strings"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/autorest"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/autorest/model"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/cmd/automation/pipeline"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/common"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/exports"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/packages/track1"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/utils"
"github.com/spf13/cobra"
)
// Command returns the automation command. Note that this command is designed to run in the root directory of
// azure-sdk-for-go. It does not work if you are running this tool in somewhere else
func Command() *cobra.Command {
automationCmd := &cobra.Command{
Use: "automation <generate input filepath> <generate output filepath>",
Args: cobra.ExactArgs(2),
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
log.SetFlags(0) // remove the time stamp prefix
return nil
},
RunE: func(cmd *cobra.Command, args []string) error {
optionPath, err := cmd.Flags().GetString("options")
if err != nil {
logError(err)
return err
}
if err := execute(args[0], args[1], Flags{
OptionPath: optionPath,
}); err != nil {
logError(err)
return err
}
return nil
},
SilenceUsage: true, // this command is used for a pipeline, the usage should never show
}
flags := automationCmd.Flags()
flags.String("options", common.DefaultOptionPath, "Specify a file with the autorest options")
return automationCmd
}
// Flags ...
type Flags struct {
OptionPath string
}
func execute(inputPath, outputPath string, flags Flags) error {
log.Printf("Reading generate input file from '%s'...", inputPath)
input, err := pipeline.ReadInput(inputPath)
if err != nil {
return fmt.Errorf("cannot read generate input: %+v", err)
}
log.Printf("Generating using the following GenerateInput...\n%s", input.String())
cwd, err := os.Getwd()
if err != nil {
return err
}
log.Printf("Using current directory as SDK root: %s", cwd)
ctx := automationContext{
sdkRoot: utils.NormalizePath(cwd),
specRoot: input.SpecFolder,
commitHash: input.HeadSha,
optionPath: flags.OptionPath,
}
output, err := ctx.generate(input)
if err != nil {
return err
}
log.Printf("Output generated: \n%s", output.String())
log.Printf("Writing output to file '%s'...", outputPath)
if err := pipeline.WriteOutput(outputPath, output); err != nil {
return fmt.Errorf("cannot write generate output: %+v", err)
}
return nil
}
type automationContext struct {
sdkRoot string
specRoot string
commitHash string
optionPath string
repoContent map[string]exports.Content
sdkVersion string
existingPackages existingPackageMap
defaultOptions model.Options
additionalOptions []model.Option
}
func (ctx *automationContext) categorizePackages() error {
ctx.existingPackages = existingPackageMap{}
serviceRoot := filepath.Join(ctx.sdkRoot, "services")
m, err := autorest.CollectGenerationMetadata(serviceRoot)
if err != nil {
return err
}
for path, metadata := range m {
// the path in the metadata map is the absolute path
relPath, err := filepath.Rel(ctx.sdkRoot, path)
if err != nil {
return err
}
ctx.existingPackages.add(utils.NormalizePath(relPath), metadata)
}
return nil
}
func (ctx *automationContext) readDefaultOptions() error {
log.Printf("Reading defaultOptions from file '%s'...", ctx.optionPath)
optionFile, err := os.Open(ctx.optionPath)
if err != nil {
return err
}
generateOptions, err := model.NewGenerateOptionsFrom(optionFile)
if err != nil {
return err
}
// parsing the default options
defaultOptions, err := model.ParseOptions(generateOptions.AutorestArguments)
if err != nil {
return fmt.Errorf("cannot parse default options from %v: %+v", generateOptions.AutorestArguments, err)
}
// remove the `--multiapi` in default options
var options []model.Option
for _, o := range defaultOptions.Arguments() {
if v, ok := o.(model.FlagOption); ok && v.Flag() == "multiapi" {
continue
}
options = append(options, o)
}
ctx.defaultOptions = model.NewOptions(options...)
log.Printf("Autorest defaultOptions: \n%+v", ctx.defaultOptions.Arguments())
// parsing the additional options
additionalOptions, err := model.ParseOptions(generateOptions.AdditionalOptions)
if err != nil {
return fmt.Errorf("cannot parse additional options from %v: %+v", generateOptions.AdditionalOptions, err)
}
ctx.additionalOptions = additionalOptions.Arguments()
return nil
}
// TODO -- support dry run
func (ctx *automationContext) generate(input *pipeline.GenerateInput) (*pipeline.GenerateOutput, error) {
if input.DryRun {
return nil, fmt.Errorf("dry run not supported yet")
}
log.Printf("Reading packages in azure-sdk-for-go...")
if err := ctx.readRepoContent(); err != nil {
return nil, err
}
log.Printf("Reading metadata information in azure-sdk-for-go...")
if err := ctx.categorizePackages(); err != nil {
return nil, err
}
log.Printf("Reading default options...")
if err := ctx.readDefaultOptions(); err != nil {
return nil, err
}
log.Printf("Reading version number...")
if err := ctx.readVersion(); err != nil {
return nil, err
}
// iterate over all the readme
results := make([]pipeline.PackageResult, 0)
errorBuilder := generateErrorBuilder{}
for _, readme := range input.RelatedReadmeMdFiles {
generateCtx := generateContext{
sdkRoot: ctx.sdkRoot,
specRoot: ctx.specRoot,
commitHash: ctx.commitHash,
repoContent: ctx.repoContent,
existingPackages: ctx.existingPackages[readme],
defaultOptions: ctx.defaultOptions,
}
packageResults, errors := generateCtx.generate(readme)
if len(errors) != 0 {
errorBuilder.add(errors...)
continue
}
// iterate over the changed packages
set := packageResultSet{}
for _, p := range packageResults {
log.Printf("Getting package result for package '%s'", p.Package.PackageName)
content := p.Package.Changelog.ToCompactMarkdown() + "\n" + p.Package.Changelog.GetChangeSummary()
// explicitly disable the breaking change detection in SDK automation track 1 since we already have quite a coverage of track 2 packages, we will leverage the breaking change detection on track 2 modules
breaking := false
breakingChangeItems := p.Package.Changelog.GetBreakingChangeItems()
set.add(pipeline.PackageResult{
Version: ctx.sdkVersion,
PackageName: getPackageIdentifier(p.Package.PackageName),
Path: []string{p.Package.PackageName},
ReadmeMd: []string{readme},
Changelog: &pipeline.Changelog{
Content: &content,
HasBreakingChange: &breaking,
BreakingChangeItems: &breakingChangeItems,
},
})
}
results = append(results, set.toSlice()...)
}
// validate the sdk structure
log.Printf("Validating services directory structure...")
exceptions, err := loadExceptions(filepath.Join(ctx.sdkRoot, "eng/tools/pkgchk/exceptions.txt"))
if err != nil {
return nil, err
}
if err := track1.VerifyWithDefaultVerifiers(filepath.Join(ctx.sdkRoot, "services"), exceptions); err != nil {
return nil, err
}
return &pipeline.GenerateOutput{
Packages: squashResults(results),
}, errorBuilder.build()
}
// squashResults squashes the package results by appending all of the `path`s in the following items to the first item
// By doing this, the SDK automation pipeline will only create one PR that contains all of the generation results
// instead of creating one PR for each generation result.
// This is to reduce the resource cost on GitHub
func squashResults(packages []pipeline.PackageResult) []pipeline.PackageResult {
if len(packages) == 0 {
return packages
}
for i := 1; i < len(packages); i++ {
// append the path of the i-th item to the first
packages[0].Path = append(packages[0].Path, packages[i].Path...)
// erase the path on the i-th item
packages[i].Path = make([]string, 0)
}
return packages
}
func (ctx *automationContext) readRepoContent() error {
ctx.repoContent = make(map[string]exports.Content)
pkgs, err := track1.List(filepath.Join(ctx.sdkRoot, "services"))
if err != nil {
return fmt.Errorf("failed to list track 1 packages: %+v", err)
}
for _, pkg := range pkgs {
relativePath, err := filepath.Rel(ctx.sdkRoot, pkg.FullPath())
if err != nil {
return err
}
relativePath = utils.NormalizePath(relativePath)
if _, ok := ctx.repoContent[relativePath]; ok {
return fmt.Errorf("duplicate package: %s", pkg.Path())
}
exp, err := exports.Get(pkg.FullPath())
if err != nil {
return err
}
ctx.repoContent[relativePath] = exp
}
return nil
}
func (ctx *automationContext) readVersion() error {
v, err := ReadVersion(filepath.Join(ctx.sdkRoot, "version"))
if err != nil {
return err
}
ctx.sdkVersion = v
return nil
}
func contains(array []autorest.GenerateResult, item string) bool {
for _, r := range array {
if utils.NormalizePath(r.Package.PackageName) == utils.NormalizePath(item) {
return true
}
}
return false
}
type generateErrorBuilder struct {
errors []error
}
func (b *generateErrorBuilder) add(err ...error) {
b.errors = append(b.errors, err...)
}
func (b *generateErrorBuilder) build() error {
if len(b.errors) == 0 {
return nil
}
var messages []string
for _, err := range b.errors {
messages = append(messages, err.Error())
}
return fmt.Errorf("total %d error(s): \n%s", len(b.errors), strings.Join(messages, "\n"))
}
type packageResultSet map[string]pipeline.PackageResult
func (s packageResultSet) contains(r pipeline.PackageResult) bool {
_, ok := s[r.PackageName]
return ok
}
func (s packageResultSet) add(r pipeline.PackageResult) {
if s.contains(r) {
log.Printf("[WARNING] The result set already contains key %s with value %+v, but we are still trying to insert a new value %+v on the same key", r.PackageName, s[r.PackageName], r)
}
s[r.PackageName] = r
}
func (s packageResultSet) toSlice() []pipeline.PackageResult {
results := make([]pipeline.PackageResult, 0)
for _, r := range s {
results = append(results, r)
}
// sort the results
sort.SliceStable(results, func(i, j int) bool {
// we first clip the preview segment and then sort by string literal
pI := strings.Replace(results[i].PackageName, "preview/", "/", 1)
pJ := strings.Replace(results[j].PackageName, "preview/", "/", 1)
return pI > pJ
})
return results
}
func getPackageIdentifier(pkg string) string {
return strings.TrimPrefix(utils.NormalizePath(pkg), "services/")
}
func loadExceptions(exceptFile string) (map[string]bool, error) {
if exceptFile == "" {
return nil, nil
}
f, err := os.Open(exceptFile)
if err != nil {
return nil, err
}
defer f.Close()
exceptions := make(map[string]bool)
scanner := bufio.NewScanner(f)
for scanner.Scan() {
exceptions[scanner.Text()] = true
}
if err = scanner.Err(); err != nil {
return nil, err
}
return exceptions, nil
}
func logError(err error) {
for _, line := range strings.Split(err.Error(), "\n") {
if l := strings.TrimSpace(line); l != "" {
log.Printf("[ERROR] %s", l)
}
}
}
|