Add check for prohibited characters in sketch file names

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -866,6 +866,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Default},
 		CheckFunction:   checkfunctions.ProhibitedCharactersInLibraryFolderName,
 	},
+	{
+		ProjectType:     projecttype.Sketch,
+		Category:        "structure",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "disallowed characters in file name",
+		Description:     "",
+		MessageTemplate: "Prohibited characters in file name(s): {{.}}. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    nil,
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.ProhibitedCharactersInSketchFileName,
+	},
 	{
 		ProjectType:     projecttype.Sketch,
 		Category:        "structure",

check/checkfunctions/sketch.go

@@ -22,8 +22,30 @@ import (
 
 	"github.com/arduino/arduino-check/check/checkdata"
 	"github.com/arduino/arduino-check/check/checkresult"
+	"github.com/arduino/arduino-check/project/sketch"
 )
 
+// ProhibitedCharactersInSketchFileName checks for prohibited characters in the sketch file names.
+func ProhibitedCharactersInSketchFileName() (result checkresult.Type, output string) {
+	directoryListing, _ := checkdata.ProjectPath().ReadDir()
+	directoryListing.FilterOutDirs()
+
+	foundInvalidSketchFileNames := []string{}
+	for _, potentialSketchFile := range directoryListing {
+		if sketch.HasSupportedExtension(potentialSketchFile) {
+			if !validProjectPathBaseName(potentialSketchFile.Base()) {
+				foundInvalidSketchFileNames = append(foundInvalidSketchFileNames, potentialSketchFile.Base())
+			}
+		}
+	}
+
+	if len(foundInvalidSketchFileNames) > 0 {
+		return checkresult.Fail, strings.Join(foundInvalidSketchFileNames, ", ")
+	}
+
+	return checkresult.Pass, ""
+}
+
 // PdeSketchExtension checks for use of deprecated .pde sketch file extensions.
 func PdeSketchExtension() (result checkresult.Type, output string) {
 	directoryListing, _ := checkdata.ProjectPath().ReadDir()

check/checkfunctions/sketch_test.go

@@ -0,0 +1,70 @@
+// 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 [email protected].
+
+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 sketchesTestDataPath *paths.Path
+
+func init() {
+	workingDirectory, _ := os.Getwd()
+	sketchesTestDataPath = paths.New(workingDirectory, "testdata", "sketches")
+}
+
+type sketchCheckFunctionTestTable struct {
+	testName            string
+	sketchFolderName    string
+	expectedCheckResult checkresult.Type
+	expectedOutputQuery string
+}
+
+func checkSketchCheckFunction(checkFunction Type, testTables []sketchCheckFunctionTestTable, t *testing.T) {
+	for _, testTable := range testTables {
+		expectedOutputRegexp := regexp.MustCompile(testTable.expectedOutputQuery)
+
+		testProject := project.Type{
+			Path:             sketchesTestDataPath.Join(testTable.sketchFolderName),
+			ProjectType:      projecttype.Sketch,
+			SuperprojectType: projecttype.Sketch,
+		}
+
+		checkdata.Initialize(testProject, schemasPath)
+
+		result, output := checkFunction()
+		assert.Equal(t, testTable.expectedCheckResult, result, testTable.testName)
+		assert.True(t, expectedOutputRegexp.MatchString(output), testTable.testName)
+	}
+}
+
+func TestProhibitedCharactersInSketchFileName(t *testing.T) {
+	testTables := []sketchCheckFunctionTestTable{
+		{"Has prohibited characters", "ProhibitedCharactersInFileName", checkresult.Fail, "^Prohibited CharactersInFileName.h$"},
+		{"No prohibited characters", "Valid", checkresult.Pass, ""},
+	}
+
+	checkSketchCheckFunction(ProhibitedCharactersInSketchFileName, testTables, t)
+}

check/checkfunctions/testdata/sketches/ProhibitedCharactersInFileName/Prohibited CharactersInFileName.h

@@ -0,0 +1,2 @@
+void setup() {}
+void loop() {}

check/checkfunctions/testdata/sketches/ProhibitedCharactersInFileName/ProhibitedCharactersInFileName.ino

@@ -0,0 +1,2 @@
+void setup() {}
+void loop() {}

check/checkfunctions/testdata/sketches/Valid/Valid.ino

@@ -30,3 +30,9 @@ func HasMainFileValidExtension(filePath *paths.Path) bool {
 	_, hasMainFileValidExtension := globals.MainFileValidExtensions[filePath.Ext()]
 	return hasMainFileValidExtension
 }
+
+// HasSupportedExtension returns whether the file at the given path has any of the file extensions supported for source/header files of a sketch.
+func HasSupportedExtension(filePath *paths.Path) bool {
+	_, hasAdditionalFileValidExtensions := globals.AdditionalFileValidExtensions[filePath.Ext()]
+	return hasAdditionalFileValidExtensions || HasMainFileValidExtension(filePath)
+}

project/sketch/sketch.go

@@ -0,0 +1,34 @@
+// 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 [email protected].
+
+package sketch
+
+import (
+	"testing"
+
+	"github.com/arduino/go-paths-helper"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestHasMainFileValidExtension(t *testing.T) {
+	assert.True(t, HasMainFileValidExtension(paths.New("/foo/bar.ino")))
+	assert.False(t, HasMainFileValidExtension(paths.New("/foo/bar.h")))
+}
+
+func TestHasSupportedExtension(t *testing.T) {
+	assert.True(t, HasSupportedExtension(paths.New("/foo/bar.ino")))
+	assert.True(t, HasSupportedExtension(paths.New("/foo/bar.h")))
+	assert.False(t, HasSupportedExtension(paths.New("/foo/bar.baz")))
+}