taft 0.1.0 → 0.2.0

data/lib/taft_files/framework/zznamezz/watir/pages/page_objects.rb

@@ -0,0 +1,166 @@
+# Base class that every defined page will inherit from
+class Page
+
+  attr_accessor :name, :displayed_field, :displayed_value
+  attr_accessor :browser
+  attr_accessor :field_parameters_array # stores parameters of each field added to the page
+
+  # Name : the name of this page, e.g. rsHomepage
+  # Field : the field used to determine if the page is displayed. More precisely,
+  # the name of the method that accesses the field. E.g. if the page has a field called 'page_title' 
+  # defined, then its accessor method 'page_title_field' will have been generated .
+  # If the displayed? check is against an expected value, specify the field name corresponding to 
+  # the read-method (e.g. page_title), and specify the value (String or Regexp).
+  # If the displayed? check is for a field to exist, specify the field's accessor method name 
+  # (e.g. page_title_field), and keep value nil.
+  def initialize(name, field, value = nil)
+    @name = name
+    @displayed_field = field
+    @displayed_value = value
+    @field_parameters_array = []
+  end
+
+  def displayed?(wait = true)
+    displayed = false
+    puts "in displayed? for page #{@name}"
+    if wait
+      puts "will wait for page to be loaded"
+      wait_until_displayed
+    end
+    
+    puts "about to send to #{@displayed_field.to_sym.inspect}"
+    begin
+      field_or_value = self.send(@displayed_field.to_sym)
+    rescue Watir::Exception::UnknownObjectException
+      # cannot find the field on the page
+      # do nothing, displayed will stay false
+    rescue Selenium::WebDriver::Error::StaleElementReferenceError
+      # TODO : fix! wait then call displayed? again?
+      puts "hit StaleElementReferenceError for page #{@name}"
+    end
+
+    puts "field_or_value retrieved is of class #{field_or_value.class}"
+    p field_or_value
+    if @displayed_value == nil
+      displayed = true if field_or_value.exists?
+    else
+      if @displayed_value.class == Regexp
+        displayed = true if field_or_value =~ @displayed_value
+      else
+        displayed = true if field_or_value == @displayed_value
+      end
+    end
+    displayed
+  end
+
+  # Method to wait for the page to be displayed, up to <timeout> seconds
+  # Returns displayed status (true/false)
+  def wait_until_displayed(timeout = 5)
+    max = timeout * 10
+    count = 0
+    displayed = false
+    while count < max
+      displayed = displayed?(false)
+      break if displayed
+      sleep 0.2
+      count += 2
+    end
+    displayed
+  end
+
+  # Defines methods to access the field of specified type, by specified key & value
+  def add_field(name, type, key, value)
+    field_parameters_array << [name, type, key, value]
+    add_field_using_constructor_class(name, type, key, value)
+  end
+  
+  # Add to self all fields that were defined on page_object
+  # E.g. the supplied page_object represents part of a panel/page that is common to several pages
+  def add_page(page_object)
+    page_object.field_parameters_array.each do |field_parameters|
+      add_field(field_parameters[0], field_parameters[1], field_parameters[2], field_parameters[3])
+    end
+  end
+
+  # Defines methods to access the field of specified type, by specified key & value
+  def add_field_using_constructor_class(name, type, key, value)
+    PageFieldConstructor.add_fields(self, name, type, key, value)
+  end
+
+end # end Page
+
+class PageFieldConstructor
+
+  # Defines methods to access the field of specified type, by specified key & value
+  def PageFieldConstructor.add_fields(page_object, name, type, key, value)
+
+    # Fields cannot have the following names : name
+    raise "Field on page #{page_object.name} with name of #{name} is not allowed" if ZZnamezzConfig::DISALLOWED_FIELD_NAMES.include?(name)
+    
+    case type
+    when :button
+      real_type = :input
+    else
+      real_type = type
+    end
+    
+    # add accessor to field
+    s = <<-METHOD
+    def page_object.#{name}_field
+#      puts "in #{name} method"
+      @browser.#{real_type}(#{key.inspect} => "#{value}")
+    end    
+    METHOD
+    #    page_object.class.module_eval(s) # do not do this - want to add methods (field) to the object, not the class!
+    eval(s)
+
+    case type
+      when :text_field
+        add_read_method(page_object, name)
+        add_write_method(page_object, name)
+      when :button
+        add_click_method(page_object, name)
+      when :link
+        add_read_method(page_object, name)
+        add_click_method(page_object, name)
+      else
+        add_read_method(page_object, name)
+    end
+
+  end
+
+  def PageFieldConstructor.add_read_method(page_object, name)
+    s = <<-READ
+        def page_object.#{name}
+#          puts "in #{name} read method"
+          #{name}_field.text # value
+        end    
+    READ
+    #    page_object.class.module_eval(s) # do not do this - want to add methods (field) to the object, not the class!
+    eval(s)
+  end
+
+  def PageFieldConstructor.add_write_method(page_object, name)
+    s = <<-WRITE
+        def page_object.#{name}=(v)
+#          puts "in #{name} write method"
+          #{name}_field.set(v) 
+        end    
+    WRITE
+    #    page_object.class.module_eval(s) # do not do this - want to add methods (field) to the object, not the class!
+    eval(s)
+  end
+
+  def PageFieldConstructor.add_click_method(page_object, name)
+    s = <<-CLICK
+        def page_object.click_#{name}
+#          puts "in #{name} click method"
+          #{name}_field.click
+        end    
+    CLICK
+    #    page_object.class.module_eval(s) # do not do this - want to add methods (field) to the object, not the class!
+    eval(s)
+  end
+
+end
+

