Merge pull request #63 from arduino/per1234/valid-library-check

Add check for valid library

Author: per1234

Diff for: check/checkconfigurations/checkconfigurations.go

@@ -791,6 +791,21 @@ var configurations = []Type{
 		ErrorModes:      nil,
 		CheckFunction:   checkfunctions.LibraryPropertiesMisspelledOptionalField,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "structure",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "invalid",
+		Description:     "",
+		MessageTemplate: "Path does not contain a valid Arduino library. See: https://arduino.github.io/arduino-cli/latest/library-specification",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    nil,
+		ErrorModes:      []checkmode.Type{checkmode.All},
+		CheckFunction:   checkfunctions.LibraryInvalid,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "structure",

Diff for: check/checkfunctions/library.go

@@ -28,6 +28,7 @@ import (
 	"github.com/arduino/arduino-check/check/checkdata/schema/compliancelevel"
 	"github.com/arduino/arduino-check/check/checkresult"
 	"github.com/arduino/arduino-check/configuration"
+	"github.com/arduino/arduino-check/project/library"
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/utils"
 	"github.com/arduino/go-properties-orderedmap"
@@ -850,6 +851,23 @@ func LibraryPropertiesMisspelledOptionalField() (result checkresult.Type, output
 	return checkresult.Pass, ""
 }
 
+// LibraryInvalid checks whether the provided path is a valid library.
+func LibraryInvalid() (result checkresult.Type, output string) {
+	directoryListing, err := checkdata.LoadedLibrary().SourceDir.ReadDir()
+	if err != nil {
+		panic(err)
+	}
+
+	directoryListing.FilterOutDirs()
+	for _, potentialHeaderFile := range directoryListing {
+		if library.HasHeaderFileValidExtension(potentialHeaderFile) {
+			return checkresult.Pass, ""
+		}
+	}
+
+	return checkresult.Fail, ""
+}
+
 // LibraryHasSubmodule checks whether the library contains a Git submodule.
 func LibraryHasSubmodule() (result checkresult.Type, output string) {
 	dotGitmodulesPath := checkdata.ProjectPath().Join(".gitmodules")

Diff for: check/checkfunctions/library_test.go

@@ -25,6 +25,7 @@ import (
 	"github.com/arduino/arduino-check/project"
 	"github.com/arduino/arduino-check/project/projecttype"
 	"github.com/arduino/go-paths-helper"
+	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -193,6 +194,17 @@ func TestLibraryPropertiesPrecompiledFieldEnabledWithFlatLayout(t *testing.T) {
 	checkLibraryCheckFunction(LibraryPropertiesPrecompiledFieldEnabledWithFlatLayout, testTables, t)
 }
 
+func TestLibraryInvalid(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Invalid flat layout", "FlatWithoutHeader", checkresult.Fail, ""},
+		{"Invalid recursive layout", "RecursiveWithoutLibraryProperties", checkresult.Fail, ""},
+		{"Valid library", "Recursive", checkresult.Pass, ""},
+	}
+
+	logrus.SetLevel(logrus.ErrorLevel)
+	checkLibraryCheckFunction(LibraryInvalid, testTables, t)
+}
+
 func TestLibraryHasSubmodule(t *testing.T) {
 	testTables := []libraryCheckFunctionTestTable{
 		{"Has submodule", "Submodule", checkresult.Fail, ""},

Diff for: check/checkfunctions/testdata/libraries/FlatWithoutHeader/FlatWithoutHeader.cpp

@@ -0,0 +1,9 @@
+name=FlatWithoutHeader
+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