refactor (compartmentalize) arduino_ci_remote.rb's two main test functions

Author: ianfixes

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 ### Changed
+- Finally put some factorization into the `arduino_ci_remote.rb` script: testing unit and testing compilation are now standalone functions
 
 ### Deprecated
 

exe/arduino_ci_remote.rb

@@ -111,162 +111,166 @@ def display_files(pathname)
   non_hidden.each { |p| puts "#{margin}#{p}" }
 end
 
-# initialize command and config
-config = ArduinoCI::CIConfig.default.from_project_library
-@arduino_cmd = ArduinoCI::ArduinoInstallation.autolocate!
-inform("Located Arduino binary") { @arduino_cmd.binary_path.to_s }
+def perform_unit_tests(config)
+  cpp_library = ArduinoCI::CppLibrary.new(Pathname.new("."), @arduino_cmd.lib_dir)
+
+  # check GCC
+  compilers = config.compilers_to_use
+  assure("The set of compilers (#{compilers.length}) isn't empty") { !compilers.empty? }
+  compilers.each do |gcc_binary|
+    attempt_multiline("Checking #{gcc_binary} version") do
+      version = cpp_library.gcc_version(gcc_binary)
+      next nil unless version
+
+      puts version.split("\n").map { |l| "    #{l}" }.join("\n")
+      version
+    end
+    inform("libasan availability for #{gcc_binary}") { cpp_library.libasan?(gcc_binary) }
+  end
 
-# index the existing libraries
-attempt("Indexing libraries") { @arduino_cmd.index_libraries } unless @arduino_cmd.libraries_indexed
+  # Ensure platforms exist for unit test, and save their info in all_platform_info keyed by name
+  all_platform_info = {}
+  config.platforms_to_unittest.each { |p| all_platform_info[p] = assured_platform("unittest", p, config) }
 
-# initialize library under test
-installed_library_path = attempt("Installing library under test") do
-  @arduino_cmd.install_local_library(Pathname.new("."))
-end
-if installed_library_path.exist?
-  inform("Library installed at") { installed_library_path.to_s }
-else
-  assure_multiline("Library installed successfully") do
-    # print out the contents of the deepest directory we actually find
-    @arduino_cmd.lib_dir.ascend do |path_part|
-      next unless path_part.exist?
-
-      break display_files(path_part)
+  # iterate boards / tests
+  if !cpp_library.tests_dir.exist?
+    inform_multiline("Skipping unit tests; no tests dir at #{cpp_library.tests_dir}") do
+      puts "  In case that's an error, this is what was found in the library:"
+      display_files(cpp_library.tests_dir.parent)
+      true
+    end
+  elsif cpp_library.test_files.empty?
+    inform_multiline("Skipping unit tests; no test files were found in #{cpp_library.tests_dir}") do
+      puts "  In case that's an error, this is what was found in the tests directory:"
+      display_files(cpp_library.tests_dir)
+      true
+    end
+  elsif config.platforms_to_unittest.empty?
+    inform("Skipping unit tests") { "no platforms were requested" }
+  else
+    config.platforms_to_unittest.each do |p|
+      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
+            exe = cpp_library.build_for_test_with_configuration(
+              unittest_path,
+              config.aux_libraries_for_unittest,
+              gcc_binary,
+              config.gcc_config(p)
+            )
+            puts
+            unless exe
+              puts "Last command: #{cpp_library.last_cmd}"
+              puts cpp_library.last_out
+              puts cpp_library.last_err
+              next false
+            end
+            cpp_library.run_test_file(exe)
+          end
+        end
+      end
     end
-    false
-  end
-end
-library_examples = @arduino_cmd.library_examples(installed_library_path)
-cpp_library = ArduinoCI::CppLibrary.new(installed_library_path, @arduino_cmd.lib_dir)
-
-# check GCC
-compilers = config.compilers_to_use
-assure("The set of compilers (#{compilers.length}) isn't empty") { !compilers.empty? }
-compilers.each do |gcc_binary|
-  attempt_multiline("Checking #{gcc_binary} version") do
-    version = cpp_library.gcc_version(gcc_binary)
-    next nil unless version
-
-    puts version.split("\n").map { |l| "    #{l}" }.join("\n")
-    version
   end