data/lib/taft_files/framework/zznamezz/watir/pages/xxabbrevxx_pages.rb

@@ -0,0 +1,101 @@
+# Class that holds definitions for all of the pages in ZZnamezz
+# These can be used to determine if the browser is currently displaying that page
+#
+# Field types :
+# Use :text_field instead of :input if it's a text-field
+# Use :button instead of :input if it's a button
+# Otherwise, use the actual HTML element type
+
+require_relative 'page_objects'
+
+class XXabbrevupperxxPages
+  
+  @@browser = nil
+  @@pages = [] # an array of Page objects
+  @@page_names = []
+
+  def self.make_pages(browser)
+    @@browser = browser
+
+    # Nav bar
+    # Not a real page, but is a panel common to many pages
+    # Don't add_page(nav_bar); do page.add_page(nav_bar)
+    nav_bar = Page.new("xxabbrevxxNavBar", "page_title", "Welcome to ZZnamezz")
+    
+    nav_bar.add_field("goto_homepage", :link, :id, "xxabbrevxx_home_header_link")
+    nav_bar.add_field("page_title", :h1, :id, "page_title")
+
+    # Homepage
+    page = Page.new("xxabbrevxxHomepage", "page_title", "Welcome to ZZnamezz")
+    
+    page.add_field("all_users", :link, :id, "users_header_link")
+    page.add_page(nav_bar)
+
+    self.add_page(page)
+
+
+    # Users
+    page = Page.new("xxabbrevxxUsers", "page_title", "Listing users")
+    
+    page.add_field("users", :table, :id, "view_users_table")
+    page.add_field("new_user", :link, :id, "new_user_link")
+    page.add_page(nav_bar)
+
+    self.add_page(page)
+
+    # Create User
+    page = Page.new("xxabbrevxxCreateUser", "page_title", "New user")
+    
+    page.add_field("user_name", :text_field, :id, "user_name")
+    page.add_field("role", :list, :id, "user_role")
+    page.add_field("save", :button, :id, "save")
+    page.add_field("back", :link, :id, "back_link")
+    page.add_page(nav_bar)
+
+    self.add_page(page)
+
+    # View User
+    page = Page.new("xxabbrevxxViewUser", "page_title", /^User/)
+
+    page.add_field("project", :div, :id, "name")
+    page.add_field("version", :div, :id, "roles")
+    page.add_field("edit", :link, :id, "edit_link")
+    page.add_field("back", :link, :id, "back_link")
+    page.add_page(nav_bar)
+
+    self.add_page(page)
+ 
+  end
+
+##################################################################################################
+
+
+  def self.add_page(page)
+    page.browser = @@browser # set the browser object for each page
+    # TODO have only one browser object (here in XXabbrevupperxxPages), and have each page know how to find it, instead of taking
+    # their own copy of the object
+    @@pages << page
+    @@page_names << page.name
+  end
+
+  # Outputs info on the pages currently stored
+  def self.info
+    s = ""
+    s += "#{@@pages.size} pages defined. Names :"
+    @@page_names.each {|f| s += "\n#{f}" }
+    s
+  end
+
+  # Will convert name to a string
+  def self.page_known?(name)
+    @@page_names.include?(name.to_s)
+  end
+
+  # Retrieves the specific page; raises if it cannot be found
+  # Will convert name to a string
+  def self.find(name)
+    raise "Could not locate page '#{name}'" unless self.page_known?(name)
+    @@pages[@@page_names.index(name.to_s)]
+  end
+end
+

