pulumi/pkg/codegen/importer/language.go
Pat Gavlin dff1299be4
[codegen] Add a code generator for resource state. (#4982)
Add a new package, `codegen/importer`, that can generate definitions for
resource states in PCL or TS/Python/C#/Go. The pipeline is relatively
simple: given a list of resource states, generate a PCL program in
memory, bind it, and pass it to the language-specific code generator.
This builds upon the existing PCL IR, and can be used with the currently
supported code generators.

Related to #1635.
2020-07-08 19:12:37 -07:00

108 lines
3.3 KiB
Go

// Copyright 2016-2020, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package importer
import (
"bytes"
"fmt"
"io"
"github.com/hashicorp/hcl/v2"
"github.com/pulumi/pulumi/pkg/v2/codegen/hcl2"
"github.com/pulumi/pulumi/pkg/v2/codegen/hcl2/syntax"
"github.com/pulumi/pulumi/pkg/v2/codegen/schema"
"github.com/pulumi/pulumi/sdk/v2/go/common/resource"
"github.com/pulumi/pulumi/sdk/v2/go/common/util/contract"
)
// A LangaugeGenerator generates code for a given Pulumi program to an io.Writer.
type LanguageGenerator func(w io.Writer, p *hcl2.Program) error
// A NameTable maps URNs to language-specific variable names.
type NameTable map[resource.URN]string
// A DiagnosticsError captures HCL2 diagnostics.
type DiagnosticsError struct {
diagnostics hcl.Diagnostics
newDiagnosticWriter func(w io.Writer, width uint, color bool) hcl.DiagnosticWriter
}
func (e *DiagnosticsError) Diagnostics() hcl.Diagnostics {
return e.diagnostics
}
// NewDiagnosticWriter returns an hcl.DiagnosticWriter that can be used to render the error's diagnostics.
func (e *DiagnosticsError) NewDiagnosticWriter(w io.Writer, width uint, color bool) hcl.DiagnosticWriter {
return e.newDiagnosticWriter(w, width, color)
}
func (e *DiagnosticsError) Error() string {
var text bytes.Buffer
err := e.NewDiagnosticWriter(&text, 0, false).WriteDiagnostics(e.diagnostics)
contract.IgnoreError(err)
return text.String()
}
func (e *DiagnosticsError) String() string {
return e.Error()
}
// GenerateLanguageDefintions generates a list of resource definitions from the given resource states.
func GenerateLanguageDefinitions(w io.Writer, loader schema.Loader, gen LanguageGenerator, states []*resource.State,
names NameTable) error {
var hcl2Text bytes.Buffer
for i, state := range states {
hcl2Def, err := GenerateHCL2Definition(loader, state, names)
if err != nil {
return err
}
pre := ""
if i > 0 {
pre = "\n"
}
_, err = fmt.Fprintf(&hcl2Text, "%s%v", pre, hcl2Def)
contract.IgnoreError(err)
}
parser := syntax.NewParser()
if err := parser.ParseFile(&hcl2Text, string("anonymous.pp")); err != nil {
return err
}
if parser.Diagnostics.HasErrors() {
// HCL2 text generation should always generate proper code.
return fmt.Errorf("internal error: %w", &DiagnosticsError{
diagnostics: parser.Diagnostics,
newDiagnosticWriter: parser.NewDiagnosticWriter,
})
}
program, diags, err := hcl2.BindProgram(parser.Files, hcl2.Loader(loader), hcl2.AllowMissingVariables)
if err != nil {
return err
}
if diags.HasErrors() {
// It is possible that the provided states do not contain appropriately-shaped inputs, so this may be user
// error.
return &DiagnosticsError{
diagnostics: diags,
newDiagnosticWriter: program.NewDiagnosticWriter,
}
}
return gen(w, program)
}