pulumi/tests/history_test.go

// Copyright 2016-2018, Pulumi Corporation.  All rights reserved.

package tests

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"os"
	"path"
	"testing"

	"github.com/stretchr/testify/assert"

	"github.com/pulumi/pulumi/pkg/backend"
	ptesting "github.com/pulumi/pulumi/pkg/testing"
	"github.com/pulumi/pulumi/pkg/testing/integration"
)

// deleteIfNotFailed deletes the files in the testing environment if the testcase has
// not failed. (Otherwise they are left to aid debugging.)
func deleteIfNotFailed(e *ptesting.Environment) {
	if !e.T.Failed() {
		e.DeleteEnvironment()
	}
}

// assertHasNoHistory runs `pulumi history` and confirms an error that the stack has not
// ever been updated.
func assertHasNoHistory(e *ptesting.Environment) {
	// NOTE: pulumi returns with exit code 0 in this scenario.
	out, err := e.RunCommand("pulumi", "history")
	assert.Equal(e.T, "", err)
	assert.Equal(e.T, "Stack has never been updated\n", out)
}

func assertEnvValue(t *testing.T, update backend.UpdateInfo, key, val string) {
	t.Helper()
	v, ok := update.Environment[key]
	if !ok {
		t.Errorf("Did not find key %q in update environment", key)
	} else {
		assert.Equal(t, val, v, "Comparing Environment values for key %q", key)
	}
}

func assertEnvKeyNotFound(t *testing.T, update backend.UpdateInfo, key string) {
	t.Helper()
	_, found := update.Environment[key]
	assert.False(t, found, "Did not expect to find key %q in update environment", key)
}

