Merge pull request #37 from arduino/per1234/official-name-prefix-check

Add check for official library name prefix

Author: per1234

Diff for: check/checkconfigurations/checkconfigurations.go

@@ -176,6 +176,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Default},
 		CheckFunction:   checkfunctions.LibraryPropertiesNameFieldStartsWithArduino,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "name field",
+		ID:              "",
+		Brief:           "missing official prefix",
+		Description:     "",
+		MessageTemplate: `Library name {{.}} is missing the "Arduino_" prefix. All new official library names must use this prefix.`,
+		DisableModes:    []checkmode.Type{checkmode.Default},
+		EnableModes:     []checkmode.Type{checkmode.Official},
+		InfoModes:       nil,
+		WarningModes:    nil,
+		ErrorModes:      []checkmode.Type{checkmode.Official},
+		CheckFunction:   checkfunctions.LibraryPropertiesNameFieldMissingOfficialPrefix,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",

Diff for: check/checkfunctions/library.go

@@ -151,6 +151,23 @@ func LibraryPropertiesNameFieldStartsWithArduino() (result checkresult.Type, out
 	return checkresult.Pass, ""
 }
 
+// LibraryPropertiesNameFieldMissingOfficialPrefix checks whether the library.properties `name` value uses the prefix required of all new official Arduino libraries.
+func LibraryPropertiesNameFieldMissingOfficialPrefix() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	name, ok := checkdata.LibraryProperties().GetOk("name")
+	if !ok {
+		return checkresult.NotRun, ""
+	}
+
+	if strings.HasPrefix(name, "Arduino_") {
+		return checkresult.Pass, ""
+	}
+	return checkresult.Fail, name
+}
+
 // LibraryPropertiesNameFieldContainsArduino checks if the library.properties "name" value contains "Arduino".
 func LibraryPropertiesNameFieldContainsArduino() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {

Diff for: check/checkfunctions/library_test.go

@@ -62,6 +62,17 @@ func checkCheckFunction(checkFunction Type, testTables []checkFunctionTestTable,
 	}
 }
 
+func TestLibraryPropertiesNameFieldMissingOfficialPrefix(t *testing.T) {
+	testTables := []checkFunctionTestTable{
+		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},
+		{"Not defined", "MissingFields", checkresult.NotRun, ""},
+		{"Correct prefix", "Arduino_Official", checkresult.Pass, ""},
+		{"Incorrect prefix", "Recursive", checkresult.Fail, "^Recursive$"},
+	}
+
+	checkCheckFunction(LibraryPropertiesNameFieldMissingOfficialPrefix, testTables, t)
+}
+
 func TestLibraryPropertiesNameFieldDuplicate(t *testing.T) {
 	testTables := []checkFunctionTestTable{
 		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},

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

@@ -0,0 +1,9 @@
+name=Arduino_Official
+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://example.com/
+architectures=avr