mrubyc-test 0.1.0

data/lib/mrubyc-ext/object.rb

@@ -0,0 +1,54 @@
+class Object
+  def to_ss
+    if self.class == NilClass
+      'nil [NilClass]'
+    elsif self == ''
+      '[NULL String]'
+    else
+      self.to_s + ' [' + self.class_name + ']'
+    end
+  end
+  def class_name
+    case self.class
+    when String
+      'String'
+    when Array
+      'Array'
+    when FalseClass
+      'FalseClass'
+    when Fixnum
+      'Fixnum'
+    when Float
+      'Float'
+    when Hash
+      'Hash'
+    when Math
+     'Math'
+    when Mutex
+      'Mutex'
+    when Numeric
+      'Numeric'
+    when Object
+      case self
+      when false
+        'FalseClass'
+      when true
+        'TrueClass'
+      else
+        'Object'
+      end
+    when Proc
+      'Proc'
+    when Range
+      'Range'
+    when String
+      'String'
+    when Symbol
+      'Symbol'
+    when VM
+      'VM'
+    else
+      '[User Defined Class]'
+    end
+  end
+end

data/lib/mrubyc-test.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "mrubyc_test_case/mrubyc_test_case"
+require "mrubyc/test/version"
+require "mrubyc/test/config"
+require "mrubyc/test/init"
+require "mrubyc/test/generator/attribute"
+require "mrubyc/test/generator/test_case"
+require "mrubyc/test/generator/script"
+require "mrubyc/test/generator/double"
+require "thor"
+
+module Mrubyc::Test
+  class Error < StandardError; end
+
+  class Tool < Thor
+    desc 'init', 'Initialize requirements for unit test of mruby/c. Some directories and files will be created. Note that existing objects may be overridden'
+    def init
+      Mrubyc::Test::Init.run
+    end
+
+    desc 'prepare', 'Create a ruby script that has all the requirements of your test'
+    def prepare
+      config = Mrubyc::Test::Config.read
+      model_files = Dir.glob(File.join(Dir.pwd, config['mruby_lib_dir'], 'models', '*.rb'))
+      test_path = File.join(Dir.pwd, config['test_dir'], '*.rb')
+      test_files = Dir.glob(test_path)
+      if test_files.size == 0
+        puts 'Test not found'
+        puts 'search path: ' + test_path
+        exit(1)
+      end
+
+      # gather attributes from your implementations and tests
+      attributes = Mrubyc::Test::Generator::Attribute.run(model_files: model_files, test_files: test_files)
+
+      # convert attributes into tast_cases
+      test_cases = Mrubyc::Test::Generator::TestCase.run(attributes)
+
+      # generate a ruby script that will be compiled by mrbc and executed in mruby/c VM
+      Mrubyc::Test::Generator::Script.run(model_files: model_files, test_files: test_files, test_cases: test_cases)
+    end
+
+    desc 'make', 'compile test script into executable && run it'
+    def make
+      config = Mrubyc::Test::Config.read
+      tmp_dir = File.join(Dir.pwd, config['test_tmp_dir'])
+      puts "cd #{tmp_dir}"
+      puts
+      exit_code = 0
+      pwd = Dir.pwd
+      FileUtils.mv "#{pwd}/#{config['mrubyc_src_dir']}/hal", "#{pwd}/#{config['mrubyc_src_dir']}/~hal"
+      begin
+        FileUtils.ln_s "#{pwd}/#{config['test_tmp_dir']}/hal", "#{pwd}/#{config['mrubyc_src_dir']}/hal"
+        Dir.chdir(tmp_dir) do
+          ['~/.rbenv/versions/mruby-1.4.1/bin/mrbc -E -B test test.rb',
+           "cc -I #{pwd}/#{config['mrubyc_src_dir']} -DMRBC_DEBUG -o test main.c #{pwd}/#{config['mrubyc_src_dir']}/*.c #{pwd}/#{config['mrubyc_src_dir']}/hal/*.c",
+           './test'].each do |cmd|
+             puts cmd
+             puts
+             exit_code = system(cmd) ? 0 : 1
+           end
+          puts
+          puts "cd -"
+          puts
+        end
+      ensure
+        FileUtils.rm "#{pwd}/#{config['mrubyc_src_dir']}/hal"
+        FileUtils.mv "#{pwd}/#{config['mrubyc_src_dir']}/~hal", "#{pwd}/#{config['mrubyc_src_dir']}/hal"
+      end
+      exit(exit_code)
+    end
+
+    desc 'test', 'shortcut for `prepare` && `make`'
+    def test
+      prepare
+      make
+    end
+  end
+end
+

