gmalamid-synthesis 0.1.8 → 0.2.0

data/README

@@ -34,6 +34,8 @@ Synthesis can be setup to ignore certain classes or modules when collecting expe
 
 If +pattern+ is not specified, it will default to <tt>test/**/*_test.rb</tt>
 
+As of version 0.2.0, Synthesis has a +DOT+ formatter which, when used, will output text in the DOT graph description language, producing system visualizations as specified by the simulated interactions in the system's tests. The output of the +DOT+ formatter can be used with tools like Graphviz( http://www.graphviz.org/ ).
+
 == Usage examples
 
 To use with Test::Unit and Mocha, ignoring Array and Hash:
@@ -54,7 +56,7 @@ To use with RSpec, running all specs in the <tt>spec</tt> directory:
     t.pattern = 'spec/**/*_spec.rb'
   end
 
-To use with Expectations, redirecting output to a file
+To use with Expectations, redirecting output to a file:
 
   require "synthesis/task"
 	
@@ -62,6 +64,23 @@ To use with Expectations, redirecting output to a file
     t.adapter = :expectations
     t.out = File.new "synthesis.test.txt", "a"
   end
+  
+To output a DOT graph:
+
+  require "synthesis/task"
+	
+  Synthesis::Task.new do |t|
+    t.formatter = :dot
+  end
+
+To use Synthesis with Rails:
+
+  require "synthesis/task"
+
+  Synthesis::Task.new do |t|
+    RAILS_ENV = "test"
+    t.pattern = 'test/**/*_test.rb'
+  end
 
 == Utilities
 

data/Rakefile

@@ -1,6 +1,5 @@
 require "rubygems"
 require "rake/testtask"
-require "rake/gempackagetask"
 require 'rake/rdoctask'
 require 'rake/contrib/sshpublisher'
 require File.dirname(__FILE__) + "/lib/synthesis/task"
@@ -27,15 +26,17 @@ Rake::TestTask.new('test:spec') do |t|
   t.pattern = 'test/synthesis/adapter/rspec/*_test.rb'
 end
 
+# Synthesis test_project tasks
+
 Synthesis::Task.new do |t|
   t.pattern = 'test_project/mocha/test/*_test.rb'
   t.ignored = [Array, Hash]
   # t.out = File.new('synthesis.test.txt', 'a')
 end
 
-Synthesis::Task.new('synthesis:expectations') do |t|
-  t.adapter = :expectations
-  t.pattern = 'test_project/expectations/test/*_test.rb'
+Synthesis::Task.new('synthesis:test:graph') do |t|
+  t.pattern = 'test_project/mocha/test/*_test.rb'
+  t.formatter = :dot
 end
 
 Synthesis::Task.new('synthesis:spec') do |t|
@@ -43,6 +44,17 @@ Synthesis::Task.new('synthesis:spec') do |t|
   t.pattern = 'test_project/rspec/*_spec.rb'
 end
 
+Synthesis::Task.new('synthesis:spec:graph') do |t|
+  t.adapter = :rspec
+  t.pattern = 'test_project/rspec/*_spec.rb'
+  t.formatter = :dot
+end
+
+Synthesis::Task.new('synthesis:expectations') do |t|
+  t.adapter = :expectations
+  t.pattern = 'test_project/expectations/test/*_test.rb'
+end
+
 namespace :test_project do
   task :all do
     STDOUT.puts `rake test_project:mocha`
@@ -78,14 +90,6 @@ task :publish_rdoc do
   Rake::SshDirPublisher.new("gmalamid@rubyforge.org", "/var/www/gforge-projects/synthesis", "doc").upload
 end
 
-Rake::GemPackageTask.new(GEMSPEC) do |t|
-  t.need_zip = false
-  t.need_tar = false
-end
-
-desc "Remove rdoc and package artefacts"
-task :clean => %w[clobber_package clobber_rdoc]
-
 task(:lf) {p Dir["lib/**/*rb"]}
 
 task(:check_gemspec) do

data/lib/synthesis/adapter/mocha.rb

@@ -16,6 +16,7 @@ module Synthesis
       Object.extend(ExpectationRecorder)
       Object.record_expectations_on(:expects)
       Mocha::Expectation.extend(ExpectationInterceptor)
+      Mocha::Expectation.intercept_test_subject_on(:invoke)
       Mocha::Expectation.intercept_expected_arguments_on(:with)
       Mocha::Expectation.intercept_expected_return_values_on(:returns)
       Mocha::Expectation.intercept_expected_return_values_on(:raises)

data/lib/synthesis/adapter/rspec.rb

