test: add e2e test suite for 'kpm pkg'

Add e2e coverage for 'kpm pkg'. We validate that the tarball produced contains
the expected files.

Rather than modify TestSuite struct with expected tar content, which is not
relevant to other tests, we store the expected_tar_content.txt within test data.

e2e tests valdate different include/exclude scenarios.

The tests are failing to start and will be fixed in the next few commits.

Signed-off-by: Aaron D Borden <adborden@a14n.net>

Author: adborden

test/e2e/kpm_test.go

@@ -1,11 +1,14 @@
 package e2e
 
 import (
+	"archive/tar"
 	"context"
 	"encoding/json"
 	"fmt"
+	"io"
 	"os"
 	"path/filepath"
+	"sort"
 	"strings"
 
 	"github.com/onsi/ginkgo/v2"
@@ -22,6 +25,59 @@ import (
 )
 
 var _ = ginkgo.Describe("Kpm CLI Testing", func() {
+	ginkgo.Context("testing 'kpm pkg'", func() {
+		testSuitesRoot := filepath.Join(filepath.Join(filepath.Join(GetWorkDir(), TEST_SUITES_DIR), "kpm"), "kpm_pkg")
+		testSuites := LoadAllTestSuites(testSuitesRoot)
+		testDataRoot := filepath.Join(filepath.Join(GetWorkDir(), TEST_SUITES_DIR), "test_data")
+		for _, ts := range testSuites {
+			ts := ts
+			ginkgo.It(ts.GetTestSuiteInfo(), func() {
+				workspace := GetWorkspace()
+
+				// Copy the test data to the workspace
+				CopyDir(filepath.Join(testDataRoot, ts.Name), filepath.Join(workspace, ts.Name))
+
+				// Run the command from test_suite.input
+				stdout, stderr, _ := ExecKpmWithWorkDir(ts.Input, filepath.Join(workspace, ts.Name))
+
+				// kpm pkg always produces no output
+				gomega.Expect(stdout).To(gomega.BeEmpty(), "unexpected stdout from kpm pkg")
+				gomega.Expect(stderr).To(gomega.BeEmpty(), "unexpected stderr from kpm pkg")
+				//time.Sleep(300 * time.Second)
+
+				// Assert the contents of the tarball without extracting
+				expectedTarContentFilepath := filepath.Join(testDataRoot, ts.Name, "expected_tar_content.txt")
+				exist, _ := utils.Exists(expectedTarContentFilepath)
+				gomega.Expect(exist).To(gomega.BeTrue(), "expected_tar_content.txt not found in test data")
+        expectedTarContentBytes, err := os.ReadFile(expectedTarContentFilepath)
+        gomega.Expect(err).ShouldNot(gomega.HaveOccurred(), "failed to read from expected_tar_content.txt")
+        expectedFiles := strings.Split(strings.TrimSpace(string(expectedTarContentBytes)), "\n")
+				sort.Strings(expectedFiles)
+
+				tarballPath := filepath.Join(workspace, ts.Name, "dist", fmt.Sprintf("%s_0.0.1.tar", ts.Name))
+				fmt.Printf("tarballPath: %s\n", tarballPath)
+				exist, _ = utils.Exists(tarballPath)
+				gomega.Expect(exist).To(gomega.BeTrue(), "pkg tarball not found, check kcl.mod name should match test suite")
+				f, err := os.Open(tarballPath)
+				gomega.Expect(err).ShouldNot(gomega.HaveOccurred(), "failed to open pkg tarball")
+				defer f.Close()
+
+				tr := tar.NewReader(f)
+				var actualFiles []string
+				for {
+					hdr, err := tr.Next()
+					if err == io.EOF {
+						break
+					}
+					gomega.Expect(err).ShouldNot(gomega.HaveOccurred(), "error reading pkg tarball")
+					actualFiles = append(actualFiles, hdr.Name)
+				}
+				sort.Strings(actualFiles)
+				gomega.Expect(actualFiles).To(gomega.Equal(expectedFiles), "unexpected pkg tarball content")
+			})
+		}
+	})
+
 	ginkgo.Context("testing 'exec kpm outside a kcl package'", func() {
 		testSuites := LoadAllTestSuites(filepath.Join(filepath.Join(filepath.Join(GetWorkDir(), TEST_SUITES_DIR), "kpm"), "exec_outside_pkg"))
 		testDataRoot := filepath.Join(filepath.Join(GetWorkDir(), TEST_SUITES_DIR), "test_data")

test/e2e/test_suite.go

@@ -63,11 +63,13 @@ func LoadTestSuite(testSuitePath, name string) TestSuite {
 	reporter.Report("kpm_e2e: loading '", name, "' from ", testSuitePath)
 	CheckTestSuite(testSuitePath, name)
 	return TestSuite{
-		Name:         name,
+		Name:             name,
 		ExpectStdout: LoadFirstFileWithExt(testSuitePath, STDOUT_EXT),
 		ExpectStderr: LoadFirstFileWithExt(testSuitePath, STDERR_EXT),
-		Input:        LoadFirstFileWithExt(testSuitePath, INPUT_EXT),
-		Envs:         LoadFirstFileWithExt(testSuitePath, ENV_EXT),
+
+		// Strip whitespace to ignore the leading and trailing new lines.
+		Input: strings.TrimSpace(LoadFirstFileWithExt(testSuitePath, INPUT_EXT)),
+		Envs:  LoadFirstFileWithExt(testSuitePath, ENV_EXT),
 	}
 }
 

test/e2e/test_suites/kpm/kpm_pkg/pkg_default/test_suite.env

@@ -0,0 +1,2 @@
+KPM_HOME=""
+KCLVM_VENDOR_HOME=""

test/e2e/test_suites/kpm/kpm_pkg/pkg_default/test_suite.input

@@ -0,0 +1 @@
+kpm pkg --target=dist

test/e2e/test_suites/kpm/kpm_pkg/pkg_default/test_suite.stderr

@@ -0,0 +1,2 @@
+KPM_HOME=""
+KCLVM_VENDOR_HOME=""

test/e2e/test_suites/kpm/kpm_pkg/pkg_default/test_suite.stdout

@@ -0,0 +1 @@
+kpm pkg --target=dist