data/lib/mrubyc/test/config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'yaml'
+
+module Mrubyc
+  module Test
+    class Config
+      class << self
+        def read(check: true)
+          FileUtils.touch('.mrubycconfig')
+          config = YAML.load_file('.mrubycconfig')
+          if check
+            if !config || config == [] || !config['test_dir']
+              raise 'Check if `.mrubycconfig` exists.'
+            end
+          end
+          config || {}
+        end
+
+        def write(config)
+          File.open('.mrubycconfig', 'r+') do |file|
+            file.write(config.to_yaml)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mrubyc/test/generator/attribute.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+
+module Mrubyc
+  module Test
+    module Generator
+      class Attribute
+        class << self
+          def run(model_files: [], test_files:)
+            # get information from model files(application code)
+            model_files.each do |model_file|
+              load model_file
+              model_class = Module.const_get(File.basename(model_file, '.rb').camelize)
+              model_class.class_eval do
+                def method_missing(_method_name, *_args)
+                  # do nothing
+                end
+              end
+            end
+            # get information from test files
+            method_locations = {}
+            description_locations = {}
+            double_method_locations = {}
+            test_files.each do |test_file|
+              load test_file
+              test_class = Module.const_get(File.basename(test_file, '.rb').camelize)
+              method_locations.merge!(test_class.class_variable_get(:@@method_locations))
+              description_locations.merge!(test_class.class_variable_get(:@@description_locations))
+              my_test = test_class.new
+              double_method_locations[test_class] = []
+              test_class.class_variable_get(:@@added_method_names)[test_class].each do |method_name, _v|
+                Mrubyc::Test::Generator::Double.init_double_method_locations
+                begin
+                  my_test.send(method_name)
+                rescue NoMethodError => e
+                end
+                double_method_locations[test_class] << { method_name => Mrubyc::Test::Generator::Double.class_variable_get(:@@double_method_locations) }
+              end
+            end
+            { method_locations: method_locations,
+              description_locations: description_locations,
+              double_method_locations: double_method_locations }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mrubyc/test/generator/double.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Mrubyc
+  module Test
+    module Generator
+      class Double
+        class << self
+          def init_double_method_locations
+            @@double_method_locations = []
+          end
+        end
+
+        def initialize(type, object, location)
+          @type = type
+          @klass = object.class
+          @location = location
+        end
+
+        def method_missing(method_name, *args)
+          @@double_method_locations << {
+            type: @type,
+            class: @klass,
+            method_name: method_name,
+            args: args.to_s,
+            block: (block_given? ? yield : nil),
+            label: @location.label,
+            path: @location.absolute_path || @location.path,
+            line: @location.lineno
+          }
+        end
+      end
+    end
+  end
+end

