mrubyc-test 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 160ab8e14780603229e59811a6dc2c387cacf4a9e9037d271d41b2e9746fea37
+  data.tar.gz: 598655a35c67729fe21fb90f4b9920428148eb59ed385ccfe32178b82cf38e65
+SHA512:
+  metadata.gz: 7a846f95b6cd76f38febef344e34ed912d396376e233c704f2a2bb4c436d30433524b01bcb860ec218cab9306f6afa1395d0e09c741bc72686ab27889d0751f2
+  data.tar.gz: 1ee0ffe96570e29fa18a6f668adbc7dc604d4087b2312c01852b8db0c9876f6548e4b4baa0cc08bccba16971964cd6a515a98d0ae2838e455f7553ab9baefdd6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.mrubycconfig
+/test/
+/mrblib/
+/mrubyc_src/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hitoshi.hasumi@monstar-lab.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mrubyc-test.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    mrubyc-test (0.1.0)
+      activesupport (~> 5.2)
+      rufo (~> 0.4)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (1.5.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rufo (0.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  mrubyc-test!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 HASUMI Hitoshi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,154 @@
+# mrubyc-test
+
+mrubyc-test is an unit test framework for [mruby/c](https://github.com/mrubyc/mrubyc), supporting basic assertions, stub and mock.
+
+## Acknowledgements
+
+The API design and implementation of this gem is greatly inspired by [test-unit](https://github.com/test-unit/test-unit). Thank the great work.
+
+## Features
+
+- Tests are applicable to mruby code. C code will not be covered
+- Tests will run on your PC (POSIX) hereby you can write *business logic* with mruby/c apart from C API matters like microcontroler peripherals
+- Simple assertions ... enough for almost firmware development though, I will increase the number of assertion
+- Stub ... You can write your mruby code without peripheral implementation by C
+- Mock ... You can call any method sill doesn't exist
+- The implementation of your application and test code will be analyzed by CRuby program, then comlpiled into mruby byte code and executed on mruby/c VM
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mrubyc-test'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mrubyc-test
+
+## Usage
+
+Assuming you are using [mrubyc-utils](https://github.com/hasumikin/mrubyc-utils) to manage your project and [rbenv](https://github.com/rbenv/rbenv) to manage Ruby versions.
+It means you have `.mrubycconfig` file in the top directory of your project.
+
+Besides, you have to locate mruby model files that are the target of testing like `mrblib/models/class_name.rb`
+
+This is an example of ESP32 project:
+
+```
+~/your_project $ tree
+.
+├── .mrubycconfig                # Created by mrubyc-utils
+├── Makefile
+├── build
+├── components
+├── main
+├── mrblib
+│      └── models               # Place your model class files here
+│            ├── class_name.rb  # The testing target `ClassName`
+│            └── my_class.rb    # The testing target `MyClass`
+│      └── tasks
+│            ├── main.rb        # Loop script isn't covered by mrubyc-test. use mrubyc-debugger
+│            └── sub.rb         # Loop script isn't covered by mrubyc-test. use mrubyc-debugger
+└── sdkconfig
+```
+
+In the same directory:
+
+    $ mrubyc-test init
+
+Then, some directories and files will be created in your project.
+Now you can run test because a sample test code was also created.
+
+    $ mrubyc-test test
+
+You should get some assertion faulures.
+Take a look at `test/sample_test.rb` to handle the failures and know how to write your own test.
+
+### Asserions
+
+```ruby
+def assertions
+  my_var = 1
+  assert_equal     1, my_var  # => success
+  assert_not_equal 2, my_var  # => success
+  assert_not_nil   my_var     # => success
+end
+```
+
+### Stubs
+
+Assuming you have a model file at `mrblib/models/sample.rb`
+
+```ruby
+class Sample
+  def do_something
+    attr_accessor :result
+    def do_something(arg)
+      @result = arg + still_not_defined_method
+    end
+  end
+end
+```
+
+Then you can test `#do_something` method without having `#still_not_defind_method` like this:
+
+```ruby
+def stub_case
+  sample_obj = Sample.new
+  stub(sample_obj).still_not_defined_method { ", so we are nice" }
+  sample_obj.do_something("Ruby is nice")
+  assert_equal 'Ruby is nice, so we are nice', sample_obj.result
+end
+```
+
+### Mocks
+
+`mrblib/models/sample.rb` looks like this time:
+
+```ruby
+class Sample
+  def do_other_thing
+    is_to_be_hit()
+  end
+end
+```
+
+You can test whether `#is_to_be_hit` method will be called:
+
+```ruby
+def mock_case
+  sample_obj = Sample.new
+  mock(sample_obj).is_to_be_hit
+  sample_obj.do_other_thing
+end
+```
+
+## Known problems
+
+- `.ruby-version` should be set to a veriosn of CRuby to use mrubyc-test command although mruby/c developers want to set it like mruby-1.4.1
+- You have to write stub or mock test fot all the methods still do not exist otherwise your test won't turn green
+
+## TODO (possibly)
+
+- Better solution of coexistence of CRuby and mruby. May be a kind of wrapper tool or rbenv plugin?
+- Assertion against arguments of mock
+- Other assertions like LT(<), GTE(>=), include?, ...etc.
+- bla bla bla
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hasumikin/mrubyc-test. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mrubyc::Test project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mrubyc-test/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mrubyc/test"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/mrubyc-test

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'mrubyc-test'
+
+Mrubyc::Test::Tool.start
+

data/lib/mrubyc-ext/hash.rb

@@ -0,0 +1,10 @@
+class Hash
+  def add_by_key(key)
+    if self.has_key?(key)
+      self[key] =+ 1
+    else
+      self[key] = 1
+    end
+  end
+end
+

data/lib/mrubyc-ext/mock.rb

@@ -0,0 +1,8 @@
+class Mock
+  attr_accessor :expected, :actual
+  def initialize
+    @expected = {}
+    @actual = {}
+  end
+end
+

data/lib/mrubyc-ext/mrubyc_test_case.rb

@@ -0,0 +1,72 @@
+class MrubycTestCase
+  def initialize(information)
+    @information = information
+    $mock ||= Mock.new
+    @puts_success_message = true
+    @puts_failure_message = true
+  end
+  def puts_information
+    puts
+    puts @information[:test_class_name] + '#' + @information[:method_name]
+  end
+  def success(assertion, expected, actual)
+    puts_information
+    $success_count += 1
+    if @puts_success_message
+      puts $colors[:success] + '  assertion : ' + assertion.to_s + $colors[:normal]
+      puts $colors[:success] + '  result    : ' + actual.to_ss + $colors[:normal]
+    else
+      print $colors[:success] + '.' + $colors[:normal]
+    end
+  end
+  def failure(assertion, expected, actual, message)
+    puts_information
+    $failure_count += 1
+    if @puts_failure_message
+      puts $colors[:failure] + '  path       : ' + @information[:path].to_s
+      puts $colors[:failure] + '  line       : ' + @information[:line].to_s
+      puts $colors[:failure] + '  description: ' + @information[:description].to_s
+      puts $colors[:failure] + '  ' + message if message
+      puts $colors[:failure] + '  assertion  : ' + assertion.to_s + $colors[:normal]
+      puts $colors[:failure] + '  expected   : ' + expected.to_ss + $colors[:normal]
+      puts $colors[:failure] + '  actual     : ' + actual.to_ss + $colors[:normal]
+    else
+      print $colors[:failure] + '.' + $colors[:normal]
+    end
+  end
+  def assert_equal(expected, actual, message = nil)
+    assertion = :assert_equal
+    actual == expected ? success(assertion, expected, actual) : failure(assertion, expected, actual, message)
+  end
+  def assert_not_equal(expected, actual, message = nil)
+    assertion = :assert_not_equal
+    actual != expected ? success(assertion, expected, actual) : failure(assertion, expected, actual, message)
+  end
+  def assert_not_nil(expression, message = nil)
+    assertion = :assert_not_nil
+    expression != nil ? success(assertion, nil, expression) : failure(assertion, nil, expression, message)
+  end
+  def self.description(text)
+  end
+  def self.desc(text)
+  end
+  def setup
+  end
+  def teardown
+  end
+  def stub(object)
+    object
+  end
+  def check_mock
+    $mock.expected.keys.each do |key|
+      $mock.actual[key] = 0 unless $mock.actual[key]
+      if $mock.expected[key] > $mock.actual[key]
+        failure(:mock, $mock.expected[key], $mock.actual[key], key.to_s + ' shoud have been called at least expected times')
+      else
+        success(:mock, $mock.expected[key], $mock.actual[key])
+      end
+    end
+  end
+end
+
+