most 0.7.3

data/lib/most/structures/test_case.rb

@@ -0,0 +1,173 @@
+#    Most - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of Most.
+#
+#    Most is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    Most is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Most. If not, see <http://www.gnu.org/licenses/>.
+
+require 'yaml'
+require 'stringio'
+
+require 'most/structures/types/path'
+require 'most/structures/types/options'
+require 'most/structures/types/report'
+
+require 'most/structures/test_runner'
+
+module Most
+
+  module TestCaseHelpers
+    def create_test_case(*args, &block)
+      TestCase.new(*args, &block)
+    end
+  end
+
+  class TestCase
+    include MetaProgrammable
+
+    include PathHelpers
+    include OptionsHelpers
+    include RunnerHelpers
+
+    def initialize(name   = 'Anonymous Test Case',
+                   input  = '',
+                   output = '',
+                   output_destination  = nil,
+                   output_preprocessor = lambda { |data| data.to_s().strip() },
+                   runner = TestRunner.new(),
+                   &block)
+
+      @name   = name
+      @input  = input
+
+      @output = output
+      @output_destination  = output_destination
+      @output_preprocessor = output_preprocessor
+
+      @runner = runner
+
+      instance_eval(&block) if block_given?
+    end
+
+    def run(options, entities)
+      result = Report.new("Test Case: #{@name}")
+
+      if options[:tests/:report/:specs]
+        result.specs = {:name => @name,
+                        :correct_output => @output,
+                        :output_destination  => @output_destination,
+                        :output_preprocessor => @output_preprocessor,
+                        :runner => @runner}
+      end
+
+      result << process(options, entities)
+      result
+    end
+
+    private
+    def process(options, entities)
+      result = @runner.run(options, entities, @input)
+
+      if result.last[:success]
+        process_result!(result.last, options)
+      end
+
+      result
+    end
+
+    def process_result!(result, options)
+      test_output = nil
+
+      if @output_destination.is_a?(Path)
+        test_output = File.read(@output_destination.expand_path()) rescue nil
+      else
+        test_output = result[:process_stdout]
+      end
+
+      unless @output_preprocessor.nil?
+        test_output = @output_preprocessor.call(test_output)
+      end
+
+      result[:processed_output] = test_output
+
+      is_correct = output_equal?(test_output, @output)
+      result[:correct] = is_correct
+
+      if not is_correct and options[:tests/:report/:differences]
+        diffs = differences(test_output, @output)
+        result[:differences] = diffs unless diffs.nil?
+      end
+      
+      nil
+    end
+
+    def differences(first_sequence, second_sequence)
+      result = nil
+
+      valid? first_sequence, second_sequence do
+        begin
+          result = SERVICES[:diff].diff(first_sequence, second_sequence)
+        rescue Exception => e
+          SERVICES[:environment].log_error(e, "Failed to process with the 'diff' service")
+        end
+      end
+
+      result
+    end
+
+    def output_equal?(output, correct_output)
+      result = nil
+
+      valid? output, correct_output do
+        first_stream  = get_stream(output)
+        second_stream = get_stream(correct_output)
+
+        result = !first_stream.nil? and !second_stream.nil?
+
+        while result and valid? first_stream, second_stream
+          first_char  = first_stream.getc()
+          second_char = second_stream.getc()
+
+          result = first_char == second_char
+
+          break if first_char.nil? or second_char.nil?
+        end
+
+        first_stream.try(:close)
+        second_stream.try(:close)
+      end
+
+      result
+    end
+
+    def get_stream(data)
+      result = nil
+
+      case data
+        when ::String
+          result = StringIO.new(data, 'r')
+        when Path
+          result = File.open(data.expand_path(), 'r')
+        else
+          result.try(:close)
+
+          exception = TypeError.new("Invalid type: #{data.class}")
+          SERVICES[:environment].log_error(exception, 'Invalid data or reference type')
+      end
+
+      result
+    end
+  end
+
+end

data/lib/most/structures/test_runner.rb