data/lib/mrubyc/test/generator/script.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rufo'
+require 'erb'
+
+module Mrubyc
+  module Test
+    module Generator
+      class Script
+        class << self
+          def run(model_files: [], test_files:, test_cases:)
+            config = Mrubyc::Test::Config.read
+            erb = ERB.new(File.read(File.expand_path('../../../../templates/test.rb.erb', __FILE__)), nil, '-')
+            mrubyc_class_dir = File.expand_path('../../../../mrubyc-ext/', __FILE__)
+            File.write(File.join(config['test_tmp_dir'], 'test.rb'), Rufo.format(erb.result(binding)))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mrubyc/test/generator/test_case.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Mrubyc
+  module Test
+    module Generator
+      class TestCase
+        class << self
+          def run(attributes)
+            test_cases = []
+            attributes[:method_locations].each do |klass, methods|
+              methods.each do |method|
+                if attributes[:description_locations].size > 0
+                  found_desc = attributes[:description_locations][klass].find do |hash|
+                    hash[:line] == method[:line] -1
+                  end
+                end
+                description = found_desc ? found_desc[:text] : ''
+                information = {
+                  test_class_name: klass.to_s,
+                  method_name: method[:method_name],
+                  path: method[:path],
+                  line: method[:line],
+                  description: description
+                }
+                stubs = []
+                mocks = []
+                attributes[:double_method_locations][klass].each do |hash|
+                  if hash.keys[0] == method[:method_name]
+                    hash[method[:method_name]].each do |double|
+                      stub_or_mock = { class_name: double[:class].to_s,
+                        instance_variables: nil, # TODO
+                        method_name: double[:method_name].to_s,
+                        args: double[:args],
+                        return_value: double[:block],
+                        line: double[:line]
+                      }
+                      if double[:type] == :stub
+                        stubs << stub_or_mock
+                      else
+                        mocks << stub_or_mock
+                      end
+                    end
+                  end
+                end
+                test_cases << {
+                  information: information,
+                  stubs: stubs,
+                  mocks: mocks
+                }
+              end
+            end
+            test_cases
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mrubyc/test/init.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'fileutils'
+
+module Mrubyc
+  module Test
+    class Init
+      class << self
+        def run
+          puts 'Initializing...'
+          puts
+
+          puts '  touch .mrubycconfig'
+          config = Mrubyc::Test::Config.read(check: false)
+          config['test_dir'] = 'test'
+          config['test_tmp_dir'] = 'test/tmp'
+          config['mruby_lib_dir'] = 'mrblib'
+          puts '  add config to .mrubycconfig'
+          Mrubyc::Test::Config.write(config)
+
+          hal_dir = "#{config['test_tmp_dir']}/hal"
+          puts "  mikdir -p #{hal_dir}"
+          FileUtils.mkdir_p(hal_dir)
+
+          Dir.chdir(hal_dir) do
+            puts "  download from https://raw.githubusercontent.com/mrubyc/mrubyc/master/src/hal_posix/hal.h"
+            system 'wget https://raw.githubusercontent.com/mrubyc/mrubyc/master/src/hal_posix/hal.h'
+            puts "  download from https://raw.githubusercontent.com/mrubyc/mrubyc/master/src/hal_posix/hal.c"
+            system 'wget https://raw.githubusercontent.com/mrubyc/mrubyc/master/src/hal_posix/hal.c'
+          end
+
+
+          puts "  mikdir -p #{config['mruby_lib_dir']}/models"
+          FileUtils.mkdir_p('test/tmp')
+
+          puts '  cp test/sample_test.rb'
+          erb = ERB.new(File.read(File.expand_path('../../../templates/sample_test.rb.erb', __FILE__)), nil, '-')
+          File.write(File.join(config['test_dir'], 'sample_test.rb'), erb.result(binding))
+
+          puts '  cp test/tmp/main.c'
+          erb = ERB.new(File.read(File.expand_path('../../../templates/main.c.erb', __FILE__)), nil, '-')
+          File.write(File.join(config['test_tmp_dir'], 'main.c'), erb.result(binding))
+
+          puts
+          puts "\e[32mWelcome to mrubyc-test, the world\'s first TDD tool for mruby/c microcontroller development.\e[37m"
+          puts "\e[33m"
+          puts 'Caution:'
+          puts 'For the time being, mrubyc-test assumes you installed mruby-1.4.1 by rbenv. So you should have `~/.rbenv/versions/mruby-1.4.1/bin.mrbc`'
+          puts 'Sorry for the inconvenience. It will be fixed soon!'
+          puts "\e[37m"
+        end
+      end
+    end
+  end
+end

data/lib/mrubyc/test/version.rb

@@ -0,0 +1,5 @@
+module Mrubyc
+  module Test
+    VERSION = "0.1.0"
+  end
+end

data/lib/mrubyc_test_case/mrubyc_test_case.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'mrubyc/test/generator/double'
+
+class MrubycTestCase
+  class << self
+    @@description_locations = {}
+    def description(text)
+      location = caller_locations(1, 1)[0]
+      path = location.absolute_path || location.path
+      line = location.lineno
+      location = {
+        text: text,
+        path: File.expand_path(path),
+        line: line,
+      }
+      add_description_location(location)
+    end
+    alias :desc :description
+
+    @@added_method_names = {}
+    @@method_locations = {}
+    def method_added(name)
+      return false if %i(method_missing setup teardown).include?(name)
+      # puts "method '#{self}' '#{name}' '#{name.class}' was added"
+      added_method_names = (@@added_method_names[self] ||= {})
+      stringified_name = name.to_s
+      location = caller_locations(1, 1)[0]
+      path = location.absolute_path || location.path
+      line = location.lineno
+      location = {
+        method_name: stringified_name,
+        path: File.expand_path(path),
+        line: line,
+      }
+      add_method_location(location)
+      added_method_names[stringified_name] = true
+    end
+
+    def added_method_names
+      (@@added_method_names[self] ||= {}).keys
+    end
+
+    private
+
+      # for RSpec
+      def init_class_variables
+        @@description_locations = {}
+        @@method_locations = {}
+        @@added_method_names = {}
+      end
+
+      def method_locations
+        @@method_locations[self] ||= []
+      end
+
+      def add_method_location(location)
+        method_locations << location
+      end
+
+      def description_locations
+        @@description_locations[self] ||= []
+      end
+
+      def add_description_location(location)
+        description_locations << location
+      end
+
+  end
+
+  def method_missing(method_name, *args)
+    case method_name
+    when :stub, :mock
+      location = caller_locations(1, 1)[0]
+      Mrubyc::Test::Generator::Double.new(method_name, args[0], location)
+    end
+  end
+end
+