Add check_code_formatting

Fixes #14

Author: per1234

.travis.yml

@@ -82,7 +82,7 @@ matrix:
         - cd ..
         - git clone https://github.com/per1234/arduino-ci-script-tests
         - cd arduino-ci-script-tests
-        - git checkout 2cb113ce9bfa1503dff3faf68e55f03ab99e13a6
+        - git checkout 6b9758211e957689803b05008e705cb88758bd2b
       script:
         - bats check_keywords_txt.bats
         - bats check_library_manager_compliance.bats
@@ -190,6 +190,8 @@ script:
 
   - check_library_manager_compliance "${SKETCHBOOK_FOLDER}/libraries/NewPing"
 
+  - check_code_formatting "1" "" "${APPLICATION_FOLDER}/arduino/examples/01.Basics/BareMinimum"
+
   # Test library installed from .zip with rename
   # Test library installed from .zip with dot in the folder name
   # Test board from hardware package manually installed from compressed file download

README.md

@@ -52,7 +52,7 @@ Control the level of verbosity of the script's output in the Travis CI log. Verb
 - Parameter: **SCRIPT_VERBOSITY_LEVEL** - `0`, `1` or `2` (least to most verbosity).
 
 ##### `set_application_folder APPLICATION_FOLDER`
-- Parameter: **APPLICATION_FOLDER** - The folder to install the Arduino IDE to. This should be set to `/usr/local/share` or a subfolder of that location. The folder will be created if it doesn't already exist. The Arduino IDE will be installed in the `arduino` subfolder.
+- Parameter: **APPLICATION_FOLDER** - The folder to install the Arduino IDE (and Artistic Style if you use `check_code_formatting`) to. This should be set to `/usr/local/share` or a subfolder of that location. The folder will be created if it doesn't already exist. The Arduino IDE will be installed in the `arduino` subfolder.
 
 ##### `set_sketchbook_folder SKETCHBOOK_FOLDER`
 - Parameter: **SKETCHBOOK_FOLDER** - The folder to be set as the Arduino IDE's sketchbook folder. The folder will be created if it doesn't already exist. Libraries installed via `install_library` will be installed to the `libraries` subfolder. Non-Boards Manager hardware packages installed via `install_package` will be installed to the `hardware` subfolder. This setting is only supported by Arduino IDE 1.5.6 and newer.
