pack: added .packignore

In some cases, there are files that may be useful, but should not
be part of artifact. The ability to add files and directories to
the .packignore file has been added, which allows you to ignore
these files and directories when packing.

Closes: [812](#812)

Author: Japsty

cli/pack/common.go

@@ -277,14 +277,30 @@ func getDestAppDir(bundleEnvPath, appName string,
 
 // copyApplications copies applications from current env to the result bundle.
 func copyApplications(bundleEnvPath string, packCtx *PackCtx,
-	cliOpts, newOpts *config.CliOpts) error {
-	var err error
+	cliOpts, newOpts *config.CliOpts, toIgnore map[string]struct{}) error {
 	for appName, instances := range packCtx.AppsInfo {
 		if len(instances) == 0 {
 			return fmt.Errorf("application %q does not have any instances", appName)
 		}
 		inst := instances[0]
 		appPath := inst.AppDir
+
+		projectPath := filepath.Dir(packCtx.configFilePath)
+		relAppPath, err := filepath.Rel(projectPath, appPath)
+		if err != nil {
+			return err
+		}
+		relAppPathUnix := filepath.ToSlash(relAppPath)
+
+		ignore, err := shouldIgnore(relAppPathUnix, toIgnore)
+		if err != nil {
+			return err
+		}
+		if ignore {
+			log.Infof("Application %s found in .packignore, skipping it...", appName)
+			continue
+		}
+
 		if inst.IsFileApp {
 			appPath = inst.InstanceScript
 			resolvedAppPath, err := filepath.EvalSymlinks(appPath)
@@ -363,6 +379,12 @@ func prepareBundle(cmdCtx *cmdcontext.CmdCtx, packCtx *PackCtx,
 	packCtx.AppList = getAppNamesToPack(packCtx)
 	log.Infof("Apps to pack: %s", strings.Join(packCtx.AppList, " "))
 
+	projectPath := filepath.Dir(packCtx.configFilePath)
+	ignorePatterns, err := readPackIgnore(projectPath)
+	if err != nil {
+		return "", fmt.Errorf("failed to read .packignore: %v", err)
+	}
+
 	if bundleEnvPath, err = updateEnvPath(bundleEnvPath, packCtx, cliOpts); err != nil {
 		return "", err
 	}
@@ -373,16 +395,20 @@ func prepareBundle(cmdCtx *cmdcontext.CmdCtx, packCtx *PackCtx,
 		return "", fmt.Errorf("error copying binaries: %s", err)
 	}
 
-	if err = copyApplications(bundleEnvPath, packCtx, cliOpts, newOpts); err != nil {
+	if err = copyApplications(bundleEnvPath, packCtx, cliOpts, newOpts, ignorePatterns); err != nil {
 		return "", fmt.Errorf("error copying applications: %s", err)
 	}
 
 	if packCtx.Archive.All {
-		if err = copyArtifacts(*packCtx, bundleEnvPath, newOpts, packCtx.AppsInfo); err != nil {
+		if err = copyArtifacts(*packCtx, bundleEnvPath, newOpts, packCtx.AppsInfo, ignorePatterns); err != nil {
 			return "", fmt.Errorf("failed copying artifacts: %s", err)
 		}
 	}
 
+	if err = removeIgnoredFiles(bundleEnvPath, ignorePatterns); err != nil {
+		return "", fmt.Errorf("failed to remove ignored files: %v", err)
+	}
+
 	if buildRocks {
 		err = buildAppRocks(cmdCtx, packCtx, cliOpts, bundleEnvPath)
 		if err != nil && !os.IsNotExist(err) {
@@ -425,7 +451,7 @@ func copyAppSrc(packCtx *PackCtx, cliOpts *config.CliOpts, srcAppPath, dstAppPat
 // copyArtifacts copies all artifacts from the current bundle configuration
 // to the passed package structure from the passed path.
 func copyArtifacts(packCtx PackCtx, basePath string, newOpts *config.CliOpts,
-	appsInfo map[string][]running.InstanceCtx) error {
+	appsInfo map[string][]running.InstanceCtx, toIgnore map[string]struct{}) error {
 
 	for _, appName := range packCtx.AppList {
 		for _, inst := range appsInfo[appName] {

cli/pack/common_test.go

@@ -1068,6 +1068,28 @@ func Test_prepareBundle(t *testing.T) {
 				{assert.FileExists, "app/tt.yaml"},
 			},
 		},
+		{
+			name: "Packing env with packignore:.",
+			params: params{
+				configPath:    "testdata/bundle_with_packignore/tt.yaml",
+				tntExecutable: tntExecutable,
+				packCtx:       PackCtx{Name: "app"},
+			},
+			wantErr: false,
+			checks: []check{
+				{assert.NoFileExists, "app2/testfile.txt"},
+
+				{assert.DirExists, "instances.enabled"},
+				{assert.NoFileExists, "instances.enabled/app"},
+
+				{assert.NoDirExists, "modules"},
+
+				{assert.DirExists, "app2"},
+				{assert.NoDirExists, "app2/var"},
+
+				{assert.NoFileExists, "app.lua"},
+			},
+		},
 	}
 
 	for _, tt := range tests {

cli/pack/ignore.go

@@ -0,0 +1,100 @@
+package pack
+
+import (
+	"bufio"
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+// readPackIgnore reads the .packignore file and returns a slice of ignore patterns.
+func readPackIgnore(projectPath string) (map[string]struct{}, error) {
+	ignoreFilePath := filepath.Join(projectPath, ".packignore")
+	file, err := os.Open(ignoreFilePath)
+	if err != nil {
+		if os.IsNotExist(err) {
+			return map[string]struct{}{}, nil
+		}
+		return nil, err
+	}
+	defer file.Close()
+
+	patterns := make(map[string]struct{})
+	scanner := bufio.NewScanner(file)
+	for scanner.Scan() {
+		line := scanner.Text()
+		line = strings.TrimSpace(line)
+		if line == "" || strings.HasPrefix(line, "#") {
+			continue
+		}
+		patterns[line] = struct{}{}
+	}
+
+	if err := scanner.Err(); err != nil {
+		return nil, err
+	}
+	return patterns, nil
+}
+
+// shouldIgnore checks if the given file path matches any of the ignore patterns.
+func shouldIgnore(path string, patterns map[string]struct{}) (bool, error) {
+	for pattern := range patterns {
+		pattern = filepath.ToSlash(pattern)
+		filePath := filepath.ToSlash(path)
+
+		if strings.HasSuffix(pattern, "/") {
+			if strings.HasPrefix(filePath, pattern) {
+				return true, nil
+			}
+			continue
+		}
+
+		match, err := filepath.Match(pattern, filePath)
+		if err != nil {
+			return false, err
+		}
+		if match {
+			return true, nil
+		}
+	}
+	return false, nil
+}
+
+// removeIgnoredFiles walks through the bundle directory and removes files or directories
+// that match the ignore patterns.
+func removeIgnoredFiles(bundleEnvPath string, patterns map[string]struct{}) error {
+	return filepath.Walk(bundleEnvPath, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+
+		relPath, err := filepath.Rel(bundleEnvPath, path)
+		if err != nil {
+			return err
+		}
+
+		relPathUnix := filepath.ToSlash(relPath)
+
+		ignore, err := shouldIgnore(relPathUnix, patterns)
+		if err != nil {
+			return err
+		}
+
+		if ignore {
+			if info.IsDir() {
+				err = os.RemoveAll(path)
+				if err != nil {
+					return fmt.Errorf("failed to remove directory %q: %v", path, err)
+				}
+				return filepath.SkipDir
+			} else {
+				err = os.Remove(path)
+				if err != nil {
+					return fmt.Errorf("failed to remove file %q: %v", path, err)
+				}
+			}
+		}
+		return nil
+	})
+}

cli/pack/ignore_test.go

@@ -0,0 +1,63 @@
+package pack
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+func TestPackIgnore(t *testing.T) {
+	projectDir, err := os.MkdirTemp("", "test")
+	if err != nil {
+		t.Fatalf("Failed to create temp directory: %v", err)
+	}
+	defer os.RemoveAll(projectDir)
+
+	packignoreFile := `
+		.txt
+		logs/
+		secret.key
+		temp*
+		*.bak
+	`
+	packignorePath := filepath.Join(projectDir, ".packignore")
+	err = os.WriteFile(packignorePath, []byte(packignoreFile), 0644)
+	if err != nil {
+		t.Fatalf("Failed to write .packignore file: %v", err)
+	}
+
+	patterns, err := readPackIgnore(projectDir)
+	if err != nil {
+		t.Fatalf("Failed to read .packignore: %v", err)
+	}
+
+	tests := []struct {
+		path     string
+		expected bool
+	}{
+		{"file.txt", true},
+		{"document.txt", true},
+		{"image.png", false},
+		{"logs/error.log", true},
+		{"logs/", true},
+		{"logs", false},
+		{"secret.key", true},
+		{"config.yaml", false},
+		{"tempfile", true},
+		{"temporary", true},
+		{"template", true},
+		{"data.bak", true},
+		{"backup.bak", true},
+		{"main.go", false},
+	}
+
+	for _, test := range tests {
+		ignore, err := shouldIgnore(test.path, patterns)
+		if err != nil {
+			t.Errorf("Error in shouldIgnore for path %q: %v", test.path, err)
+		}
+		if ignore != test.expected {
+			t.Errorf("For path %q, expected ignore=%v, got %v", test.path, test.expected, ignore)
+		}
+	}
+}

cli/pack/testdata/bundle_with_packignore/.packignore

@@ -0,0 +1,5 @@
+app2/testfile.txt
+instances.enabled/app
+modules
+app2/var
+app.lua

cli/pack/testdata/bundle_with_packignore/app.lua

@@ -0,0 +1,14 @@
+package = 'app2'
+version = 'scm-1'
+source  = {
+    url = '/dev/null',
+}
+-- Put any modules your app depends on here
+dependencies = {
+    'tarantool',
+    'lua >= 5.1',
+}
+build = {
+    type = 'none';
+}
+

cli/pack/testdata/bundle_with_packignore/app2/app2-scm-1.rockspec

@@ -0,0 +1,3 @@
+inst1:
+
+inst2: