friendly-cukes 0.0.1

data/lib/friendly/cukes/framework/library/generic/read_from_yml.rb

@@ -0,0 +1,294 @@
+=begin
+*Name           : Read_From_YML
+*Description    : class definition for reading data value from yml file
+*Author         : Chandra sekaran
+*Creation Date  : 23/08/2014
+*Updation Date  :
+=end
+
+module CUKES
+  class Read_From_YML
+    include FileLibrary     # module that define methods for all file manipulations
+
+    # Description       : opens the yml file
+    # Author            : Chandra sekaran
+    # Arguments         :
+    #   str_file_path   : relative path of the yml file
+    #
+    def initialize(str_file_path = "")
+      raise "Exception : ReadFromYML instance cannot be created with filename" if str_file_path.nil?
+      raise "Exception : file does not exists #{str_file_path}" if !is_file_exists(str_file_path)
+      @yml = open_yml_file(str_file_path)
+      @yml_file_path = str_file_path
+    rescue Exception => ex
+      $log.error("Error in opening file '#{str_file_path}' : #{ex}")
+      exit
+    end
+
+    # Description      : returns the value for the given input ypath
+    # Author           : Chandra sekaran
+    # Arguments        :
+    #   str_ypath      : ypath of the key element
+    # Return value     :
+    #   req_val        : value of the key element
+    #
+    def get_value(str_ypath = "")
+      raise "Exception : ReadFromYML - ypath cannot be empty" if str_ypath.nil?
+      req_val = traverse_yml(str_ypath)
+      return req_val
+    rescue Exception => ex
+      $log.error("Error in getting value for ypath '#{str_ypath}' : #{ex}")
+      exit
+    end
+
+    # Description      : returns the hash value for the given unique key
+    # Author           : Chandra sekaran
+    # Arguments        :
+    #   str_key        : name of the unique key
+    # Return value     :
+    #   @req_hash      : hash value of the unique key element
+    #
+    def get_values(str_key)
+      raise "Exception : ReadFromYML - key cannot be empty" if str_key.nil?
+      @yml.each do |key, value|
+        @req_hash = ''
+        if key == str_key
+          @req_hash = value
+          break
+        else
+          if value.size >= 1 and value.class.to_s == "Hash"
+            @req_hash = traverse_hash(value, str_key)
+            return @req_hash if @req_hash.class.to_s == "Hash"
+          end
+        end
+      end
+    rescue Exception => ex
+      $log.error("Error in getting value for '#{str_key}' : #{ex}")
+      exit
+    end
+
+    # Description      : returns the hash from the given input hash that matches the given key
+    # Author           : Chandra sekaran
+    # Arguments        :
+    #   hash_val       : hash element
+    #   req_key        : key to be found inside the hash element
+    # Return value     :
+    #    @hash_value   : value of the key element
+    #
+    def traverse_hash(hash_val, req_key)
+      hash_val.each do |key, value|
+        traverse_hash(value, req_key) if !value.nil? and value.size >= 1 and value.class.to_s == "Hash"
+        if key == req_key
+          @hash_value = value
+          break
+        end
+      end
+      return @hash_value
+    rescue Exception => ex
+      $log.error("Error in traversing hash '#{hash_val}' for '#{req_key}' : #{ex}")
+      exit
+    end
+
+    # Description      : traverses the yml file and gets the value for the given input ypath
+    # Author           : Chandra sekaran
+    # Arguments        :
+    #   str_ypath      : ypath of the key element
+    # Return value     :
+    #    str_value     : value of the key element
+    #
+    def traverse_yml(str_ypath)
+      str_value = ''
+      arr_key = str_ypath.split('/')
+      num_level = arr_key.size
+
+      case num_level
+        when 1
+          str_value = @yml[arr_key[0]]
+        when 2
+          str_value = @yml[arr_key[0]][arr_key[1]]
+        when 3
+          str_value = @yml[arr_key[0]][arr_key[1]][arr_key[2]]
+        when 4
+          str_value = @yml[arr_key[0]][arr_key[1]][arr_key[2]][arr_key[3]]
+        when 5
+          str_value = @yml[arr_key[0]][arr_key[1]][arr_key[2]][arr_key[3]][arr_key[4]]
+        when 6
+          str_value = @yml[arr_key[0]][arr_key[1]][arr_key[2]][arr_key[3]][arr_key[4]][arr_key[5]]
+        when 7
+          str_value = @yml[arr_key[0]][arr_key[1]][arr_key[2]][arr_key[3]][arr_key[4]][arr_key[5]][arr_key[6]]
+        else
+          raise "Given YML path cannot be traversed"
+      end
+      return str_value
+    rescue Exception => ex
+      $log.error("Error in traverse_yml '#{str_ypath}' : #{ex}")
+      exit
+    end
+
+    # Description      : returns the profile name that is currently available
+    # Author           : Chandra sekaran
+    # Arguments        :
+    #   str_box        : profile name whether development/test
+    # Return value     :
+    #    str_key       : key name of the profile
+    #
+    def get_specific_profile(str_box)
+      str_key = ""
+      # iterates through the @yml content to find the BOX key and reads the value of :in_use key and returns the key
+      # if its value is "no"
+      @yml.each do |key, value|
+        value.each do |k, v|
+        if k.downcase == BOX.downcase
+        v.each do |k1, v1|
+          if k1.downcase.include? str_box.downcase
+            v1.each do |k2, v2|
+              if k2.downcase.include? "in_use"
+                if v2.downcase == "no"
+                  str_key = k1
+                  set_value("application/#{BOX}/#{str_key}/in_use", "yes")    # updates the key values to "yes"
+                  change_execution_count("environment/parallel_execution_count", get_value("application/#{BOX}/#{str_key}/in_use"))
+                  break
+                end
+              end
+            end
+            break if str_key != ""
+          end
+          break if str_key != ""
+        end
+        break if str_key != ""
+        end
+        break if str_key != ""
+        end
+        break if str_key != ""
+      end
+      raise "All the profiles (for Login credentials) are in use and hence stopping the execution for #{BOX}/#{str_box}" if str_key == ""
+      $log.info("Currently using '#{str_key}' under '#{str_box}' profile under '#{BOX}' box")
+      str_key
+    rescue Exception => ex
+      $log.error("Error in getting free BOX config values : #{ex}")
+      exit
+    end
+
+    # Description      : returns the box and profile names that is currently available
+    # Author           : Chandra sekaran
+    # Arguments        :
+    #   str_box        : profile name whether development/test
+    # Return value     :
+    #    str_box       : key name of the box
+    #    str_key       : key name of the profile
+    #
+    def get_any_profile(str_box)
+      str_key = ""
+      str_box_avail = ""
+      # iterates through the @yml content to find the BOX key and reads the value of :in_use key and returns the key
+      # if its value is "no"
+      @yml.each do |key, value|
+        value.each do |k, v|
+          str_box_avail = k
+          v.each do |k1, v1|
+            if k1.downcase.include? str_box.downcase
+              v1.each do |k2, v2|
+                if k2.downcase.include? "in_use"
+                  if v2.downcase == "no"
+                    str_key = k1
+                    set_value("application/#{str_box_avail}/#{str_key}/in_use", "yes")    # updates the key values to "yes"
+                    change_execution_count("environment/parallel_execution_count", get_value("application/#{str_box_avail}/#{str_key}/in_use"))
+                    break
+                  end
+                end
+                break if str_key != ""
+              end
+              #break if str_key != ""
+            end
+            break if str_key != ""
+          end
+          break if str_key != ""
+        end
+        break if str_key != ""
+      end
+      raise "All the profiles (for Login credentials) are in use and hence stopping the execution for #{str_box}" if str_key == ""
+      $log.info("Currently using '#{str_key}' under '#{str_box}' profile under '#{str_box_avail}' box")
+      return str_box_avail, str_key
+    rescue Exception => ex
+      $log.error("Error in getting free PROFILE config values : #{ex}")
+      exit
+    end
+
+    # Description      : updates the parallel execution counter in config.yml file
+    # Author           : Gomathi
+    # Arguments        :
+    #   str_ypath      : ypath of yml content
+    #   str_value      : boolean value to update the counter
+    #
+    def change_execution_count(str_ypath, str_value)
+      if str_value.downcase == "yes"
+        set_value(str_ypath, get_value(str_ypath) + 1)
+      else
+        set_value(str_ypath, get_value(str_ypath) - 1)
+      end
+    end
+
+    # Description      : sets the value for the given ypath
+    # Author           : Chandra sekaran
+    # Arguments        :
+    #   str_ypath      : ypath of yml content
+    # Return value     :
+    #    str_value     : value to be set for ypath
+    #
+    def set_value(str_ypath, str_value = "")
+      raise "Exception : ReadFromYML - ypath cannot be empty" if str_ypath.nil?
+
+      @yml = open_yml_file(@yml_file_path)
+
+      arr_key = str_ypath.split('/')
+      num_level = arr_key.size
+
+      case num_level
+        when 1
+          @yml[arr_key[0]] = str_value
+        when 2
+          @yml[arr_key[0]][arr_key[1]] = str_value
+        when 3
+          @yml[arr_key[0]][arr_key[1]][arr_key[2]] = str_value
+        when 4
+          @yml[arr_key[0]][arr_key[1]][arr_key[2]][arr_key[3]] = str_value
+        when 5
+          @yml[arr_key[0]][arr_key[1]][arr_key[2]][arr_key[3]][arr_key[4]] = str_value
+        when 6
+          @yml[arr_key[0]][arr_key[1]][arr_key[2]][arr_key[3]][arr_key[4]][arr_key[5]] = str_value
+        when 7
+          @yml[arr_key[0]][arr_key[1]][arr_key[2]][arr_key[3]][arr_key[4]][arr_key[5]][arr_key[6]] = str_value
+        else
+          raise "Given YML path cannot be traversed"
+      end
+      File.open(@yml_file_path, 'w') { |h| h.write @yml.to_yaml }   # updates the yml file content with the updated hash
+      @yml = open_yml_file(@yml_file_path)
+    rescue Exception => ex
+      $log.error("Error in setting value for ypath '#{str_ypath}' : #{ex}")
+      exit
+    end
+
+    # Description      : resets all the unused profiles
+    # Author           : Chandra sekaran
+    #
+    def release_all_profiles
+      @yml.each do |key, value|
+        if key.downcase == "application"
+          value.each do |k, v|
+            v.each do |k1, v1|
+              v1.each do |k2, v2|
+                if k2.downcase.include? "in_use"
+                  set_value("#{key}/#{k}/#{k1}/#{k2}", "no") if v2.downcase == "yes"  # set "no" to in_use key for all profiles
+                end
+              end
+            end
+          end
+        end
+      end
+    rescue Exception => ex
+      $log.error("Error in releasing all profiles : #{ex}")
+      exit
+    end
+
+  end
+end

