Merge pull request #62 from arduino/per1234/name-length-check

Add checks for library and sketch base path names exceeding maximum length

Author: per1234

Diff for: check/checkconfigurations/checkconfigurations.go

@@ -881,6 +881,36 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Default},
 		CheckFunction:   checkfunctions.ProhibitedCharactersInSketchFileName,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "structure",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "folder name too long",
+		Description:     "This will be problematic for people doing manual installation of the library.",
+		MessageTemplate: "Folder name {{.}} exceeds maximum length. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Permissive},
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.LibraryFolderNameGTMaxLength,
+	},
+	{
+		ProjectType:     projecttype.Sketch,
+		Category:        "structure",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "file name too long",
+		Description:     "",
+		MessageTemplate: "File name(s): {{.}} exceed maximum length. 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.All},
+		CheckFunction:   checkfunctions.SketchFileNameGTMaxLength,
+	},
 	{
 		ProjectType:     projecttype.Sketch,
 		Category:        "structure",

Diff for: check/checkfunctions/library.go

@@ -938,6 +938,15 @@ func ProhibitedCharactersInLibraryFolderName() (result checkresult.Type, output
 	return checkresult.Pass, ""
 }
 
+// LibraryFolderNameGTMaxLength checks if the library folder name exceeds the maximum length.
+func LibraryFolderNameGTMaxLength() (result checkresult.Type, output string) {
+	if len(checkdata.ProjectPath().Base()) > 63 {
+		return checkresult.Fail, checkdata.ProjectPath().Base()
+	}
+
+	return checkresult.Pass, ""
+}
+
 // spellCheckLibraryPropertiesFieldValue returns the value of the provided library.properties field with commonly misspelled words corrected.
 func spellCheckLibraryPropertiesFieldValue(fieldName string) (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {

Diff for: check/checkfunctions/library_test.go

@@ -251,3 +251,12 @@ func TestProhibitedCharactersInLibraryFolderName(t *testing.T) {
 
 	checkLibraryCheckFunction(ProhibitedCharactersInLibraryFolderName, testTables, t)
 }
+
+func TestLibraryFolderNameGTMaxLength(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Has folder name > max length", "FolderNameTooLong12345678901234567890123456789012345678901234567890", checkresult.Fail, "^FolderNameTooLong12345678901234567890123456789012345678901234567890$"},
+		{"Folder name <= max length", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(LibraryFolderNameGTMaxLength, testTables, t)
+}

Diff for: check/checkfunctions/sketch.go

@@ -46,6 +46,27 @@ func ProhibitedCharactersInSketchFileName() (result checkresult.Type, output str
 	return checkresult.Pass, ""
 }
 
+// SketchFileNameGTMaxLength checks if the sketch file names exceed the maximum length.
+func SketchFileNameGTMaxLength() (result checkresult.Type, output string) {
+	directoryListing, _ := checkdata.ProjectPath().ReadDir()
+	directoryListing.FilterOutDirs()
+
+	foundTooLongSketchFileNames := []string{}
+	for _, potentialSketchFile := range directoryListing {
+		if sketch.HasSupportedExtension(potentialSketchFile) {
+			if len(potentialSketchFile.Base())-len(potentialSketchFile.Ext()) > 63 {
+				foundTooLongSketchFileNames = append(foundTooLongSketchFileNames, potentialSketchFile.Base())
+			}
+		}
+	}
+
+	if len(foundTooLongSketchFileNames) > 0 {
+		return checkresult.Fail, strings.Join(foundTooLongSketchFileNames, ", ")
+	}
+
+	return checkresult.Pass, ""
+}
+
 // PdeSketchExtension checks for use of deprecated .pde sketch file extensions.
 func PdeSketchExtension() (result checkresult.Type, output string) {
 	directoryListing, _ := checkdata.ProjectPath().ReadDir()

Diff for: check/checkfunctions/sketch_test.go

@@ -68,3 +68,12 @@ func TestProhibitedCharactersInSketchFileName(t *testing.T) {
 
 	checkSketchCheckFunction(ProhibitedCharactersInSketchFileName, testTables, t)
 }
+
+func TestSketchFileNameGTMaxLength(t *testing.T) {
+	testTables := []sketchCheckFunctionTestTable{
+		{"Has file name > max length", "FileNameTooLong", checkresult.Fail, "^FileNameTooLong12345678901234567890123456789012345678901234567890.h$"},
+		{"File names <= max length", "Valid", checkresult.Pass, ""},
+	}
+
+	checkSketchCheckFunction(SketchFileNameGTMaxLength, testTables, t)
+}

Diff for: check/checkfunctions/testdata/libraries/FolderNameTooLong12345678901234567890123456789012345678901234567890/library.properties

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

Diff for: check/checkfunctions/testdata/libraries/FolderNameTooLong12345678901234567890123456789012345678901234567890/src/FolderNameTooLong.h

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