@@ -26,6 +26,7 @@ module Synthesis
       Spec::Mocks::Methods.extend(ExpectationRecorder)
       Spec::Mocks::Methods.record_expectations_on(:should_receive)
       Spec::Mocks::MessageExpectation.extend(ExpectationInterceptor)
+      Spec::Mocks::MessageExpectation.intercept_test_subject_on(:invoke)
       Spec::Mocks::MessageExpectation.intercept_expected_arguments_on(:with)
       Spec::Mocks::MessageExpectation.intercept_expected_return_values_on(:and_return)
       Spec::Mocks::MessageExpectation.intercept_expected_return_values_on(:and_raise)

data/lib/synthesis/expectation.rb

@@ -20,10 +20,19 @@ module Synthesis
         meta_receiver.recordable_method(@method)
       end
       
+      def add_test_subject(test_subject)
+        (@callers ||= []) << test_subject
+      end
+      
+      def test_subject
+        @callers[0]
+      end
+      
       def explode
         if @return_values.size > 1
           @return_values.map do |v|
             expectation = self.class.new(@receiver, @method, @track, @args, [])
+            expectation.add_test_subject(@callers.shift)
             expectation.add_return_values(v)
             expectation
           end
@@ -79,11 +88,9 @@ module Synthesis
         @receiver
       end
       
-      def to_s
-        "(#{return_value_type}) " +
-        "#{@receiver.name}.#{@method}(#{@args.map { |arg| arg.class } * ', '})" + 
-        "in #{@track}"
-      end
+      def receiver_repr
+        @receiver.name
+      end      
     end
     
     class Instance < Expectation
@@ -99,11 +106,9 @@ module Synthesis
         meta_receiver
       end
       
-      def to_s
-        "(#{return_value_type}) #{meta_receiver.name}.new.#{@method}" +
-        "(#{@args.map { |arg| arg.class } * ', '})" + 
-        "in #{@track}"
-      end
+      def receiver_repr
+        "#{meta_receiver.name}.new"
+      end      
     end
     
     class NilExpectation < Expectation

data/lib/synthesis/expectation_interceptor.rb

@@ -3,6 +3,26 @@ module Synthesis
   # Synthesis to tap into it in order to collect simulated method arguments
   # and return values.
   module ExpectationInterceptor
+    # Intercept the actual mock proxy to record the test subject so that
+    # Synthesis can track which object is being tested
+    def intercept_test_subject_on(method_name)
+      (@original_methods ||= []) << method_name
+      
+      class_eval do
+        alias_method "intercepted_#{method_name}", method_name
+        
+        define_method(:get_invoke_method_name) {method_name}
+        
+        def temp_invoke(*expected_parameters, &matching_block)
+          synthesis_expectation.add_test_subject(caller(2)) if synthesis_expectation
+          send("intercepted_#{get_invoke_method_name}", *expected_parameters, &matching_block)
+        end
+          
+        alias_method method_name, :temp_invoke
+        undef temp_invoke
+      end
+    end
+    
     # Intercept the mock object framework's expectation method for declaring a mocked
     # method's arguments so that Synthesis can record them.
     def intercept_expected_arguments_on(method_name)
@@ -66,6 +86,8 @@ module Synthesis
       class_eval do
         remove_method :synthesis_expectation
         remove_method :synthesis_expectation=
+        remove_method :get_invoke_method_name
+        remove_method :get_method_name
       end
     end
     

data/lib/synthesis/expectation_record.rb

@@ -61,19 +61,9 @@ module Synthesis
       def untested_expectations
         expectations.select { |e| !e.invoked? }
       end
-
-      def print_tested_expectations
-        log; log "Tested Expectations: "
-        tested_expectations.each { |e| log e }
-      end
-
-      def print_untested_expectations
-        log; log "Untested Expectations: "
-        untested_expectations.each { |e| log e }
-      end
-
-      def print_ignored
-        log; log "Ignoring: #{ignored.to_a * ', '}"
+      
+      def has_untested_expectations?
+        untested_expectations.any?
       end
 
       private

data/lib/synthesis/formatter/dot.rb