data/lib/friendly/cukes/framework/object_repository/desktop/desktop_web_object_repo.rb

@@ -0,0 +1,50 @@
+=begin
+  *Name             : ObjectRepository
+  *Description      : module that holds the desktop web page object definitions
+  *Author           : Chandra sekaran
+  *Creation Date    : 08/05/2015
+  *Modification Date:
+=end
+
+module CUKES
+  module ObjectRepository
+
+    # object repository for desktop Google page
+    module OR_DesktopGoogle
+      include PageObject
+
+      text_field(:textfield_search,               :name   => "q")
+      button(:button_search,                      :name   => "btnG")
+      div(:div_result,                            :id     => "search")
+      link(:link_bet365,                          :href   => "http://www.bet365.com/")
+    end
+
+    # object repository for desktop Rubygems page
+    module OR_RubyGems
+      include PageObject
+
+      # home page objects
+      div(:div_header_image,                              :xpath    => "html/body/div/div[1]")
+
+      link(:link_signin,                                  :href     => "/sign_in")
+      text_field(:textfield_email,                        :id       => "session_who")
+      text_field(:textfield_password,                     :id       => "session_password")
+      button(:button_sign_in,                             :class    => "form__submit")
+      link(:link_menu,                                    :class    => "header__popup-link")
+      link(:link_signout,                                 :href     => "/sign_out")
+      text_field(:input_search,                           :id       => "query")
+
+      # gem list page objects
+      h1(:h1_title,                                       :xpath    => "//h1[contains(@class,'page__heading')]")
+      div(:div_search_result,                             :class    => "l-wrap--b")
+
+      # gem description page objects
+      text_fields(:textfield_gem_install,                 :xpath    => "//div[@class='gem__code-wrap']/input")
+      pre(:pre_gemfile,                                   :xpath    => "//div[@class='bundler']/pre")
+      div(:div_gem_version,                               :class    => "versions")
+      div(:div_gem_runtime_dependencies,                  :id       => "runtime_dependencies")
+      div(:div_gem_ruby_dependencies,                     :id       => "ruby_dependency")
+      div(:div_gem_development_dependencies,              :id       => "development_dependencies")
+    end
+  end
+end

