update ClientFactory params in readme (Azure#24180)

Author: JiaqiZhang-Dev

eng/scripts/automation_init.sh

@@ -52,6 +52,7 @@ echo "Install generator..."
 go build 2>&1
 
 cp generator $GOPATH/bin/
+rm generator
 export PATH=$GOPATH/bin:$PATH
 cd $DIRECTORY
 

eng/tools/generator/cmd/v2/common/constants.go

@@ -4,7 +4,9 @@
 package common
 
 const (
-	ChangelogFileName = "CHANGELOG.md"
-	GoModFileName     = "go.mod"
-	SdkRootPath       = "/sdk"
+	ChangelogFileName     = "CHANGELOG.md"
+	GoModFileName         = "go.mod"
+	SdkRootPath           = "/sdk"
+	ReadmeFileName        = "README.md"
+	ClientFactoryFileName = "client_factory.go"
 )

eng/tools/generator/cmd/v2/common/fileProcessor.go

@@ -837,3 +837,57 @@ func FindModuleDirByGoMod(root string) (string, error) {
 	}
 	return "", fmt.Errorf("module not found, package path:%s", root)
 }
+
+func UpdateReadmeClientFactory(path string) error {
+	readmePath := filepath.Join(path, ReadmeFileName)
+	readmeFile, err := os.ReadFile(readmePath)
+	if err != nil {
+		return err
+	}
+	noOptionalFactoryReg := regexp.MustCompile(`NewClientFactory\((.*?)(?:,\s*)?cred,\s*nil\)`)
+	withOptionalFactoryReg := regexp.MustCompile(`NewClientFactory\((.*?)(?:,\s*)?cred,\s*&options\)`)
+	oldnoOptionalFactory := noOptionalFactoryReg.FindString(string(readmeFile))
+	oldwithOptionalFactory := withOptionalFactoryReg.FindString(string(readmeFile))
+	if oldnoOptionalFactory == "" && oldwithOptionalFactory == "" {
+		return nil
+	}
+	clientFactoryFile, err := os.ReadFile(filepath.Join(path, ClientFactoryFileName))
+	if err != nil {
+		return err
+	}
+	re := regexp.MustCompile(`func\s+NewClientFactory\(([^)]+)\)`)
+	matches := re.FindStringSubmatch(string(clientFactoryFile))
+	if len(matches) <= 1 {
+		return nil
+	}
+	var factoryParams []string
+	params := strings.Split(matches[1], ",")
+	for param := range params {
+		params[param] = strings.TrimSpace(params[param])
+		paramDefinition := strings.Split(params[param], " ")
+		if len(paramDefinition) != 2 {
+			continue
+		}
+		paramName := paramDefinition[0]
+		if paramName == "credential" || paramName == "options" {
+			// fixed params, no need to process
+			continue
+		}
+		if paramName == "subscriptionID" {
+			// compatible with old version
+			factoryParams = append(factoryParams, "<subscription ID>")
+			continue
+		}
+		factoryParams = append(factoryParams, fmt.Sprintf("<%s>", paramName))
+	}
+	noOptionsParams := append(factoryParams, []string{"cred", "nil"}...)
+	withOptionsParams := append(factoryParams, []string{"cred", "&options"}...)
+	newNoOptionalFactory := fmt.Sprintf("NewClientFactory(%s)", strings.Join(noOptionsParams, ", "))
+	newWithOptionalFactory := fmt.Sprintf("NewClientFactory(%s)", strings.Join(withOptionsParams, ", "))
+	if oldnoOptionalFactory == newNoOptionalFactory && oldwithOptionalFactory == newWithOptionalFactory {
+		return nil
+	}
+	content := strings.ReplaceAll(string(readmeFile), oldnoOptionalFactory, newNoOptionalFactory)
+	content = strings.ReplaceAll(content, oldwithOptionalFactory, newWithOptionalFactory)
+	return os.WriteFile(readmePath, []byte(content), 0644)
+}

eng/tools/generator/cmd/v2/common/fileProcessor_test.go

@@ -140,3 +140,49 @@ func TestFindModule(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, "sdk/security/keyvault/azadmin", filepath.ToSlash(moduleRelativePath))
 }
+
+func TestUpdateReadMeClientFactory(t *testing.T) {
+	// Create temporary test directory
+	tmpDir, err := os.MkdirTemp("", "tmp")
+	assert.NoError(t, err)
+	defer os.RemoveAll(tmpDir)
+
+	err = os.WriteFile(filepath.Join(tmpDir, "README.md"), []byte(`
+	clientFactory, err := NewClientFactory(<subscription ID>, cred, nil)
+	clientFactory, err := NewClientFactory(<subscription ID>, cred, &options)
+	`), 0644)
+	assert.NoError(t, err)
+
+	// Test case 1: without subscription ID
+	err = os.WriteFile(filepath.Join(tmpDir, "client_factory.go"), []byte(`
+	func NewClientFactory(credential azcore.TokenCredential, options *arm.ClientOptions) *ClientFactory {
+	`), 0644)
+	assert.NoError(t, err)
+
+	err = UpdateReadmeClientFactory(tmpDir)
+	assert.NoError(t, err)
+
+	noSubContent, err := os.ReadFile(filepath.Join(tmpDir, "README.md"))
+	assert.NoError(t, err)
+	assert.Contains(t, string(noSubContent), "NewClientFactory(cred, nil)")
+	assert.Contains(t, string(noSubContent), "NewClientFactory(cred, &options)")
+
+	// Test case 2: with subscription ID
+	err = os.WriteFile(filepath.Join(tmpDir, "README.md"), []byte(`
+	clientFactory, err := NewClientFactory(cred, nil)
+	clientFactory, err := NewClientFactory(cred, &options)
+	`), 0644)
+	assert.NoError(t, err)
+	err = os.WriteFile(filepath.Join(tmpDir, "client_factory.go"), []byte(`
+	func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ClientFactory {
+	`), 0644)
+	assert.NoError(t, err)
+
+	err = UpdateReadmeClientFactory(tmpDir)
+	assert.NoError(t, err)
+
+	withSubContent, err := os.ReadFile(filepath.Join(tmpDir, "README.md"))
+	assert.NoError(t, err)
+	assert.Contains(t, string(withSubContent), `NewClientFactory(<subscription ID>, cred, nil)`)
+	assert.Contains(t, string(withSubContent), `NewClientFactory(<subscription ID>, cred, &options)`)
+}

eng/tools/generator/cmd/v2/common/generation.go

@@ -293,6 +293,12 @@ func (t *SwaggerCommonGenerator) AfterGenerate(generateParam *GenerateParam, cha
 			return nil, err
 		}
 	}
+	log.Printf("Update README.md ClientFactory...")
+	err := UpdateReadmeClientFactory(t.PackagePath)
+	if err != nil {
+		// only log error, avoid breaking the process
+		log.Printf("Update README.md ClientFactory failed! err: %v", err)
+	}
 	return nil, nil
 }
 
@@ -670,6 +676,13 @@ func (t *TypeSpecCommonGenerator) AfterGenerate(generateParam *GenerateParam, ch
 	if err := ExecuteGo(modulePath, "mod", "tidy"); err != nil {
 		return nil, err
 	}
+
+	log.Printf("Update README.md ClientFactory...")
+	err := UpdateReadmeClientFactory(t.PackagePath)
+	if err != nil {
+		// only log error, avoid breaking the process
+		log.Printf("Update README.md ClientFactory failed! err: %v", err)
+	}
 	return nil, nil
 }