calypso 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18c02c94d3be06550f507b2e2318c3f5e7dea130
-  data.tar.gz: 531ef2d2eb7dcaacfbd3eee8c02053e3fa9d18d4
+  metadata.gz: 170ce85369fbbdf51b9ef207fbb371e51167b870
+  data.tar.gz: 0cb0131ed1eecc82b9567a93a819eaf7bbbeb6a4
 SHA512:
-  metadata.gz: ed43a49b4a8acbd8b8ebc1aefb31efd589de49f4e8d9aebb61a0d697285f1b6889723c9920119fe14146902a119c15e7169abc00b44df8e9c17aa64fb0b38bf0
-  data.tar.gz: 7eb5682cfd6d3a12eddce97027f7efa095ce5237f9f7447cefe24cab306230c0f784e67d4f7585b808a2b79fbf4aa2d82b1bed9bffc680776acf37903ef5d2dd
+  metadata.gz: 7186a005c6c8d6582e99ebb87e16088760370c32160f99e5f374d692821a6cd230888ced193e8bc387debad0302d20ea38c5dd24a9ee673d9af1fa6a89b46e31
+  data.tar.gz: e54e457cfc00701dc1bb8e4fcb0e97b18b7fc8895c6593f11f9a1e233596029d38c87c7f71d3e2acd505f95fc4ad8e08991b35cbe3b714ff07bb17e2f4af2193

data/lib/calypso/hardware.rb

@@ -0,0 +1,53 @@
+#
+#   Calypso module - Unit test hardware
+#   Copyright (C) 2016  Michel Megens <dev@bietje.net>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+#
+module Calypso
+  # Calypso hardware model.
+  class Hardware
+    # @return [String] Hardware ID.
+    attr_reader :id
+    # @return [String] Hardware name.
+    attr_reader :name
+    # @return [String] CPU name.
+    attr_reader :cpu
+    # @return [Array] An array of Calypso::UnitTest
+    attr_reader :tests
+
+    # Create a new Calypso::Hardware object.
+    #
+    # @param id [String] Hardware ID.
+    # @param name [String] Hardware name.
+    # @param cpu [String] CPU name (or MCU for the matter of it).
+    def initialize(id, name, cpu)
+      @id = id
+      @name = name
+      @cpu = cpu
+      @tests = []
+    end
+
+    # Add a new test.
+    #
+    # @param test [Calypso::UnitTest] Test to add.
+    # @return [Array] The new array of [Calypso::UnitTest].
+    def add_test(test)
+      @tests.push test
+    end
+  end
+end
+

data/lib/calypso/iparser.rb

@@ -0,0 +1,61 @@
+#
+#   Calypso parser interface
+#   Copyright (C) 2016  Michel Megens <dev@bietje.net>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+#
+module Calypso
+  # Parser interface.
+  class IParser
+    # @return [Hash] Hash of unit tests.
+    attr_reader :tests
+    # @return [Hash] Hash of available hardware.
+    attr_reader :hardware
+
+    # Create a new Parser.
+    #
+    # @param file [String] Path to the configuration file.
+    def initialize(file)
+      @tests = {}
+      @hardware = {}
+      @file = file
+    end
+
+    # Cruch data.
+    #
+    # @return [nil]
+    def parse
+    end
+
+    protected
+    # Set the hardware hash.
+    #
+    # @param hw [Hash] Hash of available hardware.
+    # @return [nil]
+    def set_hardware(hw)
+      @hardware = hw
+    end
+
+    # Set the tests hash.
+    #
+    # @param tests [Hash] Hash of available tests.
+    # @return [nil]
+    def set_tests(tests)
+      @tests = tests
+    end
+  end
+end
+

data/lib/calypso/kbuild.rb

