maxmustermann/pulumi
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Decorate the AST with contextual info

Browse source 
This change decorates the AST with some information that is only known
after parsing.  This enables subsequent logic to remain context-free.
This commit is contained in:
joeduffy 2016-11-16 11:51:50 -08:00
parent 85a828fdf9
commit 917342f76f
2 changed files with 30 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
pkg/ast/types.go
View file

@ -28,12 +28,15 @@ type Node struct {
// Metadata contains human-readable metadata common to Mu's packaging formats (like Stacks and Clusters).
type Metadata struct {
Node
Name Name `json:"name,omitempty"`
Version SemVer `json:"version,omitempty"`
Description string `json:"description,omitempty"`
Author string `json:"author,omitempty"`
Website string `json:"website,omitempty"`
License string `json:"license,omitempty"`
Kind string `json:"-"` // kind is decorated post-parsing, since it is contextual.
Name Name `json:"name,omitempty"` // a friendly name for this node.
Version SemVer `json:"version,omitempty"` // a specific semantic version.
Description string `json:"description,omitempty"` // an optional friendly description.
Author string `json:"author,omitempty"` // an optional author.
Website string `json:"website,omitempty"` // an optional website for additional info.
License string `json:"license,omitempty"` // an optional license governing legal uses of this package.
}
// Stack represents a collection of private and public cloud resources, a method for constructing them, and optional
@ -52,10 +55,13 @@ type Parameters map[string]*Parameter
// Parameter describes the requirements of arguments used when constructing Stacks, etc.
type Parameter struct {
Node
Description string `json:"description,omitempty"`
Type Name `json:"type,omitempty"`
Default interface{} `json:"default,omitempty"`
Optional bool `json:"optional,omitempty"`
Name string `json:"-"` // name is decorated post-parsing, since it is contextual.
Type Name `json:"type,omitempty"` // the type of the parameter; required.
Description string `json:"description,omitempty"` // an optional friendly description of the parameter.
Default interface{} `json:"default,omitempty"` // an optional default value if the caller doesn't pass one.
Optional bool `json:"optional,omitempty"` // true if may be omitted (inferred if a default value).
}
// Services maps service names to metadata about those services.
@ -64,8 +70,12 @@ type Services map[string]*Service
// Service is a directive for instantiating another Stack, including its name, arguments, etc.
type Service struct {
Node
Type Name `json:"type,omitempty"`
// TODO: Service metadata is highly extensible. It's not yet clear how best to represent this.
Name string `json:"-"` // a friendly name; decorated post-parsing, since it is contextual.
Public bool `json:"-"` // true if this service is publicly exposed; also decorated post-parsing.
Type Name `json:"type,omitempty"` // an explicit type; if missing, the name is used.
// TODO: Service metadata is highly type-dependent. It's not yet clear how best to represent this in the schema.
}
// Dependencies maps dependency names to the semantic version the consumer depends on.

8
pkg/compiler/parsetree.go
View file

@ -47,6 +47,9 @@ func (a *ptAnalyzer) Analyze(doc *diag.Document, stack *ast.Stack) {
}
func (a *ptAnalyzer) VisitMetadata(doc *diag.Document, kind string, meta *ast.Metadata) {
// Decorate the AST with contextual information so subsequent passes can operate context-free.
meta.Kind = kind
// Metadata names are required.
if meta.Name == "" {
a.Diag().Errorf(errors.MissingMetadataName.WithDocument(doc), kind)
@ -66,9 +69,14 @@ func (a *ptAnalyzer) VisitStack(doc *diag.Document, stack *ast.Stack) {
}
func (a *ptAnalyzer) VisitParameter(doc *diag.Document, name string, param *ast.Parameter) {
// Decorate the AST with contextual information so subsequent passes can operate context-free.
param.Name = name
}
func (a *ptAnalyzer) VisitService(doc *diag.Document, name string, public bool, svc *ast.Service) {
// Decorate the AST with contextual information so subsequent passes can operate context-free.
svc.Name = name
svc.Public = public
}
func (a *ptAnalyzer) VisitDependency(doc *diag.Document, name string, dep *ast.Dependency) {