puppet7 0.2.0.beta1

data/LICENSE

@@ -0,0 +1 @@
+== puppet7

data/README

@@ -0,0 +1,80 @@
+== puppet7
+
+=== Introduction
+Puppet7 is page object library for selenium web testing.
+it's integrated RSpec2. You can write ui test code first, and then
+define page objects later.
+
+When undefined page object makes error, Puppet7 treats it pending result of rspec (yellow).
+
+
+=== Quick start
+
+You can start to write web page action and validation codes first.
+
+ require "puppet7"
+ describe_domain :MySite do
+    describe :mainPage do
+        it "should have search input and button" do
+            # all it blocks are executed in domain context
+            mainPage.open do # page context block
+                searchInput.should be_visible
+                searchButton.should be_visible
+            end
+        end
+        it "should do that you can search something." do
+            mainPage.open do
+                searchInput.type "keyword"
+                searchButton.click
+            end
+            searchResultPage do
+                should be_current
+                searchInput.text.should == "keyword"
+            end
+        end
+    end
+ end
+
+'describe_domain' is kind of a magic keyword. It'll initialize selenium session and page objects
+and it make you be able to write rspec test in page object context.
+
+Then you run this test by rspec, you can get report like below.
+
+ PENDING: 'MySite' is undefined domain!
+
+Now you define page objects.
+
+ def_domain :MySite do
+    baseurl "http://my_so_cool_site.com"
+    page :mainPage
+    page :searchResultPage
+ end
+
+ def_page :mainPage do
+    url "/"
+ end
+
+ def_page :searchResultPage do
+    url "/search"
+ end
+
+Run again rspec test. Maybe you can get report like below.
+
+ PENDING: 'searchInput' is undefined page action or ui element!
+
+Ok. It's not bad. Let's define ui element in page definition.
+
+ def_page :mainPage do
+    url "/"
+    element :searchInput, ""
+    element :searchButton, ""
+ end
+
+Run again! You can get a report.
+
+  ERROR in UI['mainPage.searchInput'] ...
+
+Like above, you can write ui testing code step by step.
+And more importantly you can write ui testing scenarios without web page.
+RSpec'll generate cool document as test result, this document is a good checklist as acceptance criteria.
+

data/lib/puppet7/common.rb

@@ -0,0 +1,59 @@
+# coding:utf-8
+
+require "puppet7/puppet"
+require "puppet7/exceptions"
+module Puppet7
+  module KernelExtension
+    # pending method for rspec. (used internally)
+    def do_pending msg, ex_klass=PuppetException
+      if Puppet.puppet_testing
+        throw :pending_declared_in_example, msg
+      else
+        raise ex_klass.new msg
+      end
+    end
+    
+    # load page definitions. (relative path based current file path)
+    #
+    # example
+    #  load_pages "pages" # load all page definitions in "./pages"
+    #
+    #  def_domain :naver do
+    #    ...
+    #  end
+    def load_pages rel_path="pages"
+      def __loading_rubyfiles dir
+        Dir.new(dir).each do |filename|
+          next if filename == '.' or filename == '..'
+          file = File.join(dir, filename)
+          if File.directory?(file)
+            __loading_rubyfiles file
+          elsif file.end_with?(".rb")
+            require file
+          end
+        end
+      end
+      caller_file = caller[0].gsub /:\d+:in.*$/, ""
+      __loading_rubyfiles File.join(File.dirname(caller_file), rel_path)
+    end
+
+
+    # return a class given name(e.g. 'MyModule::MyClass')
+    def class_by_name module_name, &block
+      klass = Kernel
+      module_name.split("::").each do |name|
+        if klass.const_defined?(name.to_sym)
+          klass = klass.const_get(name.to_sym)
+        else
+          klass = nil
+          break
+        end
+      end
+      if klass and block_given?
+        klass.class_eval &block
+      end
+      klass
+    end
+	end
+end
+include Puppet7::KernelExtension