@@ -0,0 +1,83 @@
+#
+#   Calypso module - Kbuild representation
+#   Copyright (C) 2016  Michel Megens <dev@bietje.net>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'fileutils'
+
+#
+module Calypso
+  # Kbuild model.
+  class Kbuild
+    # @return [String] Absolute path to an ETA/OS configuration file.
+    attr_reader :conf
+
+    # Build targets.
+    ETAOS_BUILD_TARGETS = "all".freeze
+    # Prebuild targets.
+    ETAOS_PREBUILD_TARGETS = "prepare".freeze
+    # Clean targets.
+    ETAOS_CLEAN_TARGETS = "clean".freeze
+    # Module install targets.
+    ETAOS_INSTALL_TARGETS = "modules_install".freeze
+
+    # Create a new Kconfig controller.
+    #
+    # @param conf [String] ETA/OS configuration file.
+    # @param test_path [String] Unit test path.
+    def initialize(conf, test_path)
+      @conf = conf
+      @path = test_path
+      FileUtils.copy(@conf, "#{Dir.pwd}/.config")
+    end
+
+    # Run the clean target on ETA/OS.
+    def clean
+      system("make #{ETAOS_CLEAN_TARGETS}")
+    end
+
+    # Build ETA/OS.
+    def build
+      system("make #{ETAOS_PREBUILD_TARGETS}")
+      system("make #{ETAOS_BUILD_TARGETS}")
+    end
+
+    # Install the ETA/OS modules.
+    #
+    # @param libdir [String] Library directory.
+    def install_modules(libdir)
+      system("make #{ETAOS_INSTALL_TARGETS} INSTALL_MOD_PATH=#{libdir}")
+    end
+
+    # Build the test.
+    #
+    # @param targets [String] Build targets.
+    def build_test(targets)
+      system("make -f scripts/Makefile.calypso TARGETS=\"#{targets}\" TEST=#{@path}")
+    end
+
+    # Build all targets.
+    # @deprecated
+    def build_all
+      clean
+      build
+      install_modules
+      build_app
+      nil
+    end
+  end
+end
+

data/lib/calypso/parserproxy.rb

@@ -0,0 +1,60 @@
+#
+#   Calypso parser proxy
+#   Copyright (C) 2016  Michel Megens <dev@bietje.net>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'calypso/iparser'
+require 'calypso/yamlparser'
+
+#
+module Calypso
+  # Proxy class for the Calypso configuration parser.
+  class ParserProxy
+    # Create a new parser proxy instance.
+    #
+    # @param type [Symbol] Parser type.
+    # @param file [String] Path to configuration file.
+    def initialize(type, file)
+      @file = File.expand_path(file)
+      @parser = case type
+                when :yaml
+                  YAMLParser.new(@file)
+                else
+                  nil
+                end
+    end
+
+    # Parse the config file.
+    def parse
+      @parser.parse
+    end
+
+    # Get the available hardware.
+    #
+    # @return [Hash] Hash of the available hardware.
+    def hardware
+      @parser.hardware
+    end
+
+    # Get a hash containing all tests.
+    #
+    # @return [Hash] All available unit tests.
+    def tests
+      @parser.tests
+    end
+  end
+end
+

data/lib/calypso/serialmonitor.rb

