arduino_ci 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba79db50704899ffaddb90377d82f1f115f10c8c3b70d967074d867c80e5133b
-  data.tar.gz: 57d1b65dee62b5c3ad9f5e9cb2ed867f18e7fcd5fffc15ccab835de31ddf021c
+  metadata.gz: b3120211b8610970115b711ea7647e43db7382f65baf3f5b58290c914e6bb68d
+  data.tar.gz: 976468bc18dd707eb5eeab43d020e034e57e9d898cd2cb140e2e7c2398a9ca11
 SHA512:
-  metadata.gz: 68cb0b6c5778c1d6478b0aff085a9937971744d20d8f863f8c57b3bb8e9ae2bfc1eac12bb00cf696171e571718f6b5ad4d0fb3837b4307ef612488c9370bcaf7
-  data.tar.gz: 24c7888ed4ddfd10c5eec94294d0608adec270b83ae1f9486b3f4a72763d3ba66723531a8ed250dd7004891b35f1ce19524f5b40318f7e2b953a7cbf8e630dfa
+  metadata.gz: aa3afee9f49c16b9ab7e05ce252fd5254cf1e01ab27f5b654de6050278b924169c425c72331cfe02047890497ed001a55af50c55d0bf3e861a67537234b351b2
+  data.tar.gz: 365c09a2d5063e08e1ed57c7cd02b8d5aa8ea9b9899e7214408e4b6b81cb150f49523755f2c0f1f31923a228acd2e13e27ff0abbb2124eb67765cb8168bc01e9

data/README.md

