Merge pull request #274 from zong-zhe/fix-win-bug

fix: fix symlink bug on windows

Author: Peefy

pkg/client/client.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"path/filepath"
 	"reflect"
+	"runtime"
 	"strings"
 
 	"github.com/BurntSushi/toml"
@@ -770,7 +771,7 @@ func (c *KpmClient) Download(dep *pkg.Dependency, localPath string) (*pkg.Depend
 		// Creating symbolic links in a global cache is not an optimal solution.
 		// This allows kclvm to locate the package by default.
 		// This feature is unstable and will be removed soon.
-		err = utils.CreateSymlink(dep.LocalFullPath, filepath.Join(filepath.Dir(localPath), dep.Name))
+		err = createDepRef(dep.LocalFullPath, filepath.Join(filepath.Dir(localPath), dep.Name))
 		if err != nil {
 			return nil, err
 		}
@@ -793,7 +794,7 @@ func (c *KpmClient) Download(dep *pkg.Dependency, localPath string) (*pkg.Depend
 		// Creating symbolic links in a global cache is not an optimal solution.
 		// This allows kclvm to locate the package by default.
 		// This feature is unstable and will be removed soon.
-		err = utils.CreateSymlink(dep.LocalFullPath, filepath.Join(filepath.Dir(localPath), dep.Name))
+		err = createDepRef(dep.LocalFullPath, filepath.Join(filepath.Dir(localPath), dep.Name))
 		if err != nil {
 			return nil, err
 		}
@@ -1361,3 +1362,14 @@ func check(dep pkg.Dependency, newDepPath string) bool {
 
 	return dep.Sum == sum
 }
+
+// createDepRef will create a dependency reference for the dependency saved on the local filesystem.
+// On the unix-like system, it will create a symbolic link.
+// On the windows system, it will create a junction.
+func createDepRef(depName, refName string) error {
+	if runtime.GOOS == "windows" {
+		return copy.Copy(depName, refName)
+	} else {
+		return utils.CreateSymlink(depName, refName)
+	}
+}

pkg/client/client_test.go

@@ -49,6 +49,13 @@ func TestDownloadOci(t *testing.T) {
 	err := os.MkdirAll(testPath, 0755)
 	assert.Equal(t, err, nil)
 
+	defer func() {
+		err := os.RemoveAll(getTestDir("download"))
+		if err != nil {
+			t.Errorf("Failed to remove directory: %v", err)
+		}
+	}()
+
 	depFromOci := pkg.Dependency{
 		Name:    "k8s",
 		Version: "1.27",
@@ -75,15 +82,39 @@ func TestDownloadOci(t *testing.T) {
 	assert.Equal(t, dep.LocalFullPath, testPath)
 
 	// Check whether the tar downloaded by `kpm add` has been deleted.
-	assert.Equal(t, utils.DirExists(filepath.Join(testPath, "k8s_1.27.tar")), false)
+	downloadPath := getTestDir("download")
+	assert.Equal(t, utils.DirExists(filepath.Join(downloadPath, "k8s_1.27.tar")), false)
+
+	assert.Equal(t, utils.DirExists(filepath.Join(downloadPath, "k8s_1.27")), true)
+	assert.Equal(t, utils.DirExists(filepath.Join(downloadPath, "k8s")), true)
+
+	// Check whether the reference and the dependency have the same hash.
+	hashDep, err := utils.HashDir(filepath.Join(downloadPath, "k8s_1.27"))
+	assert.Equal(t, err, nil)
+
+	depRefPath := filepath.Join(downloadPath, "k8s")
+	info, err := os.Lstat(depRefPath)
+	assert.Equal(t, err, nil)
+
+	if info.Mode()&os.ModeSymlink != 0 {
+		depRefPath, err = os.Readlink(depRefPath)
+		assert.Equal(t, err, nil)
+	}
 
-	err = os.RemoveAll(getTestDir("download"))
+	hashRef, err := utils.HashDir(depRefPath)
 	assert.Equal(t, err, nil)
+	assert.Equal(t, hashDep, hashRef)
 }
 
 // TestDownloadLatestOci tests the case that the version is empty.
 func TestDownloadLatestOci(t *testing.T) {
 	testPath := filepath.Join(getTestDir("download"), "a_random_name")
+	defer func() {
+		err := os.RemoveAll(getTestDir("download"))
+		if err != nil {
+			t.Errorf("Failed to remove directory: %v", err)
+		}
+	}()
 	err := os.MkdirAll(testPath, 0755)
 	assert.Equal(t, err, nil)
 	depFromOci := pkg.Dependency{
@@ -115,8 +146,24 @@ func TestDownloadLatestOci(t *testing.T) {
 	// Check whether the tar downloaded by `kpm add` has been deleted.
 	assert.Equal(t, utils.DirExists(filepath.Join(testPath, "helloworld_0.1.1.tar")), false)
 
-	err = os.RemoveAll(getTestDir("download"))
+	assert.Equal(t, utils.DirExists(filepath.Join(getTestDir("download"), "helloworld")), true)
+
+	// Check whether the reference and the dependency have the same hash.
+	hashDep, err := utils.HashDir(dep.LocalFullPath)
+	assert.Equal(t, err, nil)
+
+	depRefPath := filepath.Join(getTestDir("download"), "helloworld")
+	info, err := os.Lstat(depRefPath)
+	assert.Equal(t, err, nil)
+
+	if info.Mode()&os.ModeSymlink != 0 {
+		depRefPath, err = os.Readlink(depRefPath)
+		assert.Equal(t, err, nil)
+	}
+
+	hashRef, err := utils.HashDir(depRefPath)
 	assert.Equal(t, err, nil)
+	assert.Equal(t, hashDep, hashRef)
 }
 
 func TestDependencyGraph(t *testing.T) {

pkg/cmd/cmd_metadata.go

@@ -1,5 +1,5 @@
 // Copyright 2023 The KCL Authors. All rights reserved.
-// Deprecated: The entire contents of this file will be deprecated. 
+// Deprecated: The entire contents of this file will be deprecated.
 // Please use the kcl cli - https://github.com/kcl-lang/cli.
 
 package cmd

pkg/utils/utils_test.go

@@ -96,20 +96,6 @@ func TestUnTarDir(t *testing.T) {
 	_ = os.RemoveAll(testSrc)
 }
 
-func TestCreateSymbolLink(t *testing.T) {
-	testDir := getTestDir("test_link")
-	need_linked := filepath.Join(testDir, "need_be_linked_v1")
-	linkPath := filepath.Join(testDir, "linked")
-
-	_ = os.Remove(linkPath)
-	err := CreateSymlink(need_linked, linkPath)
-
-	linkTarget, _ := os.Readlink(linkPath)
-	assert.Equal(t, err, nil)
-	assert.Equal(t, linkTarget, need_linked)
-	_ = os.Remove(linkPath)
-}
-
 func TestDefaultKpmHome(t *testing.T) {
 	homeDir, _ := os.UserHomeDir()
 

pkg/utils/utils_unix_test.go

@@ -0,0 +1,26 @@
+//go:build linux || darwin
+// +build linux darwin
+
+package utils
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestCreateSymbolLink(t *testing.T) {
+	testDir := getTestDir("test_link")
+	need_linked := filepath.Join(testDir, "need_be_linked_v1")
+	linkPath := filepath.Join(testDir, "linked")
+
+	_ = os.Remove(linkPath)
+	err := CreateSymlink(need_linked, linkPath)
+
+	linkTarget, _ := os.Readlink(linkPath)
+	assert.Equal(t, err, nil)
+	assert.Equal(t, linkTarget, need_linked)
+	_ = os.Remove(linkPath)
+}