Make write odo-file-index.json after push success (#2751)

pkg/odo/cli/component/common_push.go

@@ -179,10 +179,14 @@ func (cpo *CommonPushOptions) Push() (err error) {
 	isForcePush := false
 
 	stdout := color.Output
+	// Ret from Indexer function
+	var ret util.IndexerRet
 
 	cmpName := cpo.LocalConfigInfo.GetName()
 	appName := cpo.LocalConfigInfo.GetApplication()
 	cpo.sourceType = cpo.LocalConfigInfo.GetSourceType()
+	// force write the content to resolvePath
+	forceWrite := false
 
 	if cpo.componentContext == "" {
 		cpo.componentContext = strings.TrimSuffix(filepath.Dir(cpo.LocalConfigInfo.Filename), ".odo")
@@ -214,17 +218,20 @@ func (cpo *CommonPushOptions) Push() (err error) {
 		}
 
 		// run the indexer and find the modified/added/deleted/renamed files
-		filesChanged, filesDeleted, err := util.RunIndexer(cpo.componentContext, absIgnoreRules)
+		ret, err = util.RunIndexer(cpo.componentContext, absIgnoreRules)
 		spinner.End(true)
 
 		if err != nil {
 			return errors.Wrap(err, "unable to run indexer")
 		}
+		if len(ret.FilesChanged) > 0 || len(ret.FilesDeleted) > 0 {
+			forceWrite = true
+		}
 
 		if cpo.doesComponentExist {
 			// apply the glob rules from the .gitignore/.odo file
 			// and ignore the files on which the rules apply and filter them out
-			filesChangedFiltered, filesDeletedFiltered := filterIgnores(filesChanged, filesDeleted, absIgnoreRules)
+			filesChangedFiltered, filesDeletedFiltered := filterIgnores(ret.FilesChanged, ret.FilesDeleted, absIgnoreRules)
 
 			// Remove the relative file directory from the list of deleted files
 			// in order to make the changes correctly within the OpenShift pod
@@ -301,6 +308,12 @@ func (cpo *CommonPushOptions) Push() (err error) {
 
 		return errors.Wrapf(err, fmt.Sprintf("failed to push component: %v", cmpName))
 	}
+	if forceWrite {
+		err = util.WriteFile(ret.NewFileMap, ret.ResolvedPath)
+		if err != nil {
+			return errors.Wrapf(err, "Failed to write file")
+		}
+	}
 
 	log.Success("Changes successfully pushed to component")
 	return

pkg/sync/adapter.go

@@ -38,6 +38,11 @@ type Adapter struct {
 // changed and devfile execution is required
 func (a Adapter) SyncFiles(syncParameters common.SyncParameters) (isPushRequired bool, err error) {
 
+	// force write the content to resolvePath
+	forceWrite := false
+	// Ret from Indexer function
+	var ret util.IndexerRet
+
 	deletedFiles := []string{}
 	changedFiles := []string{}
 	isForcePush := false
@@ -72,18 +77,22 @@ func (a Adapter) SyncFiles(syncParameters common.SyncParameters) (isPushRequired
 		}
 
 		// run the indexer and find the modified/added/deleted/renamed files
-		filesChanged, filesDeleted, err := util.RunIndexer(pushParameters.Path, absIgnoreRules)
+		ret, err = util.RunIndexer(pushParameters.Path, absIgnoreRules)
 		s.End(true)
 
 		if err != nil {
 			return false, errors.Wrap(err, "unable to run indexer")
 		}
 
+		if len(ret.FilesChanged) > 0 || len(ret.FilesDeleted) > 0 {
+			forceWrite = true
+		}
+
 		// If the component already exists, sync only the files that changed
 		if syncParameters.ComponentExists {
 			// apply the glob rules from the .gitignore/.odo file
 			// and ignore the files on which the rules apply and filter them out
-			filesChangedFiltered, filesDeletedFiltered := util.FilterIgnores(filesChanged, filesDeleted, absIgnoreRules)
+			filesChangedFiltered, filesDeletedFiltered := util.FilterIgnores(ret.FilesChanged, ret.FilesDeleted, absIgnoreRules)
 
 			// Remove the relative file directory from the list of deleted files
 			// in order to make the changes correctly within the Kubernetes pod
@@ -120,6 +129,12 @@ func (a Adapter) SyncFiles(syncParameters common.SyncParameters) (isPushRequired
 	if err != nil {
 		return false, errors.Wrapf(err, "failed to sync to component with name %s", a.ComponentName)
 	}
+	if forceWrite {
+		err = util.WriteFile(ret.NewFileMap, ret.ResolvedPath)
+		if err != nil {
+			return false, errors.Wrapf(err, "Failed to write file")
+		}
+	}
 
 	return true, nil
 }

pkg/util/file_indexer.go

@@ -131,38 +131,47 @@ func DeleteIndexFile(directory string) error {
 	return DeletePath(indexFile)
 }
 
+// A struct that represent return value of RunIndexer function
+type IndexerRet struct {
+	FilesChanged []string
+	FilesDeleted []string
+	NewFileMap   map[string]FileData
+	ResolvedPath string
+}
+
 // RunIndexer walks the given directory and finds the files which have changed and which were deleted/renamed
 // it reads the odo index file from the .odo folder
 // if no such file is present, it means it's the first time the folder is being walked and thus returns a empty list
 // after the walk, it stores the list of walked files with some information in a odo index file in the .odo folder
-// The filemap stores the values as "relative filepath" => FileData but it the filesChanged and filesDeleted are absolute paths
+// The filemap stores the values as "relative filepath" => FileData but it the FilesChanged and filesDeleted are absolute paths
 // to the files
-func RunIndexer(directory string, ignoreRules []string) (filesChanged []string, filesDeleted []string, err error) {
+func RunIndexer(directory string, ignoreRules []string) (ret IndexerRet, err error) {
 	directory = filepath.FromSlash(directory)
-	resolvedPath, err := resolveIndexFilePath(directory)
+	ret.ResolvedPath, err = resolveIndexFilePath(directory)
+
 	if err != nil {
-		return filesChanged, filesDeleted, err
+		return ret, err
 	}
 
 	// check for .gitignore file and add odo-file-index.json to .gitignore
 	gitIgnoreFile, err := CheckGitIgnoreFile(directory)
 	if err != nil {
-		return filesChanged, filesDeleted, err
+		return ret, err
 	}
 
 	// add odo-file-index.json path to .gitignore
 	err = AddOdoFileIndex(gitIgnoreFile)
 	if err != nil {
-		return filesChanged, filesDeleted, err
+		return ret, err
 	}
 
 	// read the odo index file
-	existingFileIndex, err := readFileIndex(resolvedPath)
+	existingFileIndex, err := readFileIndex(ret.ResolvedPath)
 	if err != nil {
-		return filesChanged, filesDeleted, err
+		return ret, err
 	}
 
-	newFileMap := make(map[string]FileData)
+	ret.NewFileMap = make(map[string]FileData)
 	walk := func(fn string, fi os.FileInfo, err error) error {
 		if err != nil {
 			return err
@@ -199,17 +208,17 @@ func RunIndexer(directory string, ignoreRules []string) (filesChanged []string,
 		relativeFilename = filepath.ToSlash(relativeFilename)
 
 		if _, ok := existingFileIndex.Files[relativeFilename]; !ok {
-			filesChanged = append(filesChanged, fn)
+			ret.FilesChanged = append(ret.FilesChanged, fn)
 			klog.V(4).Infof("file added: %s", fn)
 		} else if !fi.ModTime().Equal(existingFileIndex.Files[relativeFilename].LastModifiedDate) {
-			filesChanged = append(filesChanged, fn)
+			ret.FilesChanged = append(ret.FilesChanged, fn)
 			klog.V(4).Infof("last modified date changed: %s", fn)
 		} else if fi.Size() != existingFileIndex.Files[relativeFilename].Size {
-			filesChanged = append(filesChanged, fn)
+			ret.FilesChanged = append(ret.FilesChanged, fn)
 			klog.V(4).Infof("size changed: %s", fn)
 		}
 
-		newFileMap[relativeFilename] = FileData{
+		ret.NewFileMap[relativeFilename] = FileData{
 			Size:             fi.Size(),
 			LastModifiedDate: fi.ModTime(),
 		}
@@ -218,39 +227,28 @@ func RunIndexer(directory string, ignoreRules []string) (filesChanged []string,
 
 	err = filepath.Walk(directory, walk)
 	if err != nil {
-		return filesChanged, filesDeleted, err
+		return ret, err
 	}
 
 	// find files which are deleted/renamed
 	for fileName := range existingFileIndex.Files {
-		if _, ok := newFileMap[fileName]; !ok {
+		if _, ok := ret.NewFileMap[fileName]; !ok {
 			klog.V(4).Infof("Deleting file: %s", fileName)
 
 			// Return the *absolute* path to the file)
 			fileAbsolutePath, err := GetAbsPath(filepath.Join(directory, fileName))
 			if err != nil {
-				return filesChanged, filesDeleted, errors.Wrapf(err, "unable to retrieve absolute path of file %s", fileName)
+				return ret, errors.Wrapf(err, "unable to retrieve absolute path of file %s", fileName)
 			}
-			filesDeleted = append(filesDeleted, fileAbsolutePath)
-		}
-
-	}
-
-	// if there are added/deleted/modified/renamed files or folders, write it to the odo index file
-	if len(filesChanged) > 0 || len(filesDeleted) > 0 {
-		newfi := NewFileIndex()
-		newfi.Files = newFileMap
-		err = write(resolvedPath, newfi)
-		if err != nil {
-			return filesChanged, filesDeleted, err
+			ret.FilesDeleted = append(ret.FilesDeleted, fileAbsolutePath)
 		}
 	}
 
-	return filesChanged, filesDeleted, nil
+	return ret, nil
 }
 
-// writes the map of walked files and info about them, in a file
-// filepath is the location of the file to which it is supposed to be written
+// write writes the map of walked files and info about them, in a file
+// filePath is the location of the file to which it is supposed to be written
 func write(filePath string, fi *FileIndex) error {
 	jsonData, err := json.Marshal(fi)
 	if err != nil {
@@ -259,3 +257,13 @@ func write(filePath string, fi *FileIndex) error {
 	// 0600 is the mask used when a file is created using os.Create hence defaulting
 	return ioutil.WriteFile(filePath, jsonData, 0600)
 }
+
+// WriteFile writes a file map to a file, the file map is given by
+// newFileMap param and the file location is resolvedPath param
+func WriteFile(newFileMap map[string]FileData, resolvedPath string) error {
+	newfi := NewFileIndex()
+	newfi.Files = newFileMap
+	err := write(resolvedPath, newfi)
+
+	return err
+}