Add reference for ComplianceError in String() message.

openconfig · Jun 6, 2023 · feaf522 · feaf522
1 parent eee44f8
commit feaf522
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/ygnmi/unmarshal.go b/ygnmi/unmarshal.go
@@ -78,7 +78,7 @@ func (c *ComplianceErrors) String() string {
 		return ""
 	}
 	var b strings.Builder
-	b.WriteString("Noncompliance Errors by category:")
+	b.WriteString("Noncompliance Errors by category (for explanation see https://github.com/openconfig/ygnmi#noncompliance-errors):")
 	b.WriteString("\nPath Noncompliance Errors:")
 	if len(c.PathErrors) != 0 {
 		for _, e := range c.PathErrors {

diff --git a/ygnmi/unmarshal_test.go b/ygnmi/unmarshal_test.go
@@ -15,6 +15,8 @@
 package ygnmi
 
 import (
+	"fmt"
+	"strings"
 	"testing"
 	"time"
 
@@ -952,6 +954,11 @@ func TestUnmarshal(t *testing.T) {
 				pathErrs = complianceErrs.PathErrors
 				typeErrs = complianceErrs.TypeErrors
 				validateErrs = complianceErrs.ValidateErrors
+				// Validate documentation on error
+				if !strings.Contains(complianceErrs.String(), "https://github.com/openconfig/ygnmi#noncompliance-errors") {
+					fmt.Println(complianceErrs.String())
+					t.Errorf("ComplianceError String() didn't contain expected reference to documentation.")
+				}
 			}
 			if len(pathErrs) > 1 {
 				t.Fatalf("unmarshal: got more than one path unmarshal error: %v", pathErrs)