data/lib/puppet7/configuration.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+module Puppet7
+  class Configuration
+    attr_accessor :js_ext_files, :use_report, :report_file
+
+    @@selenium_default_configs = {
+      :host => 'localhost',
+      :port => 4444,
+      :browser => '*firefox',
+      :timeout_in_seconds => 15,
+      :highlight_located_element => true
+    }.freeze
+    
+    def initialize
+      @js_ext_files = []
+      @use_report = false
+      @report_file = "report.html"
+      @selenium_configs = @@selenium_default_configs.clone
+    end
+
+    def selenium_configs
+      @selenium_configs
+    end
+
+    def selenium_configs= configs
+      @selenium_configs.merge!(configs)
+    end
+  end
+  
+  def self.configuration
+    @configuration ||= Puppet7::Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+end

data/lib/puppet7/domain.rb

@@ -0,0 +1,136 @@
+# coding: utf-8
+
+require "puppet7/puppet"
+require "puppet7/page"
+require "puppet7/page_part"
+require "puppet7/utils"
+require "puppet7/exceptions"
+require "puppet7/puppet_report"
+
+module Puppet7
+  class Domain < Puppet
+    attr_accessor :baseurl, :encoding, :pages, :selenium
+    include Puppet7::Utils
+    
+    class << self
+      include Puppet7::Utils
+      def baseurl baseurl
+        self.class_eval do
+          @__baseurl = parse_url(baseurl).baseurl
+        end
+      end
+
+      def encoding encoding
+        self.class_eval do
+          @__encoding = encoding
+        end
+      end
+
+      def page page_name
+        self.class_eval do
+          @__pages ||= []
+          @__pages << page_name.to_sym
+        end
+      end
+
+      def new *args
+        # init instance
+        instance = super
+        instance.instance_eval do
+          @pages = {}
+        end
+        # init instance vars.
+        self.class_eval do
+          @__baseurl ||= nil
+          @__encoding ||= "UTF-8"
+          @__pages ||= []
+          instance.baseurl = @__baseurl
+          instance.encoding = @__encoding
+          @__pages.each do |page_name|
+            begin 
+              instance.pages[page_name.to_sym] = Page.get_instance(page_name, instance)
+              make_page_accessor page_name
+            rescue NotDefinedException
+              make_pending_page_accessor page_name
+            end
+          end
+        end
+        # check vars
+        if instance.baseurl == nil
+          Puppet7.report.add_undefined_object :domain, "#{name}.baseurl"
+          do_pending "Domain[#{instance.puppet_name}] need to define 'baseurl'!"
+        end
+        instance
+      end
+
+      private
+      def make_page_accessor page_name
+        self.class_eval <<-END
+          def #{page_name} &block
+            page = pages[:'#{page_name}']
+            if block_given?
+              @block_binding = block.binding
+              page.instance_eval &block
+              @block_binding = nil
+            end
+            page
+          end
+        END
+      end
+
+      def make_pending_page_accessor page_name
+        self.class_eval <<-END
+          def #{page_name} &block
+            Puppet7.report.add_undefined_object :page, "#{page_name}"
+            do_pending "'#{page_name}' page is Not defined!"
+          end
+        END
+      end
+    end
+
+    def baseurl= url
+      if url
+        @baseurl = parse_url(url).baseurl
+      else
+        @baseurl = nil
+      end
+    end
+
+    def current_url_info
+      parse_url(selenium.location)
+    end
+
+    def page_title
+      selenium.title.force_encoding(encoding)
+    end
+
+    def selenium 
+      if @selenium == nil
+        do_pending "Selenium is Not running!"
+      else
+        @selenium
+      end
+    end
+
+    def selenium_init?
+      @selenium != nil and @selenium.session_started?
+    end
+
+    def method_missing sym, *args, &b
+      Puppet7.report.add_undefined_object :page, sym
+      do_pending "'#{sym}' is Not defined Domain Action or it is Not defined Page!"
+    end
+
+    def image_ok? img_url
+      selenium.run_script <<-EOF
+            var __img = new Image();
+            var __img_check_result = "'CANNOT CHECKING'";
+            __img.onerror= function(){__img_check_result = false;};
+            __img.onload= function(){__img_check_result = true;};
+            __img.src = '#{img_url}';
+      EOF
+      sleep 1 # wait for check img
+      eval(selenium.get_eval('window.__img_check_result;'))
+    end
+  end
+end

