9aedb234af
In preparation for some workspace restructuring, I decided to scratch a few itches of my own in the code: * Change project's RuntimeInfo field to just Runtime, to match the serialized name in JSON/YAML. * Eliminate the no-longer-used Context and NoDefaultIgnores fields on project, and all of the associated legacy PPC-related code. * Eliminate the no-longer-used IgnoreFile constant. * Remove a bunch of "// nolint: lll" annotations, and simply format the structures with comments on dedicated lines, to avoid overly lengthy lines and lint suppressions. * Mark Dependencies and InitErrors as `omitempty` in the JSON serialization directives for CheckpointV2 files. This was done for the YAML directives, but (presumably accidentally) omitted for JSON.
303 lines
8.7 KiB
Go
303 lines
8.7 KiB
Go
// Copyright 2016-2018, 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 workspace
|
|
|
|
import (
|
|
"encoding/json"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/pulumi/pulumi/pkg/resource/config"
|
|
"github.com/pulumi/pulumi/pkg/util/contract"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/pulumi/pulumi/pkg/encoding"
|
|
"github.com/pulumi/pulumi/pkg/tokens"
|
|
)
|
|
|
|
// Analyzers is a list of analyzers to run on this project.
|
|
type Analyzers []tokens.QName
|
|
|
|
// ProjectTemplate is a Pulumi project template manifest.
|
|
type ProjectTemplate struct {
|
|
// Description is an optional description of the template.
|
|
Description string `json:"description,omitempty" yaml:"description,omitempty"`
|
|
// Quickstart contains optional text to be displayed after template creation.
|
|
Quickstart string `json:"quickstart,omitempty" yaml:"quickstart,omitempty"`
|
|
// Config is an optional template config.
|
|
Config map[string]ProjectTemplateConfigValue `json:"config,omitempty" yaml:"config,omitempty"`
|
|
}
|
|
|
|
// ProjectTemplateConfigValue is a config value included in the project template manifest.
|
|
type ProjectTemplateConfigValue struct {
|
|
// Description is an optional description for the config value.
|
|
Description string `json:"description,omitempty" yaml:"description,omitempty"`
|
|
// Default is an optional default value for the config value.
|
|
Default string `json:"default,omitempty" yaml:"default,omitempty"`
|
|
// Secret may be set to true to indicate that the config value should be encrypted.
|
|
Secret bool `json:"secret,omitempty" yaml:"secret,omitempty"`
|
|
}
|
|
|
|
// Project is a Pulumi project manifest.
|
|
//
|
|
// We explicitly add yaml tags (instead of using the default behavior from https://github.com/ghodss/yaml which works
|
|
// in terms of the JSON tags) so we can directly marshall and unmarshall this struct using go-yaml an have the fields
|
|
// in the serialized object match the order they are defined in this struct.
|
|
//
|
|
// TODO[pulumi/pulumi#423]: use DOM based marshalling so we can roundtrip the seralized structure perfectly.
|
|
type Project struct {
|
|
// Name is a required fully qualified name.
|
|
Name tokens.PackageName `json:"name" yaml:"name"`
|
|
// Runtime is a required runtime that executes code.
|
|
Runtime ProjectRuntimeInfo `json:"runtime" yaml:"runtime"`
|
|
// Main is an optional override for the program's main entry-point location.
|
|
Main string `json:"main,omitempty" yaml:"main,omitempty"`
|
|
|
|
// Description is an optional informational description.
|
|
Description *string `json:"description,omitempty" yaml:"description,omitempty"`
|
|
// Author is an optional author that created this project.
|
|
Author *string `json:"author,omitempty" yaml:"author,omitempty"`
|
|
// Website is an optional website for additional info about this project.
|
|
Website *string `json:"website,omitempty" yaml:"website,omitempty"`
|
|
// License is the optional license governing this project's usage.
|
|
License *string `json:"license,omitempty" yaml:"license,omitempty"`
|
|
|
|
// Analyzers is an optional list of analyzers that are enabled for this project.
|
|
Analyzers *Analyzers `json:"analyzers,omitempty" yaml:"analyzers,omitempty"`
|
|
|
|
// Config indicates where to store the Pulumi.<stack-name>.yaml files, combined with the folder Pulumi.yaml is in.
|
|
Config string `json:"config,omitempty" yaml:"config,omitempty"`
|
|
|
|
// Template is an optional template manifest, if this project is a template.
|
|
Template *ProjectTemplate `json:"template,omitempty" yaml:"template,omitempty"`
|
|
}
|
|
|
|
func (proj *Project) Validate() error {
|
|
if proj.Name == "" {
|
|
return errors.New("project is missing a 'name' attribute")
|
|
}
|
|
if proj.Runtime.Name() == "" {
|
|
return errors.New("project is missing a 'runtime' attribute")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// TrustResourceDependencies returns whether or not this project's runtime can be trusted to accurately report
|
|
// dependencies. Not all languages supported by Pulumi do this correctly.
|
|
func (proj *Project) TrustResourceDependencies() bool {
|
|
return proj.Runtime.Name() != "python"
|
|
}
|
|
|
|
// Save writes a project definition to a file.
|
|
func (proj *Project) Save(path string) error {
|
|
contract.Require(path != "", "path")
|
|
contract.Require(proj != nil, "proj")
|
|
contract.Requiref(proj.Validate() == nil, "proj", "Validate()")
|
|
|
|
m, err := marshallerForPath(path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
b, err := m.Marshal(proj)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return ioutil.WriteFile(path, b, 0644)
|
|
}
|
|
|
|
// ProjectStack holds stack specific information about a project.
|
|
type ProjectStack struct {
|
|
// EncryptionSalt is this stack's base64 encoded encryption salt.
|
|
EncryptionSalt string `json:"encryptionsalt,omitempty" yaml:"encryptionsalt,omitempty"`
|
|
// Config is an optional config bag.
|
|
Config config.Map `json:"config,omitempty" yaml:"config,omitempty"`
|
|
}
|
|
|
|
// Save writes a project definition to a file.
|
|
func (ps *ProjectStack) Save(path string) error {
|
|
contract.Require(path != "", "path")
|
|
contract.Require(ps != nil, "ps")
|
|
|
|
m, err := marshallerForPath(path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
b, err := m.Marshal(ps)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// nolint: gas, gas prefers 0700 for a directory, but 0755 (so group and world can read it) is what we prefer
|
|
if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil {
|
|
return err
|
|
}
|
|
|
|
return ioutil.WriteFile(path, b, 0644)
|
|
}
|
|
|
|
type ProjectRuntimeInfo struct {
|
|
name string
|
|
options map[string]interface{}
|
|
}
|
|
|
|
func NewProjectRuntimeInfo(name string, options map[string]interface{}) ProjectRuntimeInfo {
|
|
return ProjectRuntimeInfo{
|
|
name: name,
|
|
options: options,
|
|
}
|
|
}
|
|
|
|
func (info *ProjectRuntimeInfo) Name() string {
|
|
return info.name
|
|
}
|
|
|
|
func (info *ProjectRuntimeInfo) Options() map[string]interface{} {
|
|
return info.options
|
|
}
|
|
|
|
func (info ProjectRuntimeInfo) MarshalYAML() (interface{}, error) {
|
|
if info.options == nil || len(info.options) == 0 {
|
|
return info.name, nil
|
|
}
|
|
|
|
return map[string]interface{}{
|
|
"name": info.name,
|
|
"options": info.options,
|
|
}, nil
|
|
}
|
|
|
|
func (info ProjectRuntimeInfo) MarshalJSON() ([]byte, error) {
|
|
if info.options == nil || len(info.options) == 0 {
|
|
return json.Marshal(info.name)
|
|
}
|
|
|
|
return json.Marshal(map[string]interface{}{
|
|
"name": info.name,
|
|
"options": info.options,
|
|
})
|
|
}
|
|
|
|
func (info *ProjectRuntimeInfo) UnmarshalJSON(data []byte) error {
|
|
if err := json.Unmarshal(data, &info.name); err == nil {
|
|
return nil
|
|
}
|
|
|
|
var payload struct {
|
|
Name string `json:"name"`
|
|
Options map[string]interface{} `json:"options"`
|
|
}
|
|
|
|
if err := json.Unmarshal(data, &payload); err == nil {
|
|
info.name = payload.Name
|
|
info.options = payload.Options
|
|
return nil
|
|
}
|
|
|
|
return errors.New("runtime section must be a string or an object with name and options attributes")
|
|
}
|
|
|
|
func (info *ProjectRuntimeInfo) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
|
if err := unmarshal(&info.name); err == nil {
|
|
return nil
|
|
}
|
|
|
|
var payload struct {
|
|
Name string `yaml:"name"`
|
|
Options map[string]interface{} `yaml:"options"`
|
|
}
|
|
|
|
if err := unmarshal(&payload); err == nil {
|
|
info.name = payload.Name
|
|
info.options = payload.Options
|
|
return nil
|
|
}
|
|
|
|
return errors.New("runtime section must be a string or an object with name and options attributes")
|
|
}
|
|
|
|
// LoadProject reads a project definition from a file.
|
|
func LoadProject(path string) (*Project, error) {
|
|
contract.Require(path != "", "path")
|
|
|
|
m, err := marshallerForPath(path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
b, err := ioutil.ReadFile(path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var proj Project
|
|
err = m.Unmarshal(b, &proj)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
err = proj.Validate()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &proj, err
|
|
}
|
|
|
|
// LoadProjectStack reads a stack definition from a file.
|
|
func LoadProjectStack(path string) (*ProjectStack, error) {
|
|
contract.Require(path != "", "path")
|
|
|
|
m, err := marshallerForPath(path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
b, err := ioutil.ReadFile(path)
|
|
if os.IsNotExist(err) {
|
|
return &ProjectStack{
|
|
Config: make(config.Map),
|
|
}, nil
|
|
} else if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var ps ProjectStack
|
|
err = m.Unmarshal(b, &ps)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if ps.Config == nil {
|
|
ps.Config = make(config.Map)
|
|
}
|
|
|
|
return &ps, err
|
|
}
|
|
|
|
func marshallerForPath(path string) (encoding.Marshaler, error) {
|
|
ext := filepath.Ext(path)
|
|
m, has := encoding.Marshalers[ext]
|
|
if !has {
|
|
return nil, errors.Errorf("no marshaler found for file format '%v'", ext)
|
|
}
|
|
|
|
return m, nil
|
|
}
|