data/lib/taft_files/framework/zznamezz.rb

@@ -6,3 +6,7 @@ require "zznamezz/api_helpers/general"
 require "zznamezz/api_helpers/rest"
 
 require "zznamezz/ui_helpers/ui_general"
+
+require "zznamezz/watir/pages/xxabbrevxx_pages"
+require "zznamezz/watir/flows/xxabbrevxx_flows"
+require "zznamezz/watir/custom/all"

data/lib/taft_files/lib/config/runtime_constants.rb

@@ -1,6 +1,6 @@
 
 # This class holds parameters that may frequently change between test runs, e.g the test environment
-class RuntimeConstants
+module RuntimeConstants
 
     $TEST_ENV = :test_1
 
@@ -10,6 +10,10 @@ class RuntimeConstants
     MAKE_ERROR_SCREENSHOTS = true
     ERROR_SCREENSHOT_LOCATION = "screenshots"
 
+    WRITE_CI_REPORTS = false
+
+    BROWSER = :chrome
+
     RESULTS_CSV = "results.csv"
 
 end

data/lib/taft_files/lib/config/zznamezz_config.rb

@@ -6,12 +6,13 @@ class ZZnamezzConfig
     include RuntimeConstants
     
     CERTIFICATE_DIR = "certs"
+    CERTIFICATE_POPUP_TIMEOUT = 15
 
     API_VERSION = "latest"
 
     SERVERS = {
-        :test_1 => {:zznamezz_url = "https://"},
-        :ref_1 => {:zznamezz_url = "https://"},
+        :test_1 => {:zznamezz_url => "https://"},
+        :ref_1 => {:zznamezz_url => "https://"},
     }
 
     SERVER = SERVERS[$TEST_ENV]
@@ -19,4 +20,8 @@ class ZZnamezzConfig
 
     PASSED = "Passed"
     FAILED = "Failed"
+
+    DISALLOWED_FIELD_NAMES = ["name"]
+
+    ALL_USER_ROLES = ["all"]
 end

data/lib/taft_files/lib/zznamezz_test_case.rb

@@ -5,7 +5,7 @@
 # should implement their own methods and call super within them to trigger these common
 # setup/teardown methods at the right time.
 
-$LOAD_PATH.unshift File.dirname(__FILE__) + "/..")
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/.."))
 
 gem 'test-unit'
 require 'test/unit'
@@ -13,9 +13,10 @@ require 'tmpdir'
 require 'time'
 require 'fileutils'
 require 'timeout'
+require 'watir'
 
 # Config
-require 'config/zznamezz_config'
+require 'config/zznamezz_config.rb'
 
 # Helpers
 require 'framework/zznamezz.rb'
@@ -33,8 +34,6 @@ end
 
 module ZZnamezzTestCase
 
-    include ZZnamezz
-
     attr_accessor :browser_has_been_opened
 
     # optional field
@@ -44,86 +43,87 @@ module ZZnamezzTestCase
     # method (if they have any relevent failure notes).
     attr_accessor :failure_notes
 
-    # By default, unknown methods (e.g. xxabbrevupperxxPage names) are sent to the different contexts 
-    # for resolution. This allows pages to be accessed as xxabbrevxxHomePage rather than
-    # @xxabbrevxx_context.xxabbrevxxHomePage
-    def method_missing(meth, *args)
-        case meth.to_s
-        when /^xxabbrevxx/
-            @xxabbrevxx_context.send(meth, *args)
-#        when /^some_other_app/
-#            @some_other_app_context.send(meth, *args)
+    # E.g. calling homepage.displayed? from a test script :
+    # Test cannot see homepage so its call is routed through method_missing
+    # If method_missing returns an instance of the class, .displayed? can be called on it (seamlessly)
+    # At present this will happen for every call to a page from a test script
+    def method_missing(name, *args, &block)
+        #puts "ZZnamezzTestCase method_missing called; name = #{name.inspect}; #{name.class}"
+ 
+        case name.to_s
+        when /^browser$/
+            browser
+        when /^xxabbrevxx/i
+            RSPages.find(name.to_s) # return the page so that the test can use it
         else
             super
         end
     end
 
