Merge pull request #45 from arduino/per1234/dead-url-check

Add check for dead URL in library.properties url field

Author: per1234

Diff for: check/checkconfigurations/checkconfigurations.go

@@ -581,6 +581,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Default},
 		CheckFunction:   checkfunctions.LibraryPropertiesUrlFieldInvalid,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "url field",
+		ID:              "",
+		Brief:           "Dead URL",
+		Description:     "",
+		MessageTemplate: "Unable to load the library.properties url field: {{.}}",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.All},
+		ErrorModes:      nil,
+		CheckFunction:   checkfunctions.LibraryPropertiesUrlFieldDeadLink,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",

Diff for: check/checkfunctions/library.go

@@ -18,6 +18,7 @@ package checkfunctions
 // The check functions for libraries.
 
 import (
+	"net/http"
 	"strings"
 
 	"github.com/arduino/arduino-check/check/checkdata"
@@ -568,6 +569,30 @@ func LibraryPropertiesUrlFieldInvalid() (result checkresult.Type, output string)
 	return checkresult.Pass, ""
 }
 
+// LibraryPropertiesUrlFieldDeadLink checks whether the URL in the library.properties `url` field can be loaded.
+func LibraryPropertiesUrlFieldDeadLink() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	url, ok := checkdata.LibraryProperties().GetOk("url")
+	if !ok {
+		return checkresult.NotRun, ""
+	}
+
+	logrus.Tracef("Checking URL: %s", url)
+	httpResponse, err := http.Get(url)
+	if err != nil {
+		return checkresult.Fail, err.Error()
+	}
+
+	if httpResponse.StatusCode == http.StatusOK {
+		return checkresult.Pass, ""
+	}
+
+	return checkresult.Fail, httpResponse.Status
+}
+
 // LibraryPropertiesDependsFieldNotInIndex checks whether the libraries listed in the library.properties `depends` field are in the Library Manager index.
 func LibraryPropertiesDependsFieldNotInIndex() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {

Diff for: check/checkfunctions/library_test.go

@@ -124,6 +124,17 @@ func TestLibraryPropertiesParagraphFieldRepeatsSentence(t *testing.T) {
 
 	checkCheckFunction(LibraryPropertiesParagraphFieldRepeatsSentence, testTables, t)
 }
+func TestLibraryPropertiesUrlFieldDeadLink(t *testing.T) {
+	testTables := []checkFunctionTestTable{
+		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},
+		{"Not defined", "MissingFields", checkresult.NotRun, ""},
+		{"Bad URL", "BadURL", checkresult.Fail, "^Get \"http://invalid/\": dial tcp: lookup invalid:"},
+		{"HTTP error 404", "URL404", checkresult.Fail, "^404 Not Found$"},
+		{"Good URL", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkCheckFunction(LibraryPropertiesUrlFieldDeadLink, testTables, t)
+}
 
 func TestLibraryPropertiesDependsFieldNotInIndex(t *testing.T) {
 	testTables := []checkFunctionTestTable{

Diff for: check/checkfunctions/testdata/libraries/BadURL/library.properties

@@ -0,0 +1,9 @@
+name=BadURL
+version=1.0.0
+author=Cristian Maglie <[email protected]>, Pippo Pluto <[email protected]>
+maintainer=Cristian Maglie <[email protected]>
+sentence=A library that makes coding a web server a breeze.
+paragraph=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://invalid/
+architectures=avr

Diff for: check/checkfunctions/testdata/libraries/BadURL/src/BadURL.h

@@ -0,0 +1,9 @@
+name=URL404
+version=1.0.0
+author=Cristian Maglie <[email protected]>, Pippo Pluto <[email protected]>
+maintainer=Cristian Maglie <[email protected]>
+sentence=A library that makes coding a web server a breeze.
+paragraph=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://httpstat.us/404
+architectures=avr