split some files and add installer functionality

Author: ianfixes

CHANGELOG.md

@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 ### Added
+- `ArduinoInstallation` class for managing lib / executable paths
+- `DisplayManager` class for managing Xvfb instance if needed
 
 ### Changed
 

lib/arduino_ci.rb

@@ -1,124 +1,8 @@
 require "arduino_ci/version"
-
-require 'singleton'
-
-# Cross-platform way of finding an executable in the $PATH.
-# via https://stackoverflow.com/a/5471032/2063546
-#   which('ruby') #=> /usr/bin/ruby
-def which(cmd)
-  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-  ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-    exts.each do |ext|
-      exe = File.join(path, "#{cmd}#{ext}")
-      return exe if File.executable?(exe) && !File.directory?(exe)
-    end
-  end
-  nil
-end
+require "arduino_ci/arduino_cmd"
 
 # ArduinoCI contains classes for automated testing of Arduino code on the command line
 # @author Ian Katz <ifreecarve@gmail.com>
 module ArduinoCI
 
-  # Wrap the Arduino executable.  This requires, in some cases, a faked display.
-  class ArduinoCmd
-
-    # create as many ArduinoCmds as you like, but we need one and only one display manager
-    class DisplayMgr
-      include Singleton
-      attr_reader :enabled
-
-      def initialize
-        @existing = existing_display?
-        @enabled = false
-        @pid = nil
-      end
-
-      # attempt to determine if the machine is running a graphical display (i.e. not Travis)
-      def existing_display?
-        return true if RUBY_PLATFORM.include? "darwin"
-        return true if ENV["DISPLAY"].nil?
-        return true if ENV["DISPLAY"].include? ":"
-        false
-      end
-
-      # enable a virtual display
-      def enable
-        return @enabled = true if @existing   # silent no-op if built in display
-        return unless @pid.nil?
-
-        @enabled = true
-        @pid = fork do
-          puts "Forking Xvfb"
-          system("Xvfb", ":1", "-ac", "-screen", "0", "1280x1024x16")
-          puts "Xvfb unexpectedly quit!"
-        end
-        sleep(3)  # TODO: test a connection to the X server?
-      end
-
-      # disable the virtual display
-      def disable
-        return @enabled = false if @existing  # silent no-op if built in display
-        return if @pid.nil?
-
-        begin
-          Process.kill 9, @pid
-        ensure
-          Process.wait @pid
-          @pid = nil
-        end
-        puts "Xvfb killed"
-      end
-
-      # Enable a virtual display for the duration of the given block
-      def with_display
-        enable
-        begin
-          yield environment
-        ensure
-          disable
-        end
-      end
-
-      def environment
-        return nil unless @existing || @enabled
-        return {} if @existing
-        { DISPLAY => ":1.0" }
-      end
-
-      # On finalize, ensure child process is ended
-      def self.finalize
-        disable
-      end
-    end
-
-    class << self
-      protected :new
-
-      # attempt to find a workable Arduino executable across platforms
-      def guess_executable_location
-        osx_place = "/Applications/Arduino.app/Contents/MacOS/Arduino"
-        places = {
-          "arduino" => !which("arduino").nil?,
-          osx_place => (File.exist? osx_place),
-        }
-        places.each { |k, v| return k if v }
-        nil
-      end
-
-      def autolocate
-        ret = new
-        ret.path = guess_executable_location
-        ret
-      end
-    end
-
-    attr_accessor :path
-
-    def initialize
-      @display_mgr = DisplayMgr::instance
-    end
-
-  end
-
 end

lib/arduino_ci/arduino_cmd.rb

@@ -0,0 +1,34 @@
+require 'arduino_ci/display_manager'
+require 'arduino_ci/arduino_installation'
+
+module ArduinoCI
+
+  # Wrap the Arduino executable.  This requires, in some cases, a faked display.
+  class ArduinoCmd
+
+    class << self
+      protected :new
+
+      def autolocate
+        new(ArduinoInstallation.autolocate)
+      end
+
+      def autolocate!
+        new(ArduinoInstallation.autolocate!)
+      end
+
+    end
+
+    attr_accessor :installation
+
+    def initialize(installation)
+      @display_mgr = DisplayManager::instance
+      @installation = installation
+    end
+
+    def board_installed?(board)
+      system(@installation, "--board", board)
+    end
+
+  end
+end

lib/arduino_ci/arduino_installation.rb

