Refactor project identification functions

Consolidate the redundant logging code in these functions.

Author: per1234

configuration/configuration.go

@@ -31,7 +31,7 @@ func Initialize() {
 	//reportFilePath = paths.New("report.json")
 
 	feedback.SetFormat(feedback.JSON)
-	logrus.SetLevel(logrus.PanicLevel)
+	logrus.SetLevel(logrus.TraceLevel)
 
 	logrus.WithFields(logrus.Fields{
 		"superproject type filter": SuperprojectTypeFilter(),

project/project.go

@@ -143,40 +143,46 @@ func findSubprojects(superproject Type, apexSuperprojectType projecttype.Type) [
 // isProject determines if a path contains an Arduino project, and if so which type.
 func isProject(potentialProjectPath *paths.Path, projectTypeFilter projecttype.Type) (bool, projecttype.Type) {
 	logrus.Tracef("Checking if %s is %s", potentialProjectPath, projectTypeFilter)
+
+	projectType := projecttype.Not
 	if projectTypeFilter.Matches(projecttype.Sketch) && isSketch(potentialProjectPath) {
-		logrus.Tracef("%s is %s", potentialProjectPath, projecttype.Sketch)
-		return true, projecttype.Sketch
+		projectType = projecttype.Sketch
 	} else if projectTypeFilter.Matches(projecttype.Library) && isLibrary(potentialProjectPath) {
-		logrus.Tracef("%s is %s", potentialProjectPath, projecttype.Library)
-		return true, projecttype.Library
+		projectType = projecttype.Library
 	} else if projectTypeFilter.Matches(projecttype.Platform) && isPlatform(potentialProjectPath) {
-		logrus.Tracef("%s is %s", potentialProjectPath, projecttype.Platform)
-		return true, projecttype.Platform
+		projectType = projecttype.Platform
 	} else if projectTypeFilter.Matches(projecttype.PackageIndex) && isPackageIndex(potentialProjectPath) {
-		logrus.Tracef("%s is %s", potentialProjectPath, projecttype.PackageIndex)
-		return true, projecttype.PackageIndex
+		projectType = projecttype.PackageIndex
+	}
+
+	if projectType == projecttype.Not {
+		return false, projectType
 	}
-	return false, projecttype.Not
+	logrus.Tracef("%s is %s", potentialProjectPath, projectType)
+	return true, projectType
 }
 
 // isProject determines if a file is the indicator file for an Arduino project, and if so which type.
 func isProjectIndicatorFile(potentialProjectFilePath *paths.Path, projectTypeFilter projecttype.Type) (bool, projecttype.Type) {
 	logrus.Tracef("Checking if %s is %s indicator file", potentialProjectFilePath, projectTypeFilter)
+
+	projectType := projecttype.Not
 	if projectTypeFilter.Matches(projecttype.Sketch) && isSketchIndicatorFile(potentialProjectFilePath) {
-		logrus.Tracef("%s is %s indicator file", potentialProjectFilePath, projecttype.Sketch)
-		return true, projecttype.Sketch
+		projectType = projecttype.Sketch
 	} else if projectTypeFilter.Matches(projecttype.Library) && isLibraryIndicatorFile(potentialProjectFilePath) {
-		logrus.Tracef("%s is %s indicator file", potentialProjectFilePath, projecttype.Library)
-		return true, projecttype.Library
+		projectType = projecttype.Library
 	} else if projectTypeFilter.Matches(projecttype.Platform) && isPlatformIndicatorFile(potentialProjectFilePath) {
-		logrus.Tracef("%s is %s indicator file", potentialProjectFilePath, projecttype.Platform)
-		return true, projecttype.Platform
+		projectType = projecttype.Platform
 	} else if projectTypeFilter.Matches(projecttype.PackageIndex) && isPackageIndexIndicatorFile(potentialProjectFilePath) {
-		logrus.Tracef("%s is %s indicator file", potentialProjectFilePath, projecttype.PackageIndex)
-		return true, projecttype.PackageIndex
+		projectType = projecttype.PackageIndex
+	}
+
+	if projectType == projecttype.Not {
+		logrus.Tracef("%s is not indicator file", potentialProjectFilePath)
+		return false, projectType
 	}
-	logrus.Tracef("%s is not indicator file", potentialProjectFilePath)
-	return false, projecttype.Not
+	logrus.Tracef("%s is %s indicator file", potentialProjectFilePath, projectType)
+	return true, projectType
 }
 
 // isSketch determines whether a path is an Arduino sketch.

project/project_test.go

@@ -0,0 +1,24 @@
+// Package project finds and classifies Arduino projects.
+package project
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/arduino/arduino-check/project/projecttype"
+	"github.com/arduino/go-paths-helper"
+	"github.com/sirupsen/logrus"
+)
+
+func Test_isProject(t *testing.T) {
+	somepath := paths.New("e:/deleteme")
+	fmt.Printf("%s-%s", somepath, projecttype.Sketch)
+
+	logrus.SetLevel(logrus.DebugLevel)
+	logrus.WithFields(logrus.Fields{
+		"superproject type filter": projecttype.Sketch,
+		"recursive":                true,
+		"projects path":            somepath,
+	}).Debug("Configuration initialized")
+
+}

result/result_test.go

@@ -0,0 +1,14 @@
+// Package result records check results and provides reports and summary text on those results.
+package result
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/arduino/arduino-check/check/checkresult"
+)
+
+func TestInitialize(t *testing.T) {
+	summaryText := fmt.Sprintf("%v\n", checkresult.Fail)
+	print(summaryText)
+}