-
     if $WRITE_RESULTS # supplied from invokation
         WRITE_RESULTS = true
     else
         WRITE_RESULTS = false
     end
 
-    # Close the current browser and log in again
-    def re_login
-        browser.close
-
-        new_browser_on_login_page
-        # Reinitialise the contexd and @help
-        reinitialisexxabbrevupperxxContext(browser)
-    end
-
     # Connect to yyrawnameyy and reinitialise the context, etc.
     def xxabbrevxx_login(url = ZZnamezzConfig::SERVER[:zznamezz_url])
-        puts url
-        new_browser_on_login_page(url)
-        reinitialisexxabbrevupperxxContext(browser)
-    end
-
-    # Reinitialise xxabbrevupperxx context only
-    def reinitialisexxabbrevupperxxContext(new_browser)
-        @xxabbrevxx_context = ZZnamezz::Context.new(new_browser)
-        @help = xxabbrevupperxxHelper.new(@xxabbrevxx_context)
+        browser = @help.new_browser_at_url(url)
+        load_pages(browser)
     end
 
-    # Return to the previous xxabbrevupperxx session
-    def return_to_xxabbrevxx
-        self.browser = @xxabbrevxx_context.browser
+    def load_pages(browser)
+        xxabbrevupperxxPages.make_pages(browser) # cannot have pages without a browser object
+        $browsers << browser
+        @browser_has_been_opened = true
     end
 
     # Close the current browser
     def close_browser
-        self.browser.close
+        browser.close
     end
 
     def close(browser)
         if browser.exists? && ((ZZnamezzConfig::CLOSE_BROWSER_AFTER_TEST && passed?) || ZZnamezzConfig::FORCE_CLOSE_BROWSER_AFTER_TEST)
             browser.close
             $browsers.delete_at($current_browser_position - 1) # array indexing
-            self.browser = $browsers[-1] # set browser to the last one that is still in the array
+            browser = $browsers[-1] # set browser to the last one that is still in the array
         end
     end
 
     def close_all_browsers
         if (ZZnamezzConfig::CLOSE_BROWSER_AFTER_TEST && passed?) || ZZnamezzConfig::FORCE_CLOSE_BROWSER_AFTER_TEST
             until $browsers.empty?
-                self.browser = $browsers.shift
+                browser = $browsers.shift
                 browser.close
             end
         end
     end
 
+
+    @@browser = nil
+
+    def browser
+        @@browser
+    end
+
+    def browser=(b)
+        @@browser = b
+    end
+    alias set_browser browser= # note : calls of "browser = " do not work, calls of "browser=" do
+
     # Ensure that every test (that wants one) has a browser that is already logged in to the system
     def setup
 
+        @help = xxabbrevupperxxHelper.new
+
         Watir.always_locate = true # default is true; setting to false speeds up Watir to a degree
 
         # Get start time for later output in results
         @test_start_time = Time.now
 
         # Get the directory that the specific test lives in, so that it can be included in the results file
-        @test_file_dir = @test_file.split(File::SEPARATOR)[-2]
+        @test_file_dir = @test_file.split(File::SEPARATOR)[-2] if @test_file
 
         # Select default certificate if none is configured
         @certificate ||= :regular
@@ -138,7 +138,6 @@ module ZZnamezzTestCase
             xxabbrevxx_login
         elsif (@initialBrowser == :none || @initialBrowser == nil)
             browser = nil
-            reinitialisexxabbrevupperxxContext(browser)
         end
 
     end # end setup
@@ -179,8 +178,7 @@ module ZZnamezzTestCase
                     puts "Notes : #{notes}"
                 end # end unless passed?
 
-                close_all_browsers
-
+                
                 # Write to the results file
                 begin
                     File.open(ZZnamezzConfig::RESULTS_CSV, "a") do |f|
@@ -192,6 +190,9 @@ module ZZnamezzTestCase
                     puts "Had to rescue from writing results to file #{ZZnamezzConfig::RESULTS_CSV}"
                 end
             end # end if WRITE_RESULTS
