Feat: add api 'WithExternalPkg'. (#113)

* Feat: add api 'WithExternalPkg'.

* fix: fix test on windows.

* fix: add comments for WithExternalPkgs.

go.mod

@@ -16,7 +16,7 @@ require (
 	google.golang.org/grpc v1.53.0
 	google.golang.org/protobuf v1.28.1
 	gopkg.in/yaml.v3 v3.0.1
-	kusionstack.io/kclvm-artifact-go v0.5.0-alpha.2
+	kusionstack.io/kclvm-artifact-go v0.5.0-alpha.3
 )
 
 require (

go.sum

@@ -57,5 +57,5 @@ gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-kusionstack.io/kclvm-artifact-go v0.5.0-alpha.2 h1:D+R75S7pQlsIg8UTfDi1u+NHdpbd1ot9tLYIfNpN/qQ=
-kusionstack.io/kclvm-artifact-go v0.5.0-alpha.2/go.mod h1:WI+NvDeMqu1AduJT119X7q8KQdYmKfv4Nq4OvZ1tAsI=
+kusionstack.io/kclvm-artifact-go v0.5.0-alpha.3 h1:sirVOSHHmkgWdBY74luH9jNucL6ebF9L0KUTJ/r3b5Q=
+kusionstack.io/kclvm-artifact-go v0.5.0-alpha.3/go.mod h1:WI+NvDeMqu1AduJT119X7q8KQdYmKfv4Nq4OvZ1tAsI=

kclvm.go

@@ -78,6 +78,9 @@ func RunFiles(paths []string, opts ...Option) (*KCLResultList, error) {
 // WithCode returns a Option which hold a kcl source code list.
 func WithCode(codes ...string) Option { return kcl.WithCode(codes...) }
 
+// WithExternalPkgs returns a Option which hold a external package list.
+func WithExternalPkgs(externalPkgs ...string) Option { return kcl.WithExternalPkgs(externalPkgs...) }
+
 // WithKFilenames returns a Option which hold a filenames list.
 func WithKFilenames(filenames ...string) Option { return kcl.WithKFilenames(filenames...) }
 

kclvm_test.go

@@ -5,6 +5,7 @@ package kclvm_test
 import (
 	"flag"
 	"os"
+	"path/filepath"
 	"reflect"
 	"sort"
 	"strconv"
@@ -289,3 +290,17 @@ func TestListDepFiles(t *testing.T) {
 		t.Fatalf("\nexpect = %v\ngot    = %v", expect, files)
 	}
 }
+
+func TestWithExternalpkg(t *testing.T) {
+	absPath1, err := filepath.Abs("./testdata_external/external_1/")
+	assert2.Equal(t, nil, err)
+	absPath2, err := filepath.Abs("./testdata_external/external_2/")
+	assert2.Equal(t, nil, err)
+	opt := kclvm.WithExternalPkgs("external_1="+absPath1, "external_2="+absPath2)
+	result, err := kclvm.Run("./testdata/import-external/main.k", opt)
+	if err != nil {
+		t.Fatal(err)
+	}
+	assert2.Equal(t, "[{\"a\": \"Hello External_1 World!\", \"b\": \"Hello External_2 World!\"}]", result.GetRawJsonResult())
+	assert2.Equal(t, "a: Hello External_1 World!\nb: Hello External_2 World!", result.GetRawYamlResult())
+}

pkg/kcl/opt.go

@@ -18,7 +18,8 @@ type Option struct {
 	Err error
 }
 
-func newOption() *Option {
+// NewOption returns a new Option.
+func NewOption() *Option {
 	return &Option{
 		ExecProgram_Args: new(gpyrpc.ExecProgram_Args),
 	}
@@ -47,7 +48,7 @@ func ParseArgs(pathList []string, opts ...Option) (Option, error) {
 		}
 	}
 
-	args := newOption().merge(opts...).merge(tmpOptList...)
+	args := NewOption().Merge(opts...).Merge(tmpOptList...)
 	if err := args.Err; err != nil {
 		return Option{}, err
 	}
@@ -72,23 +73,40 @@ func ParseArgs(pathList []string, opts ...Option) (Option, error) {
 }
 
 func WithWorkDir(s string) Option {
-	var opt = newOption()
+	var opt = NewOption()
 	opt.WorkDir = s
 	return *opt
 }
 
 func WithKFilenames(filenames ...string) Option {
-	var opt = newOption()
+	var opt = NewOption()
 	opt.KFilenameList = filenames
 	return *opt
 }
 
 func WithCode(codes ...string) Option {
-	var opt = newOption()
+	var opt = NewOption()
 	opt.KCodeList = codes
 	return *opt
 }
 
+// kcl -E aaa=/xx/xxx/aaa main.k
+func WithExternalPkgs(key_value_list ...string) Option {
+	var args []*gpyrpc.CmdExternalPkgSpec
+	for _, kv := range key_value_list {
+		if idx := strings.Index(kv, "="); idx > 0 {
+			name, value := kv[:idx], kv[idx+1:]
+			args = append(args, &gpyrpc.CmdExternalPkgSpec{
+				PkgName: name,
+				PkgPath: value,
+			})
+		}
+	}
+	var opt = NewOption()
+	opt.ExternalPkgs = args
+	return *opt
+}
+
 // kcl -D aa=11 -D bb=22 main.k
 func WithOptions(key_value_list ...string) Option {
 	var args []*gpyrpc.CmdArgSpec
@@ -101,7 +119,7 @@ func WithOptions(key_value_list ...string) Option {
 			})
 		}
 	}
-	var opt = newOption()
+	var opt = NewOption()
 	opt.Args = args
 	return *opt
 }
@@ -123,13 +141,13 @@ func WithOverrides(override_list ...string) Option {
 			})
 		}
 	}
