Merge pull request #65 from arduino/per1234/legacy-library-check

Add check for legacy library

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -56,6 +56,21 @@ func Configurations() []Type {
 
 // configurations is an array of structs that define the configuration of each check.
 var configurations = []Type{
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "general",
+		ID:              "LP001",
+		Brief:           "missing",
+		Description:     `Although not required for 1.0 format libraries (AKA "legacy") not in Library Manager, metadata is useful, so it is recommended.`,
+		MessageTemplate: "Library has no library.properties metadata file. This file provides useful information and is required for admission to the Library Manager index. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Default},
+		ErrorModes:      []checkmode.Type{checkmode.LibraryManagerSubmission, checkmode.LibraryManagerIndexed},
+		CheckFunction:   checkfunctions.LibraryPropertiesMissing,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",

check/checkfunctions/library.go

@@ -43,6 +43,15 @@ func LibraryPropertiesFormat() (result checkresult.Type, output string) {
 	return checkresult.Pass, ""
 }
 
+// LibraryPropertiesMissing checks for presence of library.properties.
+func LibraryPropertiesMissing() (result checkresult.Type, output string) {
+	if checkdata.LoadedLibrary().IsLegacy {
+		return checkresult.Fail, ""
+	}
+
+	return checkresult.Pass, ""
+}
+
 // MisspelledLibraryPropertiesFileName checks for incorrectly spelled library.properties file name.
 func MisspelledLibraryPropertiesFileName() (result checkresult.Type, output string) {
 	directoryListing, err := checkdata.ProjectPath().ReadDir()

check/checkfunctions/library_test.go

@@ -73,6 +73,16 @@ func TestMisspelledLibraryPropertiesFileName(t *testing.T) {
 	checkLibraryCheckFunction(MisspelledLibraryPropertiesFileName, testTables, t)
 }
 
+func TestLibraryPropertiesMissing(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Legacy", "Legacy", checkresult.Fail, ""},
+		{"Flat non-legacy", "Flat", checkresult.Pass, ""},
+		{"Recursive", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(LibraryPropertiesMissing, testTables, t)
+}
+
 func TestLibraryPropertiesNameFieldMissingOfficialPrefix(t *testing.T) {
 	testTables := []libraryCheckFunctionTestTable{
 		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},
@@ -197,7 +207,7 @@ func TestLibraryPropertiesPrecompiledFieldEnabledWithFlatLayout(t *testing.T) {
 		{"Flat layout", "PrecompiledFlat", checkresult.Fail, "^true$"},
 		{"Recursive layout", "Precompiled", checkresult.Pass, ""},
 		{"Recursive, not precompiled", "NotPrecompiled", checkresult.NotRun, ""},
-		{"Flat, not precompiled", "NotPrecompiledFlat", checkresult.NotRun, ""},
+		{"Flat, not precompiled", "Flat", checkresult.NotRun, ""},
 	}
 
 	checkLibraryCheckFunction(LibraryPropertiesPrecompiledFieldEnabledWithFlatLayout, testTables, t)

check/checkfunctions/testdata/libraries/NotPrecompiledFlat/NotPrecompiledFlat.h renamed to check/checkfunctions/testdata/libraries/Flat/Flat.h

@@ -1,4 +1,4 @@
-name=NotPrecompiledFlat
+name=Flat
 version=1.0.0
 author=Cristian Maglie <[email protected]>, Pippo Pluto <[email protected]>
 maintainer=Cristian Maglie <[email protected]>