get.porter.sh/porter@v1.3.0/tests/integration/install_test.go

//go:build integration

package integration

import (
	"os"
	"path/filepath"
	"testing"

	"get.porter.sh/porter/pkg"
	"get.porter.sh/porter/pkg/porter"
	"get.porter.sh/porter/pkg/secrets"
	"get.porter.sh/porter/pkg/storage"
	"github.com/cnabio/cnab-go/secrets/host"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func TestInstall_relativePathPorterHome(t *testing.T) {
	t.Parallel()

	p := porter.NewTestPorter(t)
	defer p.Close()
	ctx := p.SetupIntegrationTest() // This creates a temp porter home directory

	// Crux for this test: change Porter's home dir to a relative path
	homeDir, err := p.Config.GetHomeDir()
	require.NoError(t, err)
	relDir, err := filepath.Rel(p.Getwd(), homeDir)
	require.NoError(t, err)
	p.SetHomeDir(relDir)

	// Bring in a porter manifest that has an install action defined
	p.AddTestBundleDir("testdata/bundles/bundle-with-custom-action", true)

	installOpts := porter.NewInstallOptions()
	err = installOpts.Validate(ctx, []string{}, p.Porter)
	require.NoError(t, err)

	// Install the bundle, assert no error occurs due to Porter home as relative path
	err = p.InstallBundle(ctx, installOpts)
	require.NoError(t, err)
}

func TestInstall_fileParam(t *testing.T) {
	t.Parallel()

	p := porter.NewTestPorter(t)
	defer p.Close()
	ctx := p.SetupIntegrationTest()

	bundleName := p.AddTestBundleDir("testdata/bundles/bundle-with-file-params", false)

	installOpts := porter.NewInstallOptions()
	installOpts.Params = []string{"myfile=./myfile"}
	installOpts.ParameterSets = []string{"myparam"}
	testParamSets := storage.NewParameterSet("", "myparam", secrets.SourceMap{
		Name: "myotherfile",
		Source: secrets.Source{
			Strategy: host.SourcePath,
			Hint:     "./myotherfile",
		},
	},
		secrets.SourceMap{
			Name: "yetanotherfile",
			Source: secrets.Source{
				Strategy: host.SourceEnv,
				Hint:     "YET_ANOTHER_FILE_PATH",
			},
		})

	os.Setenv("YET_ANOTHER_FILE_PATH", "./myfile")
	defer os.Unsetenv("YET_ANOTHER_FILE_PATH")

	p.TestParameters.InsertParameterSet(ctx, testParamSets)

	err := installOpts.Validate(ctx, []string{}, p.Porter)
	require.NoError(t, err)

	err = p.InstallBundle(ctx, installOpts)
	require.NoError(t, err)

	output := p.TestConfig.TestContext.GetOutput()
	require.Contains(t, output, "Hello World!", "expected action output to contain provided file contents")

	outputs, err := p.Installations.GetLastOutputs(ctx, "", bundleName)
	require.NoError(t, err, "GetLastOutput failed")
	myfile, ok := outputs.GetByName("myfile")
	require.True(t, ok, "expected myfile output to be persisted")
	assert.Equal(t, "Hello World!", string(myfile.Value), "expected output to match the decoded file contents")
	myotherfile, ok := outputs.GetByName("myotherfile")
	require.True(t, ok, "expected myotherfile output to be persisted")
	assert.Equal(t, "Hello Other World!", string(myotherfile.Value), "expected output 'myotherfile' to match the decoded file contents")
	yetanotherfile, ok := outputs.GetByName("yetanotherfile")
	require.True(t, ok, "expected yetanotherfile output to be persisted")
	assert.Equal(t, "Hello World!", string(yetanotherfile.Value), "expected output 'yetanotherfile' to match the decoded file contents")
}

func TestInstall_withDockerignore(t *testing.T) {
	t.Parallel()

	p := porter.NewTestPorter(t)
	defer p.Close()
	ctx := p.SetupIntegrationTest()

	p.AddTestBundleDir("testdata/bundles/outputs-example", true)

	// Create .dockerignore file which ignores the helpers script
	err := p.FileSystem.WriteFile(".dockerignore", []byte("helpers.sh"), pkg.FileModeWritable)
	require.NoError(t, err)

	opts := porter.NewInstallOptions()
	err = opts.Validate(ctx, []string{}, p.Porter)
	require.NoError(t, err)

	// Verify Porter uses the .dockerignore file (no helpers script added to installer image)
	err = p.InstallBundle(ctx, opts)
	// The following line would be seen from the daemon, but is printed directly to stdout:
	// Error: couldn't run command ./helpers.sh dump-config: fork/exec ./helpers.sh: no such file or directory
	// We should check this once https://github.com/cnabio/cnab-go/issues/78 is closed
	require.EqualError(t, err, "1 error occurred:\n\t* container exit code: 1, message: <nil>\n\n")
}

func TestInstall_stringParam(t *testing.T) {

	p := porter.NewTestPorter(t)
	defer p.Close()
	ctx := p.SetupIntegrationTest()

	p.AddTestBundleDir("testdata/bundles/bundle-with-string-params", false)

	installOpts := porter.NewInstallOptions()
	installOpts.Params = []string{"name=Demo Time"}

	err := installOpts.Validate(ctx, []string{}, p.Porter)
	require.NoError(t, err)

	err = p.InstallBundle(ctx, installOpts)
	require.NoError(t, err)

	output := p.TestConfig.TestContext.GetOutput()
	require.Contains(t, output, "Hello, Demo Time", "expected action output to contain provided file contents")
}

func TestInstall_overrideParamIncludedInParamSet(t *testing.T) {

	p := porter.NewTestPorter(t)
	defer p.Close()
	ctx := p.SetupIntegrationTest()

	p.AddTestBundleDir("testdata/bundles/bundle-with-string-params", false)

	installOpts := porter.NewInstallOptions()
	installOpts.Params = []string{"name=Demo Time"}
	installOpts.ParameterSets = []string{"myparam"}
	testParamSets := storage.NewParameterSet("", "myparam", secrets.SourceMap{
		Name: "name",
		Source: secrets.Source{
			Strategy: host.SourceEnv,
			Hint:     "DEMO_TIME",
		},
	})
	p.TestParameters.InsertParameterSet(ctx, testParamSets)

	err := installOpts.Validate(ctx, []string{}, p.Porter)
	require.NoError(t, err)

	err = p.InstallBundle(ctx, installOpts)
	require.NoError(t, err)

	output := p.TestConfig.TestContext.GetOutput()
	require.Contains(t, output, "Hello, Demo Time", "expected action output to contain provided file contents")
}

func TestInstall_SensitiveValuesAreNotLogged(t *testing.T) {
	p := porter.NewTestPorter(t)
	defer p.Close()
	ctx := p.SetupIntegrationTest()

	p.AddTestBundleDir("testdata/bundles/failing-bundle-with-sensitive-data", false)

	installOpts := porter.NewInstallOptions()
	installOpts.Params = []string{"password=topsecret"}

	err := installOpts.Validate(ctx, []string{}, p.Porter)
	require.NoError(t, err)

	err = p.InstallBundle(ctx, installOpts)
	require.Error(t, err)

	output := p.TestConfig.TestContext.GetOutput()
	require.NotContains(t, output, "topsecret", "expected sensitive data to not be logged")
	require.Contains(t, output, "*******")
}