Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor templating e2e test to not depend on CLI output #3147

Merged
merged 1 commit into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 32 additions & 28 deletions src/test/e2e/04_create_templating_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,53 +5,42 @@
package test

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

"github.com/stretchr/testify/require"

"github.com/zarf-dev/zarf/src/api/v1alpha1"
layout2 "github.com/zarf-dev/zarf/src/internal/packager2/layout"
)

func TestCreateTemplating(t *testing.T) {
t.Log("E2E: Create Templating")

// run `zarf package create` with a specified image cache location
tmpdir := t.TempDir()
decompressPath := filepath.Join(tmpdir, ".package-decompressed")
sbomPath := filepath.Join(tmpdir, ".sbom-location")

pkgName := fmt.Sprintf("zarf-package-templating-%s.tar.zst", e2e.Arch)
sbomPath := t.TempDir()
outPath := t.TempDir()
templatingPath := filepath.Join(outPath, fmt.Sprintf("zarf-package-templating-%s.tar.zst", e2e.Arch))
fileFoldersPath := filepath.Join(outPath, fmt.Sprintf("zarf-package-file-folders-templating-sbom-%s.tar.zst", e2e.Arch))

// Test that not specifying a package variable results in an error
_, _, err := e2e.Zarf(t, "package", "create", "src/test/packages/04-templating", "--confirm")
_, _, err := e2e.Zarf(t, "package", "create", "src/test/packages/04-templating", "-o", outPath, "--confirm")
require.Error(t, err)

// Test a simple package variable example with `--set` (will fail to pull an image if this is not set correctly)
stdOut, stdErr, err := e2e.Zarf(t, "package", "create", "src/test/packages/04-templating", "--set", "PODINFO_VERSION=6.4.0", "--confirm")
require.NoError(t, err, stdOut, stdErr)

stdOut, stdErr, err = e2e.Zarf(t, "t", "archiver", "decompress", pkgName, decompressPath, "--unarchive-all")
require.NoError(t, err, stdOut, stdErr)
_, _, err = e2e.Zarf(t, "package", "create", "src/test/packages/04-templating", "-o", outPath, "--set", "PODINFO_VERSION=6.4.0", "--confirm")
require.NoError(t, err)

// Check that the constant in the zarf.yaml is replaced correctly
builtConfig, err := os.ReadFile(decompressPath + "/zarf.yaml")
pkgLayout, err := layout2.LoadFromTar(context.Background(), templatingPath, layout2.PackageLayoutOptions{})
require.NoError(t, err)
require.Contains(t, string(builtConfig), "name: PODINFO_VERSION\n value: 6.4.0")
expectedConstant := v1alpha1.Constant{Name: "PODINFO_VERSION", Value: "6.4.0", Pattern: "^[\\w\\-\\.]+$"}
require.Contains(t, pkgLayout.Pkg.Constants, expectedConstant)

// Test that files and file folders template and handle SBOMs correctly
stdOut, stdErr, err = e2e.Zarf(t, "package", "create", "src/test/packages/04-file-folders-templating-sbom/", "--sbom-out", sbomPath, "--confirm")
require.NoError(t, err, stdOut, stdErr)
require.Contains(t, stdErr, "Creating SBOMs for 0 images and 2 components with files.")

fileFoldersPkgName := fmt.Sprintf("zarf-package-file-folders-templating-sbom-%s.tar.zst", e2e.Arch)

// Deploy the package and look for the variables in the output
stdOut, stdErr, err = e2e.Zarf(t, "package", "deploy", fileFoldersPkgName, "--set", "DOGGO=doggy", "--set", "KITTEH=meowza", "--set", "PANDA=pandemonium", "--confirm")
require.NoError(t, err, stdOut, stdErr)
require.Contains(t, stdErr, "A doggy barks!")
require.Contains(t, stdErr, " - meowza")
require.Contains(t, stdErr, "# Total pandemonium")
_, _, err = e2e.Zarf(t, "package", "create", "src/test/packages/04-file-folders-templating-sbom/", "-o", outPath, "--sbom-out", sbomPath, "--confirm")
require.NoError(t, err)

// Ensure that the `requirements.txt` files are discovered correctly
require.FileExists(t, filepath.Join(sbomPath, "file-folders-templating-sbom", "compare.html"))
Expand All @@ -65,5 +54,20 @@ func TestCreateTemplating(t *testing.T) {
require.NoError(t, err)
require.Contains(t, string(filesJSON), "pandas")

e2e.CleanFiles(t, pkgName, fileFoldersPkgName)
// Deploy the package and look for the variables in the output
workingPath := t.TempDir()
_, _, err = e2e.ZarfInDir(t, workingPath, "package", "deploy", fileFoldersPath, "--set", "DOGGO=doggy", "--set", "KITTEH=meowza", "--set", "PANDA=pandemonium", "--confirm")
require.NoError(t, err)

b, err := os.ReadFile(filepath.Join(workingPath, "temp", "requirements.txt"))
require.NoError(t, err)
require.Equal(t, "# Total pandemonium\npandas==1.5.0\n", string(b))

b, err = os.ReadFile(filepath.Join(workingPath, "temp", "include-files", "simple.txt"))
require.NoError(t, err)
require.Equal(t, "A doggy barks!\n", string(b))

b, err = os.ReadFile(filepath.Join(workingPath, "temp", "include-files", "something.yaml"))
require.NoError(t, err)
require.Equal(t, "something:\n - a\n - meowza\n - meows\n", string(b))
}
2 changes: 0 additions & 2 deletions src/test/packages/04-file-folders-templating-sbom/zarf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ components:
after:
- cmd: cat temp/include-files/simple.txt
- cmd: cat temp/include-files/something.yaml
- cmd: rm -r temp
- name: files
required: true
files:
Expand All @@ -28,4 +27,3 @@ components:
onDeploy:
after:
- cmd: cat temp/requirements.txt
- cmd: rm -r temp