fix: enable milvus.yaml check (#34567) (#35446)

See #32168

pr: #34567 #35152

---------

Signed-off-by: Ted Xu <[email protected]>

Makefile

@@ -372,7 +372,7 @@ clean:
 
 milvus-tools: print-build-info
 	@echo "Building tools ..."
-	@mkdir -p $(INSTALL_PATH)/tools && go env -w CGO_ENABLED="1" && GO111MODULE=on $(GO) build \
+	@. $(PWD)/scripts/setenv.sh && mkdir -p $(INSTALL_PATH)/tools && go env -w CGO_ENABLED="1" && GO111MODULE=on $(GO) build \
 		-pgo=$(PGO_PATH)/default.pgo -ldflags="-X 'main.BuildTags=$(BUILD_TAGS)' -X 'main.BuildTime=$(BUILD_TIME)' -X 'main.GitCommit=$(GIT_COMMIT)' -X 'main.GoVersion=$(GO_VERSION)'" \
 		-o $(INSTALL_PATH)/tools $(PWD)/cmd/tools/* 1>/dev/null
 

cmd/tools/config-docs-generator/main.go

@@ -217,6 +217,9 @@ func (s Section) sectionPageContent() string {
 	ret += fmt.Sprintf("# %s-related Configurations"+mdNextLine, s.Name)
 	ret += s.descriptionContent() + mdNextLine
 	for _, field := range s.Fields {
+		if len(field.Description) == 0 || field.Description[0] == "" {
+			continue
+		}
 		ret += field.sectionPageContent() + mdNextLine
 	}
 
@@ -248,21 +251,20 @@ const fieldTableTemplate = `<table id="%s">
 func (f Field) sectionPageContent() string {
 	ret := fmt.Sprintf("## `%s`", f.Name) + mdNextLine
 	desp := f.descriptionContent()
-	if len(desp) > 0 {
-		desp = "\n" + desp + "      "
-	}
 	ret += fmt.Sprintf(fieldTableTemplate, f.Name, desp, f.DefaultValue)
 	return ret
 }
 
 func (f Field) descriptionContent() string {
 	var ret string
 	lines := len(f.Description)
-	for i, descLine := range f.Description {
-		ret += fmt.Sprintf("        <li>%s</li>", descLine)
-		if i < lines-1 {
-			ret += "\n"
+	if lines > 1 {
+		for _, descLine := range f.Description {
+			ret += fmt.Sprintf("\n        <li>%s</li>      ", descLine)
 		}
+	} else {
+		ret = fmt.Sprintf("        %s      ", f.Description[0])
 	}
+
 	return ret
 }

cmd/tools/config/generate_test.go

@@ -16,6 +16,7 @@ import (
 	"bytes"
 	"fmt"
 	"os"
+	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -30,20 +31,26 @@ import (
 //	 Please be noted that milvus.yaml is generated by code, so don't edit it directly, instead, change the code in paramtable
 //		and run `make milvus-tools && ./bin/tools/config gen-yaml && mv milvus.yaml configs/milvus.yaml`.
 func TestYamlFile(t *testing.T) {
+	log.SetLevel(zap.InfoLevel)
 	w := bytes.Buffer{}
 	WriteYaml(&w)
 
 	base := paramtable.NewBaseTable()
 	f, err := os.Open(fmt.Sprintf("%s/%s", base.GetConfigDir(), "milvus.yaml"))
 	assert.NoError(t, err, "expecting configs/milvus.yaml")
+	log.Info("Verifying config", zap.String("file", f.Name()))
 	defer f.Close()
 	fileScanner := bufio.NewScanner(f)
 	codeScanner := bufio.NewScanner(&w)
+
 	for fileScanner.Scan() && codeScanner.Scan() {
+		if strings.Contains(codeScanner.Text(), "etcd:") || strings.Contains(codeScanner.Text(), "minio:") || strings.Contains(codeScanner.Text(), "pulsar:") {
+			// Skip check of endpoints given by .env
+			continue
+		}
 		if fileScanner.Text() != codeScanner.Text() {
 			assert.FailNow(t, fmt.Sprintf("configs/milvus.yaml is not consistent with paramtable, file: [%s], code: [%s]. Do not edit milvus.yaml directly.",
 				fileScanner.Text(), codeScanner.Text()))
 		}
-		log.Error("", zap.Any("file", fileScanner.Text()), zap.Any("code", codeScanner.Text()))
 	}
 }