check_library_manager_compliance: Improve error/warning messages

Author: per1234

arduino-ci-script.sh

@@ -2280,28 +2280,28 @@ function check_library_manager_compliance() {
 
   # Check whether folder exists
   if [[ ! -d "$normalizedLibraryPath" ]]; then
-    echo "ERROR: Specified folder: $libraryPath doesn't exist."
+    echo "ERROR: ${libraryPath}: Folder doesn't exist."
     return $ARDUINO_CI_SCRIPT_CHECK_LIBRARY_MANAGER_COMPLIANCE_FOLDER_DOESNT_EXIST_EXIT_STATUS
   fi
 
   # Check for .exe files
   local -r exePath=$(find "$normalizedLibraryPath" -type f -name '*.exe')
   if [[ "$exePath" != "" ]]; then
-    echo "ERROR: .exe file found at $exePath"
+    echo "ERROR: ${exePath}: .exe file found."
     exitStatus=$(set_exit_status "$exitStatus" $ARDUINO_CI_SCRIPT_CHECK_LIBRARY_MANAGER_COMPLIANCE_EXE_FOUND_EXIT_STATUS)
   fi
 
   # Check for .development file
   local -r dotDevelopmentPath=$(find "$normalizedLibraryPath" -maxdepth 1 -type f -name '.development')
   if [[ "$dotDevelopmentPath" != "" ]]; then
-    echo "ERROR: .development file found at $dotDevelopmentPath"
+    echo "ERROR: ${dotDevelopmentPath}: .development file found."
     exitStatus=$(set_exit_status "$exitStatus" $ARDUINO_CI_SCRIPT_CHECK_LIBRARY_MANAGER_COMPLIANCE_DOT_DEVELOPMENT_FOUND_EXIT_STATUS)
   fi
 
   # Check for symlink
   local -r symlinkPath=$(find "$normalizedLibraryPath" -type l)
   if [[ "$symlinkPath" != "" ]]; then
-    echo "ERROR: Symlink found at $symlinkPath"
+    echo "ERROR: ${symlinkPath}: Symlink found."
     exitStatus=$(set_exit_status "$exitStatus" $ARDUINO_CI_SCRIPT_CHECK_LIBRARY_MANAGER_COMPLIANCE_SYMLINK_FOUND_EXIT_STATUS)
   fi
 
@@ -2317,7 +2317,7 @@ function check_library_manager_compliance() {
     check_folder_name "$libraryManagerFolderName"
     local -r checkFolderNameExitStatus=$?
     if [[ $checkFolderNameExitStatus -ne $ARDUINO_CI_SCRIPT_SUCCESS_EXIT_STATUS ]]; then
-      echo "ERROR: ${normalizedLibraryPath}'s name value $nameValue does not meet the requirements of the Arduino Library Manager indexer. See: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#libraryproperties-file-format"
+      echo "ERROR: ${normalizedLibraryPath}/library.properties: name value: $nameValue does not meet the requirements of the Arduino Library Manager indexer. See: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#libraryproperties-file-format"
       exitStatus=$(set_exit_status "$exitStatus" $((ARDUINO_CI_SCRIPT_CHECK_LIBRARY_MANAGER_COMPLIANCE_CHECK_FOLDER_NAME_OFFSET + checkFolderNameExitStatus)))
     fi
   fi

tests/check_library_manager_compliance.bats

@@ -16,7 +16,7 @@ source ../arduino-ci-script.sh
   echo "Exit status: $status | Expected: $expectedExitStatus"
   [ "$status" -eq $expectedExitStatus ]
   [ "${#lines[@]}" -eq 1 ]
-  outputRegex="^ERROR: Specified folder: \./check_library_manager_compliance/DoesntExist doesn't exist\.$"
+  outputRegex="^ERROR: \./check_library_manager_compliance/DoesntExist: Folder doesn't exist\.$"
   [[ "${lines[0]}" =~ $outputRegex ]]
 }
 
@@ -26,7 +26,7 @@ source ../arduino-ci-script.sh
   echo "Exit status: $status | Expected: $expectedExitStatus"
   [ "$status" -eq $expectedExitStatus ]
   [ "${#lines[@]}" -eq 1 ]
-  outputRegex='^ERROR: \.exe file found at \./check_library_manager_compliance/ContainsExe/asdf\.exe$'
+  outputRegex='^ERROR: \./check_library_manager_compliance/ContainsExe/asdf\.exe: \.exe file found\.$'
   [[ "${lines[0]}" =~ $outputRegex ]]
 }
 