+            
+            close_all_browsers
+
         rescue Timeout::Error => t_error
             puts "Timeout::Error :"
             puts t_error

data/lib/taft_files/tests/v1/tc_r001_01_an_example_test.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift("#{File.expand_path(File.dirname(__FILE__))}/../../lib")
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../../lib")
 
 require "zznamezz_test_case"
 

data/taft.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name        = 'taft'
-  s.version     = '0.1.0'
+  s.version     = '0.2.0'
   s.licenses    = ['MIT']
-  s.summary     = "Test Automation Framework Template"
-  s.description = "This gem will deploy/install a skeleton code framework for the automated testing of applications with APIs and/or web-UIs"
+  s.summary     = "Test Automation Framework Template (TAFT)"
+  s.description = "TAFT will deploy/install a skeleton code framework for the automated testing of applications with APIs and/or web-UIs"
   s.authors     = ["Richard Morrisby"]
   s.email       = 'rmorrisby@gmail.com'
   s.files       = ["lib/taft.rb"]
   s.homepage    = 'https://rubygems.org/gems/taft'
-  s.required_ruby_version = '>=1.9'
+  s.required_ruby_version = '>=2.6'
   s.files = Dir['**/**']
   s.test_files = Dir["test/test*.rb"]
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: taft
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Morrisby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 2019-10-05 00:00:00.000000000 Z
 dependencies: []
-description: This gem will deploy/install a skeleton code framework for the automated
+description: TAFT will deploy/install a skeleton code framework for the automated
   testing of applications with APIs and/or web-UIs
 email: rmorrisby@gmail.com
 executables: []
@@ -20,11 +20,34 @@ files:
 - LICENCE.txt
 - README.md
 - build.rb
+- examples/ruby/rs/framework/red_sky.rb
+- examples/ruby/rs/framework/red_sky/api_helpers/general.rb
+- examples/ruby/rs/framework/red_sky/api_helpers/rest.rb
+- examples/ruby/rs/framework/red_sky/ui_helpers/ui_general.rb
+- examples/ruby/rs/framework/red_sky/watir/custom/all.rb
+- examples/ruby/rs/framework/red_sky/watir/custom/rs_custom.rb
+- examples/ruby/rs/framework/red_sky/watir/flows/flow_objects.rb
+- examples/ruby/rs/framework/red_sky/watir/flows/rs_flow_names.rb
+- examples/ruby/rs/framework/red_sky/watir/flows/rs_flows.rb
+- examples/ruby/rs/framework/red_sky/watir/pages/page_objects.rb
+- examples/ruby/rs/framework/red_sky/watir/pages/rs_pages.rb
+- examples/ruby/rs/lib/config/red_sky_config.rb
+- examples/ruby/rs/lib/config/runtime_constants.rb
+- examples/ruby/rs/lib/red_sky_test_case.rb
+- examples/ruby/rs/tests/v1/tc_r001_01_an_example_test.rb
+- examples/ruby/rs/tests/v1/tc_r001_01_google_search.rb
 - lib/taft.rb
 - lib/taft_files/framework/zznamezz.rb
 - lib/taft_files/framework/zznamezz/api_helpers/general.rb
 - lib/taft_files/framework/zznamezz/api_helpers/rest.rb
 - lib/taft_files/framework/zznamezz/ui_helpers/ui_general.rb
+- lib/taft_files/framework/zznamezz/watir/custom/all.rb
+- lib/taft_files/framework/zznamezz/watir/custom/xxabbrevxx_custom.rb
+- lib/taft_files/framework/zznamezz/watir/flows/flow_objects.rb
+- lib/taft_files/framework/zznamezz/watir/flows/xxabbrevxx_flow_names.rb
+- lib/taft_files/framework/zznamezz/watir/flows/xxabbrevxx_flows.rb
+- lib/taft_files/framework/zznamezz/watir/pages/page_objects.rb
+- lib/taft_files/framework/zznamezz/watir/pages/xxabbrevxx_pages.rb
 - lib/taft_files/lib/config/runtime_constants.rb
 - lib/taft_files/lib/config/zznamezz_config.rb
 - lib/taft_files/lib/zznamezz_test_case.rb
@@ -43,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -53,6 +76,6 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Test Automation Framework Template
+summary: Test Automation Framework Template (TAFT)
 test_files:
 - test/test_example.rb