@@ -142,6 +142,15 @@ Check [keywords.txt](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Li
 Make some additional checks for compliance with the requirements for adding a library to the [Library Manager index](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ). This function should be used in combination with `check_library_structure' and 'check_library_properties' to ensure full compliance with the requirements.
 - Parameter: **libraryPath** - Path of the library to check.
 
+##### `check_code_formatting strictness excludedPathList targetPath`
+Check code formatting for compliance with the Arduino code style. The [Artistic Style](http://astyle.sourceforge.net) formatter tool is used for this check. If it's not already installed, it will be installed to the `astyle` subfolder of the folder specified to `set_application_folder`.
+- Parameter: **strictness** - Determines how strict to be about code formatting compliance: 1 (least strict) - 3 (most strict). Each strictness level is based on the previous one, but with additional requirements.
+  - `1`: The Arduino IDE's auto format configuration.
+  - `2`: The configuration Arduino uses to format their example sketches.
+  - `3`: A custom configuration based on a study of the prevailing styles used in official Arduino code.
+- Parameter: **excludedPathList** - A comma-separated list of paths to exclude from the check.
+- Parameter: **targetPath** - The path to run the check on. All code files will be checked recursively.
+
 ##### `build_sketch sketchPath boardID allowFail IDEversion`
 ##### `build_sketch sketchPath boardID allowFail [IDEversionList]`
 ##### `build_sketch sketchPath boardID allowFail startIDEversion endIDEversion`

arduino-ci-script.sh

@@ -2333,6 +2333,76 @@ function check_library_manager_compliance() {
   return "$exitStatus"
 }
 
+function check_code_formatting() {
+  local -r strictness="$1"
+  local -r excludedPathList="$2"
+  local -r targetPath="$3"
+
+  local -r astyleConfigurationFolder="etc/astyle-configurations"
+  local -r astyleConfigurationExtension=".conf"
+
+  # Fold the output in the Travis CI log
+  echo -e -n 'travis_fold:start:check_code_formatting\r'
+
+  if [[ $strictness -lt 1 ]] || [[ $strictness -gt 3 ]]; then
+    echo "ERROR: Invalid strictness parameter value. Valid values are 1 (least strict) - 3 (most strict)"
+    return "$ARDUINO_CI_SCRIPT_FAILURE_EXIT_STATUS"
+  fi
+
+  if ! [[ -d "$targetPath" ]]; then
+    echo "ERROR: targetPath doesn't exist"
+    return "$ARDUINO_CI_SCRIPT_FAILURE_EXIT_STATUS"
+  fi
+
+  local scriptFolder
+  # https://stackoverflow.com/a/246128
+  local scriptSource="${BASH_SOURCE[0]}"
+  while [ -h "$scriptSource" ]; do # Resolve $scriptSource until the file is no longer a symlink
+    scriptFolder="$(cd -P "$(dirname "$scriptSource")" >/dev/null 2>&1 && pwd)"
+    scriptSource="$(readlink "$scriptSource")"
+    [[ $scriptSource != /* ]] && scriptSource="$scriptFolder/$scriptSource" # If $scriptSource was a relative symlink, we need to resolve it relative to the path where the symlink file was located
+  done
+  scriptFolder="$(cd -P "$(dirname "$scriptSource")" >/dev/null 2>&1 && pwd)"
+
+  # Assemble the find options for the excluded paths from the list
+  for excludedPath in ${excludedPathList//,/ }; do
+    excludeOptions="$excludeOptions -path $excludedPath -prune -or"
+  done
+
+  local astylePath
+  astylePath=$(command -v astyle)
+  if [[ ! -e "$astylePath" ]]; then
+    # Install astyle
+    # Save the current folder
+    local -r previousFolder="$PWD"
+    mkdir "${ARDUINO_CI_SCRIPT_APPLICATION_FOLDER}/astyle"
+    wget --no-verbose $ARDUINO_CI_SCRIPT_QUIET_OPTION --output-document="${ARDUINO_CI_SCRIPT_TEMPORARY_FOLDER}/astyle.tar.gz" "https://iweb.dl.sourceforge.net/project/astyle/astyle/astyle%203.1/astyle_3.1_linux.tar.gz"
+    tar --extract --file="${ARDUINO_CI_SCRIPT_TEMPORARY_FOLDER}/astyle.tar.gz" --directory="${ARDUINO_CI_SCRIPT_APPLICATION_FOLDER}"
+    cd "${ARDUINO_CI_SCRIPT_APPLICATION_FOLDER}/astyle/build/gcc"
+    eval "make $ARDUINO_CI_SCRIPT_VERBOSITY_REDIRECT"
+    astylePath="${ARDUINO_CI_SCRIPT_APPLICATION_FOLDER}/astyle/build/gcc/bin/astyle"
+    # Return to the previous folder
+    cd "$previousFolder"
+  fi
+
+  # Set default exit status
+  exitStatus="$ARDUINO_CI_SCRIPT_SUCCESS_EXIT_STATUS"
+
+  while read -r filename; do
+    # Check if it's a file (find matches on pruned folders)
+    if [[ -f "$filename" ]]; then
+      if ! diff --strip-trailing-cr "$filename" <("${astylePath}" --options="${scriptFolder}/${astyleConfigurationFolder}/${strictness}${astyleConfigurationExtension}" --dry-run <"$filename"); then
+        echo "ERROR: Non-compliant code formatting in $filename"
+        # Make the function fail
+        exitStatus="$ARDUINO_CI_SCRIPT_FAILURE_EXIT_STATUS"
+      fi
+    fi
+  done <<<"$(eval "find $targetPath -regextype posix-extended $excludeOptions \( -iregex '.*\.((ino)|(h)|(hpp)|(hh)|(hxx)|(h\+\+)|(cpp)|(cc)|(cxx)|(c\+\+)|(cp)|(c)|(ipp)|(ii)|(ixx)|(inl)|(tpp)|(txx)|(tpl))$' -and -type f \)")"
+
+  echo -e -n 'travis_fold:end:check_code_formatting\r'
+  return "$exitStatus"
+}
+
 # Set default verbosity (must be called after the function definitions
 set_script_verbosity 0
 

etc/astyle-configurations/1.conf

@@ -0,0 +1,33 @@
+# source: https://raw.githubusercontent.com/arduino/Arduino/1.8.9/build/shared/lib/formatter.conf
+
+# This configuration file contains a selection of the available options provided by the formatting tool "Artistic Style"
+# http://astyle.sourceforge.net/astyle.html
+#
+# If you wish to change them, don't edit this file.
+# Instead, copy it in the same folder of file "preferences.txt" and modify the copy. This way, you won't lose your custom formatter settings when upgrading the IDE
+# If you don't know where file preferences.txt is stored, open the IDE, File -> Preferences and you'll find a link
+
+mode=c
+
+# 2 spaces indentation
+indent=spaces=2
+
+# also indent macros
+indent-preprocessor
+
+# indent classes, switches (and cases), comments starting at column 1
+indent-classes
+indent-switches
+indent-cases
+indent-col1-comments
+
+# put a space around operators
+pad-oper
+
+# put a space after if/for/while
+pad-header
+
+# if you like one-liners, keep them
+keep-one-line-statements
+
+remove-comment-prefix

etc/astyle-configurations/2.conf

@@ -0,0 +1,46 @@
+# source: https://raw.githubusercontent.com/arduino/Arduino/1.8.9/build/shared/examples_formatter.conf
+
+# This configuration file contains a selection of the available options provided by the formatting tool "Artistic Style"
+# http://astyle.sourceforge.net/astyle.html
+#
+# If you wish to change them, don't edit this file.
+# Instead, copy it in the same folder of file "preferences.txt" and modify the copy. This way, you won't lose your custom formatter settings when upgrading the IDE
+# If you don't know where file preferences.txt is stored, open the IDE, File -> Preferences and you'll find a link
+
+mode=c
+
+# 2 spaces indentation
+indent=spaces=2
+
+# also indent macros
+indent-preprocessor
+
+# indent classes, switches (and cases), comments starting at column 1
+indent-classes
+indent-switches
+indent-cases
+indent-col1-comments
+
+# put a space around operators
+pad-oper
+
+# put a space after if/for/while
+pad-header
+
+# if you like one-liners, keep them
+keep-one-line-statements
+
+style=java
+attach-namespaces
+attach-classes
+attach-inlines
+attach-extern-c
+indent-modifiers
+indent-namespaces
+indent-labels
+indent-preproc-block
+indent-preproc-define
+indent-preproc-cond
+unpad-paren
+add-brackets
+remove-comment-prefix

etc/astyle-configurations/3.conf

@@ -0,0 +1,125 @@
+# source: https://github.com/arduino/ArduinoCore-avr/issues/71#issuecomment-466763471 2019-06-09
+
+# formatter.conf, examples_formatter.conf
+mode=c
+
+
+# examples_formatter.conf
+# http://astyle.sourceforge.net/astyle.html#_style=java
+# Considering changing this to the synonym "style=attach", which seems more descriptive
+style=java
+
+
+# examples_formatter.conf
+attach-namespaces
+
+# examples_formatter.conf
+attach-classes
+
+# examples_formatter.conf
+attach-inlines
+
+# examples_formatter.conf
+attach-extern-c
+
+
+# formatter.conf, examples_formatter.conf
+indent=spaces=2
+
+# formatter.conf, examples_formatter.conf
+indent-classes
+
+# formatter.conf, examples_formatter.conf
+indent-switches
+
+# formatter.conf, examples_formatter.conf
+indent-cases
+
+# formatter.conf, examples_formatter.conf
+indent-col1-comments
+
+# examples_formatter.conf
+indent-modifiers
+
+# examples_formatter.conf
+indent-namespaces
+
+# examples_formatter.conf
+indent-labels
+
+# examples_formatter.conf
+indent-preproc-define
+
+
+# formatter.conf, examples_formatter.conf
+pad-header
+
+# formatter.conf, examples_formatter.conf
+pad-oper
+
+# examples_formatter.conf
+unpad-paren
+
+
+# formatter.conf, examples_formatter.conf
+remove-comment-prefix
+
+# formatter.conf, examples_formatter.conf
+# http://astyle.sourceforge.net/astyle.html#_keep-one-line-statements
+# "Don't break complex statements and multiple statements residing on a single line."
+# I don't like one line complex statements, but I guess since it's in formatter.conf it must stay.
+keep-one-line-statements
+
+
+
+# Options from examples_formatter.conf that I think should be removed:
+
+# http://astyle.sourceforge.net/astyle.html#_indent-preproc-block
+# "Indent preprocessor blocks at brace level zero and immediately within a namespace. There are restrictions on what will be indented. Blocks within methods, classes, arrays, etc., will not be indented. Blocks containing braces or multi-line define statements will not be indented. Without this option the preprocessor block is not indented."
+# This does indent for #ifdef, but not for #ifndef, so it's quite inconsistent
+# Indentation of preprocessor directives as done by this option is not very common in Arduino AVR Boards core, and where it is used, it's typically done inconsistently throughout the file
+indent-preproc-block
+
+# http://astyle.sourceforge.net/astyle.html#_indent-preproc-cond
+# "Indent preprocessor conditional statements to the same level as the source code."
+# Indentation of preprocessor directives as done by this option is very rare in Arduino AVR Boards core
+indent-preproc-cond
+
+
+
+# Options I have not implemented from formatter.conf or examples_formatter.conf:
+
+# examples_formatter.conf
+# Not a valid option in the latest version of AStyle. I think the correct option name is "add-braces", which I do use in my configuration
+# add-brackets
+
+# formatter.conf, examples_formatter.conf
+# Not a valid option in the latest version of AStyle.
+# indent-preprocessor
+
+
+
+# Options I have added:
+
+# http://astyle.sourceforge.net/astyle.html#_add-braces
+# "I believe this is the correct option name to use instead the "add-brackets" option used in examples_formatter.conf. "add-brackets" is not a valid option in the latest version of AStyle"
+add-braces
+
+# http://astyle.sourceforge.net/astyle.html#_convert-tabs
+# "Converts tabs into spaces in the non-indentation part of the line."
+# AStyle is already configured to use spaces for indentation by indent=spaces=2. The Arduino IDE uses spaces instead of tabs by default.
+convert-tabs
+
+# http://astyle.sourceforge.net/astyle.html#_attach-return-type
+# "Attach the return type to the function name in function definitions."
+attach-return-type
+
+# http://astyle.sourceforge.net/astyle.html#_attach-return-type
+# "Attach the return type to the function name in function declarations."
+attach-return-type-decl
+
+# http://astyle.sourceforge.net/astyle.html#_align-pointer
+# "Attach a pointer or reference operator (*, &, or ^) to either the variable type (left) or variable name (right), or place it between the type and name (middle)."
+# In Arduino AVR Boards core, name alignment of pointers is somewhat more common, though all possible styles are used
+# I don't care which style is chosen (type, middle, name), but I do think one should be chosen and used.
+align-pointer=name