mips_tester 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    mips_tester (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mips_tester!
+  rspec (> 2.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Federico Ravasio
+
+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,32 @@
+# MIPS Tester
+MIPS Tester is a simple class that provides the ability to mass test MIPS assemblies.
+It relies on MARS (it's ugly I know, but SPIM's cli doesn't work with automated inputs).
+
+## Installation & Prerequisites
+
+* Install MIPS Tester:
+
+		$> gem install mips_tester
+
+* Install the Java Runtime
+
+* Download [MARS](http://courses.missouristate.edu/KenVollmar/MARS/)
+	Put it somewhere handy, the path will be requested at runtime!
+
+## Getting Started: Test an empty program
+
+	$> touch test.asm
+	$> irb
+	$irb :001> require 'mips_tester'
+	$irb :002> tester = MIPSTester::MIPS.new :mars_path => "/Applications/MARS_4_1.jar"
+	$irb :003> tester.run "test.asm" do
+	$irb :004>		register :s0 => 0x01
+	$irb :005>		register :s1 => 0x45
+	$irb :006>		expected :s0 => 0x01, :s1 => 0x45
+	$irb :007>		verbose! # Optional verbosity!
+	$irb :008> end
+		=> true
+
+## TO-DOs
+* Ability to input memory address and expect their results
+* Better failing messages

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'yard'
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+desc "run spec tests"
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = 'spec/*_spec.rb'
+end
+
+desc 'Generate documentation'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/*.rb', '-', 'LICENSE']
+  t.options = ['--main', 'README.md', '--no-private']
+end

data/lib/mips_tester.rb

@@ -0,0 +1,97 @@
+require 'tempfile' unless defined? Tempfile
+require 'pp'
+
+module MIPSTester
+  VERSION = "0.0.1"
+  
+  class MIPS
+    REGISTER = /^(at|v[01]|a[0-3]|s[0-7]|t\d|[2-9]|1[0-9]|2[0-5])$/
+    ADDRESS = /^(\d{1,10}|0x[\da-f]{1,8}|0b[01]{1,32})$/
+  
+    def initialize(params = {})
+      @mars_path = params.delete(:mars_path)
+      raise Exception.new("Provide valid Mars jar!") if not @mars_path or not File.exists? @mars_path
+    end
+  
+    def run(file, &block)
+      raise Exception.new("Provide valid file!") if not file or not File.exists? file
+      raise Exception.new("Provide block!") if not block
+    
+      reset!
+  
+      instance_eval(&block)
+    
+      asm = Tempfile.new "temp.asm"
+      asm.write prep_registers(@regs)
+      asm.write File.read(file)
+      asm.close
+    
+      cli = `#{["java -jar", @mars_path, @regs.keys.join(" "), "nc dec", asm.path].join(" ")}`
+    
+      begin
+        results = parse_results cli
+        
+        if @verbose
+          puts "\nExpected:"
+          pp @exp
+          puts "\nResults:"
+          pp results
+        end
+        
+        return compare_hashes(@exp, results)
+      rescue Exception => ex
+        puts ex.message
+        return nil
+      ensure
+        asm.unlink
+      end
+    end
+  
+    private
+    
+    def verbose!; @verbose = true; end
+    def register hash; @regs.merge! hash; end
+    def expected hash; @exp.merge! hash; end
+    
+    def reset!
+      @regs = {}; @exp = {}; @verbose = false
+    end
+  
+    def parse_results(results)
+      if results =~ /^Error/
+        throw Exception.new "Error in file\nReason: #{results}\n\n"
+      end
+      
+      out = {}
+      
+      results.split("\n")[1..-1].map do |reg|
+        g = reg.strip.split("\t")
+        out.merge! g[0].gsub("$", "") => g[1].to_i
+      end
+      
+      out
+    end
+  
+    def prep_registers(regs)
+      out = ""
+      regs.each_pair do |key, value|
+        if key =~ REGISTER
+          out << "li\t\t$#{key}, #{value}\n"
+        elsif key =~ ADDRESS
+          out << "li\t\t$t0, #{key}\n"
+          out << "li\t\t$t1, 0x#{value.to_s(16)}\n"
+          out << "sb\t\t$t1, ($t0)\n"
+        end
+      end
+      out
+    end
+    
+    def compare_hashes(first, second)
+      first.each_pair do |key, value|
+        return false unless second[key.to_s] == value
+      end
+      
+      true
+    end
+  end
+end

data/mips_tester.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require 'mips_tester'
+
+Gem::Specification.new do |s|
+  s.name = 'mips_tester'
+  s.version = MIPSTester::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Federico Ravasio']
+  s.email = ['ravasio.federico@gmail.com']
+  s.summary = 'Class to test MIPS asm files'
+  s.homepage = 'http://github.com/razielgn/mips_tester'
+  s.description = s.summary + ". It relies on MARS\' cli, so be sure to download its JAR first."
+
+  s.required_ruby_version = '>=1.9.2'
+
+  s.add_development_dependency 'rspec', '>2.0'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/spec/mips_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe MIPSTester::MIPS do
+  let :mips do
+    MIPSTester::MIPS.new :mars_path => "/Applications/MARS_4_1.jar"
+  end
+  
+  it 'should work properly with an empty file' do
+    mips.run fixture_path("empty.asm") do
+      register :s0 => 0x0C, :s1 => 0x3F
+      register :s2 => 0x34
+      expected :s0 => 0x0C, :s1 => 0x3F
+      expected :s2 => 0x34
+    end.should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'mips_tester'
+
+def fixture_path(filename)
+  File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: mips_tester
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Federico Ravasio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
+  version_requirements: *id001
+description: Class to test MIPS asm files. It relies on MARS' cli, so be sure to download its JAR first.
+email: 
+- ravasio.federico@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/mips_tester.rb
+- mips_tester-0.0.1.gem
+- mips_tester.gemspec
+- spec/fixtures/empty.asm
+- spec/mips_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/razielgn/mips_tester
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Class to test MIPS asm files
+test_files: 
+- spec/fixtures/empty.asm
+- spec/mips_spec.rb
+- spec/spec_helper.rb