|
| 1 | +require "arduino_ci/version" |
| 2 | + |
| 3 | +require 'singleton' |
| 4 | + |
| 5 | +# Cross-platform way of finding an executable in the $PATH. |
| 6 | +# via https://stackoverflow.com/a/5471032/2063546 |
| 7 | +# which('ruby') #=> /usr/bin/ruby |
| 8 | +def which(cmd) |
| 9 | + exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : [''] |
| 10 | + ENV['PATH'].split(File::PATH_SEPARATOR).each do |path| |
| 11 | + exts.each do |ext| |
| 12 | + exe = File.join(path, "#{cmd}#{ext}") |
| 13 | + return exe if File.executable?(exe) && !File.directory?(exe) |
| 14 | + end |
| 15 | + end |
| 16 | + nil |
| 17 | +end |
| 18 | + |
| 19 | +# ArduinoCI contains classes for automated testing of Arduino code on the command line |
| 20 | +# @author Ian Katz <[email protected]> |
| 21 | +module ArduinoCI |
| 22 | + |
| 23 | + # Wrap the Arduino executable. This requires, in some cases, a faked display. |
| 24 | + class ArduinoCmd |
| 25 | + |
| 26 | + # create as many ArduinoCmds as you like, but we need one and only one display manager |
| 27 | + class DisplayMgr |
| 28 | + include Singleton |
| 29 | + attr_reader :enabled |
| 30 | + |
| 31 | + def initialize |
| 32 | + @existing = existing_display? |
| 33 | + @enabled = false |
| 34 | + @pid = nil |
| 35 | + end |
| 36 | + |
| 37 | + # attempt to determine if the machine is running a graphical display (i.e. not Travis) |
| 38 | + def existing_display? |
| 39 | + return true if RUBY_PLATFORM.include? "darwin" |
| 40 | + return true if ENV["DISPLAY"].include? ":" |
| 41 | + false |
| 42 | + end |
| 43 | + |
| 44 | + # enable a virtual display |
| 45 | + def enable |
| 46 | + return @enabled = true if @existing # silent no-op if built in display |
| 47 | + return unless @pid.nil? |
| 48 | + |
| 49 | + @enabled = true |
| 50 | + @pid = fork do |
| 51 | + puts "Forking Xvfb" |
| 52 | + system("Xvfb", ":1", "-ac", "-screen", "0", "1280x1024x16") |
| 53 | + puts "Xvfb unexpectedly quit!" |
| 54 | + end |
| 55 | + sleep(3) # TODO: test a connection to the X server? |
| 56 | + end |
| 57 | + |
| 58 | + # disable the virtual display |
| 59 | + def disable |
| 60 | + return @enabled = false if @existing # silent no-op if built in display |
| 61 | + return if @pid.nil? |
| 62 | + |
| 63 | + begin |
| 64 | + Process.kill 9, @pid |
| 65 | + ensure |
| 66 | + Process.wait @pid |
| 67 | + @pid = nil |
| 68 | + end |
| 69 | + puts "Xvfb killed" |
| 70 | + end |
| 71 | + |
| 72 | + # Enable a virtual display for the duration of the given block |
| 73 | + def with_display |
| 74 | + enable |
| 75 | + begin |
| 76 | + yield environment |
| 77 | + ensure |
| 78 | + disable |
| 79 | + end |
| 80 | + end |
| 81 | + |
| 82 | + def environment |
| 83 | + return nil unless @existing || @enabled |
| 84 | + return {} if @existing |
| 85 | + { DISPLAY => ":1.0" } |
| 86 | + end |
| 87 | + |
| 88 | + # On finalize, ensure child process is ended |
| 89 | + def self.finalize |
| 90 | + disable |
| 91 | + end |
| 92 | + end |
| 93 | + |
| 94 | + class << self |
| 95 | + protected :new |
| 96 | + |
| 97 | + # attempt to find a workable Arduino executable across platforms |
| 98 | + def guess_executable_location |
| 99 | + osx_place = "/Applications/Arduino.app/Contents/MacOS/Arduino" |
| 100 | + places = { |
| 101 | + "arduino" => !which("arduino").nil?, |
| 102 | + osx_place => (File.exist? osx_place), |
| 103 | + } |
| 104 | + places.each { |k, v| return k if v } |
| 105 | + nil |
| 106 | + end |
| 107 | + |
| 108 | + def autolocate |
| 109 | + ret = new |
| 110 | + ret.path = guess_executable_location |
| 111 | + ret |
| 112 | + end |
| 113 | + end |
| 114 | + |
| 115 | + attr_accessor :path |
| 116 | + |
| 117 | + def initialize |
| 118 | + @display_mgr = DisplayMgr::instance |
| 119 | + end |
| 120 | + |
| 121 | + end |
| 122 | + |
| 123 | +end |
0 commit comments