@@ -1,10 +1,18 @@
-[![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci)
-[![Build Status](https://travis-ci.org/ifreecarve/arduino_ci.svg)](https://travis-ci.org/ifreecarve/arduino_ci)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.1.9)
 
-# ArduinoCI Ruby gem (`arduino_ci`)
+# ArduinoCI Ruby gem (`arduino_ci`) [![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci) [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.1.10)
 
-[Arduino CI](https://github.com/ifreecarve/arduino_ci) is a Ruby gem for executing Continuous Integration (CI) tests on an Arduino library -- both locally and as part of a service like Travis CI.
+
+[Arduino CI](https://github.com/ianfixes/arduino_ci) is a cross-platform Ruby gem for executing Continuous Integration (CI) tests on an Arduino library -- both locally and as part of a service like Travis CI.
+
+It doesn't matter whether your contributors are using OSX, Linux, or Windows; everyone can run unit tests locally with `arduino_ci`, and be assured that the CI system used by the GitHub project maintainer will run the same tests and get the same results.
+
+You don't have to take my word for it; let the build logs speak for themselves:
+
+Platform | CI Status
+---------|:---------
+OSX      | [![OSX Build Status](http://badges.herokuapp.com/travis/ianfixes/arduino_ci?env=BADGE=osx&label=build&branch=master)](https://travis-ci.org/ianfixes/arduino_ci)
+Linux    | [![Linux Build Status](http://badges.herokuapp.com/travis/ianfixes/arduino_ci?env=BADGE=linux&label=build&branch=master)](https://travis-ci.org/ianfixes/arduino_ci)
+Windows  | [![Windows Build status](https://ci.appveyor.com/api/projects/status/8f6e39dea319m83q?svg=true)](https://ci.appveyor.com/project/ianfixes/arduino-ci)
 
 
 ## Installation In Your GitHub Project And Using Travis CI
@@ -373,12 +381,12 @@ This software is in alpha.  But [SampleProjects/DoSomething](SampleProjects/DoSo
 
 * The Arduino library is not fully mocked.
 * I don't have preprocessor defines for all the Arduino board flavors
-* https://github.com/ifreecarve/arduino_ci/issues
+* https://github.com/ianfixes/arduino_ci/issues
 
 
 ## Author
 
-This gem was written by Ian Katz (ifreecarve@gmail.com) in 2018.  It's released under the Apache 2.0 license.
+This gem was written by Ian Katz (ianfixes@gmail.com) in 2018.  It's released under the Apache 2.0 license.
 
 
 ## See Also

data/cpp/arduino/Arduino.h

@@ -59,6 +59,14 @@ typedef unsigned int word;
 
 
 
+/*
+unsigned long pulseIn(uint8_t pin, uint8_t state, unsigned long timeout);
+unsigned long pulseInLong(uint8_t pin, uint8_t state, unsigned long timeout);
+
+void shiftOut(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder, uint8_t val);
+uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder);
+
+*/
 
 // Get the bit location within the hardware port of the given virtual pin.
 // This comes from the pins_*.c file for the active board configuration.
@@ -66,6 +74,43 @@ typedef unsigned int word;
 #define analogInPinToBit(P) (P)
 #define digitalPinToInterrupt(P) (P)
 
+/*
+// On the ATmega1280, the addresses of some of the port registers are
+// greater than 255, so we can't store them in uint8_t's.
+extern const uint16_t PROGMEM port_to_mode_PGM[];
+extern const uint16_t PROGMEM port_to_input_PGM[];
+extern const uint16_t PROGMEM port_to_output_PGM[];
+
+extern const uint8_t PROGMEM digital_pin_to_port_PGM[];
+// extern const uint8_t PROGMEM digital_pin_to_bit_PGM[];
+extern const uint8_t PROGMEM digital_pin_to_bit_mask_PGM[];
+extern const uint8_t PROGMEM digital_pin_to_timer_PGM[];
+
+// Get the bit location within the hardware port of the given virtual pin.
+// This comes from the pins_*.c file for the active board configuration.
+//
+// These perform slightly better as macros compared to inline functions
+//
+#define digitalPinToPort(P) ( pgm_read_byte( digital_pin_to_port_PGM + (P) ) )
+#define digitalPinToBitMask(P) ( pgm_read_byte( digital_pin_to_bit_mask_PGM + (P) ) )
+#define digitalPinToTimer(P) ( pgm_read_byte( digital_pin_to_timer_PGM + (P) ) )
+#define analogInPinToBit(P) (P)
+#define portOutputRegister(P) ( (volatile uint8_t *)( pgm_read_word( port_to_output_PGM + (P))) )
+#define portInputRegister(P) ( (volatile uint8_t *)( pgm_read_word( port_to_input_PGM + (P))) )
+#define portModeRegister(P) ( (volatile uint8_t *)( pgm_read_word( port_to_mode_PGM + (P))) )
+
+*/
+
+
+/* TODO
+
+// USB
+#include "USBAPI.h"
+Keyboard
+Mouse
+
+*/
+
 // uint16_t makeWord(uint16_t w);
 // uint16_t makeWord(byte h, byte l);
 inline unsigned int makeWord(unsigned int w) { return w; }
@@ -73,6 +118,23 @@ inline unsigned int makeWord(unsigned char h, unsigned char l) { return (h << 8)
 
 #define word(...) makeWord(__VA_ARGS__)
 
-
-
-
+unsigned long pulseIn(uint8_t pin, uint8_t state, unsigned long timeout = 1000000L);
+unsigned long pulseInLong(uint8_t pin, uint8_t state, unsigned long timeout = 1000000L);
+
+// audio is taken care of in GODMODE
+
+
+// BIG TODO ON THIS ONE
+// $ find . | grep pins_
+// ./arduino-1.8.5/hardware/arduino/avr/variants/circuitplay32u4/pins_arduino.h
+// ./arduino-1.8.5/hardware/arduino/avr/variants/eightanaloginputs/pins_arduino.h
+// ./arduino-1.8.5/hardware/arduino/avr/variants/ethernet/pins_arduino.h
+// ./arduino-1.8.5/hardware/arduino/avr/variants/gemma/pins_arduino.h
+// ./arduino-1.8.5/hardware/arduino/avr/variants/leonardo/pins_arduino.h
+// ./arduino-1.8.5/hardware/arduino/avr/variants/mega/pins_arduino.h
+// ./arduino-1.8.5/hardware/arduino/avr/variants/micro/pins_arduino.h
+// ./arduino-1.8.5/hardware/arduino/avr/variants/robot_control/pins_arduino.h
+// ./arduino-1.8.5/hardware/arduino/avr/variants/robot_motor/pins_arduino.h
+// ./arduino-1.8.5/hardware/arduino/avr/variants/standard/pins_arduino.h
+// ./arduino-1.8.5/hardware/arduino/avr/variants/yun/pins_arduino.h
+// #include "pins_arduino.h"

data/cpp/arduino/Godmode.cpp

@@ -38,6 +38,7 @@ long random(long vmax)
 {
   GodmodeState* godmode = GODMODE();
   godmode->seed += 4294967291;  // it's a prime that fits in 32 bits
+  godmode->seed = godmode->seed % 4294967296; // explicitly wrap in case we're on a 64-bit impl
   return godmode->seed % vmax;
 }
 

data/cpp/arduino/Godmode.h

@@ -2,6 +2,7 @@
 #include "ArduinoDefines.h"
 #include <avr/io.h>
 #include "WString.h"
+#include "ci/Queue.h"
 #include "PinHistory.h"
 
 // random
@@ -38,6 +39,10 @@ class GodmodeState {
     unsigned long readDelayMicros;
   };
 
+  struct ToneDef {
+
+  };
+
   public:
     unsigned long micros;
     unsigned long seed;

data/cpp/arduino/WString.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include <stdlib.h>
+#include <stdexcept>
 #include <string.h>
 #include <algorithm>
 #include <iostream>
@@ -11,8 +12,8 @@ typedef std::string string;
 
 // work around some portability issues
 #if defined(__clang__)
-  #define ARDUINOCI_ISNAN ::isnan
-  #define ARDUINOCI_ISINF ::isinf
+  #define ARDUINOCI_ISNAN isnan
+  #define ARDUINOCI_ISINF isinf
 #elif defined(__GNUC__) || defined(__GNUG__)
   #define ARDUINOCI_ISNAN std::isnan
   #define ARDUINOCI_ISINF std::isinf
@@ -73,6 +74,8 @@ class String: public string
     explicit String(unsigned int val , unsigned char base=10): string(mytoa(val, base)) {}
     explicit String(long val,          unsigned char base=10): string(mytoas(val, base)) {}
     explicit String(unsigned long val, unsigned char base=10): string(mytoa(val, base)) {}
+    explicit String(long long val,     unsigned char base=10): string(mytoas(val, base)) {}
+    explicit String(unsigned long long val, unsigned char base=10): string(mytoa(val, base)) {}
 
     explicit String(float val,  unsigned char decimalPlaces=2): string(dtoas(val, decimalPlaces)) {}
     explicit String(double val, unsigned char decimalPlaces=2): string(dtoas(val, decimalPlaces)) {}
@@ -95,6 +98,8 @@ class String: public string
     unsigned char concat(unsigned int num)  { append(String(num)); return 1; }
     unsigned char concat(long num)          { append(String(num)); return 1; }
     unsigned char concat(unsigned long num) { append(String(num)); return 1; }
+    unsigned char concat(long long num)     { append(String(num)); return 1; }
+    unsigned char concat(unsigned long long num) { append(String(num)); return 1; }
     unsigned char concat(float num)         { append(String(num)); return 1; }
     unsigned char concat(double num)        { append(String(num)); return 1; }
 
@@ -107,6 +112,8 @@ class String: public string
     String & operator += (unsigned int num)  { concat(num);  return *this; }
     String & operator += (long num)          { concat(num);  return *this; }
     String & operator += (unsigned long num) { concat(num);  return *this; }
+    String & operator += (long long num)     { concat(num);  return *this; }
+    String & operator += (unsigned long long num) { concat(num);  return *this; }
     String & operator += (float num)         { concat(num);  return *this; }
     String & operator += (double num)        { concat(num);  return *this; }
 
@@ -169,9 +176,15 @@ class String: public string
       assign(substr(b, e - b + 1));
     }
 
-    long toInt(void) const      { return std::stol(*this); }
     float toFloat(void) const   { return std::stof(*this); }
     double toDouble(void) const { return std::stod(*this); }
+    long toInt(void) const      {
+      try {
+        return std::stol(*this);
+      } catch (std::out_of_range) {
+        return std::stoll(*this);
+      }
+    }
 
 };
 

data/exe/arduino_ci_remote.rb

@@ -121,7 +121,7 @@ elsif config.platforms_to_unittest.empty?
 else
   config.platforms_to_unittest.each do |p|
     board = all_platforms[p][:board]
-    assure("Switching to board for #{p} (#{board})") { @arduino_cmd.use_board(board) } unless last_board == board
+    # assure("Switching to board for #{p} (#{board})") { @arduino_cmd.use_board(board) } unless last_board == board
     last_board = board
     cpp_library.test_files.each do |unittest_path|
       unittest_name = File.basename(unittest_path)

data/lib/arduino_ci/arduino_cmd.rb

@@ -274,7 +274,7 @@ module ArduinoCI
       end
 
       # install the library
-      FileUtils.ln_s(realpath, destination_path)
+      Host.symlink(realpath, destination_path)
       destination_path
     end
 

data/lib/arduino_ci/arduino_cmd_windows.rb

@@ -0,0 +1,34 @@
+require "arduino_ci/host"
+require 'arduino_ci/arduino_cmd'
+
+module ArduinoCI
+
+  # Implementation of OSX commands
+  class ArduinoCmdWindows < ArduinoCmd
+    flag :get_pref,        "--get-pref"
+    flag :set_pref,        "--pref"
+    flag :save_prefs,      "--save-prefs"
+    flag :use_board,       "--board"
+    flag :install_boards,  "--install-boards"
+    flag :install_library, "--install-library"
+    flag :verify,          "--verify"
+
+    # run the arduino command
+    # @return [bool] whether the command succeeded
+    def _run_and_output(*args, **kwargs)
+      Host.run_and_output(*args, **kwargs)
+    end
+
+    # run the arduino command
+    # @return [Hash] keys for :success, :out, and :err
+    def _run_and_capture(*args, **kwargs)
+      Host.run_and_capture(*args, **kwargs)
+    end
+
+    def _lib_dir
+      File.join(ENV['userprofile'], "Documents", "Arduino", "libraries")
+    end
+
+  end
+
+end

data/lib/arduino_ci/arduino_downloader.rb

@@ -0,0 +1,204 @@
+require "fileutils"
+require 'open-uri'
+require 'zip'
+
+DOWNLOAD_ATTEMPTS = 3
+
+module ArduinoCI
+
+  # Manage the OS-specific download & install of Arduino
+  class ArduinoDownloader
+
+    def initialize(desired_ide_version)
+      @desired_ide_version = desired_ide_version
+    end
+
+    # Provide guidelines to the implementer of this class
+    def self.must_implement(method)
+      raise NotImplementedError, "#{self.class.name} failed to implement ArduinoDownloader.#{method}"
+    end
+
+    # Make any preparations or run any checks prior to making changes
+    # @return [string] Error message, or nil if success
+    def prepare
+      nil
+    end
+
+    # The autolocated executable of the installation
+    #
+    # @return [string] or nil
+    def self.autolocated_executable
+      # Arbitrarily, I'm going to pick the force installed location first
+      # if it exists.  I'm not sure why we would have both, but if we did
+      # a force install then let's make sure we actually use it.
+      locations = [self.force_installed_executable, self.existing_executable]
+      locations.each do |loc|
+        next if loc.nil?
+        next unless File.exist? loc
+        return loc
+      end
+      nil
+    end
+
+    # The autolocated directory of the installation
+    #
+    # @return [string] or nil
+    def self.autolocated_installation
+      # Arbitrarily, I'm going to pick the force installed location first
+      # if it exists.  I'm not sure why we would have both, but if we did
+      # a force install then let's make sure we actually use it.
+      locations = [self.force_install_location, self.existing_installation]
+      locations.each do |loc|
+        next if loc.nil?
+        next unless File.exist? loc
+        return loc
+      end
+      nil
+    end
+
+    # The path to the directory of an existing installation, or nil
+    # @return [string]
+    def self.existing_installation
+      self.must_implement(__method__)
+    end
+
+    # The executable Arduino file in an existing installation, or nil
+    # @return [string]
+    def self.existing_executable
+      self.must_implement(__method__)
+    end
+
+    # The executable Arduino file in a forced installation, or nil
+    # @return [string]
+    def self.force_installed_executable
+      self.must_implement(__method__)
+    end
+
+    # The technology that will be used to complete the download
+    # (for logging purposes)
+    # @return [string]
+    def downloader
+      "open-uri"
+    end
+
+    # The technology that will be used to extract the download
+    # (for logging purposes)
+    # @return [string]
+    def extracter
+      "Zip"
+    end
+
+    # The URL of the desired IDE package (zip/tar/etc) for this platform
+    # @return [string]
+    def package_url
+      "https://downloads.arduino.cc/#{package_file}"
+    end
+
+    # The local file (dir) name of the desired IDE package (zip/tar/etc)
+    # @return [string]
+    def package_file
+      self.class.must_implement(__method__)
+    end
+
+    # The local filename of the extracted IDE package (zip/tar/etc)
+    # @return [string]
+    def extracted_file
+      self.class.must_implement(__method__)
+    end
+
+    # @return [String] The location where a forced install will go
+    def self.force_install_location
+      File.join(ENV['HOME'], 'arduino_ci_ide')
+    end
+
+    # Download the package_url to package_file
+    # @return [bool] whether successful
+    def download
+      # Turned off ssl verification
+      # This should be acceptable because it won't happen on a user's machine, just CI
+
+      # define a progress-bar printer
+      chunk_size = 1024 * 1024 * 1024
+      total_size = 0
+      dots = 0
+      dot_printer = lambda do |size|
+        total_size += size
+        needed_dots = (total_size / chunk_size).to_i
+        unprinted_dots = needed_dots - dots
+        print("." * unprinted_dots) if unprinted_dots > 0
+        dots = needed_dots
+      end
+
+      open(package_url, ssl_verify_mode: 0, progress_proc: dot_printer) do |url|
+        File.open(package_file, 'wb') { |file| file.write(url.read) }
+      end
+    end
+
+    # Extract the package_file to extracted_file
+    # @return [bool] whether successful
+    def extract
+      Zip::File.open(package_file) do |zip|
+        batch_size = [1, (zip.size / 100).to_i].max
+        dots = 0
+        zip.each do |file|
+          print "." if (dots % batch_size).zero?
+          file.restore_permissions = true
+          file.extract { accept_all }
+          dots += 1
+        end
+      end
+    end
+
+    # Move the extracted package file from extracted_file to the force_install_location
+    # @return [bool] whether successful
+    def install
+      # Move only the content of the directory
+      FileUtils.mv extracted_file, self.class.force_install_location
+    end
+
+    # Forcibly install Arduino on linux from the web
+    # @return [bool] Whether the command succeeded
+    def execute
+      error_preparing = prepare
+      unless error_preparing.nil?
+        puts "Arduino force-install failed preparation: #{error_preparing}"
+        return false
+      end
+
+      attempts = 0
+
+      loop do
+        if File.exist? package_file
+          puts "Arduino package seems to have been downloaded already" if attempts.zero?
+          break
+        elsif attempts >= DOWNLOAD_ATTEMPTS
+          break puts "After #{DOWNLOAD_ATTEMPTS} attempts, failed to download #{package_url}"
+        else
+          print "Attempting to download Arduino package with #{downloader}"
+          download
+          puts
+        end
+        attempts += 1
+      end
+
+      if File.exist? extracted_file
+        puts "Arduino package seems to have been extracted already"
+      elsif File.exist? package_file
+        print "Extracting archive with #{extracter}"
+        extract
+        puts
+      end
+
+      if File.exist? self.class.force_install_location
+        puts "Arduino package seems to have been installed already"
+      elsif File.exist? extracted_file
+        install
+      else
+        puts "Arduino force-install failed"
+      end
+
+      File.exist? self.class.force_install_location
+    end
+
+  end
+end