re-enable and expand selection and rejection of test files

Author: ianfixes

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - `to_h` and `to_s` functions for `ci_config.rb`
 - `CIConfig::clone`
 - Ability to override `CIConfig` from a hash instead of just a file
+- `arduino_ci_remote.rb` now supports command line switches `--testfile-select=GLOB` and `--testfile-reject=GLOB` (which can both be repeated)
 
 ### Changed
 - Simplified the use of `Array.each` with a return statement; it's now simply `Array.find`
@@ -22,6 +23,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 - Determining a working OSX launch command no longer breaks on non-English installations
+- `arduino_ci_remote.rb` now honors selected and rejected test files
 
 ### Security
 

README.md

@@ -34,6 +34,25 @@ source 'https://rubygems.org'
 gem 'arduino_ci'
 ```
 
+### Testing Locally
+
+First, pull in the `arduino_ci` library as a dependency.
+
+```
+$ bundle install
+```
+
+
+With that installed, just the following shell command each time you want the tests to execute:
+
+```
+$ bundle exec arduino_ci_remote.rb
+```
+
+
+
+### Testing with remote CI
+
 > **Note:** `arduino_ci_remote.rb` expects to be run from the root directory of your Arduino project library.
 
 

REFERENCE.md

@@ -9,6 +9,28 @@ These defaults are specified in [misc/default.yml](misc/default.yml).  You are f
 
 ## Overriding default build behavior
 
+### From the command line
+
+The following options are currently available in the `arduino_ci_remote.rb` test runner.
+
+```
+Usage: arduino_ci_remote.rb [options]
+        --testfile-select=GLOB       Unit test file (or glob) to select
+        --testfile-reject=GLOB       Unit test file (or glob) to reject
+    -h, --help                       Prints this help
+```
+
+#### `--testfile-select` option
+
+This allows a file (or glob) pattern to be executed in your tests directory, creating a whitelist of files to test.  E.g. `--testfile-select=test_animal_*.cpp` would match `test_animal_cat.cpp` and `test_animal_dog.cpp` (testing only those) and not `test_plant_rose.cpp`.
+
+#### `--testfile-reject` option
+
+This allows a file (or glob) pattern to be executed in your tests directory, creating a blacklist of files to skip.  E.g. `--testfile-reject=test_animal_*.cpp` would match `test_animal_cat.cpp` and `test_animal_dog.cpp` (skipping those) and test only `test_plant_rose.cpp`, `test_plant_daisy.cpp`, etc.
+
+
+### From configuration
+
 `.arduino-ci.yml` files will override the default behavior.  There are 3 places you can put them:
 
 1. the root of your library

exe/arduino_ci_remote.rb

@@ -2,13 +2,49 @@
 require 'arduino_ci'
 require 'set'
 require 'pathname'
+require 'optparse'
 
 WIDTH = 80
 FIND_FILES_INDENT = 4
 
 @failure_count = 0
 @passfail = proc { |result| result ? "✓" : "✗" }
 
+# Use some basic parsing to allow command-line overrides of config
+class Parser
+  def self.parse(options)
+    parsed_config = {}
+    parsed_config["unittest"] = {}
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: #{File.basename(__FILE__)} [options]"
+
+      opts.on("--testfile-select=GLOB", "Unit test file (or glob) to select") do |p|
+        parsed_config["unittest"]["testfiles"] ||= {}
+        parsed_config["unittest"]["testfiles"]["select"] ||= []
+        parsed_config["unittest"]["testfiles"]["select"] << p
+      end
+
+      opts.on("--testfile-reject=GLOB", "Unit test file (or glob) to reject") do |p|
+        parsed_config["unittest"]["testfiles"] ||= {}
+        parsed_config["unittest"]["testfiles"]["reject"] ||= []
+        parsed_config["unittest"]["testfiles"]["reject"] << p
+      end
+
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+    end
+
+    opt_parser.parse!(options)
+    parsed_config
+  end
+end
+
+# Read in command line options and make them read-only
+@cli_options = (Parser.parse ARGV).freeze
+
 # terminate after printing any debug info.  TODO: capture debug info
 def terminate(final = nil)
   puts "Failures: #{@failure_count}"
@@ -117,7 +153,10 @@ def display_files(pathname)
   non_hidden.each { |p| puts "#{margin}#{p}" }
 end
 
-def perform_unit_tests(config)
+def perform_unit_tests(file_config)
+  puts file_config.to_h[:unittest].to_s
+  config = file_config.with_override_config(@cli_options)
+  puts config.to_h[:unittest].to_s
   cpp_library = ArduinoCI::CppLibrary.new(Pathname.new("."), @arduino_cmd.lib_dir)
 
   # check GCC
@@ -155,7 +194,7 @@ def perform_unit_tests(config)
     inform("Skipping unit tests") { "no platforms were requested" }
   else
     config.platforms_to_unittest.each do |p|
-      cpp_library.test_files.each do |unittest_path|
+      config.allowable_unittest_files(cpp_library.test_files).each do |unittest_path|
         unittest_name = unittest_path.basename.to_s
         compilers.each do |gcc_binary|
           attempt_multiline("Unit testing #{unittest_name} with #{gcc_binary}") do