-  inform("libasan availability for #{gcc_binary}") { cpp_library.libasan?(gcc_binary) }
 end
 
-# Ensure platforms exist for unit test, and save their info in all_platform_info keyed by name
-all_platform_info = {}
-config.platforms_to_unittest.each { |p| all_platform_info[p] = assured_platform("unittest", p, config) }
-
-# gather up all required boards for compilation so we can install them up front.
-# start with the "platforms to unittest" and add the examples
-# while we're doing that, get the aux libraries as well
-example_platform_info = {}
-board_package_url = {}
-aux_libraries = Set.new(config.aux_libraries_for_unittest + config.aux_libraries_for_build)
-# while collecting the platforms, ensure they're defined
-library_examples.each do |path|
-  ovr_config = config.from_example(path)
-  ovr_config.platforms_to_build.each do |platform|
-    # assure the platform if we haven't already
-    next if example_platform_info.key?(platform)
-
-    platform_info = assured_platform("library example", platform, config)
-    next if platform_info.nil?
-
-    example_platform_info[platform] = all_platform_info[platform] = platform_info
-    package = platform_info[:package]
-    board_package_url[package] = ovr_config.package_url(package)
-  end
-  aux_libraries.merge(ovr_config.aux_libraries_for_build)
-end
+def perform_compilation_tests(config)
 
-# with all platform info, we can extract unique packages and their urls
-# do that, set the URLs, and download the packages
-all_packages = all_platform_info.values.map { |v| v[:package] }.uniq.reject(&:nil?)
+  # index the existing libraries
+  attempt("Indexing libraries") { @arduino_cmd.index_libraries } unless @arduino_cmd.libraries_indexed
 
-# inform about builtin packages
-all_packages.select { |p| config.package_builtin?(p) }.each do |p|
-  inform("Using built-in board package") { p }
-end
+  # initialize library under test
+  installed_library_path = attempt("Installing library under test") do
+    @arduino_cmd.install_local_library(Pathname.new("."))
+  end
+  if installed_library_path.exist?
+    inform("Library installed at") { installed_library_path.to_s }
+  else
+    assure_multiline("Library installed successfully") do
+      # print out the contents of the deepest directory we actually find
+      @arduino_cmd.lib_dir.ascend do |path_part|
+        next unless path_part.exist?
 
-# make sure any non-builtin package has a URL defined
-all_packages.reject { |p| config.package_builtin?(p) }.each do |p|
-  assure("Board package #{p} has a defined URL") { board_package_url[p] }
-end
+        break display_files(path_part)
+      end
+      false
+    end
+  end
+  library_examples = @arduino_cmd.library_examples(installed_library_path)
+
+  # gather up all required boards for compilation so we can install them up front.
+  # start with the "platforms to unittest" and add the examples
+  # while we're doing that, get the aux libraries as well
+  example_platform_info = {}
+  board_package_url = {}
+  aux_libraries = Set.new(config.aux_libraries_for_unittest + config.aux_libraries_for_build)
+  # while collecting the platforms, ensure they're defined
+
+  library_examples.each do |path|
+    ovr_config = config.from_example(path)
+    ovr_config.platforms_to_build.each do |platform|
+      # assure the platform if we haven't already
+      next if example_platform_info.key?(platform)
+
+      platform_info = assured_platform("library example", platform, config)
+      next if platform_info.nil?
+
+      example_platform_info[platform] = platform_info
+      package = platform_info[:package]
+      board_package_url[package] = ovr_config.package_url(package)
+    end
+    aux_libraries.merge(ovr_config.aux_libraries_for_build)
+  end
 
-# set up all the board manager URLs.
-# we can safely reject nils now, they would be for the builtins
-all_urls = all_packages.map { |p| board_package_url[p] }.uniq.reject(&:nil?)
+  # with all platform info, we can extract unique packages and their urls
+  # do that, set the URLs, and download the packages
+  all_packages = example_platform_info.values.map { |v| v[:package] }.uniq.reject(&:nil?)
 
-unless all_urls.empty?
-  assure("Setting board manager URLs") do
-    @arduino_cmd.board_manager_urls = all_urls
+  # inform about builtin packages
+  all_packages.select { |p| config.package_builtin?(p) }.each do |p|
+    inform("Using built-in board package") { p }
   end
