Add option: AllowExternalLinksToFail

wjdp · Jan 4, 2020 · 33a1d0f · 33a1d0f
1 parent 57fe7e6
commit 33a1d0f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/htmltest/check-link.go b/htmltest/check-link.go
@@ -111,6 +111,10 @@ func (hT *HTMLTest) checkLink(document *htmldoc.Document, node *html.Node) {
 }
 
 func (hT *HTMLTest) checkExternal(ref *htmldoc.Reference) {
+	issueLevel := issues.LevelError
+	if hT.opts.AllowExternalLinksToFail {
+		issueLevel = issues.LevelWarning
+	}
 	if !hT.opts.CheckExternal {
 		hT.issueStore.AddIssue(issues.Issue{
 			Level:     issues.LevelDebug,
@@ -184,15 +188,15 @@ func (hT *HTMLTest) checkExternal(ref *htmldoc.Reference) {
 				cleanedMessage := strings.TrimPrefix(err.Error(), prefix)
 				// Add error
 				hT.issueStore.AddIssue(issues.Issue{
-					Level:     issues.LevelError,
+					Level:     issueLevel,
 					Message:   cleanedMessage,
 					Reference: ref,
 				})
 				return
 			}
 			if strings.Contains(err.Error(), "Client.Timeout") {
 				hT.issueStore.AddIssue(issues.Issue{
-					Level:     issues.LevelError,
+					Level:     issueLevel,
 					Message:   "request exceeded our ExternalTimeout",
 					Reference: ref,
 				})
@@ -213,7 +217,7 @@ func (hT *HTMLTest) checkExternal(ref *htmldoc.Reference) {
 
 			// Unhandled client error, return generic error
 			hT.issueStore.AddIssue(issues.Issue{
-				Level:     issues.LevelError,
+				Level:     issueLevel,
 				Message:   err.Error(),
 				Reference: ref,
 			})
@@ -249,7 +253,7 @@ func (hT *HTMLTest) checkExternal(ref *htmldoc.Reference) {
 		} else {
 			// Failed VCRed requests end up here with a status code of zero
 			hT.issueStore.AddIssue(issues.Issue{
-				Level:     issues.LevelError,
+				Level:     issueLevel,
 				Message:   fmt.Sprintf("%s %d", "Non-OK status:", statusCode),
 				Reference: ref,
 			})

diff --git a/htmltest/options.go b/htmltest/options.go
@@ -13,6 +13,8 @@ import (
 // Options struct for htmltest, user and default options are merged and mapped
 // into an instance of this struct.
 type Options struct {
+	AllowExternalLinksToFail bool
+
 	DirectoryPath  string
 	DirectoryIndex string
 	FilePath       string
@@ -78,6 +80,8 @@ type Options struct {
 func DefaultOptions() map[string]interface{} {
 	// Specify defaults here
 	return map[string]interface{}{
+		"AllowExternalLinksToFail": false,
+
 		"DirectoryIndex": "index.html",
 		"FileExtension":  ".html",