Add dedicated file for tests of the functions in check/checkfunctions/checkfunctions.go

check/checkfunctions/checkfunctions.go will contain check functions that aren't specific to a single project type. There
are a large, ever increasing, number of tests for check functions, and each group of check function types may have
different testing requirements, so it's helpful to split them up a bit.

Author: per1234

check/checkfunctions/checkfunctions_test.go

@@ -0,0 +1,72 @@
+// 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 checkfunctions
+
+import (
+	"os"
+	"regexp"
+	"testing"
+
+	"github.com/arduino/arduino-check/check/checkdata"
+	"github.com/arduino/arduino-check/check/checkresult"
+	"github.com/arduino/arduino-check/project"
+	"github.com/arduino/arduino-check/project/projecttype"
+	"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", "general")
+}
+
+type checkFunctionTestTable struct {
+	testName            string
+	projectFolderName   string
+	projectType         projecttype.Type
+	superProjectType    projecttype.Type
+	expectedCheckResult checkresult.Type
+	expectedOutputQuery string
+}
+
+func checkCheckFunction(checkFunction Type, testTables []checkFunctionTestTable, t *testing.T) {
+	for _, testTable := range testTables {
+		expectedOutputRegexp := regexp.MustCompile(testTable.expectedOutputQuery)
+
+		testProject := project.Type{
+			Path:             testDataPath.Join(testTable.projectFolderName),
+			ProjectType:      testTable.projectType,
+			SuperprojectType: testTable.superProjectType,
+		}
+
+		checkdata.Initialize(testProject, schemasPath)
+
+		result, output := checkFunction()
+		assert.Equal(t, testTable.expectedCheckResult, result, testTable.testName)
+		assert.True(t, expectedOutputRegexp.MatchString(output), testTable.testName)
+	}
+}
+
+func TestMissingReadme(t *testing.T) {
+	testTables := []checkFunctionTestTable{
+		{"Readme", "readme", projecttype.Sketch, projecttype.Sketch, checkresult.Pass, ""},
+		{"No readme", "no-readme", projecttype.Sketch, projecttype.Sketch, checkresult.Fail, ""},
+	}
+
+	checkCheckFunction(MissingReadme, testTables, t)
+}

check/checkfunctions/library_test.go

@@ -29,12 +29,12 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-var testDataPath *paths.Path
+var librariesTestDataPath *paths.Path
 var schemasPath *paths.Path
 
 func init() {
 	workingDirectory, _ := os.Getwd()
-	testDataPath = paths.New(workingDirectory, "testdata", "libraries")
+	librariesTestDataPath = paths.New(workingDirectory, "testdata", "libraries")
 	schemasPath = paths.New(workingDirectory, "..", "..", "etc", "schemas")
 }
 
@@ -50,7 +50,7 @@ func checkLibraryCheckFunction(checkFunction Type, testTables []libraryCheckFunc
 		expectedOutputRegexp := regexp.MustCompile(testTable.expectedOutputQuery)
 
 		testProject := project.Type{
-			Path:             testDataPath.Join(testTable.libraryFolderName),
+			Path:             librariesTestDataPath.Join(testTable.libraryFolderName),
 			ProjectType:      projecttype.Library,
 			SuperprojectType: projecttype.Library,
 		}
@@ -263,9 +263,9 @@ func TestLibraryHasSubmodule(t *testing.T) {
 
 func TestLibraryContainsSymlinks(t *testing.T) {
 	testLibrary := "Recursive"
-	symlinkPath := testDataPath.Join(testLibrary, "test-symlink")
+	symlinkPath := librariesTestDataPath.Join(testLibrary, "test-symlink")
 	// It's probably most friendly to developers using Windows to create the symlink needed for the test on demand.
-	err := os.Symlink(testDataPath.Join(testLibrary, "library.properties").String(), symlinkPath.String())
+	err := os.Symlink(librariesTestDataPath.Join(testLibrary, "library.properties").String(), symlinkPath.String())
 	require.Nil(t, err, "This test must be run as administrator on Windows to have symlink creation privilege.")
 	defer symlinkPath.RemoveAll() // clean up
 
@@ -392,12 +392,3 @@ func TestRecursiveLibraryWithUtilityFolder(t *testing.T) {
 
 	checkLibraryCheckFunction(RecursiveLibraryWithUtilityFolder, testTables, t)
 }
-
-func TestMissingReadme(t *testing.T) {
-	testTables := []libraryCheckFunctionTestTable{
-		{"Readme", "Readme", checkresult.Pass, ""},
-		{"No readme", "NoReadme", checkresult.Fail, ""},
-	}
-
-	checkLibraryCheckFunction(MissingReadme, testTables, t)
-}