Merge pull request #217 from zong-zhe/fix-metadata-autoupdate

fix: remove the autoupdate of kcl.mod when use 'kpm metadata'

pkg/client/client.go

@@ -228,11 +228,12 @@ func (c *KpmClient) ResolvePkgDepsMetadata(kclPkg *pkg.KclPkg, update bool) erro
 			}
 		}
 	}
-
-	// update the kcl.mod and kcl.mod.lock.
-	err := kclPkg.UpdateModAndLockFile()
-	if err != nil {
-		return err
+	if update {
+		// update the kcl.mod and kcl.mod.lock.
+		err := kclPkg.UpdateModAndLockFile()
+		if err != nil {
+			return err
+		}
 	}
 	return nil
 }

pkg/client/client_test.go

@@ -740,3 +740,41 @@ func TestUpdateWithKclModlock(t *testing.T) {
 		assert.Equal(t, err, nil)
 	}()
 }
+
+func TestMetadataOffline(t *testing.T) {
+	kpmcli, err := NewKpmClient()
+	assert.Equal(t, err, nil)
+
+	testDir := getTestDir("test_metadata_offline")
+	kclMod := filepath.Join(testDir, "kcl.mod")
+	uglyKclMod := filepath.Join(testDir, "ugly.kcl.mod")
+	BeautifulKclMod := filepath.Join(testDir, "beautiful.kcl.mod")
+
+	uglyContent, err := os.ReadFile(uglyKclMod)
+	assert.Equal(t, err, nil)
+	err = copy.Copy(uglyKclMod, kclMod)
+	assert.Equal(t, err, nil)
+	defer func() {
+		err := os.Remove(kclMod)
+		assert.Equal(t, err, nil)
+	}()
+
+	beautifulContent, err := os.ReadFile(BeautifulKclMod)
+	assert.Equal(t, err, nil)
+	kclPkg, err := pkg.LoadKclPkg(testDir)
+	assert.Equal(t, err, nil)
+
+	res, err := kpmcli.ResolveDepsMetadataInJsonStr(kclPkg, false)
+	assert.Equal(t, err, nil)
+	assert.Equal(t, res, "{\"packages\":{}}")
+	content_after_metadata, err := os.ReadFile(kclMod)
+	assert.Equal(t, err, nil)
+	assert.Equal(t, string(content_after_metadata), string(uglyContent))
+
+	res, err = kpmcli.ResolveDepsMetadataInJsonStr(kclPkg, true)
+	assert.Equal(t, err, nil)
+	assert.Equal(t, res, "{\"packages\":{}}")
+	content_after_metadata, err = os.ReadFile(kclMod)
+	assert.Equal(t, err, nil)
+	assert.Equal(t, utils.RmNewline(string(content_after_metadata)), utils.RmNewline(string(beautifulContent)))
+}

pkg/client/test_data/test_metadata_offline/beautiful.kcl.mod

@@ -0,0 +1,5 @@
+[package]
+name = "test_metadata_offline"
+edition = "0.0.1"
+version = "0.0.1"
+

pkg/client/test_data/test_metadata_offline/main.k

@@ -0,0 +1 @@
+The_first_kcl_program = 'Hello World!'

pkg/client/test_data/test_metadata_offline/ugly.kcl.mod

@@ -0,0 +1,10 @@
+[package]
+
+
+
+
+
+name = "test_metadata_offline"
+edition = "0.0.1"
+version = "0.0.1"
+

pkg/cmd/cmd_metadata.go

@@ -79,13 +79,6 @@ func NewMetadataCmd(kpmcli *client.KpmClient) *cli.Command {
 				return err
 			}
 
-			if autoUpdate {
-				err = kclPkg.UpdateModAndLockFile()
-				if err != nil {
-					return err
-				}
-			}
-
 			fmt.Println(jsonStr)
 
 			return nil