-	var opt = newOption()
+	var opt = NewOption()
 	opt.Overrides = overrides
 	return *opt
 }
 
 func WithPrintOverridesAST(printOverrideAst bool) Option {
-	var opt = newOption()
+	var opt = NewOption()
 	opt.PrintOverrideAst = printOverrideAst
 	return *opt
 }
@@ -143,25 +161,27 @@ func WithSettings(filename string) Option {
 	if err != nil {
 		return Option{Err: fmt.Errorf("kcl.WithSettings(%q): %v", filename, err)}
 	}
-	var opt = newOption()
+	var opt = NewOption()
 	opt.ExecProgram_Args = f.To_ExecProgram_Args()
 	return *opt
 }
 
-// kcl -n
+// kcl -n --disable_none
 func WithDisableNone(disableNone bool) Option {
-	var opt = newOption()
+	var opt = NewOption()
 	opt.DisableNone = disableNone
 	return *opt
 }
 
+// kcl -k --sort_keys
 func WithSortKeys(sortKeys bool) Option {
-	var opt = newOption()
+	var opt = NewOption()
 	opt.SortKeys = sortKeys
 	return *opt
 }
 
-func (p *Option) merge(opts ...Option) *Option {
+// Merge will merge all options into one.
+func (p *Option) Merge(opts ...Option) *Option {
 	for _, opt := range opts {
 		if opt.ExecProgram_Args == nil {
 			continue
@@ -217,6 +237,9 @@ func (p *Option) merge(opts ...Option) *Option {
 		if opt.IncludeSchemaTypePath {
 			p.IncludeSchemaTypePath = opt.IncludeSchemaTypePath
 		}
+		if opt.ExternalPkgs != nil {
+			p.ExternalPkgs = append(p.ExternalPkgs, opt.ExternalPkgs...)
+		}
 	}
 	return p
 }

pkg/path/lazypath_windows.go

@@ -15,6 +15,15 @@
 
 package path
 
-import "os"
+import (
+	"go/build"
+	"os"
+)
 
-func libHome() string { return os.Getenv("APPDATA") }
+func libHome() string {
+	gopath := os.Getenv("GOPATH")
+	if gopath == "" {
+		gopath = build.Default.GOPATH
+	}
+	return gopath
+}