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
|
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
package autorest
import (
"bufio"
"encoding/json"
"fmt"
"io"
"log"
"os"
"path/filepath"
"strings"
"time"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/autorest/model"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/exports"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/utils"
)
// GenerateContext describes the context that would be used in an autorest generation task
type GenerateContext interface {
SDKRoot() string
SpecRoot() string
RepoContent() map[string]exports.Content
}
// GenerateInput describes the input information for a package generation
type GenerateInput struct {
// Readme is the relative path of the readme file to the root directory of azure-sdk-for-go
Readme string
// Tag is the readme tag to be generated
Tag string
// CommitHash is the head commit hash of azure-rest-api-specs
CommitHash string
// Options specifies the options that this generation task will be using
Options model.Options
}
// GenerateOptions describes the options for a package generation
type GenerateOptions struct {
// MetadataOutputRoot specifies the root directory of all the metadata goes.
// Metadata will be generated to a temp directory if not specified.
// The metadataOutput directory will not be removed after the generation succeeded
MetadataOutputRoot string
// Stderr ...
Stderr io.Writer
// Stdout ...
Stdout io.Writer
// AutoRestLogPrefix ...
AutoRestLogPrefix string
// ChangelogTitle
ChangelogTitle string
// Validators ...
Validators []MetadataValidateFunc
}
// GenerateResult describes the result of a generation task
type GenerateResult struct {
// MetadataOutputRoot stores the metadata output root which is the same as in options, or randomly generated if not specified in options
MetadataOutputRoot string
// Metadata is the GenerationMetadata of the generated package
Metadata GenerationMetadata
// Package is the changelog information of the generated package
Package ChangelogResult
}
// GeneratePackage is a wrapper function of the autorest execution task
func GeneratePackage(ctx GenerateContext, input GenerateInput, options GenerateOptions) (*GenerateResult, error) {
if err := input.validate(); err != nil {
return nil, err
}
if err := options.validate(); err != nil {
return nil, err
}
absReadme := filepath.Join(ctx.SpecRoot(), input.Readme)
metadataOutput := filepath.Join(options.MetadataOutputRoot, input.Tag)
g := NewGeneratorFromOptions(input.Options).WithTag(input.Tag).WithMetadataOutput(metadataOutput).WithReadme(absReadme)
// generate
if err := generate(g, options.Stdout, options.Stderr, options.AutoRestLogPrefix); err != nil {
return nil, fmt.Errorf("failed to execute autorest: %+v", err)
}
// parse the metadata from autorest
metadataMap, err := NewMetadataProcessorFromLocation(metadataOutput).Process()
if err != nil {
return nil, fmt.Errorf("failed to parse metadata in '%s': %+v", metadataOutput, err)
}
// validate
if err := validate(input.Readme, metadataMap, options.Validators); err != nil {
return nil, fmt.Errorf("failed in validation: %+v", err)
}
// write the changelog and metadata file
result, metadata, err := changelogAndMetadata(ctx, input, metadataMap, options.ChangelogTitle, g.Arguments())
if err != nil {
return nil, err
}
return &GenerateResult{
MetadataOutputRoot: options.MetadataOutputRoot,
Metadata: *metadata,
Package: *result,
}, nil
}
func generate(generator *Generator, stdout, stderr io.Writer, prefix string) error {
stdoutPipe, _ := generator.StdoutPipe()
stderrPipe, _ := generator.StderrPipe()
defer stdoutPipe.Close()
defer stderrPipe.Close()
var arguments []string
for _, o := range generator.Arguments() {
arguments = append(arguments, o.Format())
}
log.Printf("Generation parameters: %s", strings.Join(arguments, ", "))
_ = generator.Start()
// we put all the output from autorest to stderr since those are logs in order not to interrupt the proper output of the release command
go scannerPrint(bufio.NewScanner(stdoutPipe), stdout, prefix)
go scannerPrint(bufio.NewScanner(stderrPipe), stderr, prefix)
return generator.Wait()
}
func validate(readme string, metadataMap map[string]model.Metadata, validators []MetadataValidateFunc) error {
builder := validationErrorBuilder{
readme: readme,
}
for tag, metadata := range metadataMap {
errors := ValidateMetadata(validators, tag, metadata)
if len(errors) != 0 {
builder.add(errors...)
}
}
return builder.build()
}
type validationErrorBuilder struct {
readme string
errors []error
}
func (b *validationErrorBuilder) add(errors ...error) {
b.errors = append(b.errors, errors...)
}
func (b *validationErrorBuilder) build() error {
if len(b.errors) == 0 {
return nil
}
var messages []string
for _, e := range b.errors {
messages = append(messages, e.Error())
}
return fmt.Errorf("validation failed in readme '%s' with %d error(s): \n%s", b.readme, len(b.errors), strings.Join(messages, "\n"))
}
func changelogAndMetadata(ctx GenerateContext, input GenerateInput, metadataMap map[string]model.Metadata, changelogTitle string, argument []model.Option) (*ChangelogResult, *GenerationMetadata, error) {
result, err := changelog(ctx, metadataMap, changelogTitle)
if err != nil {
return nil, nil, fmt.Errorf("failed to write changelog file: %+v", err)
}
// write the metadata file
metadata, err := metadata(input, *result, argument)
if err != nil {
return nil, nil, fmt.Errorf("failed to write metadata file: %+v", err)
}
return result, metadata, nil
}
func changelog(ctx GenerateContext, metadataMap map[string]model.Metadata, changelogTitle string) (*ChangelogResult, error) {
// process the changelog
changelogResults, err := NewChangelogProcessorFromContext(ctx).Process(metadataMap)
if err != nil {
return nil, fmt.Errorf("failed to process the changelog: %+v", err)
}
// we should only have one changelog
if len(changelogResults) != 1 {
return nil, fmt.Errorf("expecting 1 changelog result, but got %d", len(changelogResults))
}
changelogPath, err := WriteChangelogFile(changelogTitle, changelogResults[0])
if err != nil {
return nil, fmt.Errorf("failed to write changelog file: %+v", err)
}
log.Printf("changelog file writes to '%s'", changelogPath)
return &changelogResults[0], nil
}
func metadata(input GenerateInput, result ChangelogResult, arguments []model.Option) (*GenerationMetadata, error) {
metadata := getMetadata(input, result, arguments)
metadataPath, err := WriteMetadataFile(result.PackageFullPath, metadata)
if err != nil {
return nil, err
}
log.Printf("metadata file writes to '%s'", metadataPath)
return &metadata, nil
}
func getMetadata(input GenerateInput, result ChangelogResult, arguments []model.Option) GenerationMetadata {
options := AdditionalOptionsToString(arguments)
codeGenVersion := input.Options.CodeGeneratorVersion()
return GenerationMetadata{
CommitHash: input.CommitHash,
Readme: NormalizedSpecRoot + utils.NormalizePath(input.Readme),
Tag: input.Tag,
CodeGenVersion: codeGenVersion,
RepositoryURL: "https://github.com/Azure/azure-rest-api-specs.git",
AutorestCommand: fmt.Sprintf("autorest --use=%s --tag=%s --go-sdk-folder=/_/azure-sdk-for-go %s /_/azure-rest-api-specs/%s",
codeGenVersion, result.Tag, strings.Join(options, " "), utils.NormalizePath(input.Readme)),
AdditionalProperties: GenerationMetadataAdditionalProperties{
AdditionalOptions: strings.Join(options, " "),
},
}
}
func (input GenerateInput) validate() error {
if input.Readme == "" {
return fmt.Errorf("`Readme` cannot be empty in input")
}
if filepath.IsAbs(input.Readme) {
return fmt.Errorf("`Readme` must be a relative path")
}
if input.Tag == "" {
return fmt.Errorf("`Tag` cannot be empty in input")
}
if input.Options == nil {
return fmt.Errorf("`Options` cannot be nil")
}
return nil
}
func (options *GenerateOptions) validate() error {
if options.MetadataOutputRoot == "" {
options.MetadataOutputRoot = filepath.Join(os.TempDir(), fmt.Sprintf("generation-metadata-%v", time.Now().Unix()))
}
if options.ChangelogTitle == "" {
options.ChangelogTitle = "Change History"
}
return nil
}
// WriteChangelogFile writes the changelog to the disk
func WriteChangelogFile(title string, result ChangelogResult) (string, error) {
fileContent := fmt.Sprintf(`# %s
%s`, title, result.Changelog.ToMarkdown())
path := filepath.Join(result.PackageFullPath, ChangelogFilename)
changelogFile, err := os.Create(path)
if err != nil {
return "", err
}
defer changelogFile.Close()
if _, err := changelogFile.WriteString(fileContent); err != nil {
return "", err
}
return path, nil
}
// WriteMetadataFile writes the metadata to the disk
func WriteMetadataFile(packagePath string, metadata GenerationMetadata) (string, error) {
metadataFilepath := filepath.Join(packagePath, MetadataFilename)
metadataFile, err := os.Create(metadataFilepath)
if err != nil {
return "", err
}
defer metadataFile.Close()
// marshal metadata
b, err := json.MarshalIndent(metadata, "", " ")
if err != nil {
return "", fmt.Errorf("cannot marshal metadata: %+v", err)
}
if _, err := metadataFile.Write(b); err != nil {
return "", err
}
return metadataFilepath, nil
}
// scannerPrint prints the scanner to writer with a specified prefix
func scannerPrint(scanner *bufio.Scanner, writer io.Writer, prefix string) error {
if writer == nil {
return nil
}
for scanner.Scan() {
line := scanner.Text()
if _, err := fmt.Fprintln(writer, fmt.Sprintf("%s%s", prefix, line)); err != nil {
return err
}
}
return nil
}
|