Merge pull request #233 from zong-zhe/feat-run-api

feat: optimize api 'RunWithOpts' and disable some output with '--no_sum_check'
kcl-lang · Dec 22, 2023 · 092d3db · 092d3db
2 parents f2d9f9b + ebd4328
commit 092d3db
Show file tree

Hide file tree

Showing 4 changed files with 100 additions and 42 deletions.
diff --git a/pkg/client/client.go b/pkg/client/client.go
@@ -178,27 +178,31 @@ func (c *KpmClient) ResolvePkgDepsMetadata(kclPkg *pkg.KclPkg, update bool) erro
 		searchPath = c.homePath
 	}
 
-	// alian the dependencies between kcl.mod and kcl.mod.lock
-	// clean the dependencies in kcl.mod.lock which not in kcl.mod
-	// clean the dependencies in kcl.mod.lock and kcl.mod which have different version
-	for name, dep := range kclPkg.Dependencies.Deps {
-		modDep, ok := kclPkg.ModFile.Dependencies.Deps[name]
-		if !ok || !dep.WithTheSameVersion(modDep) {
-			reporter.ReportMsgTo(
-				fmt.Sprintf("removing '%s' with version '%s'", name, dep.Version),
-				c.logWriter,
-			)
-			delete(kclPkg.Dependencies.Deps, name)
+	// If under the mode of '--no_sum_check', the checksum of the package will not be checked.
+	// There is no kcl.mod.lock, and the dependencies in kcl.mod and kcl.mod.lock do not need to be aligned.
+	if !c.noSumCheck {
+		// alian the dependencies between kcl.mod and kcl.mod.lock
+		// clean the dependencies in kcl.mod.lock which not in kcl.mod
+		// clean the dependencies in kcl.mod.lock and kcl.mod which have different version
+		for name, dep := range kclPkg.Dependencies.Deps {
+			modDep, ok := kclPkg.ModFile.Dependencies.Deps[name]
+			if !ok || !dep.WithTheSameVersion(modDep) {
+				reporter.ReportMsgTo(
+					fmt.Sprintf("removing '%s' with version '%s'", name, dep.Version),
+					c.logWriter,
+				)
+				delete(kclPkg.Dependencies.Deps, name)
+			}
 		}
-	}
-	// add the dependencies in kcl.mod which not in kcl.mod.lock
-	for name, d := range kclPkg.ModFile.Dependencies.Deps {
-		if _, ok := kclPkg.Dependencies.Deps[name]; !ok {
-			reporter.ReportMsgTo(
-				fmt.Sprintf("adding '%s' with version '%s'", name, d.Version),
-				c.logWriter,
-			)
-			kclPkg.Dependencies.Deps[name] = d
+		// add the dependencies in kcl.mod which not in kcl.mod.lock
+		for name, d := range kclPkg.ModFile.Dependencies.Deps {
+			if _, ok := kclPkg.Dependencies.Deps[name]; !ok {
+				reporter.ReportMsgTo(
+					fmt.Sprintf("adding '%s' with version '%s'", name, d.Version),
+					c.logWriter,
+				)
+				kclPkg.Dependencies.Deps[name] = d
+			}
 		}
 	}
 

diff --git a/pkg/client/client_test.go b/pkg/client/client_test.go
@@ -2,6 +2,7 @@ package client
 
 import (
 	"archive/tar"
+	"bytes"
 	"encoding/json"
 	"fmt"
 	"io"
@@ -234,15 +235,15 @@ func TestVendorDeps(t *testing.T) {
 	kcl2Sum, _ := utils.HashDir(filepath.Join(kpm_home, "kcl2"))
 
 	depKcl1 := pkg.Dependency{
-		Name:      "kcl1",
-		FullName:  "kcl1",
-		Sum:       kcl1Sum,
+		Name:     "kcl1",
+		FullName: "kcl1",
+		Sum:      kcl1Sum,
 	}
 
 	depKcl2 := pkg.Dependency{
-		Name:      "kcl2",
-		FullName:  "kcl2",
-		Sum:       kcl2Sum,
+		Name:     "kcl2",
+		FullName: "kcl2",
+		Sum:      kcl2Sum,
 	}
 
 	kclPkg := pkg.KclPkg{
@@ -316,15 +317,15 @@ func TestResolveDepsVendorMode(t *testing.T) {
 	kcl2Sum, _ := utils.HashDir(filepath.Join(kpm_home, "kcl2"))
 
 	depKcl1 := pkg.Dependency{
-		Name:      "kcl1",
-		FullName:  "kcl1",
-		Sum:       kcl1Sum,
+		Name:     "kcl1",
+		FullName: "kcl1",
+		Sum:      kcl1Sum,
 	}
 
 	depKcl2 := pkg.Dependency{
-		Name:      "kcl2",
-		FullName:  "kcl2",
-		Sum:       kcl2Sum,
+		Name:     "kcl2",
+		FullName: "kcl2",
+		Sum:      kcl2Sum,
 	}
 
 	kclPkg := pkg.KclPkg{
@@ -382,15 +383,15 @@ func TestCompileWithEntryFile(t *testing.T) {
 
 	kcl1Sum, _ := utils.HashDir(filepath.Join(kpm_home, "kcl1"))
 	depKcl1 := pkg.Dependency{
-		Name:      "kcl1",
-		FullName:  "kcl1",
-		Sum:       kcl1Sum,
+		Name:     "kcl1",
+		FullName: "kcl1",
+		Sum:      kcl1Sum,
 	}
 	kcl2Sum, _ := utils.HashDir(filepath.Join(kpm_home, "kcl2"))
 	depKcl2 := pkg.Dependency{
-		Name:      "kcl2",
-		FullName:  "kcl2",
-		Sum:       kcl2Sum,
+		Name:     "kcl2",
+		FullName: "kcl2",
+		Sum:      kcl2Sum,
 	}
 
 	kclPkg := pkg.KclPkg{
@@ -845,17 +846,20 @@ func TestRunWithNoSumCheck(t *testing.T) {
 
 func TestUpdateWithNoSumCheck(t *testing.T) {
 	pkgPath := getTestDir("test_update_no_sum_check")
-
 	kpmcli, err := NewKpmClient()
 	assert.Equal(t, err, nil)
 
+	var buf bytes.Buffer
+	kpmcli.SetLogWriter(&buf)
+
 	kpmcli.SetNoSumCheck(true)
 	kclPkg, err := kpmcli.LoadPkgFromPath(pkgPath)
 	assert.Equal(t, err, nil)
 
 	err = kpmcli.UpdateDeps(kclPkg)
 	assert.Equal(t, err, nil)
 	assert.Equal(t, utils.DirExists(filepath.Join(pkgPath, "kcl.mod.lock")), false)
+	assert.Equal(t, buf.String(), "")
 
 	kpmcli.SetNoSumCheck(false)
 	kclPkg, err = kpmcli.LoadPkgFromPath(pkgPath)
@@ -864,6 +868,7 @@ func TestUpdateWithNoSumCheck(t *testing.T) {
 	err = kpmcli.UpdateDeps(kclPkg)
 	assert.Equal(t, err, nil)
 	assert.Equal(t, utils.DirExists(filepath.Join(pkgPath, "kcl.mod.lock")), true)
+	assert.Equal(t, buf.String(), "adding 'helloworld' with version '0.1.1'\ndownloading 'kcl-lang/helloworld:0.1.1' from 'ghcr.io/kcl-lang/helloworld:0.1.1'\n")
 
 	defer func() {
 		_ = os.Remove(filepath.Join(pkgPath, "kcl.mod.lock"))

diff --git a/pkg/opt/opt.go b/pkg/opt/opt.go
@@ -30,10 +30,23 @@ func MergeOptions(opts ...CompileOptions) CompileOptions {
 	var opt = DefaultCompileOptions()
 	for _, o := range opts {
 		opt.Merge(*o.Option)
-		opt.isVendor = o.isVendor
-		opt.hasSettingsYaml = o.hasSettingsYaml
+		if o.writer != nil {
+			opt.writer = o.writer
+		}
+
+		if o.isVendor {
+			opt.isVendor = o.isVendor
+		}
+
+		if o.hasSettingsYaml {
+			opt.hasSettingsYaml = o.hasSettingsYaml
+		}
+
+		if o.noSumCheck {
+			opt.noSumCheck = o.noSumCheck
+		}
+
 		opt.entries = append(opt.entries, o.entries...)
-		opt.noSumCheck = o.noSumCheck
 	}
 	return *opt
 }

diff --git a/pkg/opt/opt_test.go b/pkg/opt/opt_test.go
@@ -20,3 +20,39 @@ func TestWorkDirAsPkgPath(t *testing.T) {
 	opts.SetEntries([]string{"override.k"})
 	assert.Equal(t, opts.Entries(), []string{"override.k"})
 }
+
+func TestCompilationMerge(t *testing.T) {
+	opts := MergeOptions(
+		WithEntries([]string{"test.k"}),
+	)
+	assert.Equal(t, opts.Entries(), []string{"test.k"})
+	assert.Equal(t, opts.NoSumCheck(), false)
+	assert.Equal(t, opts.IsVendor(), false)
+
+	opts = MergeOptions(
+		opts,
+		WithNoSumCheck(true),
+	)
+
+	assert.Equal(t, opts.Entries(), []string{"test.k"})
+	assert.Equal(t, opts.NoSumCheck(), true)
+	assert.Equal(t, opts.IsVendor(), false)
+
+	opts = MergeOptions(
+		opts,
+		WithVendor(true),
+	)
+
+	assert.Equal(t, opts.Entries(), []string{"test.k"})
+	assert.Equal(t, opts.NoSumCheck(), true)
+	assert.Equal(t, opts.IsVendor(), true)
+
+	opts = MergeOptions(
+		opts,
+		WithEntries([]string{"test1.k"}),
+	)
+
+	assert.Equal(t, opts.Entries(), []string{"test.k", "test1.k"})
+	assert.Equal(t, opts.NoSumCheck(), true)
+	assert.Equal(t, opts.IsVendor(), true)
+}