airshipctl/pkg/document/plugin/templater/templater_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 templater_test

import (
	"bytes"
	"testing"

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

	"sigs.k8s.io/kustomize/kyaml/kio"
	"sigs.k8s.io/yaml"

	"crypto/x509"
	"crypto/x509/pkix"
	"encoding/base64"
	"encoding/pem"

	"opendev.org/airship/airshipctl/pkg/document/plugin/templater"
)

func TestTemplater(t *testing.T) {
	testCases := []struct {
		cfg         string
		expectedOut string
		expectedErr string
	}{
		{
			cfg: `
apiVersion: airshipit.org/v1alpha1
kind: Templater
metadata:
  name: notImportantHere
values:
  hosts:
    - macAddress: 00:aa:bb:cc:dd
      name: node-1
    - macAddress: 00:aa:bb:cc:ee
      name: node-2
template: |
  {{ range .hosts -}}
  ---
  apiVersion: metal3.io/v1alpha1
  kind: BareMetalHost
  metadata:
    name: {{ .name }}
  spec:
    bootMACAddress: {{ .macAddress }}
  {{ end -}}`,
			expectedOut: `apiVersion: metal3.io/v1alpha1
kind: BareMetalHost
metadata:
  name: node-1
spec:
  bootMACAddress: 00:aa:bb:cc:dd
---
apiVersion: metal3.io/v1alpha1
kind: BareMetalHost
metadata:
  name: node-2
spec:
  bootMACAddress: 00:aa:bb:cc:ee
`,
		},
		{
			cfg: `
apiVersion: airshipit.org/v1alpha1
kind: Templater
metadata:
  name: notImportantHere
values:
  test:
    someKey:
      anotherKey: value
    of:
      - toYaml
template: |
  {{ toYaml . -}}
`,
			expectedOut: `test:
  of:
  - toYaml
  someKey:
    anotherKey: value
`,
		},
		{
			cfg: `
apiVersion: airshipit.org/v1alpha1
kind: Templater
metadata:
  name: notImportantHere
values:
  test:
    of:
      - badToYamlInput
template: |
  {{ toYaml ignorethisbadinput -}}
`,
			expectedOut: ``,
		},
		{
			cfg: `
apiVersion: airshipit.org/v1alpha1
kind: Templater
metadata:
  name: notImportantHere
template: |
  {{ end }`,
			expectedErr: "template: tmpl:1: unexpected \"}\" in end",
		},
		{
			cfg: `
apiVersion: airshipit.org/v1alpha1
kind: Templater
metadata:
  name: notImportantHere
values:
template: |
  touint32: {{ toUint32 10 -}}
`,
			expectedOut: `touint32: 10
`,
		},
		{
			cfg: `
apiVersion: airshipit.org/v1alpha1
kind: Templater
metadata:
  name: notImportantHere
values:
  regex: "^[a-z]{5,10}$"
  nomatchregex: "^[a-z]{0,4}$"
  limit: 10
template: |
  truepassword: {{ regexMatch .regex (regexGen .regex (.limit|int)) }}
  falsepassword: {{ regexMatch .nomatchregex (regexGen .regex (.limit|int)) }}
`,
			expectedOut: `truepassword: true
falsepassword: false
`,
		}, {
			cfg: `
apiVersion: airshipit.org/v1alpha1
kind: Templater
metadata:
  name: notImportantHere
values:
  name: test
  regex: "^[a-z]{5,10}$"
  limit: 0
template: |
  password: {{ regexGen .regex (.limit|int) }}
`,
			expectedErr: "template: tmpl:1:13: executing \"tmpl\" at " +
				"<regexGen .regex (.limit | int)>: error calling regexGen: " +
				"Limit cannot be less than or equal to 0",
		},
		{
			cfg: `
apiVersion: airshipit.org/v1alpha1
kind: Templater
metadata:
  name: notImportantHere
values:
  name: test
  regex: "^[a-z"
  limit: 10
template: |
  password: {{ regexGen .regex (.limit|int) }}
`,
			expectedErr: "template: tmpl:1:13: executing \"tmpl\" " +
				"at <regexGen .regex (.limit | int)>: error calling " +
				"regexGen: error parsing regexp: missing closing ]: `[a-z`",
		},
		{
			cfg: `
apiVersion: airshipit.org/v1alpha1
kind: Templater
metadata:
  name: notImportantHere
template: |
  FileExists: {{ fileExists "./templater.go" }}
  NoFileExists: {{ fileExists "./templater1.go" }}
`,
			expectedOut: `FileExists: true
NoFileExists: false
`,
		},
	}

	for _, tc := range testCases {
		cfg := make(map[string]interface{})
		err := yaml.Unmarshal([]byte(tc.cfg), &cfg)
		require.NoError(t, err)
		plugin, err := templater.New(cfg)
		require.NoError(t, err)
		buf := &bytes.Buffer{}
		nodes, err := plugin.Filter(nil)
		if tc.expectedErr != "" {
			assert.EqualError(t, err, tc.expectedErr)
		}
		err = kio.ByteWriter{Writer: buf}.Write(nodes)
		require.NoError(t, err)
		assert.Equal(t, tc.expectedOut, buf.String())
	}
}

func TestGenSignedCertEx(t *testing.T) {
	testCases := []struct {
		cfg             string
		expectedSubject pkix.Name
	}{
		{
			cfg: `
apiVersion: airshipit.org/v1alpha1
kind: Templater
metadata:
  name: notImportantHere
values:
  name: test
  regex: "^[a-z]{5,10}$"
  limit: 0
template: |
  {{- $targetClusterCa:=genCAEx "Kubernetes API" 3650 }}
  {{- $targetKubeconfigCert:= genSignedCertEx "/CN=admin/O=system:masters" nil nil 365 $targetClusterCa }}
  cert: {{ $targetKubeconfigCert.Cert|b64enc|quote }}
`,
			expectedSubject: pkix.Name{
				CommonName: `admin`,
				Organization: []string{
					`system:masters`,
				},
			},
		},
	}

	for _, tc := range testCases {
		cfg := make(map[string]interface{})
		err := yaml.Unmarshal([]byte(tc.cfg), &cfg)
		require.NoError(t, err)
		plugin, err := templater.New(cfg)
		require.NoError(t, err)
		buf := &bytes.Buffer{}
		nodes, err := plugin.Filter(nil)
		require.NoError(t, err)
		err = kio.ByteWriter{Writer: buf}.Write(nodes)
		require.NoError(t, err)

		res := make(map[string]string)
		err = yaml.Unmarshal(buf.Bytes(), &res)
		require.NoError(t, err)

		key, err := base64.StdEncoding.DecodeString(res["cert"])
		require.NoError(t, err)

		der, _ := pem.Decode(key)
		if der == nil {
			t.Errorf("failed to find PEM block")
			return
		}

		cert, err := x509.ParseCertificate(der.Bytes)
		if err != nil {
			t.Errorf("failed to parse: %s", err)
			return
		}
		cert.Subject.Names = nil
		assert.Equal(t, tc.expectedSubject, cert.Subject)
	}
}