github.com/wmuizelaar/kpt@v0.0.0-20221018115725-bd564717b2ed/commands/pkg/init/cmdinit_test.go

// Copyright 2019 Google LLC
//
// 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 init_test

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

	initialization "github.com/GoogleContainerTools/kpt/commands/pkg/init"
	"github.com/GoogleContainerTools/kpt/internal/builtins"
	"github.com/GoogleContainerTools/kpt/internal/printer/fake"
	"github.com/GoogleContainerTools/kpt/internal/testutil"
	"github.com/GoogleContainerTools/kpt/internal/util/man"
	"github.com/stretchr/testify/assert"
)

func TestMain(m *testing.M) {
	os.Exit(testutil.ConfigureTestKptCache(m))
}

// TestCmd verifies the directory is initialized
func TestCmd(t *testing.T) {
	d := t.TempDir()
	assert.NoError(t, os.Mkdir(filepath.Join(d, "my-pkg"), 0700))

	r := initialization.NewRunner(fake.CtxWithDefaultPrinter(), "kpt")
	r.Command.SetArgs([]string{filepath.Join(d, "my-pkg"), "--description", "my description"})
	err := r.Command.Execute()
	assert.NoError(t, err)

	// verify the contents
	b, err := os.ReadFile(filepath.Join(d, "my-pkg", "Kptfile"))
	assert.NoError(t, err)
	assert.Equal(t, `apiVersion: kpt.dev/v1
kind: Kptfile
metadata:
  name: my-pkg
  annotations:
    config.kubernetes.io/local-config: "true"
info:
  description: my description
`, string(b))

	b, err = os.ReadFile(filepath.Join(d, "my-pkg", man.ManFilename))
	assert.NoError(t, err)
	assert.Equal(t, strings.ReplaceAll(`# my-pkg

## Description
my description

## Usage

### Fetch the package
'kpt pkg get REPO_URI[.git]/PKG_PATH[@VERSION] my-pkg'
Details: https://kpt.dev/reference/cli/pkg/get/

### View package content
'kpt pkg tree my-pkg'
Details: https://kpt.dev/reference/cli/pkg/tree/

### Apply the package
'''
kpt live init my-pkg
kpt live apply my-pkg --reconcile-timeout=2m --output=table
'''
Details: https://kpt.dev/reference/cli/live/
`, "'", "`"), string(b))

	b, err = os.ReadFile(filepath.Join(d, "my-pkg", builtins.PkgContextFile))
	assert.NoError(t, err)
	assert.Equal(t, b, []byte(builtins.AbstractPkgContext()))
}

func TestCmd_currentDir(t *testing.T) {
	d := t.TempDir()
	assert.NoError(t, os.Mkdir(filepath.Join(d, "my-pkg"), 0700))
	packageDir := filepath.Join(d, "my-pkg")
	currentDir, err := os.Getwd()
	assert.NoError(t, err)
	err = func() error {
		nestedErr := os.Chdir(packageDir)
		if nestedErr != nil {
			return nestedErr
		}
		defer func() {
			deferErr := os.Chdir(currentDir)
			if deferErr != nil {
				panic(deferErr)
			}
		}()

		r := initialization.NewRunner(fake.CtxWithDefaultPrinter(), "kpt")
		r.Command.SetArgs([]string{".", "--description", "my description"})
		return r.Command.Execute()
	}()
	assert.NoError(t, err)

	// verify the contents
	b, err := os.ReadFile(filepath.Join(packageDir, "Kptfile"))
	assert.NoError(t, err)
	assert.Equal(t, `apiVersion: kpt.dev/v1
kind: Kptfile
metadata:
  name: my-pkg
  annotations:
    config.kubernetes.io/local-config: "true"
info:
  description: my description
`, string(b))
}

func TestCmd_DefaultToCurrentDir(t *testing.T) {
	d := t.TempDir()
	assert.NoError(t, os.Mkdir(filepath.Join(d, "my-pkg"), 0700))
	packageDir := filepath.Join(d, "my-pkg")
	currentDir, err := os.Getwd()
	assert.NoError(t, err)
	err = func() error {
		nestedErr := os.Chdir(packageDir)
		if nestedErr != nil {
			return nestedErr
		}
		defer func() {
			deferErr := os.Chdir(currentDir)
			if deferErr != nil {
				panic(deferErr)
			}
		}()

		r := initialization.NewRunner(fake.CtxWithDefaultPrinter(), "kpt")
		r.Command.SetArgs([]string{"--description", "my description"})
		return r.Command.Execute()
	}()
	assert.NoError(t, err)

	// verify the contents
	b, err := os.ReadFile(filepath.Join(packageDir, "Kptfile"))
	assert.NoError(t, err)
	assert.Equal(t, `apiVersion: kpt.dev/v1
kind: Kptfile
metadata:
  name: my-pkg
  annotations:
    config.kubernetes.io/local-config: "true"
info:
  description: my description
`, string(b))
}

// TestCmd_failExists verifies the command throws and error if the directory exists
func TestCmd_failNotExists(t *testing.T) {
	d := t.TempDir()
	r := initialization.NewRunner(fake.CtxWithDefaultPrinter(), "kpt")
	r.Command.SetArgs([]string{filepath.Join(d, "my-pkg"), "--description", "my description"})
	err := r.Command.Execute()
	if assert.Error(t, err) {
		assert.Contains(t, err.Error(), "does not exist")
	}
}