mips_tester 0.0.1 → 0.1.0

data/.gitignore

@@ -0,0 +1,54 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store?
+ehthumbs.db
+Icon?
+Thumbs.db
+
+coverage
+rdoc
+pkg
+test/tmp
+test/version_tmp
+tmp
+pkg
+*.gem
+*.rbc
+lib/bundler/man
+spec/reports
+.config
+InstalledFiles
+.bundle
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mips_tester (0.0.1)
+    mips_tester (0.1.0)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -19,14 +19,10 @@ It relies on MARS (it's ugly I know, but SPIM's cli doesn't work with automated
 	$> 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 :003> tester.test "test.asm" do
+	$irb :004>		set :s0 => 0x01
+	$irb :005>		set '0x10010004' => 45
+	$irb :006>		expect :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
+		=> true

data/lib/mips_tester.rb

@@ -1,47 +1,88 @@
 require 'tempfile' unless defined? Tempfile
-require 'pp'
 
+# Main MIPSTester module
 module MIPSTester
-  VERSION = "0.0.1"
+  # Library version
+  VERSION = "0.1.0"
   
-  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})$/
+  # MIPSFileError Exception, raised when test file is not valid or non-existent
+  class MIPSFileError < Exception; end
+  
+  # MIPSInvalidBlockError Exception, raised when no block is given to test method
+  class MIPSInvalidBlockError < Exception; end
+  
+  # MIPSMarsError Exception, raised when MARS installation path is not valid.
+  class MIPSMarsError < Exception; end
   
+  # Main MIPS tester class.
+  # It provides the methods to test MIPS ASMs files
+  class MIPS
+    # Register validation
+    REGISTER_REGEX = /^(at|v[01]|a[0-3]|s[0-7]|t\d|[2-9]|1[0-9]|2[0-5])$/
+    
+    # Memory address validation
+    ADDRESS_REGEX = /^0x[\da-f]{8}$/
+    
+    # MARS jar path
+    attr_reader :mars_path
+    
+    # Create a new MIPSTester::MIPS object
+    #
+    # @example
+    #   MIPSTester::MIPS.new :mars_path => 'path/to/mars.jar'
+    #
+    # @return [MIPSTester::MIPS] The MIPSTester::MIPS object 
     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
+      raise MIPSMarsError.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
+    # Run a given file in the emulator. *A provided block is mandatory*, with starter registers
+    # and expected values.
+    # A simple DSL is provided:
+    # * set [Hash] => set initial registers or memory addresses
+    # * expect [Hash] => expect values of registers or memory addresses
+    # * verbose! => optional, if given prints on STDOUT set registers and expected ones
+    #
+    # @example
+    #   test "file.asm" do
+    #     set :s1 => 6, '0x10010000' => 0xFF
+    #     expect :s5 => 6
+    #     verbose!
+    #   end
+    #
+    # @param file [String] The path to the file to run
+    # @param block The block to provide info on what to test
+    #
+    # @return [Boolean] True if the test went well, False if not.
+    def test(file, &block)
+      raise MIPSFileError.new("Provide valid file.") if not file or not File.exists? file
+      raise MIPSInvalidBlockError.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.write(prep_params + File.read(file))
       asm.close
     
-      cli = `#{["java -jar", @mars_path, @regs.keys.join(" "), "nc dec", asm.path].join(" ")}`
-    
+      cli = `#{["java -jar",
+                @mars_path,
+                @regs.empty? ? "" : @regs.keys.join(" "), 
+                @addresses.empty? ? "" : [@addresses.keys.min, @addresses.keys.max].join("-"),
+                "nc dec",
+                asm.path].join(" ")}`
+      
       begin
         results = parse_results cli
         
-        if @verbose
-          puts "\nExpected:"
-          pp @exp
-          puts "\nResults:"
-          pp results
-        end
+        puts "Expected:\n#{@exp}\nResults:\n#{results}" if @verbose
         
         return compare_hashes(@exp, results)
       rescue Exception => ex
         puts ex.message
-        return nil
+        return false
       ensure
         asm.unlink
       end
@@ -50,39 +91,50 @@ module MIPSTester
     private
     
     def verbose!; @verbose = true; end