@@ -0,0 +1,103 @@
+#    Most - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of Most.
+#
+#    Most is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    Most is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Most. If not, see <http://www.gnu.org/licenses/>.
+
+require 'yaml'
+
+require 'most/structures/types/path'
+require 'most/structures/types/options'
+require 'most/structures/types/report'
+
+require 'most/structures/box'
+
+module Most
+
+  module RunnerHelpers
+    def create_test_runner(*args, &block)
+      TestRunner.new(*args, &block)
+    end
+  end
+
+  class TestRunner
+    include MetaProgrammable
+
+    include PathHelpers
+    include OptionsHelpers
+
+    def initialize(name = 'Anonymous Test Runner', steps = [], &block)
+      @name  = name
+      @steps = steps
+
+      instance_eval(&block) if block_given?
+    end
+
+    def run(options, entities, input)
+      result = Report.new("Test Runner: #{@name}")
+
+      if options[:tests/:report/:specs]
+        result.specs = {:name  => @name,
+                        :steps => @steps}
+      end
+
+      result << execute(options, entities, input)
+      result
+    end
+
+    def add_step(step, &block)
+      @steps ||= []
+      if step.is_a?(Class) and block_given?
+        @steps << step.new(&block)
+      else
+        @steps << step
+      end
+    end
+
+    private
+    def execute(options, entities, input)
+      result = {:success => true,
+                :steps => [],
+                :process_stdout => nil}
+
+      globals = {};
+      @steps.each do |step|
+        step_box = Box.new do
+          options  options
+          entities entities
+          globals  globals
+          input    input
+        end
+
+        step_result = step_box.run(step)
+        globals     = step_box.globals
+
+        result[:steps] << step_box
+        result[:process_stdout] = step_result.last[:process_stdout]
+
+        unless step_result.last[:success]
+          if options[:tests/:steps/:break/:unsuccessful]
+            result[:success] = false
+          end
+        end
+
+        break unless result[:success]
+      end
+
+      result
+    end
+  end
+
+end

data/lib/most/structures/types/options.rb

@@ -0,0 +1,67 @@
+#    Most - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of Most.
+#
+#    Most is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    Most is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Most. If not, see <http://www.gnu.org/licenses/>.
+
+require 'yaml'
+
+module Most
+
+  module OptionsHelpers
+    def create_options(*args, &block)
+      Options.new(*args, &block)
+    end
+  end
+
+  class Options < Hash
+    def initialize(hash = nil)
+      super(); replace(hash) unless hash.nil?
+    end
+
+    def [](key, *args)
+      if key.is_a?(Array)
+        args.unshift(*key[1..-1])
+        key = key.first
+      end
+
+      result = super(key)
+
+      args.each do |item|
+        break if result.nil?
+        result = result.try(:[], item)
+      end
+
+      result
+    end
+
+    def has_any?(*args)
+      result = nil
+
+      args.each do |item|
+        if item.is_a?(Array)
+          result = self[*item]
+        else
+          result = self[item]
+        end
+
+        break unless result.nil?
+      end
+
+      result
+    end
+  end
+
+end

data/lib/most/structures/types/path.rb

@@ -0,0 +1,39 @@
+#    Most - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of Most.
+#
+#    Most is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    Most is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Most. If not, see <http://www.gnu.org/licenses/>.
+
+require 'yaml'
+
+module Most
+
+  module PathHelpers
+    def path(path)
+      Path.new(path)
+    end
+  end
+
+  class Path < String
+    def initialize(path = '')
+      super(path)
+    end
+
+    def expand_path()
+      File.expand_path(self)
+    end
+  end
+
+end

data/lib/most/structures/types/report.rb

@@ -0,0 +1,84 @@
+#    Most - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of Most.
+#
+#    Most is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    Most is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Most. If not, see <http://www.gnu.org/licenses/>.
+
+require 'yaml'
+
+module Most
+
+  class Report
+    attr_accessor :name, :specs
+    
+    def initialize(name = 'Untitled Report', specs = {})
+      @name  = name
+      @specs = specs
+      
+      @units = []
+    end
+
+    def add_entry(entry)
+      @units << entry
+    end
+    alias << add_entry
+
+    def get_entry(index)
+      @units[index]
+    end
+    alias [] get_entry
+
+    def set_entry(index, value)
+      @units[index] = value
+    end
+    alias []= set_entry
+
+    def delete_entry(entry)
+      @units.delete(entry)
+    end
+    alias delete delete_entry
+
+    def delete_entry_at(index)
+      @units.delete_at(index)
+    end
+    alias delete_at delete_entry_at
+
+    def first_entry()
+      @units.first
+    end
+    alias first first_entry
+
+    def first_entry=(entry)
+      @units.first = entry
+    end
+    alias first= first_entry=
+
+    def last_entry()
+      @units.last
+    end
+    alias last last_entry
+
+    def last_entry=(entry)
+      @units.last = entry
+    end
+    alias last= last_entry=
+
+    def to_s()
+      to_yaml()
+    end
+    alias text to_s
+  end
+
+end