func TestHistoryCommand(t *testing.T) {
	// The --output-json flag on pulumi history is hidden behind an environment variable.
	os.Setenv("PULUMI_DEBUG_COMMANDS", "1")
	defer os.Unsetenv("PULUMI_DEBUG_COMMANDS")

	// We fail if no stack is selected.
	t.Run("NoStackSelected", func(t *testing.T) {
		e := ptesting.NewEnvironment(t)
		defer deleteIfNotFailed(e)
		integration.CreateBasicPulumiRepo(e)

		e.RunCommand("pulumi", "login", "--cloud-url", e.LocalURL())
		out, err := e.RunCommandExpectError("pulumi", "history")
		assert.Equal(t, "", out)
		assert.NotEqual(t, err, "")
	})

	// We don't display any history for a stack that has never been updated.
	t.Run("NoUpdates", func(t *testing.T) {
		e := ptesting.NewEnvironment(t)
		defer deleteIfNotFailed(e)
		integration.CreateBasicPulumiRepo(e)

		e.RunCommand("pulumi", "login", "--cloud-url", e.LocalURL())
		e.RunCommand("pulumi", "stack", "init", "no-updates-test")
		assertHasNoHistory(e)
		e.RunCommand("pulumi", "stack", "rm", "--yes")
	})

	// The "history" command uses the currently selected stack.
	t.Run("CurrentlySelectedStack", func(t *testing.T) {
		e := ptesting.NewEnvironment(t)
		defer deleteIfNotFailed(e)
		integration.CreateBasicPulumiRepo(e)
		e.ImportDirectory("integration/stack_outputs")

		e.RunCommand("pulumi", "login", "--cloud-url", e.LocalURL())
		e.RunCommand("pulumi", "stack", "init", "stack-without-updates")
		e.RunCommand("pulumi", "stack", "init", "history-test")

		// Update the history-test stack.
		e.RunCommand("yarn", "install")
		e.RunCommand("yarn", "link", "@pulumi/pulumi")
		e.RunCommand("yarn", "run", "build")
		e.RunCommand("pulumi", "update", "--force", "-m", "updating stack...")

		// Confirm we see the update message in thie history output.
		out, err := e.RunCommand("pulumi", "history")
		assert.Equal(t, "", err)
		assert.Contains(t, out, "updating stack...")

		// Change stack and confirm the history command honors the selected stack.
		e.RunCommand("pulumi", "stack", "select", "stack-without-updates")
		assertHasNoHistory(e)

		// Change stack back, and confirm still has history.
		e.RunCommand("pulumi", "stack", "select", "history-test")
		out, err = e.RunCommand("pulumi", "history")
		assert.Equal(t, "", err)
		assert.Contains(t, out, "updating stack...")
		e.RunCommand("pulumi", "stack", "rm", "--yes", "--force")
	})

	// That the history command contains accurate data about the update history.
	t.Run("Data(Deploy,Kind,Result)", func(t *testing.T) {
		e := ptesting.NewEnvironment(t)
		defer deleteIfNotFailed(e)
		integration.CreateBasicPulumiRepo(e)
		e.ImportDirectory("integration/stack_outputs")

		e.RunCommand("pulumi", "login", "--cloud-url", e.LocalURL())
		e.RunCommand("pulumi", "stack", "init", "history-test")

		// Update the history-test stack.
		e.RunCommand("yarn", "install")
		e.RunCommand("yarn", "link", "@pulumi/pulumi")
		e.RunCommand("yarn", "run", "build")
		e.RunCommand("pulumi", "update", "--force", "-m", "first update (successful)")

		// Now we "break" the program, by adding gibberish to bin/index.js.
		indexJS := path.Join(e.CWD, "bin", "index.js")
		origContents, err := ioutil.ReadFile(indexJS)
		assert.NoError(t, err, "Reading bin/index.js")

		var invalidJS bytes.Buffer
		invalidJS.Write(origContents)
		invalidJS.WriteString("\n\n... with random text -> syntax error, too")
		err = ioutil.WriteFile(indexJS, invalidJS.Bytes(), os.ModePerm)
		assert.NoError(t, err, "Writing bin/index.js")

		e.RunCommandExpectError("pulumi", "update", "--force", "-m", "second update (failure)")

		// Fix it
		err = ioutil.WriteFile(indexJS, origContents, os.ModePerm)
		assert.NoError(t, err, "Writing bin/index.js")
		e.RunCommand("pulumi", "update", "--force", "-m", "third update (successful)")

		// Destroy
		e.RunCommand("pulumi", "destroy", "--force", "-m", "fourth update (destroy)")

		// Confirm the history is as expected. Output as JSON and parse the result.
		stdout, stderr := e.RunCommand("pulumi", "history", "--output-json")
		assert.Equal(t, "", stderr)

		var updateRecords []backend.UpdateInfo
		err = json.Unmarshal([]byte(stdout), &updateRecords)
		if err != nil {
			t.Fatalf("Error marshalling `pulumi history` output as JSON: %v", err)
		}
		if len(updateRecords) != 4 {
			t.Fatalf("didn't get expected number of updates from testcase. Raw history output:\n%v", stdout)
		}

		// The most recent updates are listed first.
		update := updateRecords[0]
		assert.Equal(t, "fourth update (destroy)", update.Message)
		assert.True(t, backend.DestroyUpdate == update.Kind)
		assert.True(t, backend.SucceededResult == update.Result)

		update = updateRecords[1]
		assert.Equal(t, "third update (successful)", update.Message)
		assert.True(t, backend.DeployUpdate == update.Kind)
		assert.True(t, backend.SucceededResult == update.Result)

		update = updateRecords[2]
		assert.Equal(t, "second update (failure)", update.Message)
		assert.True(t, backend.DeployUpdate == update.Kind)
		assert.True(t, backend.FailedResult == update.Result)

		update = updateRecords[3]
		assert.Equal(t, "first update (successful)", update.Message)
		assert.True(t, backend.DeployUpdate == update.Kind)
		assert.True(t, backend.SucceededResult == update.Result)

		if t.Failed() {
			t.Logf("Test failed. Printing raw history output:\n%v", stdout)
		}

		// Call stack rm to run the "delete history file too" codepath.
		e.RunCommand("pulumi", "stack", "rm", "--yes")
	})

	// We include git-related data in the environment metadata.
	t.Run("Data(Environment[Git])", func(t *testing.T) {
		e := ptesting.NewEnvironment(t)
		defer deleteIfNotFailed(e)
		integration.CreateBasicPulumiRepo(e)
		e.ImportDirectory("integration/stack_outputs")

		e.RunCommand("pulumi", "login", "--cloud-url", e.LocalURL())
		e.RunCommand("pulumi", "stack", "init", "history-test")
		e.RunCommand("yarn", "install")
		e.RunCommand("yarn", "link", "@pulumi/pulumi")
		e.RunCommand("yarn", "run", "build")

		// Configure the git repo used for the test, so it doesn't use global defaults.
		gitUserName := "R. Sanchez"
		gitUserEmail := "rs@example.com"
		e.RunCommand("git", "config", "user.name", gitUserName)
		e.RunCommand("git", "config", "user.email", gitUserEmail)

		// Update 1, git repo that has no commits.
		e.RunCommand("pulumi", "update", "--force", "-m", "first update (git repo has no commits)")

		// Update 2, repo has commit, but no remote.
		e.RunCommand("git", "add", ".")
		update2GitCommitMessage := "First commit of test files"
		e.RunCommand("git", "commit", "-m", update2GitCommitMessage)
		e.RunCommand("pulumi", "update", "--force", "-m", "second update (git commit, no remote)")

		// Update 3, repo has remote and is dirty (by rewriting index.ts).
		indexTS := path.Join(e.CWD, "index.ts")
		origContents, err := ioutil.ReadFile(indexTS)
		assert.NoError(t, err, "Reading index.ts")

		err = ioutil.WriteFile(indexTS, []byte("change to file..."), os.ModePerm)
		assert.NoError(t, err, "writing index.ts")

		e.RunCommand("git", "remote", "add", "origin", "git@github.com:rick/c-132")
		e.RunCommand("pulumi", "update", "--force", "-m", "third update (is dirty, has remote)")

		// Update 4, replaces index.ts and adds some other random data. Since the update is after the commit,
		// the git repo should be marked as clean.
		err = ioutil.WriteFile(indexTS, origContents, os.ModePerm)
		assert.NoError(t, err, "writing index.ts")
		ioutil.WriteFile(path.Join(e.CWD, "new-file.txt"), []byte("data"), os.ModePerm)

		gitAuthorName := "B. Man"
		gitAuthorEmail := "bm@example.com"
		authorInfo := fmt.Sprintf("%s <%s>", gitAuthorName, gitAuthorEmail)
		update4GitCommitMessage := "git commit #4\nmulti-line even!"
		e.RunCommand("git", "add", ".")
		e.RunCommand("git", "commit", "-m", update4GitCommitMessage, "--author", authorInfo)
		e.RunCommand("pulumi", "update", "--force", "-m", "fourth update (is clean)")

		// Confirm the history is as expected. Output as JSON and parse the result.
		stdout, stderr := e.RunCommand("pulumi", "history", "--output-json")
		assert.Equal(t, "", stderr)

		var updateRecords []backend.UpdateInfo
		err = json.Unmarshal([]byte(stdout), &updateRecords)
		if err != nil {
			t.Fatalf("Error marshalling `pulumi history` output as JSON: %v", err)
		}
		if len(updateRecords) != 4 {
			t.Fatalf("didn't get expected number of updates from testcase. Raw history output:\n%v", stdout)
		}
		e.RunCommand("pulumi", "stack", "rm", "--yes", "--force")

		// The first update doesn't have any git information, since
		// nothing has been committed yet.
		t.Log("Checking first update...")
		update := updateRecords[3]
		assertEnvKeyNotFound(e.T, update, backend.GitHead)

		// The second update has a commit.
		t.Log("Checking second update...")
		update = updateRecords[2]
		// We don't know what the SHA will be ahead of time, since the code we use to call `pulumi init`
		// uses the current time as part of the --name flag.
		headSHA, ok := update.Environment[backend.GitHead]
		assert.True(t, ok, "Didn't find %s in environment", backend.GitHead)
		assert.Equal(t, 40, len(headSHA), "Commit SHA was not expected length")
		assertEnvValue(e.T, update, backend.GitDirty, "false")
		assertEnvValue(e.T, update, backend.GitCommitMessage, update2GitCommitMessage)
		assertEnvValue(e.T, update, backend.GitCommitter, gitUserName)
		assertEnvValue(e.T, update, backend.GitCommitterEmail, gitUserEmail)
		// Author defaults to committer if not specified.
		assertEnvValue(e.T, update, backend.GitAuthor, gitUserName)
		assertEnvValue(e.T, update, backend.GitAuthorEmail, gitUserEmail)

		// The github-related info is still not set though.
		assertEnvKeyNotFound(e.T, update, backend.GitHubLogin)
		assertEnvKeyNotFound(e.T, update, backend.GitHubRepo)

		// The third commit sets a remote (which we detect as a GitHub repo) and is now dirty.
		t.Log("Checking third update...")
		update = updateRecords[1]
		assertEnvValue(e.T, update, backend.GitHead, headSHA)
		assertEnvValue(e.T, update, backend.GitDirty, "true")
		// No git commits made since previous update, only repo dirtied. So the environment data is the same.
		assertEnvValue(e.T, update, backend.GitCommitMessage, update2GitCommitMessage)
		assertEnvValue(e.T, update, backend.GitCommitter, gitUserName)
		assertEnvValue(e.T, update, backend.GitCommitterEmail, gitUserEmail)
		assertEnvValue(e.T, update, backend.GitAuthor, gitUserName)
		assertEnvValue(e.T, update, backend.GitAuthorEmail, gitUserEmail)

		// However, a git remote was added. So it should be available now.
		assertEnvValue(e.T, update, backend.GitHubLogin, "rick")
		assertEnvValue(e.T, update, backend.GitHubRepo, "c-132")

		// The fourth commit is clean (by restoring to the previous commit).
		t.Log("Checking fourth update...")
		update = updateRecords[0]

		// Confirm the HEAD SHA has changed because of the new commit.
		newHeadSHA, newSHAOK := update.Environment[backend.GitHead]
		assert.True(t, newSHAOK, "Didn't find git.head for last update")
		assert.NotEqual(t, headSHA, newHeadSHA)

		assertEnvValue(e.T, update, backend.GitDirty, "false")
		assertEnvValue(e.T, update, backend.GitCommitMessage, update4GitCommitMessage)
		assertEnvValue(e.T, update, backend.GitCommitter, gitUserName)
		assertEnvValue(e.T, update, backend.GitCommitterEmail, gitUserEmail)
		// Author was specified for this commit, so check it is set.
		assertEnvValue(e.T, update, backend.GitAuthor, gitAuthorName)
		assertEnvValue(e.T, update, backend.GitAuthorEmail, gitAuthorEmail)

		assertEnvValue(e.T, update, backend.GitHubLogin, "rick")
		assertEnvValue(e.T, update, backend.GitHubRepo, "c-132")

		if t.Failed() {
			t.Logf("Test failed. Printing raw history output:\n%v\n", stdout)
		}
	})
}