add a filter to pkg/zip to extract only necessary binary (#182)

Signed-off-by: Denis Vaumoron <dvaumoron@gmail.com>
tofuutils · Jun 22, 2024 · 843e6bc · 843e6bc
1 parent e57de0e
commit 843e6bc
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 105 deletions.
diff --git a/pkg/check/binary/check.go b/pkg/check/binary/check.go
diff --git a/pkg/check/binary/testdata/test.bin b/pkg/check/binary/testdata/test.bin
diff --git a/pkg/check/binary/testdata/test.txt b/pkg/check/binary/testdata/test.txt
diff --git a/pkg/check/binary/check_test.go → pkg/pathfilter/pathfilter.go b/pkg/check/binary/check_test.go → pkg/pathfilter/pathfilter.go
@@ -16,34 +16,18 @@
  *
  */
 
-package bincheck_test
+package pathfilter
 
-import (
-	"testing"
+import "strings"
 
-	bincheck "github.com/tofuutils/tenv/v2/pkg/check/binary"
-)
+// Handle '/' and '\' separated path.
+func NameEqual(targetName string) func(string) bool {
+	return func(path string) bool {
+		separatorIndex := strings.LastIndexByte(path, '/')
+		if separatorIndex == -1 {
+			separatorIndex = strings.LastIndexByte(path, '\\')
+		}
 
-func TestTextFileCheck(t *testing.T) {
-	t.Parallel()
-
-	isBinary, err := bincheck.Check("testdata/test.txt")
-	if err != nil {
-		t.Fatalf("Error checking non-binary file: %v", err)
-	}
-	if isBinary {
-		t.Errorf("Expected non-binary file, got binary")
-	}
-}
-
-func TestBinaryFileCheck(t *testing.T) {
-	t.Parallel()
-
-	isBinary, err := bincheck.Check("testdata/test.bin")
-	if err != nil {
-		t.Fatalf("Error checking non-binary file: %v", err)
-	}
-	if !isBinary {
-		t.Errorf("Expected binary file, got non-binary")
+		return path[separatorIndex+1:] == targetName
 	}
 }
diff --git a/pkg/zip/zip.go b/pkg/zip/zip.go
@@ -26,12 +26,10 @@ import (
 	"os"
 	"path/filepath"
 	"strings"
-
-	bincheck "github.com/tofuutils/tenv/v2/pkg/check/binary"
 )
 
 // ensure the directory exists with a MkdirAll call.
-func UnzipToDir(dataZip []byte, dirPath string) error {
+func UnzipToDir(dataZip []byte, dirPath string, filter func(string) bool) error {
 	err := os.MkdirAll(dirPath, 0o755)
 	if err != nil {
 		return err
@@ -44,36 +42,16 @@ func UnzipToDir(dataZip []byte, dirPath string) error {
 	}
 
 	for _, file := range zipReader.File {
-		if err = copyZipFileToDir(file, dirPath); err != nil {
+		if err = copyZipFileToDir(file, dirPath, filter); err != nil {
 			return err
 		}
-
-		files, err := os.ReadDir(dirPath)
-		if err != nil {
-			return err
-		}
-
-		for _, file := range files {
-			filePath := filepath.Join(dirPath, file.Name())
-
-			isBinary, err := bincheck.Check(filePath)
-			if err != nil {
-				return err
-			}
-
-			if !isBinary {
-				if err = os.Remove(filePath); err != nil {
-					return err
-				}
-			}
-		}
 	}
 
 	return nil
 }
 
 // a separate function allows deferred Close to execute earlier.
-func copyZipFileToDir(zipFile *zip.File, dirPath string) error {
+func copyZipFileToDir(zipFile *zip.File, dirPath string, filter func(string) bool) error {
 	destPath, err := sanitizeArchivePath(dirPath, zipFile.Name)
 	if err != nil {
 		return err
@@ -95,6 +73,10 @@ func copyZipFileToDir(zipFile *zip.File, dirPath string) error {
 		return err
 	}
 
+	if !filter(destPath) {
+		return nil
+	}
+
 	return os.WriteFile(destPath, data, zipFile.Mode())
 }
 

diff --git a/versionmanager/retriever/terraform/terraformretriever.go b/versionmanager/retriever/terraform/terraformretriever.go
@@ -34,6 +34,8 @@ import (
 	pgpcheck "github.com/tofuutils/tenv/v2/pkg/check/pgp"
 	sha256check "github.com/tofuutils/tenv/v2/pkg/check/sha256"
 	"github.com/tofuutils/tenv/v2/pkg/download"
+	"github.com/tofuutils/tenv/v2/pkg/pathfilter"
+	"github.com/tofuutils/tenv/v2/pkg/winbin"
 	"github.com/tofuutils/tenv/v2/pkg/zip"
 	htmlretriever "github.com/tofuutils/tenv/v2/versionmanager/retriever/html"
 )
@@ -130,7 +132,7 @@ func (r TerraformRetriever) InstallRelease(version string, targetPath string) er
 		return err
 	}
 
-	return zip.UnzipToDir(data, targetPath)
+	return zip.UnzipToDir(data, targetPath, pathfilter.NameEqual(winbin.GetBinaryName(config.TerraformName)))
 }
 
 func (r TerraformRetriever) ListReleases() ([]string, error) {

diff --git a/versionmanager/retriever/tofu/tofuretriever.go b/versionmanager/retriever/tofu/tofuretriever.go
@@ -34,6 +34,8 @@ import (
 	sha256check "github.com/tofuutils/tenv/v2/pkg/check/sha256"
 	"github.com/tofuutils/tenv/v2/pkg/download"
 	"github.com/tofuutils/tenv/v2/pkg/github"
+	"github.com/tofuutils/tenv/v2/pkg/pathfilter"
+	"github.com/tofuutils/tenv/v2/pkg/winbin"
 	"github.com/tofuutils/tenv/v2/pkg/zip"
 	htmlretriever "github.com/tofuutils/tenv/v2/versionmanager/retriever/html"
 )
@@ -114,7 +116,7 @@ func (r TofuRetriever) InstallRelease(versionStr string, targetPath string) erro
 		return err
 	}
 
-	return zip.UnzipToDir(data, targetPath)
+	return zip.UnzipToDir(data, targetPath, pathfilter.NameEqual(winbin.GetBinaryName(config.TofuName)))
 }
 
 func (r TofuRetriever) ListReleases() ([]string, error) {