Add check for includes missing from library

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -701,6 +701,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Default},
 		CheckFunction:   checkfunctions.LibraryPropertiesIncludesFieldLTMinLength,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "includes field",
+		ID:              "",
+		Brief:           "includes file not in library",
+		Description:     `People often think this is the way to define their library's dependencies, which breaks the "Sketch > Include Library" feature for that library.`,
+		MessageTemplate: "library.properties includes field item(s) {{.}} not found in library.",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Permissive},
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.LibraryPropertiesIncludesFieldItemNotFound,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",

check/checkdata/library.go

@@ -50,6 +50,12 @@ func InitializeForLibrary(project project.Type, schemasPath *paths.Path) {
 	if err != nil {
 		logrus.Errorf("Error loading library from %s: %s", project.Path, err)
 		loadedLibrary = nil
+		sourceHeaders = nil
+	} else {
+		sourceHeaders, err = loadedLibrary.SourceHeaders()
+		if err != nil {
+			panic(err)
+		}
 	}
 
 	if libraryManagerIndex == nil { // Only download the Library Manager index once
@@ -106,6 +112,13 @@ func LoadedLibrary() *libraries.Library {
 	return loadedLibrary
 }
 
+var sourceHeaders []string
+
+// SourceHeaders returns the list of library source header filenames discovered by Arduino CLI.
+func SourceHeaders() []string {
+	return sourceHeaders
+}
+
 var libraryManagerIndex map[string]interface{}
 
 // LibraryManagerIndex returns the Library Manager index data.

check/checkfunctions/library.go

@@ -723,6 +723,47 @@ func LibraryPropertiesIncludesFieldLTMinLength() (result checkresult.Type, outpu
 	return checkresult.Pass, ""
 }
 
+// LibraryPropertiesIncludesFieldItemNotFound checks whether the header files specified in the library.properties `includes` field are in the library.
+func LibraryPropertiesIncludesFieldItemNotFound() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	includes, ok := checkdata.LibraryProperties().GetOk("includes")
+	if !ok {
+		return checkresult.NotRun, ""
+	}
+
+	includesList, err := properties.SplitQuotedString(includes, "", false)
+	if err != nil {
+		panic(err)
+	}
+
+	findInclude := func(include string) bool {
+		for _, header := range checkdata.SourceHeaders() {
+			logrus.Tracef("Comparing include %s with header file %s", include, header)
+			if include == header {
+				logrus.Tracef("match!")
+				return true
+			}
+		}
+		return false
+	}
+
+	includesNotInLibrary := []string{}
+	for _, include := range includesList {
+		if !findInclude(include) {
+			includesNotInLibrary = append(includesNotInLibrary, include)
+		}
+	}
+
+	if len(includesNotInLibrary) > 0 {
+		return checkresult.Fail, strings.Join(includesNotInLibrary, ", ")
+	}
+
+	return checkresult.Pass, ""
+}
+
 // LibraryPropertiesPrecompiledFieldInvalid checks for invalid value in the library.properties "precompiled" field.
 func LibraryPropertiesPrecompiledFieldInvalid() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {

check/checkfunctions/library_test.go

@@ -158,6 +158,17 @@ func TestLibraryPropertiesDotALinkageFieldTrueWithFlatLayout(t *testing.T) {
 	checkCheckFunction(LibraryPropertiesDotALinkageFieldTrueWithFlatLayout, testTables, t)
 }
 
+func TestLibraryPropertiesIncludesFieldItemNotFound(t *testing.T) {
+	testTables := []checkFunctionTestTable{
+		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},
+		{"Not defined", "MissingFields", checkresult.NotRun, ""},
+		{"Missing includes", "MissingIncludes", checkresult.Fail, "^Nonexistent.h$"},
+		{"Present includes", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkCheckFunction(LibraryPropertiesIncludesFieldItemNotFound, testTables, t)
+}
+
 func TestLibraryPropertiesPrecompiledFieldEnabledWithFlatLayout(t *testing.T) {
 	testTables := []checkFunctionTestTable{
 		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},

check/checkfunctions/testdata/libraries/MissingIncludes/library.properties

@@ -0,0 +1,10 @@
+name=MissingIncludes
+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
+includes=Nonexistent.h