@@ -36,7 +36,7 @@ source ../arduino-ci-script.sh
   echo "Exit status: $status | Expected: $expectedExitStatus"
   [ "$status" -eq $expectedExitStatus ]
   [ "${#lines[@]}" -eq 1 ]
-  outputRegex='^ERROR: \.development file found at \./check_library_manager_compliance/ContainsDotDevelopment/\.development$'
+  outputRegex='^ERROR: \./check_library_manager_compliance/ContainsDotDevelopment/\.development: \.development file found\.$'
   [[ "${lines[0]}" =~ $outputRegex ]]
 }
 
@@ -46,7 +46,7 @@ source ../arduino-ci-script.sh
   echo "Exit status: $status | Expected: $expectedExitStatus"
   [ "$status" -eq $expectedExitStatus ]
   [ "${#lines[@]}" -eq 1 ]
-  outputRegex='^ERROR: Symlink found at \./check_library_manager_compliance/ContainsSymlink/IsSymlink$'
+  outputRegex='^ERROR: \./check_library_manager_compliance/ContainsSymlink/IsSymlink: Symlink found\.$'
   [[ "${lines[0]}" =~ $outputRegex ]]
 }
 
@@ -59,7 +59,7 @@ source ../arduino-ci-script.sh
   [ "${#lines[@]}" -eq 2 ]
   outputRegex='^ERROR: Invalid folder name: -Foobar\. Folder name beginning with a - or \. is not allowed\.$'
   [[ "${lines[0]}" =~ $outputRegex ]]
-  outputRegex="^ERROR: \./check_library_manager_compliance/InvalidCharactersAtStartOfName's name value -Foobar does not meet the requirements of the Arduino Library Manager indexer\. See: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#libraryproperties-file-format$"
+  outputRegex="^ERROR: \./check_library_manager_compliance/InvalidCharactersAtStartOfName/library.properties: name value: -Foobar does not meet the requirements of the Arduino Library Manager indexer\. See: https://github\.com/arduino/Arduino/wiki/Arduino-IDE-1\.5:-Library-specification#libraryproperties-file-format$"
   [[ "${lines[1]}" =~ $outputRegex ]]
 }
 
@@ -71,7 +71,7 @@ source ../arduino-ci-script.sh
   [ "${#lines[@]}" -eq 2 ]
   outputRegex='^ERROR: Invalid folder name: Foo\(bar\)\. Only letters, numbers, dots, dashes, and underscores are allowed\.$'
   [[ "${lines[0]}" =~ $outputRegex ]]
-  outputRegex="^ERROR: \./check_library_manager_compliance/InvalidCharactersInName's name value Foo\(bar\) does not meet the requirements of the Arduino Library Manager indexer\. See: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#libraryproperties-file-format$"
+  outputRegex="^ERROR: \./check_library_manager_compliance/InvalidCharactersInName/library.properties: name value: Foo\(bar\) does not meet the requirements of the Arduino Library Manager indexer\. See: https://github\.com/arduino/Arduino/wiki/Arduino-IDE-1\.5:-Library-specification#libraryproperties-file-format$"
   [[ "${lines[1]}" =~ $outputRegex ]]
 }
 
@@ -83,6 +83,6 @@ source ../arduino-ci-script.sh
   [ "${#lines[@]}" -eq 2 ]
   outputRegex='^ERROR: Folder name asdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdf exceeds the maximum of 63 characters\.$'
   [[ "${lines[0]}" =~ $outputRegex ]]
-  outputRegex="^ERROR: \./check_library_manager_compliance/NameTooLong's name value asdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdf does not meet the requirements of the Arduino Library Manager indexer\. See: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#libraryproperties-file-format$"
+  outputRegex="^ERROR: \./check_library_manager_compliance/NameTooLong/library\.properties: name value: asdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdf does not meet the requirements of the Arduino Library Manager indexer\. See: https://github\.com/arduino/Arduino/wiki/Arduino-IDE-1\.5:-Library-specification#libraryproperties-file-format$"
   [[ "${lines[1]}" =~ $outputRegex ]]
 }