fix: defensive programming has been added to api 'GetEntries()' to re…

…duce NPE (#238) Signed-off-by: zongz <zongzhe1024@163.com>
kcl-lang · Dec 25, 2023 · 7aa8c2c · 7aa8c2c
1 parent 0796c98
commit 7aa8c2c
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 4 deletions.
diff --git a/pkg/api/kpm_pkg.go b/pkg/api/kpm_pkg.go
@@ -93,7 +93,7 @@ func (pkg *KclPackage) GetPkgHomePath() string {
 }
 
 // GetPkgProfile returns the profile of the package.
-func (pkg *KclPackage) GetPkgProfile() pkg.Profile {
+func (pkg *KclPackage) GetPkgProfile() *pkg.Profile {
 	return pkg.pkg.GetPkgProfile()
 }
 

diff --git a/pkg/api/kpm_pkg_test.go b/pkg/api/kpm_pkg_test.go
@@ -5,7 +5,9 @@ import (
 	"testing"
 
 	"gotest.tools/v3/assert"
+	"kcl-lang.io/kcl-go/pkg/kcl"
 	"kcl-lang.io/kpm/pkg/client"
+	"kcl-lang.io/kpm/pkg/opt"
 )
 
 func TestPackageApi(t *testing.T) {
@@ -169,3 +171,25 @@ func TestGetSchemaTypeUnderEmptyDir(t *testing.T) {
 	assert.Equal(t, schemas[filepath.Join(".")]["SchemaInMain"].Type, "schema")
 	assert.Equal(t, schemas[filepath.Join(".")]["SchemaInMain"].SchemaName, "SchemaInMain")
 }
+
+func TestGetEntries(t *testing.T) {
+	testPath := getTestDir("test_get_entries")
+	pkgPath := filepath.Join(testPath, "no_entries")
+	pkg, err := GetKclPackage(pkgPath)
+	assert.Equal(t, err, nil)
+	assert.Equal(t, len(pkg.GetPkgProfile().GetEntries()), 0)
+
+	pkgPath = filepath.Join(testPath, "with_path_entries")
+	pkg, err = GetKclPackage(pkgPath)
+	assert.Equal(t, err, nil)
+	assert.Equal(t, len(pkg.GetPkgProfile().GetEntries()), 1)
+
+	res, err := RunWithOpts(
+		opt.WithEntries(pkg.GetPkgProfile().GetEntries()),
+		opt.WithKclOption(kcl.WithWorkDir(pkgPath)),
+	)
+
+	assert.Equal(t, err, nil)
+	assert.Equal(t, res.GetRawYamlResult(), "sub: test in sub")
+	assert.Equal(t, res.GetRawJsonResult(), "[{\"sub\": \"test in sub\"}]")
+}
diff --git a/pkg/api/test_data/test_get_entries/no_entries/kcl.mod b/pkg/api/test_data/test_get_entries/no_entries/kcl.mod
@@ -0,0 +1,5 @@
+[package]
+name = "no_entries"
+edition = "0.0.1"
+version = "0.0.1"
+
diff --git a/pkg/api/test_data/test_get_entries/no_entries/kcl.mod.lock b/pkg/api/test_data/test_get_entries/no_entries/kcl.mod.lock
diff --git a/pkg/api/test_data/test_get_entries/no_entries/main.k b/pkg/api/test_data/test_get_entries/no_entries/main.k
@@ -0,0 +1 @@
+The_first_kcl_program = 'Hello World!'
diff --git a/pkg/api/test_data/test_get_entries/with_path_entries/kcl.mod b/pkg/api/test_data/test_get_entries/with_path_entries/kcl.mod
@@ -0,0 +1,8 @@
+[package]
+name = "with_path_entries"
+edition = "0.0.1"
+version = "0.0.1"
+
+[profile]
+entries = ["sub/sub.k"]
+
diff --git a/pkg/api/test_data/test_get_entries/with_path_entries/kcl.mod.lock b/pkg/api/test_data/test_get_entries/with_path_entries/kcl.mod.lock
diff --git a/pkg/api/test_data/test_get_entries/with_path_entries/sub/sub.k b/pkg/api/test_data/test_get_entries/with_path_entries/sub/sub.k
@@ -0,0 +1 @@
+sub = "test in sub"
diff --git a/pkg/package/modfile.go b/pkg/package/modfile.go
@@ -97,7 +97,7 @@ func (profile *Profile) IntoKclOptions() *kcl.Option {
 
 // GetEntries will get the entry kcl files from profile.
 func (profile *Profile) GetEntries() []string {
-	if profile.Entries == nil {
+	if profile == nil || profile.Entries == nil {
 		return []string{}
 	}
 	return *profile.Entries

diff --git a/pkg/package/package.go b/pkg/package/package.go
@@ -185,8 +185,8 @@ func (kclPkg *KclPkg) GetPkgEdition() string {
 }
 
 // GetPkgProfile returns the profile of package.
-func (kclPkg *KclPkg) GetPkgProfile() Profile {
-	return *kclPkg.ModFile.Profiles
+func (kclPkg *KclPkg) GetPkgProfile() *Profile {
+	return kclPkg.ModFile.Profiles
 }
 
 // GetPkgTarName returns the kcl package tar name "<package_name>-v<package_version>.tar"