data/lib/puppet7/element.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+require "puppet7/selenium_locator_actions"
+
+module Puppet7
+  class Element
+    include Puppet7::SeleniumLocatorActions
+    
+    attr_reader :parent, :name, :nclick, :xpath
+    def initialize parent, name, xpath=:pending, nclick=:pending
+      @parent = parent
+      @name = name.to_sym
+      @xpath = xpath
+    end
+
+    def image_ok?
+      img_url = attr("src")
+      @parent.image_ok? img_url
+    end
+
+    def each
+      if count == 1
+        yield self
+      elsif count > 1
+        count.times do |idx|
+          yield Element.new(@parent, "#{@name}_#{idx}", _xpath_list_access(idx), @nclick)
+        end
+      end
+    end
+
+    def [] idx
+      Element.new(@parent, "#{@name}_#{idx}", _xpath_list_access(idx), @nclick)
+    end
+
+    def child rel_xpath
+      Element.new(@parent, "#{name}_#{rel_xpath}", "#{@xpath}#{rel_xpath}", @nclick)
+    end
+
+    def fullname
+      "#{@parent.fullname}.#{@name}"
+    end
+
+    
+    private
+    def selenium
+      if @xpath == :pending
+        try_pending "#{fullname} has no xpath!"
+      end
+      begin
+        return yield(@parent.selenium)
+      rescue => err
+        raise "Error in UI[#{fullname}] : #{err}"
+      end if block_given?
+      @parent.selenium
+    end
+
+    def _xpath_list_access idx
+      xpath_list = @xpath.sub(/^xpath=/, "")
+      "xpath=(#{xpath_list})[#{idx +1}]"
+    end
+  end
+end

data/lib/puppet7/exceptions.rb

@@ -0,0 +1,17 @@
+# coding:utf-8
+
+module Puppet7
+  # Exception for all puppet7 error
+  class PuppetException < Exception;end
+  
+  # Exception for using not defined Puppets
+  class NotDefinedException < PuppetException ;end
+
+  # Exception for duplicated Elements.
+  class DuplicatedUIElementException < PuppetException ;end
+  class DuplicatedPagePartException < PuppetException ;end
+
+  # Exception for error while initializing selenium.
+  class SeleniumException < PuppetException ;end
+  class SeleniumInitError < SeleniumException ;end
+end

data/lib/puppet7/extend.rb