-    def register hash; @regs.merge! hash; end
-    def expected hash; @exp.merge! hash; end
+    
+    def set hash
+      hash.each_pair do |key, value|
+        case key
+          when REGISTER_REGEX then @regs.merge! key => value
+          when ADDRESS_REGEX then @addresses.merge! key => value
+          else puts "Warning: #{key} not recognized as register or memory address. Discarded."
+        end
+      end
+    end
+    
+    def expect hash; @exp.merge! hash; end
     
     def reset!
-      @regs = {}; @exp = {}; @verbose = false
+      @regs = {}; @addresses = {}; @exp = {}; @verbose = false
     end
   
     def parse_results(results)
-      if results =~ /^Error/
-        throw Exception.new "Error in file\nReason: #{results}\n\n"
-      end
+      raise Exception.new "Error in given file!\nReason: #{results}\n\n" if results =~ /^Error/
       
       out = {}
       
-      results.split("\n")[1..-1].map do |reg|
-        g = reg.strip.split("\t")
-        out.merge! g[0].gsub("$", "") => g[1].to_i
+      results.split("\n")[1..-1].each do |reg|
+        key, value = reg.strip.split("\t")
+        
+        if key =~ /^Mem/
+          out.merge! key[4..-2] => value.to_i
+        else
+          out.merge! key[1..-1] => value.to_i
+        end
       end
       
       out
     end
   
-    def prep_registers(regs)
+    def prep_params
       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
+      @regs.each_pair {|key, value| out << "li\t\t$#{key}, #{value}\n" }
+      @addresses.each_pair do |key, value|
+        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
+      
       out
     end
     

data/spec/mips_spec.rb

@@ -1,16 +1,61 @@
 require 'spec_helper'
+include MIPSTester
 
-describe MIPSTester::MIPS do
-  let :mips do
-    MIPSTester::MIPS.new :mars_path => "/Applications/MARS_4_1.jar"
+describe MIPS do
+  context 'passing wrong parameters' do
+    it 'should raise exception if not valid MARS path is given' do
+      expect do
+        MIPS.new :mars_path => '/tmp/MARS.jar'
+      end.to raise_error(::MIPSMarsError)
+    end
+    
+    it 'should raise exception if not valid file path is given' do
+      mips = MIPS.new :mars_path => "/Applications/MARS_4_1.jar"
+      expect do
+        mips.test fixture_path("non-existing.asm") {}
+      end.to raise_error(::MIPSFileError)
+    end
+    
+    it 'should raise exception if no block is given on test method' do
+      mips = MIPS.new :mars_path => "/Applications/MARS_4_1.jar"
+      expect do
+        mips.test fixture_path("empty.asm")
+      end.to raise_error(::MIPSInvalidBlockError)
+    end
   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
+  
+  context 'work on empty file' do
+    let :mips do
+      MIPS.new :mars_path => "/Applications/MARS_4_1.jar"
+    end
+    
+    it 'should expect given register values' do
+      mips.test fixture_path("empty.asm") do
+        set :s0 => 0x0C, :s1 => 0x3F
+        expect :s0 => 0x0C, :s1 => 0x3F
+      end.should be_true
+    end
+    
+    it 'should fail with expected results different from set results' do
+      mips.test fixture_path("empty.asm") do
+        set :s0 => 0x0D, :s1 => 0x3E
+        expect :s0 => 0x0C, :s1 => 0x3F
+      end.should be_false
+    end
+    
+    it 'should expect given memory address values' do
+      mips.test fixture_path("empty.asm") do
+        set '0x10010000' => 45, '0x10010010' => 32, '0x10010020' => 0xFF
+        expect '0x10010000' => 45, '0x10010010' => 32, '0x10010020' => 0xFF
+      end.should be_true
+    end
+    
+    it 'should expect mixed parameters' do
+      mips.test fixture_path("empty.asm") do
+        set '0x10010000' => 45, :s0 => 32
+        expect '0x10010000' => 45, :s0 => 32
+      end.should be_true
+    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: mips_tester
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Federico Ravasio
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-17 00:00:00 +02:00
+date: 2011-04-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,13 +34,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
 - 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