12e5e46c73
The logic for validating prompted values in 'new' wasn't quite right, leading to the possibility of creating Pulumi.yaml files with blank project names. This manifests in various ways and I've hit it a number of times over the past few months because of the way we handle project/stack name conflicts in 'new' -- which itself is a bit annoying too: https://github.com/pulumi/pulumi/blob/master/pkg/cmd/pulumi/new.go#L206-L207 Because we substitue a default value of "", and because the prompting logic assumed default values are always valid, we would skip validation and therefore accept a blank Pulumi.yaml file. This generates an invalid project which causes errors elsewhere, such as error: failed to load Pulumi project located at ".../Pulumi.yaml": project is missing a 'name' attribute I hit this all the time with our getting started guide because I've gone through it so many times and have leftover stacks from prior run-throughs. I wouldn't be surprised if a lot of people hit this. The solution here validates all values, including the default. Note also that we failed to validate the value used by 'new --yes' which meant you could bypass all validation by passing --yes, leading to similar outcomes. I've added a couple new tests for these cases. There is a risk we depend on illegal default values somewhere which will now be rejected, but that would seem strange, and assuming the tests pass, I would assume that's not true. Let me know if that's wrong. Fixes pulumi/pulumi#3255.
304 lines
8.8 KiB
Go
304 lines
8.8 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 (
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestGetValidDefaultProjectName(t *testing.T) {
|
|
// Valid names remain the same.
|
|
for _, name := range getValidProjectNamePrefixes() {
|
|
assert.Equal(t, name, getValidProjectName(name))
|
|
}
|
|
assert.Equal(t, "foo", getValidProjectName("foo"))
|
|
assert.Equal(t, "foo1", getValidProjectName("foo1"))
|
|
assert.Equal(t, "foo-", getValidProjectName("foo-"))
|
|
assert.Equal(t, "foo-bar", getValidProjectName("foo-bar"))
|
|
assert.Equal(t, "foo_", getValidProjectName("foo_"))
|
|
assert.Equal(t, "foo_bar", getValidProjectName("foo_bar"))
|
|
assert.Equal(t, "foo.", getValidProjectName("foo."))
|
|
assert.Equal(t, "foo.bar", getValidProjectName("foo.bar"))
|
|
|
|
// Invalid characters are left off.
|
|
assert.Equal(t, "foo", getValidProjectName("!foo"))
|
|
assert.Equal(t, "foo", getValidProjectName("@foo"))
|
|
assert.Equal(t, "foo", getValidProjectName("#foo"))
|
|
assert.Equal(t, "foo", getValidProjectName("$foo"))
|
|
assert.Equal(t, "foo", getValidProjectName("%foo"))
|
|
assert.Equal(t, "foo", getValidProjectName("^foo"))
|
|
assert.Equal(t, "foo", getValidProjectName("&foo"))
|
|
assert.Equal(t, "foo", getValidProjectName("*foo"))
|
|
assert.Equal(t, "foo", getValidProjectName("(foo"))
|
|
assert.Equal(t, "foo", getValidProjectName(")foo"))
|
|
|
|
// Invalid names are replaced with a fallback name.
|
|
assert.Equal(t, "project", getValidProjectName("!"))
|
|
assert.Equal(t, "project", getValidProjectName("@"))
|
|
assert.Equal(t, "project", getValidProjectName("#"))
|
|
assert.Equal(t, "project", getValidProjectName("$"))
|
|
assert.Equal(t, "project", getValidProjectName("%"))
|
|
assert.Equal(t, "project", getValidProjectName("^"))
|
|
assert.Equal(t, "project", getValidProjectName("&"))
|
|
assert.Equal(t, "project", getValidProjectName("*"))
|
|
assert.Equal(t, "project", getValidProjectName("("))
|
|
assert.Equal(t, "project", getValidProjectName(")"))
|
|
assert.Equal(t, "project", getValidProjectName("!@#$%^&*()"))
|
|
}
|
|
|
|
func getValidProjectNamePrefixes() []string {
|
|
var results []string
|
|
for ch := 'A'; ch <= 'Z'; ch++ {
|
|
results = append(results, string(ch))
|
|
}
|
|
for ch := 'a'; ch <= 'z'; ch++ {
|
|
results = append(results, string(ch))
|
|
}
|
|
results = append(results, "_")
|
|
results = append(results, ".")
|
|
return results
|
|
}
|
|
|
|
func TestRetrieveNonExistingTemplate(t *testing.T) {
|
|
tests := []struct {
|
|
testName string
|
|
templateKind TemplateKind
|
|
}{
|
|
{
|
|
testName: "TemplateKindPulumiProject",
|
|
templateKind: TemplateKindPulumiProject,
|
|
},
|
|
{
|
|
testName: "TemplateKindPolicyPack",
|
|
templateKind: TemplateKindPolicyPack,
|
|
},
|
|
}
|
|
|
|
templateName := "not-the-template-that-exists-in-pulumi-repo-nor-on-disk"
|
|
for _, tt := range tests {
|
|
t.Run(tt.testName, func(t *testing.T) {
|
|
_, err := RetrieveTemplates(templateName, false, tt.templateKind)
|
|
assert.NotNil(t, err)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRetrieveStandardTemplate(t *testing.T) {
|
|
tests := []struct {
|
|
testName string
|
|
templateKind TemplateKind
|
|
templateName string
|
|
}{
|
|
{
|
|
testName: "TemplateKindPulumiProject",
|
|
templateKind: TemplateKindPulumiProject,
|
|
templateName: "typescript",
|
|
},
|
|
{
|
|
testName: "TemplateKindPolicyPack",
|
|
templateKind: TemplateKindPolicyPack,
|
|
templateName: "aws-typescript",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.testName, func(t *testing.T) {
|
|
repository, err := RetrieveTemplates(tt.templateName, false, tt.templateKind)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, false, repository.ShouldDelete)
|
|
|
|
// Root should point to Pulumi templates directory
|
|
// (e.g. ~/.pulumi/templates or ~/.pulumi/templates-policy)
|
|
templateDir, _ := GetTemplateDir(tt.templateKind)
|
|
assert.Equal(t, templateDir, repository.Root)
|
|
|
|
// SubDirectory should be a direct subfolder of Root with the name of the template
|
|
expectedPath := filepath.Join(repository.Root, tt.templateName)
|
|
assert.Equal(t, expectedPath, repository.SubDirectory)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRetrieveHttpsTemplate(t *testing.T) {
|
|
tests := []struct {
|
|
testName string
|
|
templateKind TemplateKind
|
|
templateURL string
|
|
yamlFile string
|
|
expectedSubPath []string
|
|
}{
|
|
{
|
|
testName: "TemplateKindPulumiProject",
|
|
templateKind: TemplateKindPulumiProject,
|
|
templateURL: "https://github.com/pulumi/pulumi-aws/tree/master/examples/minimal",
|
|
yamlFile: "Pulumi.yaml",
|
|
expectedSubPath: []string{"examples", "minimal"},
|
|
},
|
|
{
|
|
testName: "TemplateKindPolicyPack",
|
|
templateKind: TemplateKindPolicyPack,
|
|
templateURL: "https://github.com/pulumi/examples/tree/master/policy-packs/aws-ts-advanced",
|
|
yamlFile: "PulumiPolicy.yaml",
|
|
expectedSubPath: []string{"policy-packs", "aws-ts-advanced"},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.testName, func(t *testing.T) {
|
|
repository, err := RetrieveTemplates(tt.templateURL, false, tt.templateKind)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, true, repository.ShouldDelete)
|
|
|
|
// Root should point to a subfolder of a Temp Dir
|
|
tempDir := os.TempDir()
|
|
pattern := filepath.Join(tempDir, "*")
|
|
matched, _ := filepath.Match(pattern, repository.Root)
|
|
assert.True(t, matched)
|
|
|
|
// SubDirectory follows the path of the template in the Git repo
|
|
pathElements := append([]string{repository.Root}, tt.expectedSubPath...)
|
|
expectedPath := filepath.Join(pathElements...)
|
|
assert.Equal(t, expectedPath, repository.SubDirectory)
|
|
|
|
// SubDirectory should exist and contain the template files
|
|
yamlPath := filepath.Join(repository.SubDirectory, tt.yamlFile)
|
|
_, err = os.Stat(yamlPath)
|
|
assert.Nil(t, err)
|
|
|
|
// Clean Up
|
|
err = repository.Delete()
|
|
assert.Nil(t, err)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRetrieveHttpsTemplateOffline(t *testing.T) {
|
|
tests := []struct {
|
|
testName string
|
|
templateKind TemplateKind
|
|
templateURL string
|
|
}{
|
|
{
|
|
testName: "TemplateKindPulumiProject",
|
|
templateKind: TemplateKindPulumiProject,
|
|
templateURL: "https://github.com/pulumi/pulumi-aws/tree/master/examples/minimal",
|
|
},
|
|
{
|
|
testName: "TemplateKindPolicyPack",
|
|
templateKind: TemplateKindPolicyPack,
|
|
templateURL: "https://github.com/pulumi/examples/tree/master/policy-packs/aws-ts-advanced",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.testName, func(t *testing.T) {
|
|
_, err := RetrieveTemplates(tt.templateURL, true, tt.templateKind)
|
|
assert.NotNil(t, err)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRetrieveFileTemplate(t *testing.T) {
|
|
tests := []struct {
|
|
testName string
|
|
templateKind TemplateKind
|
|
}{
|
|
{
|
|
testName: "TemplateKindPulumiProject",
|
|
templateKind: TemplateKindPulumiProject,
|
|
},
|
|
{
|
|
testName: "TemplateKindPolicyPack",
|
|
templateKind: TemplateKindPolicyPack,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.testName, func(t *testing.T) {
|
|
repository, err := RetrieveTemplates(".", false, tt.templateKind)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, false, repository.ShouldDelete)
|
|
|
|
// Both Root and SubDirectory just point to the (existing) specified folder
|
|
assert.Equal(t, ".", repository.Root)
|
|
assert.Equal(t, ".", repository.SubDirectory)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestProjectNames(t *testing.T) {
|
|
tests := []struct {
|
|
testName string
|
|
projectName string
|
|
expectError bool
|
|
}{
|
|
{
|
|
testName: "Correct Project Name",
|
|
projectName: "SampleProject",
|
|
expectError: false,
|
|
},
|
|
{
|
|
testName: "Project Name with unsupported punctuation",
|
|
projectName: "SampleProject!",
|
|
expectError: true,
|
|
},
|
|
{
|
|
testName: "Project Name starting with the word Pulumi",
|
|
projectName: "PulumiProject",
|
|
expectError: false,
|
|
},
|
|
{
|
|
testName: "Project Name greater than 100 characters",
|
|
projectName: "cZClTe6xrjgKzH5QS8rFEPqYK1z4bbMeMr6n89n87djq9emSAlznQXXkkCEpBBCaZAFNlCvbfqVcqoifYlfPl11hvekIDjXVIY7m1",
|
|
expectError: true,
|
|
},
|
|
{
|
|
testName: "Project Name is Pulumi",
|
|
projectName: "Pulumi",
|
|
expectError: true,
|
|
},
|
|
{
|
|
testName: "Project Name is Pulumi - mixed case",
|
|
projectName: "pUlumI",
|
|
expectError: true,
|
|
},
|
|
{
|
|
testName: "Project Name is Pulumi.Test",
|
|
projectName: "Pulumi.Test",
|
|
expectError: true,
|
|
},
|
|
{
|
|
testName: "Empty Project Name",
|
|
projectName: "",
|
|
expectError: true,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.testName, func(t *testing.T) {
|
|
err := ValidateProjectName(tt.projectName)
|
|
if tt.expectError {
|
|
assert.Error(t, err)
|
|
} else {
|
|
assert.Nil(t, err)
|
|
}
|
|
})
|
|
}
|
|
}
|