Delete files by filters

Author: cardil

pkg/files/delete_by_filters.go

@@ -0,0 +1,34 @@
+package files
+
+import (
+	"io/fs"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/openshift-knative/deviate/pkg/errors"
+)
+
+// ErrCantDeleteFiles when cannot delete files.
+var ErrCantDeleteFiles = errors.New("cannot delete files")
+
+// DeleteFiles will delete all matching files starting at given root directory.
+func (f Filters) DeleteFiles(root string) error {
+	matcher := f.Matcher()
+	err := filepath.WalkDir(root, func(pth string, de fs.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+		if de.IsDir() {
+			// continue
+			return nil
+		}
+		pth = filepath.ToSlash(pth)
+		relPath := strings.TrimPrefix(pth, root+"/")
+		if matcher.Matches(relPath) {
+			return os.Remove(pth)
+		}
+		return nil
+	})
+	return errors.Wrap(err, ErrCantDeleteFiles)
+}

pkg/files/delete_by_filters_test.go

@@ -0,0 +1,64 @@
+package files_test
+
+import (
+	"os"
+	"path"
+	"slices"
+	"testing"
+
+	gitv5 "github.com/go-git/go-git/v5"
+	"github.com/openshift-knative/deviate/pkg/files"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestDeleteByFilters(t *testing.T) {
+	root := t.TempDir()
+	paths := []string{
+		"a.txt",
+		"a/b.txt",
+		"a/b/c.md",
+		"a/b/c.txt",
+		"a/b/d.md",
+		"a/b/d.txt",
+		"a/b/e/f.md",
+		"a/b/e/f.txt",
+		"a/c.txt",
+		"c.txt",
+	}
+	for _, file := range paths {
+		fp := path.Join(root, file)
+		dir := path.Dir(fp)
+		require.NoError(t, os.MkdirAll(dir, 0o755))
+		require.NoError(t, os.WriteFile(fp, []byte("test"), 0o600))
+	}
+
+	filters := files.Filters{
+		Include: []string{"a/b/**"},
+		Exclude: []string{"**.txt"},
+	}
+	require.NoError(t, filters.DeleteFiles(root))
+
+	repo, err := gitv5.PlainInit(root, false)
+	require.NoError(t, err)
+	wt, err := repo.Worktree()
+	require.NoError(t, err)
+
+	st, serr := wt.Status()
+	require.NoError(t, serr)
+	got := make([]string, 0, len(st))
+	for f := range st {
+		got = append(got, f)
+	}
+	slices.Sort(got)
+	want := []string{
+		"a.txt",
+		"a/b.txt",
+		"a/b/c.txt",
+		"a/b/d.txt",
+		"a/b/e/f.txt",
+		"a/c.txt",
+		"c.txt",
+	}
+	assert.Equal(t, want, got)
+}

pkg/files/filters.go

@@ -35,6 +35,7 @@ func (m Matcher) Matches(pth string) bool {
 	for _, pattern := range m.Include {
 		if pattern.Match(pth) {
 			result = true
+			break
 		}
 	}
 	if !result {

pkg/sync/remove_unwanted_upstream_files.go

@@ -1,26 +1,13 @@
 package sync
 
 import (
-	"io/fs"
-	"os"
-	"path"
-	"path/filepath"
-
 	"github.com/openshift-knative/deviate/pkg/errors"
 )
 
 func (o Operation) removeUnwantedUpstreamFiles() error {
 	o.Println("- Remove unwanted upstream files")
-	matcher := o.Config.DeleteFromUpstream.Matcher()
 
-	return errors.Wrap(filepath.WalkDir(o.State.Project.Path, func(pth string, _ fs.DirEntry, err error) error {
-		if err != nil {
-			return err
-		}
-		if matcher.Matches(pth) {
-			fp := path.Join(o.State.Project.Path, pth)
-			return os.RemoveAll(fp)
-		}
-		return nil
-	}), ErrSyncFailed)
+	return errors.Wrap(
+		o.Config.DeleteFromUpstream.DeleteFiles(o.State.Project.Path),
+		ErrSyncFailed)
 }