-end
 
-all_packages.each do |p|
-  assure("Installing board package #{p}") do
-    @arduino_cmd.install_boards(p)
+  # make sure any non-builtin package has a URL defined
+  all_packages.reject { |p| config.package_builtin?(p) }.each do |p|
+    assure("Board package #{p} has a defined URL") { board_package_url[p] }
   end
-end
 
-aux_libraries.each do |l|
-  if @arduino_cmd.library_present?(l)
-    inform("Using pre-existing library") { l.to_s }
-  else
-    assure("Installing aux library '#{l}'") { @arduino_cmd.install_library(l) }
-  end
-end
+  # set up all the board manager URLs.
+  # we can safely reject nils now, they would be for the builtins
+  all_urls = all_packages.map { |p| board_package_url[p] }.uniq.reject(&:nil?)
 
-# iterate boards / tests
-last_board = nil
-if !cpp_library.tests_dir.exist?
-  inform_multiline("Skipping unit tests; no tests dir at #{cpp_library.tests_dir}") do
-    puts "  In case that's an error, this is what was found in the library:"
-    display_files(cpp_library.tests_dir.parent)
-    true
+  unless all_urls.empty?
+    assure("Setting board manager URLs") do
+      @arduino_cmd.board_manager_urls = all_urls
+    end
   end
-elsif cpp_library.test_files.empty?
-  inform_multiline("Skipping unit tests; no test files were found in #{cpp_library.tests_dir}") do
-    puts "  In case that's an error, this is what was found in the tests directory:"
-    display_files(cpp_library.tests_dir)
-    true
+
+  all_packages.each do |p|
+    assure("Installing board package #{p}") do
+      @arduino_cmd.install_boards(p)
+    end
   end
-elsif config.platforms_to_unittest.empty?
-  inform("Skipping unit tests") { "no platforms were requested" }
-else
-  config.platforms_to_unittest.each do |p|
-    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
-          exe = cpp_library.build_for_test_with_configuration(
-            unittest_path,
-            config.aux_libraries_for_unittest,
-            gcc_binary,
-            config.gcc_config(p)
-          )
-          puts
-          unless exe
-            puts "Last command: #{cpp_library.last_cmd}"
-            puts cpp_library.last_out
-            puts cpp_library.last_err
-            next false
-          end
-          cpp_library.run_test_file(exe)
-        end
-      end
+
+  aux_libraries.each do |l|
+    if @arduino_cmd.library_present?(l)
+      inform("Using pre-existing library") { l.to_s }
+    else
+      assure("Installing aux library '#{l}'") { @arduino_cmd.install_library(l) }
     end
   end
-end
 
-if config.platforms_to_build.empty?
-  inform("Skipping builds") { "no platforms were requested" }
-elsif library_examples.empty?
-  inform_multiline("Skipping builds; no examples found in #{installed_library_path}") do
-    display_files(installed_library_path)
+  last_board = nil
+  if config.platforms_to_build.empty?
+    inform("Skipping builds") { "no platforms were requested" }
+    return
+  elsif library_examples.empty?
+    inform_multiline("Skipping builds; no examples found in #{installed_library_path}") do
+      display_files(installed_library_path)
+    end
+    return
   end
-else
+
   attempt("Setting compiler warning level")  { @arduino_cmd.set_pref("compiler.warning_level", "all") }
 
   # switching boards takes time, so iterate board first
@@ -280,7 +284,7 @@ def display_files(pathname)
   end
 
   examples_by_platform.each do |platform, example_paths|
-    board = all_platform_info[platform][:board]
+    board = example_platform_info[platform][:board]
     assure("Switching to board for #{platform} (#{board})") { @arduino_cmd.use_board(board) } unless last_board == board
     last_board = board
 
@@ -297,6 +301,16 @@ def display_files(pathname)
       end
     end
   end
+
 end
 
+# initialize command and config
+config = ArduinoCI::CIConfig.default.from_project_library
+
+@arduino_cmd = ArduinoCI::ArduinoInstallation.autolocate!
+inform("Located Arduino binary") { @arduino_cmd.binary_path.to_s }
+
+perform_unit_tests(config)
+perform_compilation_tests(config)
+
 terminate(true)