Merge pull request #93 from openconfig/add-documentation-to-complianc…

…eerr

Add reference for ComplianceError in String() message.

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 (see https://github.com/openconfig/ygnmi#noncompliance-errors):")
 	b.WriteString("\nPath Noncompliance Errors:")
 	if len(c.PathErrors) != 0 {
 		for _, e := range c.PathErrors {

ygnmi/unmarshal_test.go

@@ -15,6 +15,7 @@
 package ygnmi
 
 import (
+	"strings"
 	"testing"
 	"time"
 
@@ -952,6 +953,10 @@ 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") {
+					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)