Add convenience functions for detecting whether a path contains library files

Author: per1234

check/checkfunctions/library.go

@@ -904,16 +904,8 @@ func LibraryPropertiesMisspelledOptionalField() (result checkresult.Type, output
 
 // 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, ""
-		}
+	if library.ContainsHeaderFile(checkdata.LoadedLibrary().SourceDir) {
+		return checkresult.Pass, ""
 	}
 
 	return checkresult.Fail, ""

project/library/library.go

@@ -17,6 +17,8 @@
 package library
 
 import (
+	"fmt"
+
 	"github.com/arduino/go-paths-helper"
 )
 
@@ -35,6 +37,30 @@ func HasHeaderFileValidExtension(filePath *paths.Path) bool {
 	return hasHeaderFileValidExtension
 }
 
+// ContainsHeaderFile checks whether the provided path contains a file with valid header extension.
+func ContainsHeaderFile(searchPath *paths.Path) bool {
+	if searchPath.NotExist() {
+		panic(fmt.Sprintf("Error: provided path %s does not exist.", searchPath))
+	}
+	if searchPath.IsNotDir() {
+		panic(fmt.Sprintf("Error: provided path %s is not a directory.", searchPath))
+	}
+
+	directoryListing, err := searchPath.ReadDir()
+	if err != nil {
+		panic(err)
+	}
+
+	directoryListing.FilterOutDirs()
+	for _, potentialHeaderFile := range directoryListing {
+		if HasHeaderFileValidExtension(potentialHeaderFile) {
+			return true
+		}
+	}
+
+	return false
+}
+
 // See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata
 var metadataFilenames = map[string]struct{}{
 	"library.properties": empty,
@@ -49,6 +75,30 @@ func IsMetadataFile(filePath *paths.Path) bool {
 	return false
 }
 
+// ContainsMetadataFile checks whether the provided path contains an Arduino library metadata file.
+func ContainsMetadataFile(searchPath *paths.Path) bool {
+	if searchPath.NotExist() {
+		panic(fmt.Sprintf("Error: provided path %s does not exist.", searchPath))
+	}
+	if searchPath.IsNotDir() {
+		panic(fmt.Sprintf("Error: provided path %s is not a directory.", searchPath))
+	}
+
+	directoryListing, err := searchPath.ReadDir()
+	if err != nil {
+		panic(err)
+	}
+
+	directoryListing.FilterOutDirs()
+	for _, potentialMetadataFile := range directoryListing {
+		if IsMetadataFile(potentialMetadataFile) {
+			return true
+		}
+	}
+
+	return false
+}
+
 // See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples
 var examplesFolderValidNames = map[string]struct{}{
 	"examples": empty,

project/library/library_test.go

@@ -0,0 +1,41 @@
+// This file is part of arduino-check.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-check.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package library
+
+import (
+	"os"
+	"testing"
+
+	"github.com/arduino/go-paths-helper"
+	"github.com/stretchr/testify/assert"
+)
+
+var testDataPath *paths.Path
+
+func init() {
+	workingDirectory, _ := os.Getwd()
+	testDataPath = paths.New(workingDirectory, "testdata")
+}
+
+func TestContainsHeaderFile(t *testing.T) {
+	assert.True(t, ContainsHeaderFile(testDataPath.Join("ContainsHeaderFile")))
+	assert.False(t, ContainsHeaderFile(testDataPath.Join("ContainsNoHeaderFile")))
+}
+
+func TestContainsMetadataFile(t *testing.T) {
+	assert.True(t, ContainsMetadataFile(testDataPath.Join("ContainsMetadataFile")))
+	assert.False(t, ContainsMetadataFile(testDataPath.Join("ContainsNoMetadataFile")))
+}