data/lib/friendly/cukes/framework/object_repository/mobile/mobile_web_object_repo.rb

@@ -0,0 +1,22 @@
+=begin
+  *Name             : ObjectRepository
+  *Description      : module that holds the mobile web page object definitions
+  *Author           : Chandra sekaran
+  *Creation Date    : 08/05/2015
+  *Modification Date:
+=end
+
+module CUKES
+  module ObjectRepository
+
+    # object repository for mobile Google page
+    module OR_MobileGoogle
+      include PageObject
+
+      text_field(:textfield_search,               :name   => "q")
+      button(:button_search,                      :name   => "btnG")
+      div(:div_result,                            :id     => "main")
+      link(:link_rubygems,                        :href   => "https://rubygems.org/")
+    end
+  end
+end

data/lib/friendly/cukes/framework/page_objects/desktop/gem_search.rb

@@ -0,0 +1,213 @@
+=begin
+  *Name             : Gem Search
+  *Description      : class that holds the Gem page objects and method definitions
+  *Author           : Chandra sekaran
+  *Creation Date    : 24/04/2015
+  *Modification Date:
+=end
+
+module CUKES
+  class RubyGems
+    include PageObject
+    include PageUtils
+    include FileLibrary
+    include ObjectRepository::OR_RubyGems
+
+    # Description     : invoked automatically when the page class object is created
+    # Author          : Chandra sekaran
+    #
+    def initialize_page
+      wait_for_page_load
+    end
+
+    # Description     : sign into the application
+    # Author          : Chandra sekaran
+    #
+    def sign_in
+      click_on(link_signin_element)
+      wait_for_object(textfield_email_element, "Could not find textfield Email")
+      self.textfield_email = USER_NAME  # "profchan2k15@gmail.com"
+      self.textfield_password = PASSWORD  # "chan123@1"
+      click_on(button_sign_in_element)
+      wait_for_page_load
+      #raise "Error in sign in" if !is_text_present(self, "CHAN90", 120)
+      $log.success("Sign in successful")
+    rescue Exception => ex
+      $log.error("Failure while signing in : #{ex}")
+      exit
+    end
+
+    # Description     : sign out from the application
+    # Author          : Chandra sekaran
+    #
+    def sign_out
+      click_on(link_menu_element)
+      click_on(link_signout_element)
+      #raise "Error in sign out" if !is_text_present(self, "Sign in", 120)
+      $log.success("Sign out successful")
+    rescue Exception => ex
+      $log.error("Failure while signing out : #{ex}")
+      exit
+    end
+
+    # Description        : searches for the given input gem name
+    # Author             : Chandra sekaran
+    # Arguments          :
+    #   gem_name         : name of the gem
+    #   str_data_node    : test data root node name
+    #
+    def search_for_gem(gem_name = "", str_data_node = "gems")
+      if gem_name == ""
+        # the set_scenario_based_datafile method sets the test data content from the given input file name
+        # present in library/app_specific/datafile_names.rb
+        # the yml file can be :
+        # *  a local data file - inside the current feature name directory
+        # *  a global data file - inside desktop directory
+        hash_gem_name = set_scenario_based_datafile(GEM_NAME)
+        gem_name = hash_gem_name[str_data_node]["gem_name"]
+      end
+      wait_for_object(input_search_element, "Could not find search textbox")
+      self.input_search = gem_name
+      input_search_element.send_keys(:enter)
+    rescue Exception => ex
+      $log.error("Failure while searching for gem '#{gem_name}' : #{ex}")
+      exit
+    end
+
+    # Description        : compares the gem header name
+    # Author             : Chandra sekaran
+    # Argument           :
+    #   gem_name         : name of the gem
+    #
+    def compare_heading(gem_name)
+      wait_for_object(h1_title_element)
+      expected_heading = "search for #{gem_name}"
+      actual_heading = h1_title_element.text
+      raise "The expected heading is #{expected_heading} but actual heading is #{actual_heading}" if actual_heading != expected_heading
+      wait_for_object(div_search_result_element, "Could not find gem result list")
+      raise "No gems found for the given gem" if div_search_result_element.text.include?("No gems found")
+    rescue Exception => ex
+      $log.error("Failure while comparing Gem header for gem '#{gem_name}' : #{ex}")
+      exit
+    end
+
+    # Description        : searches for the specific gem and selects it
+    # Author             : Chandra sekaran
+    #
+    def fetch_desired_gem
+      gem_object = ""
+      gem_name = ""
+      max = 0
+      div_search_result_element.link_elements(:xpath => "./a").each do |parent|
+        current = parent.paragraph_element(:xpath => "./p").text
+        current = current.gsub!(',','').to_i if current.include?(',')
+        if max < current.to_i
+          max = current.to_i
+          gem_object = parent.strong_element(:xpath => "./div/h2")
+        end
+      end
+      gem_name = gem_object.text
+      gem_object.click
+      gem_name
+    rescue Exception => ex
+      $log.error("Failure while getting desired gem : #{ex}")
+      exit
+    end
+
+    # Description        : fetches the gem details
+    # Author             : Chandra sekaran
+    # Argument           :
+    #   gem              : name of the gem
+    #
+    def fetch_gem_details(gem)
+      wait_for_object(h1_title_element)
+
+      gem_name, gem_version = split_gem_and_version(gem)
+      gem_heading = gem_name + " " + gem_version
+      raise "The expected value is '#{gem_heading}' but the actual value is '#{h1_title_element.text}'" if h1_title_element.text != gem_heading
+
+      $log.info "Gem Description"
+      $log.info "\tGem Name     : #{h1_title_element.text}"
+      $log.info "\tGem install  : #{textfield_gem_install_elements.last.value}"
+      $log.info "\tGemfile      : #{textfield_gem_install_elements.first.value}"
+
+      fetch_gem_versions
+      fetch_gem_runtime_dependencies
+      fetch_gem_ruby_dependencies
+      fetch_gem_development_dependencies
+    rescue Exception => ex
+      $log.error("Failure while fetching Gem details for gem '#{gem_name}' : #{ex}")
+      exit
+    end
+
+    # Description        : fetches the gem version
+    # Author             : Chandra sekaran
+    #
+    def fetch_gem_versions
+      $log.info "Versions"
+      fetch_list_items(div_gem_version_element)
+    end
+
+    # Description        : fetches the gem runtime dependencies
+    # Author             : Chandra sekaran
+    #
+    def fetch_gem_runtime_dependencies
+      $log.info "Runtime Dependencies"
+      fetch_list_items(div_gem_runtime_dependencies_element)
+    end
+
+    # Description        : fetches the gem ruby dependencies
+    # Author             : Chandra sekaran
+    #
+    def fetch_gem_ruby_dependencies
+      $log.info "Ruby Dependency"
+      fetch_list_items(div_gem_ruby_dependencies_element)
+    end
+
+    # Description        : fetches the gem development dependencies
+    # Author             : Chandra sekaran
+    #
+    def fetch_gem_development_dependencies
+      $log.info "Ruby Dependency"
+      fetch_list_items(div_gem_development_dependencies_element)
+    end
+
+    # Description        : fetches the text under list of elements
+    # Author             : Chandra sekaran
+    # Argument           :
+    #   parent_element   : parent element object
+    #
+    def fetch_list_items(parent_element)
+      if parent_element.exists? && parent_element.visible?
+        list_elements = ""
+        if parent_element.div_element(:xpath => "./div[@class='t-list__items']").exists?
+          list_elements = parent_element.link_elements(:xpath => "./div[@class='t-list__items']/a")
+        elsif parent_element.ordered_list_element(:xpath => "./ol").exists?
+          list_elements = parent_element.list_item_elements(:xpath => "./ol/li")
+        end
+        list_elements.each do |list|
+          $log.info "\t #{list.text}"
+        end
+      else
+        $log.info "\t No data found"
+      end
+    rescue Exception => ex
+      $log.error("Failure while fetching gem list items : #{ex}")
+      exit
+    end
+
+    # Description        : splits gem name and its version from given input string
+    # Author             : Chandra sekaran
+    # Argument           :
+    #   gem              : gem name string with version
+    # Return Arguments   :
+    #   gem_name         : gem name
+    #   gem_version      : gem version
+    #
+    def split_gem_and_version(gem)
+      gem_name = gem.split(" ").first
+      gem_version = gem.split(" ").last
+      return gem_name, gem_version
+    end
+  end
+end