Merge pull request #58 from Peefy/refactor-source-field

refactor: source field to impl better local package running

.gitignore

@@ -15,3 +15,4 @@
 vendor/
 .kclvm
 .DS_store
+kcl.mod.lock

pkg/edit/bootstrap.go

@@ -9,7 +9,7 @@ import (
 	"strings"
 
 	"kcl-lang.io/cli/pkg/options"
-	src "kcl-lang.io/krm-kcl/pkg/source"
+	"kcl-lang.io/krm-kcl/pkg/source"
 
 	"sigs.k8s.io/kustomize/kyaml/errors"
 	"sigs.k8s.io/kustomize/kyaml/kio"
@@ -36,7 +36,7 @@ const (
 // A pointer to []*yaml.RNode objects that represent the output YAML objects of the KCL program.
 func RunKCL(name, source string, resourceList *yaml.RNode) ([]*yaml.RNode, error) {
 	// 1. Construct KCL code from source.
-	file, err := SourceToTempFile(source)
+	entry, err := SourceToTempEntry(source)
 	if err != nil {
 		return nil, errors.Wrap(err)
 	}
@@ -47,7 +47,7 @@ func RunKCL(name, source string, resourceList *yaml.RNode) ([]*yaml.RNode, error
 	}
 	// 3. Run the KCL code.
 	result := bytes.NewBuffer([]byte{})
-	opts.Entries = []string{file}
+	opts.Entries = []string{entry}
 	opts.Writer = result
 	err = opts.Run()
 	if err != nil {
@@ -77,28 +77,30 @@ func ToKCLValueString(value *yaml.RNode, defaultValue string) (string, error) {
 	return string(jsonString), nil
 }
 
-// SourceToTempFile convert source to a temp KCL file.
-func SourceToTempFile(source string) (string, error) {
-	// 1. Construct KCL code from source.
-	localeSource, err := src.LocaleSource(source)
-	if err != nil {
-		return "", errors.Wrap(err)
-	}
-	if src.IsOCI(source) {
-		return source, nil
-	}
-	// Create temp files.
-	tmpDir, err := os.MkdirTemp("", "sandbox")
-	if err != nil {
-		return "", fmt.Errorf("error creating temp directory: %v", err)
-	}
-	// Write kcl code in the temp file.
-	file := filepath.Join(tmpDir, "prog.k")
-	err = os.WriteFile(file, []byte(localeSource), 0666)
-	if err != nil {
-		return "", errors.Wrap(err)
+// SourceToTempEntry convert source to a temp KCL file.
+func SourceToTempEntry(src string) (string, error) {
+	if source.IsOCI(src) {
+		// Read code from a OCI source.
+		return src, nil
+	} else if source.IsLocal(src) {
+		return src, nil
+	} else if source.IsRemoteUrl(src) || source.IsGit(src) || source.IsVCSDomain(src) {
+		// Read code from local path or a remote url.
+		return source.ReadThroughGetter(src)
+	} else {
+		// May be a inline code source.
+		tmpDir, err := os.MkdirTemp("", "sandbox")
+		if err != nil {
+			return "", fmt.Errorf("error creating temp directory: %v", err)
+		}
+		// Write kcl code in the temp file.
+		file := filepath.Join(tmpDir, "prog.k")
+		err = os.WriteFile(file, []byte(src), 0666)
+		if err != nil {
+			return "", errors.Wrap(err)
+		}
+		return file, nil
 	}
-	return file, nil
 }
 
 func constructOptions(resourceList *yaml.RNode) (*options.RunOptions, error) {

pkg/options/testdata/set-annotation.k

@@ -17,7 +17,7 @@ schema KCLRunSpec:
 
 resource: ResourceList = option("resource_list")
 # Use `k = v` to override existing annotations
-annotations = {"${k}" = v for k, v in option("params").annotations or {}}
+annotations = {"${k}" = v for k, v in option("params")?.annotations or {}}
 items = [item | {
     metadata.annotations: annotations
-} for item in option("items")]
+} for item in option("items") or []]

pkg/source/getter.go

@@ -26,7 +26,6 @@ func ReadThroughGetter(src string) (string, error) {
 	if err != nil {
 		return "", fmt.Errorf("error creating temp file: %v", err)
 	}
-	defer os.RemoveAll(tmpDir)
 
 	// Build the client
 	client := &getter.Client{
@@ -64,5 +63,5 @@ func ReadThroughGetter(src string) (string, error) {
 	}
 
 	// 5. Read source from the temp directory
-	return GetSourceFromDir(tmpDir)
+	return tmpDir, nil
 }

pkg/source/git.go

@@ -18,7 +18,7 @@ const (
 
 // IsGit determines whether or not a source is to be treated as a git source.
 func IsGit(src string) bool {
-	return strings.HasPrefix(src, fmt.Sprintf("%s://", GitScheme))
+	return strings.HasPrefix(src, fmt.Sprintf("%s::", GitScheme))
 }
 
 // IsVCSDomain determines whether or not a source is to be treated as a VCS source.

pkg/source/local.go

@@ -3,9 +3,6 @@ package source
 import (
 	"path/filepath"
 	"strings"
-
-	"kcl-lang.io/kpm/pkg/reporter"
-	"kcl-lang.io/kpm/pkg/runner"
 )
 
 // IsLocal determines whether or not a source is to be treated as a local path.
@@ -15,25 +12,3 @@ func IsLocal(src string) bool {
 	}
 	return false
 }
-
-// ReadFromLocalSource reads source code from a local file system path source.
-//
-// Parameters:
-// - src: a local file system path.
-//
-// Return:
-// A string containing the source code, and an error if any.
-func ReadFromLocalSource(src string) (string, error) {
-	// Find the mod root
-
-	modpath, kpmerr := runner.FindModRootFrom(src)
-	if kpmerr != nil {
-		if kpmerr.Type() != reporter.KclModNotFound {
-			return "", kpmerr
-		} else {
-			modpath = filepath.Dir(src)
-		}
-	}
-
-	return GetSourceFromDir(modpath)
-}

pkg/source/oci.go

@@ -8,22 +8,9 @@ import (
 const (
 	// OCIScheme is the URL scheme for OCI-based requests
 	OCIScheme = "oci"
-	// TarPattern is the wildcard pattern for tar files.
-	TarPattern = "*.tar"
 )
 
 // IsOCI determines whether or not a URL is to be treated as an OCI URL
 func IsOCI(src string) bool {
 	return strings.HasPrefix(src, fmt.Sprintf("%s://", OCIScheme))
 }
-
-// ReadFromOCISource reads source code from an OCI (Open Container Initiative) source.
-//
-// Parameters:
-// - src: a string containing the OCI source URL.
-//
-// Return:
-// A string containing the source code, and an error if any.
-func ReadFromOCISource(src string) (string, error) {
-	return src, nil
-}

tests/mutation/set-annotations/main.k

@@ -1,9 +1,9 @@
 items = lambda {
-    resource = option("resource_list")
-    items = resource.items
-    params = option("params")
+    resource = option("resource_list") or {}
+    items = resource.items or []
+    params = option("params") or {}
     # Use `k = v` to override existing annotations
-    annotations = {k = v for k, v in params.annotations}
+    annotations = {k = v for k, v in params.annotations or {}}
     [item | {
         metadata.annotations: annotations
     } for item in items]