airshipctl/pkg/phase/render_test.go

/*
 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

     https://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 phase_test

import (
	"bytes"
	"fmt"
	"io/ioutil"
	"path"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"opendev.org/airship/airshipctl/pkg/config"
	"opendev.org/airship/airshipctl/pkg/phase"
	"opendev.org/airship/airshipctl/pkg/phase/errors"
	"opendev.org/airship/airshipctl/pkg/phase/ifc"
	"opendev.org/airship/airshipctl/testutil"
)

func TestRender(t *testing.T) {
	rs := testutil.DummyConfig()
	dummyManifest := rs.Manifests["dummy_manifest"]
	dummyManifest.TargetPath = "testdata"
	dummyManifest.PhaseRepositoryName = config.DefaultTestPhaseRepo
	dummyManifest.Repositories = map[string]*config.Repository{
		config.DefaultTestPhaseRepo: {
			URLString: "",
		},
	}
	dummyManifest.MetadataPath = "metadata.yaml"
	fixturePath := "phase"
	tests := []struct {
		name       string
		expResFile string
		expErr     error

		settings *phase.RenderCommand
	}{
		{
			name: "No Filters",
			settings: &phase.RenderCommand{
				Source: phase.RenderSourcePhase,
				PhaseID: ifc.ID{
					Name: fixturePath,
				},
			},
			expResFile: "noFilter.yaml",
			expErr:     nil,
		},
		{
			name: "All Filters",
			settings: &phase.RenderCommand{
				Label:      "airshipit.org/deploy-k8s=false",
				Annotation: "airshipit.org/clustertype=ephemeral",
				APIVersion: "metal3.io/v1alpha1",
				Kind:       "BareMetalHost",
				Source:     phase.RenderSourcePhase,
				PhaseID: ifc.ID{
					Name: fixturePath,
				},
			},
			expResFile: "allFilters.yaml",
			expErr:     nil,
		},
		{
			name: "Multiple Labels",
			settings: &phase.RenderCommand{
				Label:  "airshipit.org/deploy-k8s=false, airshipit.org/ephemeral-node=true",
				Source: phase.RenderSourcePhase,
				PhaseID: ifc.ID{
					Name: fixturePath,
				},
			},
			expResFile: "multiLabels.yaml",
			expErr:     nil,
		},
		{
			name: "Malformed Label",
			settings: &phase.RenderCommand{
				Label:  "app=(",
				Source: phase.RenderSourcePhase,
				PhaseID: ifc.ID{
					Name: fixturePath,
				},
			},
			expErr: fmt.Errorf("unable to parse requirement: found '(', expected: identifier"),
		},
		{
			name: "Malformed Label",
			settings: &phase.RenderCommand{
				Label:  "app=(",
				Source: phase.RenderSourceExecutor,
				PhaseID: ifc.ID{
					Name: fixturePath,
				},
			},
			expErr: fmt.Errorf("unable to parse requirement: found '(', expected: identifier"),
		},
		{
			name: "source doesn't exist",
			settings: &phase.RenderCommand{
				Source: "unknown",
			},
			expErr: errors.ErrUnknownRenderSource{Source: "unknown",
				ValidSources: []string{phase.RenderSourceConfig, phase.RenderSourceExecutor, phase.RenderSourcePhase}},
		},
		{
			name: "phase name not specified",
			settings: &phase.RenderCommand{
				Source: phase.RenderSourcePhase,
			},
			expErr: errors.ErrRenderPhaseNameNotSpecified{
				Sources: []string{phase.RenderSourceExecutor, phase.RenderSourcePhase}},
		},
	}

	for _, tt := range tests {
		tt := tt
		t.Run(tt.name, func(t *testing.T) {
			var expectedOut []byte
			var err error
			if tt.expResFile != "" {
				expectedOut, err = ioutil.ReadFile(path.Join("testdata", "expected", tt.expResFile))
				require.NoError(t, err)
			}
			out := &bytes.Buffer{}
			err = tt.settings.RunE(func() (*config.Config, error) {
				return rs, nil
			}, out)
			assert.Equal(t, tt.expErr, err)
			assert.Equal(t, expectedOut, out.Bytes())
		})
	}
}

func TestRenderConfigBundle(t *testing.T) {
	rs := testutil.DummyConfig()
	dummyManifest := rs.Manifests["dummy_manifest"]
	dummyManifest.TargetPath = "testdata"
	dummyManifest.PhaseRepositoryName = config.DefaultTestPhaseRepo
	dummyManifest.Repositories = map[string]*config.Repository{
		config.DefaultTestPhaseRepo: {},
	}
	dummyManifest.MetadataPath = "metadata.yaml"
	buf := bytes.NewBuffer([]byte{})
	settings := &phase.RenderCommand{
		Source: phase.RenderSourceConfig,
	}
	err := settings.RunE(func() (*config.Config, error) {
		return rs, nil
	}, buf)
	assert.NoError(t, err)
	// check that it contains phases and cluster map
	assert.Contains(t, buf.String(), "kind: Phase")
	assert.Contains(t, buf.String(), "kind: ClusterMap")
}