client/test/e2e/plugins_test.go

// Copyright 2019 The Knative Authors

// 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 im
// See the License for the specific language governing permissions and
// limitations under the License.

// +build e2e

package e2e

import (
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"testing"

	"gotest.tools/assert"
	"knative.dev/client/pkg/util"
)

const (
	TestPluginCode string = `#!/bin/bash

echo "Hello Knative, I'm a Kn plugin"
echo "  My plugin file is $0"
echo "  I received arguments: $1 $2 $3 $4"`

	KnConfigDefault string = `plugins-dir: %s
lookup-plugins: %s`

	FileModeReadable   = 0644
	FileModeReadWrite  = 0666
	FileModeExecutable = 0777
)

func TestPluginWorkflow(t *testing.T) {
	var (
		knConfigDir, knPluginsDir, knPluginsDir2  string
		knConfigPath, knPluginPath, knPluginPath2 string
		lookupPlugins                             bool
		err                                       error
	)

	t.Parallel()
	test := NewE2eTest(t)
	setup := func(t *testing.T) {
		test.createNamespaceOnSetup = false
		test.Setup(t)
		defer test.Teardown(t)

		knConfigDir, err = ioutil.TempDir("", "kn-config")
		assert.NilError(t, err)

		knPluginsDir = filepath.Join(knConfigDir, "plugins")
		err = os.MkdirAll(knPluginsDir, FileModeExecutable)
		assert.NilError(t, err)

		knPluginsDir2 = filepath.Join(knConfigDir, "plugins2")
		err = os.MkdirAll(knPluginsDir2, FileModeExecutable)
		assert.NilError(t, err)

		knConfigPath = test.createFile(t, "config.yaml", "", knConfigDir, FileModeReadWrite)
		assert.Assert(t, knConfigPath != "")

		knPluginPath = test.createFile(t, "kn-helloe2e", TestPluginCode, knPluginsDir, FileModeExecutable)
		assert.Assert(t, knPluginPath != "")

		knPluginPath2 = test.createFile(t, "kn-hello2e2e", TestPluginCode, knPluginsDir2, FileModeExecutable)
		assert.Assert(t, knPluginPath2 != "")
	}

	teardown := func(t *testing.T) {
		err = os.RemoveAll(knConfigDir)
		assert.NilError(t, err)
	}

	t.Run("when kn config is empty", func(t *testing.T) {
		t.Run("when using --plugin-dir", func(t *testing.T) {
			t.Run("when --plugins-dir has a plugin", func(t *testing.T) {
				t.Run("when --lookup-plugins is false", func(t *testing.T) {
					lookupPlugins = false

					setup(t)
					defer teardown(t)

					assert.Assert(t, lookupPlugins == false)
					knFlags := []string{fmt.Sprintf("--plugins-dir=%s", knPluginsDir), fmt.Sprintf("--lookup-plugins=%t", lookupPlugins)}

					t.Run("list plugin in --plugins-dir", func(t *testing.T) {
						test.listPlugin(t, knFlags, []string{knPluginPath}, []string{})
					})

					t.Run("execute plugin in --plugins-dir", func(t *testing.T) {
						test.runPlugin(t, knFlags, "helloe2e", []string{"e2e", "test"}, []string{"Hello Knative, I'm a Kn plugin", "I received arguments: e2e"})
					})

					t.Run("does not list any other plugin in $PATH", func(t *testing.T) {
						test.listPlugin(t, knFlags, []string{knPluginPath}, []string{knPluginPath2})
					})
				})

				t.Run("with --lookup-plugins is true", func(t *testing.T) {
					lookupPlugins = true

					setup(t)
					defer teardown(t)

					assert.Assert(t, lookupPlugins == true)
					knFlags := []string{fmt.Sprintf("--plugins-dir=%s", knPluginsDir), fmt.Sprintf("--lookup-plugins=%t", lookupPlugins)}

					t.Run("list plugin in --plugins-dir", func(t *testing.T) {
						test.listPlugin(t, knFlags, []string{knPluginPath}, []string{knPluginPath2})
					})

					t.Run("execute plugin in --plugins-dir", func(t *testing.T) {
						test.runPlugin(t, knFlags, "helloe2e", []string{}, []string{"Hello Knative, I'm a Kn plugin"})
					})

					t.Run("when other plugins are in $PATH", func(t *testing.T) {
						var oldPath string

						setupPath := func(t *testing.T) {
							oldPath = os.Getenv("PATH")
							err := os.Setenv("PATH", fmt.Sprintf("%s:%s", oldPath, knPluginsDir2))
							assert.NilError(t, err)
						}

						tearDownPath := func(t *testing.T) {
							err = os.Setenv("PATH", oldPath)
							assert.NilError(t, err)
						}

						t.Run("list plugin in $PATH", func(t *testing.T) {
							setupPath(t)
							defer tearDownPath(t)
							test.listPlugin(t, knFlags, []string{knPluginPath, knPluginPath2}, []string{})
						})

						t.Run("execute plugin in $PATH", func(t *testing.T) {
							setupPath(t)
							defer tearDownPath(t)
							test.runPlugin(t, knFlags, "hello2e2e", []string{}, []string{"Hello Knative, I'm a Kn plugin"})
						})
					})
				})
			})
		})
	})
}

// Private

func (test *e2eTest) createFile(t *testing.T, fileName, fileContent, filePath string, fileMode os.FileMode) string {
	file := filepath.Join(filePath, fileName)
	err := ioutil.WriteFile(file, []byte(fileContent), fileMode)
	assert.NilError(t, err)
	return file
}

func (test *e2eTest) listPlugin(t *testing.T, knFlags []string, expectedPlugins []string, unexpectedPlugins []string) {
	knArgs := append([]string{}, knFlags...)
	knArgs = append(knArgs, []string{"plugin", "list"}...)

	out, err := test.kn.RunWithOpts(knArgs, runOpts{NoNamespace: true})
	assert.NilError(t, err)
	assert.Check(t, util.ContainsAll(out, expectedPlugins...))
	assert.Check(t, util.ContainsNone(out, unexpectedPlugins...))
}

func (test *e2eTest) runPlugin(t *testing.T, knFlags []string, pluginName string, args []string, expectedOutput []string) {
	knArgs := append([]string{}, knFlags...)
	knArgs = append(knArgs, pluginName)
	knArgs = append(knArgs, args...)

	out, err := test.kn.RunWithOpts(knArgs, runOpts{NoNamespace: true})
	assert.NilError(t, err)
	for _, output := range expectedOutput {
		assert.Check(t, util.ContainsAll(out, output))
	}
}