@@ -0,0 +1,109 @@
+#
+#   Calypso module - Unit test
+#   Copyright (C) 2016  Michel Megens <dev@bietje.net>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'serialport'
+require 'thread'
+
+#
+module Calypso
+  # Calypso's serial controller
+  class SerialMonitor
+    # @return [String] Path to the serial device.
+    attr_reader :portname
+    # @return [Fixnum] Serial baud rate.
+    attr_reader :baud
+    # @return [Fixnum] Number of data bits per byte.
+    attr_reader :databits
+    # @return [Fixnum] Number of stop bits.
+    attr_reader :stopbits
+    # @return [Symbol] Connection parity.
+    attr_reader :parity
+    # @return [Array<String>] Array of data read from the serial port.
+    attr_reader :data
+
+    # Calypso application exit token.
+    CALYPSO_EXIT = "calypso_exit".freeze
+
+    # Create a new serial port controller.
+    #
+    # @param port [String] Path to the serial device.
+    # @param baud [Fixnum] Serial baud rate.
+    # @param databits [Fixnum] Number of data bits per byte.
+    # @param stopbits [Fixnum] Number of stop bits.
+    # @param parity [Symbol] Connection parity.
+    def initialize(port, baud = 9600, databits = 8, stopbits = 1, parity = SerialPort::NONE)
+      @port = SerialPort.new(port, baud, databits, stopbits, parity)
+      @portname = port
+      @baud = baud
+      @databits = databits
+      @stopbits = stopbits
+      @parity = parity
+      @data = nil
+      @mutex = Mutex.new
+    end
+
+    # Monitor the serial port.
+    #
+    # @return [Boolean] Whether or not the application was manually stopped.
+    def monitor
+      running = true
+      ary = []
+      manual_stop = false
+
+      thread = Thread.new do
+        while running do
+          begin
+            input = gets
+            puts input
+            if input.nil?
+              @mutex.synchronize {running = false}
+              manual_stop = true
+              Thread.stop
+              break
+            end
+
+            input.chomp!
+            @port.write input
+            @port.flush
+          rescue Exception => e
+            puts e.message
+            exit
+          end
+        end
+      end
+
+      while (data = @port.gets.chomp) do
+        if data.eql? CALYPSO_EXIT then
+          Thread.kill thread
+          ary.push data
+          break
+        end
+
+        puts data
+        ary.push data
+        break unless running
+      end
+
+      thread.join unless manual_stop
+      @port.close
+      @data = ary
+      manual_stop
+    end
+  end
+end
+

data/lib/calypso/serialportdata.rb

@@ -0,0 +1,50 @@
+#
+#   Calypso module - SerialPort wrapper
+#   Copyright (C) 2016  Michel Megens <dev@bietje.net>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+#
+module Calypso
+  # Serial port information wrapper.
+  class SerialPortData
+    # @return [String] Path to the serial device.
+    attr_reader :port
+    # @return [Fixnum] Serial baud rate.
+    attr_reader :baud
+    # @return [Fixnum] Number of data bits per byte.
+    attr_reader :databits
+    # @return [Fixnum] Number of stop bits.
+    attr_reader :stopbits
+    # @return [Symbol] Connection parity.
+    attr_reader :parity
+
+    # Create a new serial port controller.
+    #
+    # @param port [String] Path to the serial device.
+    # @param baud [Fixnum] Serial baud rate.
+    # @param databits [Fixnum] Number of data bits per byte.
+    # @param stopbits [Fixnum] Number of stop bits.
+    # @param parity [Symbol] Connection parity.
+    def initialize(port, baud = 9600, databits = 8, stopbits = 1, parity = SerialPort::NONE)
+      @port = port
+      @baud = baud
+      @databits = databits
+      @stopbits = stopbits
+      @parity = parity
+    end
+  end
+end
+

data/lib/calypso/unittest.rb