@@ -0,0 +1,173 @@
+# coding:utf-8
+
+require "puppet7/common"
+require "puppet7/page_part"
+require "puppet7/page"
+require "puppet7/domain"
+require "puppet7/exceptions"
+
+module Puppet7
+  module KernelExtension
+		# Define a PagePart.
+		#
+		# Create a subclass of PagePart given name, and then evaluation given block in the class context.
+		#
+		# - example.
+		#  def_part :header do
+		#  	element :logo, by_xpath('//*[id="logo"]')
+    #  	part :gnb
+		#  end
+		#
+		def def_part part_name, &block
+			PagePart.subclass(part_name).class_eval &block
+		end
+
+    # Define a Page
+    def def_page page_name, &block
+			Page.subclass(page_name.to_sym).class_eval &block if block
+    end
+
+    # Define a Domain
+    def def_domain domain_name, &block
+			Domain.subclass(domain_name.to_sym).class_eval &block if block
+    end
+
+    # initialze domain.
+    #
+    # - create domain object and pages...
+    # - initialize selenium session.
+    # - execute code block and finish domain if given block.
+    #
+    def begin_domain domain_name, &block
+      Puppet.begin_testing
+			if Domain.subclass?(domain_name)
+				# create domain
+				@domain = Domain.get_instance(domain_name)
+				# init selenium
+				begin
+					@domain.selenium = SeleniumSupport.init_selenium :url => @domain.baseurl
+				rescue SeleniumInitError => err # ignore exception
+					STDERR.puts "#{err}"
+				end
+				begin
+					yield @domain
+				rescue => err
+					STDERR.puts "#{err}"
+				end if block_given?
+				@domain
+			else
+				Puppet7.report.add_undefined_object :domain, domain_name
+				do_pending "Not Defined Domain : #{domain_name}"
+			end
+    end
+
+    # end selenium session of domain initialized.
+    def end_domain
+      Puppet.end_testing
+      return unless @domain and @domain.selenium_init?
+      sleep 1; # delay for image error checking
+
+      # get error images
+      image_errors = @domain.selenium.get_stored_var :imageErrors;
+      image_errors.each do |page, images|
+        Puppet7.report.add_image_errors(page, images)
+      end
+
+      # get js errors
+      js_errors = @domain.selenium.get_stored_var :jsErrors;
+      js_errors.each do |page, errs|
+        Puppet7.report.add_js_errors(page, errs)
+      end
+      @domain.selenium.stop
+    end
+
+
+
+    # get database accessor
+    def get_dbaccessor dbi_url, user, passwd, dir
+      sqlexec = Puppet7::SQLExec.new dbi_url, user, passwd
+      caller_file = caller[0].gsub /:\d+:in.*$/, ""
+      sqldir = File.join(File.dirname(caller_file), dir)
+      Puppet7::SQLAgent.new(sqlexec, sqldir)
+    end
+
+    # it is shortcut for begin_domain .. end_domain.
+    #
+    # It supply domain object and domain context when you write tests with rspec.
+    #
+    # example
+    #  describe_domain :naver do
+    #    describe "main_page" do
+    #      it "should have search input and search button." do
+    #        # you could write test in domain context.
+    #        main_page.open do
+    #          # you could write code in page context in code block of page
+    #          search_input.should be_visible?
+    #          search_button.should be_visible?
+    #        end
+    #      end
+    #      it "should move login page, when click login button." do
+    #        main_page.open.login_button.click
+    #        login_page do
+    #         # page block checks url automatically
+    #         # if current location is not login page, error occurrs.
+    #         user_input.should be_visible
+    #         passwd_input.should be_visible
+    #        end
+    #      end
+    #   end
+    # end
+    def describe_domain domain_name, *args, &block
+      describe "#{domain_name}", *args do
+        before(:each) do
+          begin_domain domain_name.to_sym
+        end
+        after(:each) do
+          end_domain
+        end
+        self.instance_exec &block
+      end
+    end
+	end
+end
+include Puppet7::KernelExtension
+
+# hook method_missing of RSpec Example group.
+#
+# it is able to write test in domain context.
+class_by_name "RSpec::Core::ExampleGroup" do
+  def method_missing sym, *args, &block
+    begin # first try super
+      super
+    rescue # hook later...
+      @domain.send sym, *args, &block
+    end
+  end
+end
+
+# hook example
+class_by_name "RSpec::Core::Example" do
+  alias_method :__run_before_each, :run_before_each
+  def run_before_each
+    __run_before_each
+    begin
+      desc = self.description
+      @example_group_instance.instance_eval do
+        @domain.selenium.set_stored_var :testing_message, desc
+      end
+    rescue
+    end if @example_group_instance.instance_eval("@domain && @domain.selenium_init?")
+  end
+end 
+
+class Array
+  def each_with *other_arrays
+    other_arrays.each do |arr|
+      raise "Error: not same array length." if arr.length != length
+    end
+
+    each_index do |i|
+      yield self[i], *(other_arrays.collect {|arr| arr[i]})
+    end
+  end
+end