@@ -0,0 +1,91 @@
+require "parse_tree"
+require "sexp"
+require "sexp_processor"
+
+module Synthesis
+  class DotFormatter < Formatter
+    def initialize
+      Expectation::Expectation.send(:include, ExpectationReportFormat::Dot)
+    end
+    
+    def digraph
+      puts "digraph synthesis_expectations {"
+      puts "  rankdir=LR;"
+      puts "  size=\"8,10\";"
+      puts "  ratio=\"fill\";"
+      puts "  node [shape = circle];"
+      puts "  edge [color = green]"
+      report_tested_expectations
+      puts
+      puts "  edge [color = red]"
+      report_untested_expectations
+      puts "}"
+    end
+    alias format_failure digraph
+    alias format_success digraph
+  end
+  
+  module ExpectationReportFormat
+    module Dot
+      def to_report
+        "  \"#{test_subject_name}\" -> \"#{receiver_class}\" " +
+        "[ label = \"(#{return_value_type}) #{method}(#{arg_types * ', '})\" ];"
+      end
+          
+      private
+    
+      def test_subject_name
+        filename, line, method = test_subject[1].split(':')
+        method = method.scan(/`(.*)'/)[0][0]
+        ruby = File.read(filename)
+        parser = ParseTree.new
+        sexp = parser.parse_tree_for_string(ruby, filename).first
+        sexp = Sexp.from_array(sexp)
+        return DotProcessor.process(sexp, method)
+      rescue
+        filename ? "#{filename} (#{line})" : "?"
+      end
+
+      class DotProcessor < SexpProcessor
+        attr_accessor :method
+        attr_reader :klazz
+
+        def self.process(exp, method)
+          analyzer = self.new
+          analyzer.method = method
+          analyzer.process(exp)
+          analyzer.klazz
+        end
+
+        def initialize
+          super
+          self.strict = false
+          self.auto_shift_type = true
+          @ancestors = []
+        end
+
+        def process_module(exp)
+          name = exp.shift
+          @ancestors.push name
+          result = s(:module, name, process(exp.shift))
+          @ancestors.pop
+          result
+        end
+
+        def process_class(exp)
+          name = exp.shift
+          @ancestors.push name
+          result = s(:class, name, exp.shift, process(exp.shift))
+          @ancestors.pop
+          result
+        end
+
+        def process_defn(exp)
+          name = exp.shift
+          @klazz = @ancestors * '::' if name == method.to_sym
+          s(:defn, name, process(exp.shift), process(exp.shift))
+        end
+      end
+    end
+  end
+end

data/lib/synthesis/formatter/text.rb

@@ -0,0 +1,32 @@
+module Synthesis
+  class TextFormatter < Formatter
+    include Logging
+    
+    def initialize
+      Expectation::Expectation.send(:include, ExpectationReportFormat::Text)
+    end
+    
+    def format_success
+      log; log "Verified #{ExpectationRecord.expectations.size} expectations"
+      log "SUCCESS."
+    end
+
+    def format_failure
+      log; log "Tested Expectations: "
+      report_tested_expectations
+      log; log "Untested Expectations: "
+      report_untested_expectations
+      log "Ignoring: #{ExpectationRecord.ignored.to_a * ', '}"
+      log; log "FAILED."
+    end
+  end
+  
+  module ExpectationReportFormat
+    module Text
+      def to_report
+        "(#{return_value_type}) #{receiver_repr}.#{@method}" +
+        "(#{arg_types * ', '}) in #{@track}"
+      end
+    end
+  end
+end

data/lib/synthesis/formatter.rb

@@ -0,0 +1,21 @@
+module Synthesis
+  class Formatter
+    def report_tested_expectations
+      ExpectationRecord.tested_expectations.each { |e| puts e.to_report }
+    end
+    
+    def report_untested_expectations
+      ExpectationRecord.untested_expectations.each { |e| puts e.to_report }
+    end
+    
+    class << self
+      def load
+        @formatter.new
+      end
+    
+      def inherited(subclass)
+        @formatter = subclass
+      end
+    end
+  end
+end

data/lib/synthesis/method_invocation_watcher.rb

@@ -1,8 +1,15 @@
 module Synthesis
   class MethodInvocationWatcher
     def self.invoked(receiver, method, args = [], return_values = [])
+      # cal = caller.clone
+      # cal.shift # ignore first (eval)
+      # path_from_spec = []
+      # begin
+      #   c = cal.shift
+      #   path_from_spec.unshift c # unless c =~ /(\(eval\)|gems)/
+      # end until c =~ /(spec|test)/
       matcher = Expectation.new(receiver, method, nil, args, return_values)
-      ExpectationRecord[matcher].invoked!
+      ExpectationRecord[matcher].invoked! # path_from_spec
     end
   end
 end

data/lib/synthesis/reporter.rb

@@ -1,24 +1,13 @@
 module Synthesis
   class Reporter
-    class << self
-      include Logging
-
-      def report
-        if failed?
-          ExpectationRecord.print_tested_expectations
-          ExpectationRecord.print_untested_expectations
-          ExpectationRecord.print_ignored
-          log; log "FAILED."
-          return -1
-        end
-        log; log "Verified #{ExpectationRecord.expectations.size} expectations"
-        log "SUCCESS."
-        0
-      end
-
-      def failed?
-        ExpectationRecord.untested_expectations.any?
+    def self.report
+      formatter = Formatter.load
+      if ExpectationRecord.has_untested_expectations?
+        formatter.format_failure
+        return -1
       end
+      formatter.format_success
+      0
     end
   end
 end

data/lib/synthesis/runner.rb

@@ -1,7 +1,8 @@
 module Synthesis
   class Runner
-    def self.run(adapter, pattern)
+    def self.run(adapter, pattern, formatter)
       require "synthesis/adapter/#{adapter}"
+      require "synthesis/formatter/#{formatter}"
       Adapter.load(pattern).run
       at_exit { Reporter.report unless $! }
     end    

data/lib/synthesis/task.rb

@@ -6,7 +6,8 @@ require File.dirname(__FILE__) + "/../synthesis/logging"
 module Synthesis
   class Task < Rake::TaskLib
     include Logging
-    attr_accessor :verbose, :pattern, :ruby_opts, :adapter, :out, :ignored, :libs
+    attr_accessor :verbose, :pattern, :ruby_opts
+    attr_accessor :adapter, :out, :ignored, :libs, :formatter
 
     def initialize(name='synthesis:test')
       @name, @ignored, @libs = name, [], []
@@ -14,6 +15,7 @@ module Synthesis
       @pattern ||= 'test/**/*_test.rb'
       @ruby_opts ||= []
       @adapter ||= :mocha
+      @formatter ||= :text
       define
     end
     
@@ -37,7 +39,7 @@ module Synthesis
           require File.dirname(__FILE__) + "/../synthesis/runner"
           Synthesis::Logging.const_set(:OUT, @out) if @out
           Synthesis::ExpectationRecord.ignore(*@ignored)
-          Synthesis::Runner.run(@adapter, @pattern)
+          Synthesis::Runner.run(@adapter, @pattern, @formatter)
         end
       end
       self

data/lib/synthesis/util/mock_instance/rspec.rb

@@ -15,4 +15,4 @@ module Spec::Mocks::Methods
 
     return instance
   end
-end
+end

data/lib/synthesis.rb

@@ -14,4 +14,5 @@ require "synthesis/expectation_matcher"
 require "synthesis/expectation_interceptor"
 require "synthesis/expectation_recorder"
 require "synthesis/reporter"
+require "synthesis/formatter"
 require "synthesis/adapter"

data/synthesis.gemspec

@@ -1,10 +1,10 @@
 GEMSPEC =Gem::Specification.new do |s|
   s.name = 'synthesis'
-  s.version = '0.1.8'
+  s.version = '0.2.0'
   s.platform = Gem::Platform::RUBY
   s.rubyforge_project = "synthesis"
   s.summary, s.description = 'A tool for Synthesized Testing'
-  s.authors = 'Stuart Caborn, George Malamidis'
+  s.authors = 'Stuart Caborn, George Malamidis, Danilo Sato'
   s.email = 'george@nutrun.com'
   s.homepage = 'http://synthesis.rubyforge.org'
   s.has_rdoc = true
@@ -24,6 +24,9 @@ GEMSPEC =Gem::Specification.new do |s|
     "lib/synthesis/expectation_interceptor.rb",
     "lib/synthesis/expectation_matcher.rb",
     "lib/synthesis/expectation_record.rb",
+    "lib/synthesis/formatter/dot.rb",
+    "lib/synthesis/formatter/text.rb",
+    "lib/synthesis/formatter.rb",
     "lib/synthesis/expectation_recorder.rb",
     "lib/synthesis/logging.rb",
     "lib/synthesis/method_invocation_watcher.rb",

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: gmalamid-synthesis
 version: !ruby/object:Gem::Version 
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors: 
-- Stuart Caborn, George Malamidis
+- Stuart Caborn, George Malamidis, Danilo Sato
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-10-09 00:00:00 -07:00
+date: 2008-10-27 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,9 @@ files:
 - lib/synthesis/expectation_interceptor.rb
 - lib/synthesis/expectation_matcher.rb
 - lib/synthesis/expectation_record.rb
+- lib/synthesis/formatter/dot.rb
+- lib/synthesis/formatter/text.rb
+- lib/synthesis/formatter.rb
 - lib/synthesis/expectation_recorder.rb
 - lib/synthesis/logging.rb
 - lib/synthesis/method_invocation_watcher.rb