pulumi/pkg/testing/integration/pulumi.go

76 lines
2.5 KiB
Go
Raw Normal View History

2018-05-22 21:43:36 +02:00
// 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 integration
import (
"fmt"
"io/ioutil"
2017-10-31 02:23:20 +01:00
"os"
"path"
"strings"
"github.com/pulumi/pulumi/sdk/v3/go/common/testing"
"github.com/pulumi/pulumi/sdk/v3/go/common/workspace"
"github.com/stretchr/testify/assert"
)
2017-10-31 02:23:20 +01:00
// CreateBasicPulumiRepo will initialize the environment with a basic Pulumi repository and
// project file definition. Returns the repo owner and name used.
Remove the need to `pulumi init` for the local backend This change removes the need to `pulumi init` when targeting the local backend. A fair amount of the change lays the foundation that the next set of changes to stop having `pulumi init` be used for cloud stacks as well. Previously, `pulumi init` logically did two things: 1. It created the bookkeeping directory for local stacks, this was stored in `<repository-root>/.pulumi`, where `<repository-root>` was the path to what we belived the "root" of your project was. In the case of git repositories, this was the directory that contained your `.git` folder. 2. It recorded repository information in `<repository-root>/.pulumi/repository.json`. This was used by the cloud backend when computing what project to interact with on Pulumi.com The new identity model will remove the need for (2), since we only need an owner and stack name to fully qualify a stack on pulumi.com, so it's easy enough to stop creating a folder just for that. However, for the local backend, we need to continue to retain some information about stacks (e.g. checkpoints, history, etc). In addition, we need to store our workspace settings (which today just contains the selected stack) somehere. For state stored by the local backend, we change the URL scheme from `local://` to `local://<optional-root-path>`. When `<optional-root-path>` is unset, it defaults to `$HOME`. We create our `.pulumi` folder in that directory. This is important because stack names now must be unique within the backend, but we have some tests using local stacks which use fixed stack names, so each integration test really wants its own "view" of the world. For the workspace settings, we introduce a new `workspaces` directory in `~/.pulumi`. In this folder we write the workspace settings file for each project. The file name is the name of the project, combined with the SHA1 of the path of the project file on disk, to ensure that multiple pulumi programs with the same project name have different workspace settings. This does mean that moving a project's location on disk will cause the CLI to "forget" what the selected stack was, which is unfortunate, but not the end of the world. If this ends up being a big pain point, we can certianly try to play games in the future (for example, if we saw a .git folder in a parent folder, we could store data in there). With respect to compatibility, we don't attempt to migrate older files to their newer locations. For long lived stacks managed using the local backend, we can provide information on where to move things to. For all stacks (regardless of backend) we'll require the user to `pulumi stack select` their stack again, but that seems like the correct trade-off vs writing complicated upgrade code.
2018-04-17 01:15:10 +02:00
func CreateBasicPulumiRepo(e *testing.Environment) {
2017-10-31 02:23:20 +01:00
e.RunCommand("git", "init")
contents := "name: pulumi-test\ndescription: a test\nruntime: nodejs\n"
filePath := fmt.Sprintf("%s.yaml", workspace.ProjectFile)
filePath = path.Join(e.CWD, filePath)
err := ioutil.WriteFile(filePath, []byte(contents), os.ModePerm)
assert.NoError(e, err, "writing %s file", filePath)
}
// GetStacks returns the list of stacks and current stack by scraping `pulumi stack ls`.
// Assumes .pulumi is in the current working directory. Fails the test on IO errors.
func GetStacks(e *testing.Environment) ([]string, *string) {
out, err := e.RunCommand("pulumi", "stack", "ls")
outLines := strings.Split(out, "\n")
if len(outLines) == 0 {
e.Fatalf("command didn't output as expected")
}
2017-12-03 14:38:31 +01:00
// Confirm header row matches.
// TODO(pulumi/pulumi/issues/496): Provide structured output for pulumi commands. e.g., so we can avoid this
// err-prone scraping with just deserializings a JSON object.
assert.True(e, strings.HasPrefix(outLines[0], "NAME"), "First line was: %q\n--\n%q\n--\n%q\n", outLines[0], out, err)
2017-12-03 14:38:31 +01:00
var stackNames []string
var currentStack *string
stackSummaries := outLines[1:]
for _, summary := range stackSummaries {
if summary == "" {
break
}
firstSpace := strings.Index(summary, " ")
if firstSpace != -1 {
stackName := strings.TrimSpace(summary[:firstSpace])
if strings.HasSuffix(stackName, "*") {
currentStack = &stackName
stackName = strings.TrimSuffix(stackName, "*")
}
stackNames = append(stackNames, stackName)
}
}
return stackNames, currentStack
}