Go rewrite copy comments script (#11715)

Author: zli82016

mmv1/description-copy.go

@@ -22,13 +22,287 @@ func CopyAllDescriptions(tempMode bool) {
 		"attributes:",
 	}
 
-	for i, id := range identifiers {
-		CopyText(id, len(identifiers)-1 == i, tempMode)
+	for _, id := range identifiers {
+		CopyText(id, tempMode)
 	}
+
+	copyComments(tempMode)
+}
+
+// TODO rewrite: ServicePerimeters.yaml is an exeption and needs manually fixing the comments over after switchover
+// Used to copy/paste comments from Ruby -> Go YAML files
+func copyComments(tempMode bool) {
+	log.Printf("Starting to copy comments from Ruby yaml files to Go yaml files")
+
+	renamedFields := map[string]string{
+		"skip_sweeper":           "exclude_sweeper",
+		"skip_delete":            "exclude_delete",
+		"skip_test":              "exclude_test",
+		"skip_import_test":       "exclude_import_test",
+		"skip_docs":              "exclude_docs",
+		"skip_attribution_label": "exclude_attribution_label",
+		"skip_read":              "exclude_read",
+		"skip_default_cdiff":     "exclude_default_cdiff",
+		"skip_docs_values":       "skip_docs_values",
+		"values":                 "enum_values",
+	}
+	var allProductFiles []string = make([]string, 0)
+	glob := "products/**/go_product.yaml"
+	if tempMode {
+		glob = "products/**/*.temp"
+	}
+	files, err := filepath.Glob(glob)
+	if err != nil {
+		return
+	}
+	for _, filePath := range files {
+		dir := filepath.Dir(filePath)
+		allProductFiles = append(allProductFiles, fmt.Sprintf("products/%s", filepath.Base(dir)))
+	}
+
+	for _, productPath := range allProductFiles {
+		// Gather go and ruby file pairs
+		yamlMap := make(map[string][]string)
+		yamlPaths, err := filepath.Glob(fmt.Sprintf("%s/*", productPath))
+		if err != nil {
+			log.Fatalf("Cannot get yaml files: %v", err)
+		}
+		for _, yamlPath := range yamlPaths {
+			if strings.HasSuffix(yamlPath, "_new") {
+				continue
+			}
+
+			if tempMode {
+				cutName, found := strings.CutSuffix(yamlPath, ".temp")
+				if !found {
+					continue
+				}
+
+				baseName := filepath.Base(yamlPath)
+				yamlMap[baseName] = make([]string, 2)
+				yamlMap[baseName][1] = yamlPath
+				yamlMap[baseName][0] = cutName
+				continue
+			}
+
+			fileName := filepath.Base(yamlPath)
+			baseName, found := strings.CutPrefix(fileName, "go_")
+			if yamlMap[baseName] == nil {
+				yamlMap[baseName] = make([]string, 2)
+			}
+			if found {
+				yamlMap[baseName][1] = yamlPath
+			} else {
+				yamlMap[baseName][0] = yamlPath
+			}
+		}
+
+		for _, files := range yamlMap {
+			rubyPath := files[0]
+			goPath := files[1]
+
+			recordingComments := false
+			comments := ""
+			commentsMap := make(map[string]string, 0)
+			nestedNameLine := ""
+			previousNameLine := ""
+			trimmedPreviousLine := ""
+
+			// Ready Ruby yaml
+			wholeLineComment, err := regexp.Compile(`^\s*#.*?`)
+			if err != nil {
+				log.Fatalf("Cannot compile the regular expression: %v", err)
+			}
+
+			if err != nil {
+				log.Fatalf("Cannot compile the regular expression: %v", err)
+			}
+
+			file, _ := os.Open(rubyPath)
+			defer file.Close()
+			scanner := bufio.NewScanner(file)
+			for scanner.Scan() {
+				line := scanner.Text()
+				if line == "" {
+					if recordingComments {
+						comments = fmt.Sprintf("%s\n%s", comments, line)
+					}
+					continue
+				}
+
+				if wholeLineComment.MatchString(line) {
+					if !recordingComments {
+						recordingComments = true
+						comments = line
+					} else {
+						comments = fmt.Sprintf("%s\n%s", comments, line)
+					}
+				} else {
+					normalizedLine := line
+
+					indexOfComment := strings.Index(normalizedLine, " # ")
+					if indexOfComment > 0 { // The comments are in the same line with the code
+						comments = normalizedLine[indexOfComment:]
+						recordingComments = true
+						normalizedLine = strings.TrimRight(normalizedLine[:indexOfComment], " ")
+					}
+
+					normalizedLine = strings.ReplaceAll(normalizedLine, "'", "")
+					normalizedLine = strings.ReplaceAll(normalizedLine, `"`, "")
+					normalizedLine = strings.ReplaceAll(normalizedLine, `\`, "")
+					normalizedLine = strings.ReplaceAll(normalizedLine, ": :", ": ")
+					normalizedLine = strings.ReplaceAll(normalizedLine, "- :", "- ")
+					trimmed := strings.TrimSpace(normalizedLine)
+					index := strings.Index(normalizedLine, trimmed)
+
+					if index == 0 {
+						previousNameLine = ""
+						nestedNameLine = ""
+					} else if index >= 2 && (strings.HasPrefix(trimmedPreviousLine, "- !ruby/object") || strings.HasPrefix(trimmedPreviousLine, "--- !ruby/object")) {
+						normalizedLine = fmt.Sprintf("%s- %s", normalizedLine[:index-2], normalizedLine[index:])
+
+						if strings.HasPrefix(trimmed, "name:") {
+							if nestedNameLine != "" {
+								previousNameLine = nestedNameLine
+							}
+							nestedNameLine = normalizedLine
+						}
+					}
+
+					trimmedPreviousLine = trimmed
+
+					if recordingComments {
+						if !strings.HasPrefix(comments, "# Copyright") {
+							// The line is a type, for example - !ruby/object:Api::Type::Array.
+							// The lines of types are not present in Go yaml files
+							if strings.HasPrefix(trimmed, "- !ruby/object") || strings.HasPrefix(trimmed, "--- !ruby/object") {
+								continue
+							}
+
+							// Remove suffix " !ruby/object" as the types are not present in Go yaml files
+							indexOfRuby := strings.Index(normalizedLine, ": !ruby/object")
+							if indexOfRuby >= 0 {
+								normalizedLine = normalizedLine[:indexOfRuby+1]
+							}
+							// Remove suffix Api::Type::
+							indexOfRuby = strings.Index(normalizedLine, " Api::Type::")
+							if indexOfRuby >= 0 {
+								normalizedLine = normalizedLine[:indexOfRuby]
+							}
+
+							// Some fields are renamed during yaml file conversion
+							field := strings.Split(normalizedLine, ":")[0]
+							if shouldUseFieldName(normalizedLine) {
+								normalizedLine = field
+							}
+
+							field = strings.TrimSpace(field)
+							if goName, ok := renamedFields[field]; ok {
+								normalizedLine = strings.Replace(normalizedLine, field, goName, 1)
+							}
+
+							key := fmt.Sprintf("%s$%s$%s", previousNameLine, nestedNameLine, normalizedLine)
+							commentsMap[key] = comments
+						}
+						recordingComments = false
+						comments = ""
+					}
+				}
+			}
+
+			// Read Go yaml while writing to a temp file
+			firstLine := true
+			nestedNameLine = ""
+			previousNameLine = ""
+			newFilePath := fmt.Sprintf("%s_new", goPath)
+			fo, _ := os.Create(newFilePath)
+			w := bufio.NewWriter(fo)
+			file, _ = os.Open(goPath)
+			defer file.Close()
+			scanner = bufio.NewScanner(file)
+			for scanner.Scan() {
+				line := scanner.Text()
+
+				if firstLine {
+					if strings.Contains(line, "NOT CONVERTED - RUN YAML MODE") {
+						firstLine = false
+						continue
+					} else {
+						break
+					}
+				}
+
+				if len(commentsMap) > 0 && !wholeLineComment.MatchString(line) && line != "" { // This line is not a comment
+					normalizedLine := strings.ReplaceAll(line, "'", "")
+					normalizedLine = strings.ReplaceAll(normalizedLine, `"`, "")
+					trimmed := strings.TrimSpace(normalizedLine)
+					index := strings.Index(normalizedLine, trimmed)
+
+					if index == 0 {
+						previousNameLine = ""
+						nestedNameLine = ""
+					} else if index >= 2 && strings.HasPrefix(trimmed, "- name:") {
+						if nestedNameLine != "" {
+							previousNameLine = nestedNameLine
+						}
+						nestedNameLine = normalizedLine
+					}
+
+					field := strings.Split(normalizedLine, ":")[0]
+					if shouldUseFieldName(normalizedLine) {
+						normalizedLine = field
+					}
+
+					key := fmt.Sprintf("%s$%s$%s", previousNameLine, nestedNameLine, normalizedLine)
+					if comments, ok := commentsMap[key]; ok {
+						delete(commentsMap, key)
+						line = fmt.Sprintf("%s\n%s", comments, line)
+					}
+				}
+				_, err := w.WriteString(fmt.Sprintf("%s\n", line))
+				if err != nil {
+					log.Fatalf("Error when writing the line %s: %#v", line, err)
+				}
+			}
+
+			if !firstLine {
+				// Flush writes any buffered data to the underlying io.Writer.
+				if err = w.Flush(); err != nil {
+					panic(err)
+				}
+
+				if len(commentsMap) > 0 {
+					log.Printf("Some comments in rubyPath %s are not copied over: %#v", rubyPath, commentsMap)
+				}
+				// Overwrite original file with temp
+				os.Rename(newFilePath, goPath)
+			} else {
+				os.Remove(newFilePath)
+			}
+		}
+	}
+	log.Printf("Finished to copy comments from Ruby yaml files to Go yaml files")
+}
+
+// custom template files in Go yaml files have different names
+// The format of primary_resource_name for enum is different in Go yaml files
+func shouldUseFieldName(line string) bool {
+	filedNames := []string{
+		"templates/terraform/",
+		"primary_resource_name:",
+		"default_value:",
+		"deprecation_message:",
+	}
+	for _, fieldName := range filedNames {
+		if strings.Contains(line, fieldName) {
+			return true
+		}
+	}
+	return false
 }
 
 // Used to copy/paste text from Ruby -> Go YAML files
-func CopyText(identifier string, last, tempMode bool) {
+func CopyText(identifier string, tempMode bool) {
 	var allProductFiles []string = make([]string, 0)
 	glob := "products/**/go_product.yaml"
 	if tempMode {
@@ -135,14 +409,13 @@ func CopyText(identifier string, last, tempMode bool) {
 				if firstLine {
 					if strings.Contains(line, "NOT CONVERTED - RUN YAML MODE") {
 						firstLine = false
-						if !last {
-							w.WriteString(fmt.Sprintf("NOT CONVERTED - RUN YAML MODE\n"))
-						}
+						w.WriteString(fmt.Sprintf("NOT CONVERTED - RUN YAML MODE\n"))
 						continue
 					} else {
 						break
 					}
 				}
+
 				if strings.Contains(line, identifier) {
 					if index >= len(text) {
 						log.Printf("did not replace %s correctly! Is the file named correctly?", goPath)

mmv1/products/accesscontextmanager/go_AccessLevel.yaml

@@ -13,6 +13,7 @@
 
 # Warning: This is a temporary file, and should not be edited directly
 ---
+# This is the singular of `AccessLevels`, any changes here should be made to `AccessLevels` as well
 name: 'AccessLevel'
 description: |
   An AccessLevel is a label that can be applied to requests to GCP services,
@@ -31,6 +32,11 @@ docs:
 id_format: '{{name}}'
 base_url: ''
 self_link: '{{name}}'
+# This is an unusual API, so we need to use a few fields to map the methods
+# to the right URL.
+# create_url is the Create URL
+# base_url is the Get and Delete and Patch URL. It is empty on purpose.
+# List won't work yet. It should share a URL with Create.
 create_url: '{{parent}}/accessLevels'
 update_verb: 'PATCH'
 update_mask: true
@@ -57,6 +63,7 @@ async:
 custom_code:
   encoder: 'templates/terraform/encoders/go/access_level_never_send_parent.go.tmpl'
   custom_import: 'templates/terraform/custom_import/go/set_access_policy_parent_from_self_link.go.tmpl'
+# Skipping the sweeper due to the non-standard base_url
 exclude_sweeper: true
 examples:
   - name: 'access_context_manager_access_level_basic'
@@ -65,6 +72,8 @@ examples:
       access_level_name: 'chromeos_no_lock'
     exclude_test: true
 parameters:
+  # Parent is a path parameter that _cannot_ be read or sent in the request at all.
+  # This must be done at the provider level.
   - name: 'parent'
     type: String
     description: |
@@ -111,6 +120,8 @@ properties:
         enum_values:
           - 'AND'
           - 'OR'
+      # All of the false defaults below here are omitted on purpose.
+      # Let's keep this as simple as possible, since they will all be set by the API.
       - name: 'conditions'
         type: Array
         description: |

mmv1/products/accesscontextmanager/go_AccessLevelCondition.yaml

@@ -37,6 +37,11 @@ docs:
 id_format: '{{access_level}}'
 base_url: ''
 self_link: '{{access_level}}'
+# This is an unusual API, so we need to use a few fields to map the methods
+# to the right URL.
+# create_url is the Create URL
+# base_url is the Get and Delete and Patch URL. It is empty on purpose.
+# List won't work yet. It should share a URL with Create.
 create_url: '{{access_level}}'
 create_verb: 'PATCH'
 update_mask: true
@@ -45,6 +50,7 @@ immutable: true
 mutex: '{{access_level}}'
 import_format:
   - '{{access_level}}'
+ # no unique way to specify
 exclude_import: true
 timeouts:
   insert_minutes: 20
@@ -73,6 +79,7 @@ nested_query:
   modify_by_patch: true
 custom_code:
 exclude_tgc: true
+# Skipping the sweeper due to the non-standard base_url and because this is fine-grained under AccessLevel
 exclude_sweeper: true
 examples:
   - name: 'access_context_manager_access_level_condition_basic'