@@ -0,0 +1,77 @@
+# Cross-platform way of finding an executable in the $PATH.
+# via https://stackoverflow.com/a/5471032/2063546
+#   which('ruby') #=> /usr/bin/ruby
+def which(cmd)
+  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+  ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+    exts.each do |ext|
+      exe = File.join(path, "#{cmd}#{ext}")
+      return exe if File.executable?(exe) && !File.directory?(exe)
+    end
+  end
+  nil
+end
+
+module ArduinoCI
+
+  # Manage the OS-specific install location of Arduino
+  class ArduinoInstallation
+    attr_accessor :cmd_path
+    attr_accessor :lib_dir
+
+    class << self
+      def force_install_location
+        File.join(ENV['HOME'], 'arduino_ci_ide')
+      end
+
+      # attempt to find a workable Arduino executable across platforms
+      def autolocate
+        ret = new
+
+        osx_place = "/Applications/Arduino.app/Contents/MacOS/Arduino"
+        if File.exist? osx_place
+          ret.cmd_path = File.join(osx_place, "arduino")
+          ret.lib_dir = File.join(osx_place, "Libraries")
+          return ret
+        end
+
+        posix_place = which("arduino")
+        unless posix_place.nil?
+          ret.cmd_path = posix_place
+          ret.lib_dir = File.join(ENV['HOME'], "Sketchbook") # assume linux
+          # https://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use/how-to-install-a-library
+          return ret
+        end
+
+        if File.exist? force_install_location
+          ret.cmd_path = File.join(force_install_location, "arduino")
+          ret.lib_dir = File.join(force_install_location, "libraries")
+          # TODO: "libraries" is what's in the adafruit install.sh script
+          return ret
+        end
+
+        ret
+      end
+
+      # Attempt to find a workable Arduino executable across platforms, and install it if we don't
+      def autolocate!
+        candidate = autolocate
+        return candidate unless candidate.cmd_path.nil?
+        # force the install
+
+        if force_install
+          candidate.cmd_path = File.join(force_install_location, "arduino")
+          candidate.lib_dir = File.join(force_install_location, "libraries")
+        end
+        candidate
+      end
+
+      def force_install
+        system("wget", "https://downloads.arduino.cc/arduino-1.6.5-linux64.tar.xz")
+        system("tar", "xf", "arduino-1.6.5-linux64.tar.xz")
+        system("mv", "arduino-1.6.5", force_install_location)
+      end
+
+    end
+  end
+end

lib/arduino_ci/display_manager.rb

@@ -0,0 +1,74 @@
+require 'singleton'
+
+module ArduinoCI
+
+  # When arduino commands run, they need a graphical display.
+  # This class handles the setup of that display, if needed.
+  class DisplayManager
+    include Singleton
+    attr_reader :enabled
+
+    def initialize
+      @existing = existing_display?
+      @enabled = false
+      @pid = nil
+    end
+
+    # attempt to determine if the machine is running a graphical display (i.e. not Travis)
+    def existing_display?
+      return true if RUBY_PLATFORM.include? "darwin"
+      return true if ENV["DISPLAY"].nil?
+      return true if ENV["DISPLAY"].include? ":"
+      false
+    end
+
+    # enable a virtual display
+    def enable
+      return @enabled = true if @existing   # silent no-op if built in display
+      return unless @pid.nil?
+
+      @enabled = true
+      @pid = fork do
+        puts "Forking Xvfb"
+        system("Xvfb", ":1", "-ac", "-screen", "0", "1280x1024x16")
+        puts "Xvfb unexpectedly quit!"
+      end
+      sleep(3)  # TODO: test a connection to the X server?
+    end
+
+    # disable the virtual display
+    def disable
+      return @enabled = false if @existing  # silent no-op if built in display
+      return if @pid.nil?
+
+      begin
+        Process.kill 9, @pid
+      ensure
+        Process.wait @pid
+        @pid = nil
+      end
+      puts "Xvfb killed"
+    end
+
+    # Enable a virtual display for the duration of the given block
+    def with_display
+      enable
+      begin
+        yield environment
+      ensure
+        disable
+      end
+    end
+
+    def environment
+      return nil unless @existing || @enabled
+      return {} if @existing
+      { DISPLAY => ":1.0" }
+    end
+
+    # On finalize, ensure child process is ended
+    def self.finalize
+      disable
+    end
+  end
+end

spec/arduino_cmd_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+RSpec.describe ArduinoCI::ArduinoCmd do
+  it "Finds the Arduino executable" do
+    arduino_cmd = ArduinoCI::ArduinoCmd.autolocate
+    # expect(arduino_cmd.path).not_to be nil
+  end
+end
+

spec/arduino_installation_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+RSpec.describe ArduinoCI::ArduinoInstallation do
+  context "force_install_location" do
+    it "is resolvable" do
+      expect(ArduinoCI::ArduinoInstallation.force_install_location).not_to be nil
+    end
+  end
+
+  context "autolocate" do
+    it "doesn't fail" do
+      ArduinoCI::ArduinoInstallation.autolocate
+    end
+  end
+
+  context "autolocate!" do
+    it "doesn't fail" do
+      installation = ArduinoCI::ArduinoInstallation.autolocate!
+      expect(installation.cmd_path).not_to be nil
+      expect(installation.lib_dir).not_to be nil
+    end
+  end
+
+end
+

spec/arduino_exec_spec.rb renamed to spec/display_manager_spec.rb

@@ -1,27 +1,20 @@
 require "spec_helper"
 
-RSpec.describe ArduinoCI::ArduinoCmd do
-  it "Finds the Arduino executable" do
-    arduino_cmd = ArduinoCI::ArduinoCmd.autolocate
-    # expect(arduino_cmd.path).not_to be nil
-  end
-end
-
-RSpec.describe ArduinoCI::ArduinoCmd::DisplayMgr do
+RSpec.describe ArduinoCI::DisplayManager do
   context "singleton ::instance" do
     it "produces an instance" do
-      expect(ArduinoCI::ArduinoCmd::DisplayMgr::instance).not_to be_nil
+      expect(ArduinoCI::DisplayManager::instance).not_to be_nil
     end
   end
 
   context "with_display" do
     it "Properly enables and disables" do
-      manager = ArduinoCI::ArduinoCmd::DisplayMgr::instance
+      manager = ArduinoCI::DisplayManager::instance
       expect(manager.enabled).to be false
       manager.with_display do |environment|
         expect(manager.enabled).to be true
         expect(environment.class).to eq(Hash)
-        also_manager = ArduinoCI::ArduinoCmd::DisplayMgr::instance
+        also_manager = ArduinoCI::DisplayManager::instance
         expect(also_manager.enabled).to be true
       end
       expect(manager.enabled).to be false