@@ -0,0 +1,114 @@
+#
+#   Calypso module - Unit test
+#   Copyright (C) 2016  Michel Megens <dev@bietje.net>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'calypso/serialmonitor'
+require 'calypso/serialportdata'
+require 'calypso/kbuild'
+
+#
+module Calypso
+  # Unit test model class
+  class UnitTest
+    # @return [String] Unit test name.
+    attr_reader :name
+    # @return [String] Unit test path.
+    attr_reader :path
+    # @return [Symbol] Unit test mode.
+    attr_reader :mode
+    # @return [Calypso::Hardware] Unit test hardware.
+    attr_reader :hw
+    # @return [Calypso::Hardware] Unit test hardware.
+    attr_reader :hardware
+    # @return [String] Unit test build and execution targets.
+    attr_reader :exec
+    # @return [Boolean] Whether or not the test should be ran automatically.
+    attr_reader :autorun
+
+    # Create a new UnitTest model.
+    #
+    # @param conf [Hash] Unit test configuration values.
+    # @param serial [Calypso::SerialPortData] Serial port information.
+    # @param hw [Calypso::Hardware] Unit test hardware.
+    def initialize(conf, serial, hw)
+      @name = conf['name']
+      @path = File.expand_path conf['path']
+      @mode = conf['mode'] == 'manual' ? :manual : :auto
+      @hw = hw
+      @hardware = hw
+      @exec = conf['execute']
+      config = conf['config']
+      @conf = "#{@path}/#{config}" unless conf.nil?
+      @libdir = File.expand_path conf['libdir'] unless conf['libdir'].nil?
+      @serial = serial
+      @raw = conf
+      @success = false
+      @autorun = conf['autorun']
+      @compare_file = conf['compare']
+    end
+
+    # Execute the unit test.
+    #
+    # @return [Boolean] Whether or not the test executed succesfully.
+    def execute
+      kbuild = Kbuild.new(@conf, @path)
+
+      unless Calypso.options.bare
+        kbuild.clean
+        kbuild.build
+        kbuild.install_modules(@libdir)
+      end
+      
+      kbuild.build_test(@exec)
+      sp = Calypso::SerialMonitor.new(@serial.port)
+      manual_stop = sp.monitor
+
+      if manual_stop or @mode == :manual
+        print "Did the test run succesfully? [y/n]: "
+        reply = gets.chomp
+        @success = true if reply.eql? 'y' or reply.eql? 'Y'
+      else
+        @success = compare(sp)
+      end
+    end
+
+    # Check if the test ran succesfully.
+    #
+    # @return [Boolean] Whether or not the test executed succesfully.
+    def success?
+      @success
+    end
+
+    private
+    def compare(serial)
+      return if @compare_file.nil?
+      path = "#{@path}/#{@compare_file}"
+      data = serial.data
+      idx = 0
+
+      file = File.open path
+      while (line = file.gets) do
+        line.chomp!
+        return false unless line.eql? data[idx]
+        idx += 1
+      end
+
+      return true
+    end
+  end
+end
+

data/lib/calypso/version.rb

@@ -19,5 +19,5 @@
 #
 module Calypso
   # Calypso version constant
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/calypso/yamlparser.rb

@@ -0,0 +1,65 @@
+#
+#   Calypso YAML parser
+#   Copyright (C) 2016  Michel Megens <dev@bietje.net>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'yaml'
+
+require 'calypso/iparser'
+require 'calypso/hardware'
+require 'calypso/unittest'
+require 'calypso/serialportdata'
+
+#
+module Calypso
+  # YAML parser library
+  class YAMLParser < IParser
+    # Create a new YAML parser.
+    #
+    # @param file [String] Path to the configuration file.
+    def initialize(file)
+      super
+    end
+
+    # Parse the configuration file.
+    #
+    # @return [nil]
+    def parse
+      obj = YAML.load_file(@file)
+      hardware = Hash.new
+      tests = Hash.new
+
+      obj['hardware'].each do |key, value|
+        hw = Calypso::Hardware.new(key, value['name'], value['cpu'])
+        hardware[key] = hw
+      end
+
+      obj['unit-tests'].each do |key, value|
+        hw = hardware[value['hardware']]
+        port = value['port']
+        baud = value['baud']
+        serial = Calypso::SerialPortData.new(port, baud)
+        tst = Calypso::UnitTest.new(value, serial, hw)
+        tests[key] = tst
+        hw.add_test tst
+      end
+
+      set_hardware(hardware)
+      set_tests(tests)
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calypso
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michel Megens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-13 00:00:00.000000000 Z
+date: 2016-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,7 +76,15 @@ extra_rdoc_files: []
 files:
 - bin/calypso
 - lib/calypso.rb
+- lib/calypso/hardware.rb
+- lib/calypso/iparser.rb
+- lib/calypso/kbuild.rb
+- lib/calypso/parserproxy.rb
+- lib/calypso/serialmonitor.rb
+- lib/calypso/serialportdata.rb
+- lib/calypso/unittest.rb
 - lib/calypso/version.rb
+- lib/calypso/yamlparser.rb
 homepage: http://etaos.bietje.net/calypso
 licenses:
 - GPLv3