comments added for tests

Author: nareshnavinash

libraries/logger.rb

@@ -108,6 +108,7 @@ def self.fail(message)
     end
 end
 
+# At the end of all the test run, the console logs will be written to a new log file under reports/logs which can be used for future reference
 at_exit {
     File.open("reports/logs/[" + Time.now.localtime.to_s + "].log", "w+") do |f|
         f.puts($logger_text_array)

locators/profile_preview.rb

@@ -26,7 +26,7 @@ def initialize
             @country = Locator.new(:css, "section.up-card-section span[itemprop='country-name']")
             @earned = Locator.new(:xpath, "//section[contains(@class,'up-card-section')]//div[contains(@class, 'col-compact')][1]")
             @overview_expand_button = Locator.new(:css, "div.up-line-clamp button[aria-expanded='false']")
-            @overview = Locator.new(:css, "section.row div.up-line-clamp-expanded")
+            @overview = Locator.new(:css, "section.row section.up-card-section div.up-line-clamp-expanded")
             @upskill_tags = Locator.new(:css, "section.row section.up-card-section div.skills span")
             @associated_with = Locator.new(:css, "section.row div.mt-30 div.d-flex")
 

pages/profile_preview.rb

@@ -37,7 +37,7 @@ def create_hash_for_client_details
 
       # To return if the profile preview page is displayed
       def is_profile_preview_displayed?
-        return @overview.is_present_with_wait?(30)
+        return @upskill_tags.is_present_with_wait?(30)
       end
 
     end

spec/spec_helper.rb

@@ -1,3 +1,8 @@
+# This is to implement the rspec's test flow structure that is used to define the tests
+# This is implemented using Nested Layouts concept
+# This is responsible for the logging of description, test steps and the numbering are happening here
+# Before all, before each, after all, after each steps are also declared here
+# This file can be taken as a backbone for the tests that are going to be scripted in this framework
 require_relative "../libraries/logger.rb"
 require_relative "../libraries/driver.rb"
 require_relative "../libraries/config.rb"
@@ -9,30 +14,37 @@
 $test = 0
 $step = 0
 
+# Before all block which can be declared for each test file
 def before_all(&block)
     yield if block_given?
 end
 
+# After all block which can be declared for each test file
 def after_all(&block)
     $after_all = lambda { yield }
 end
 
+# This will be executed before each `it` described in the tests
 def before_each_test(&block)
     $before_each_test = lambda { yield }
 end
 
+# This will be executed after each `it` described in the tests
 def after_each_test(&block)
     $after_each_test = lambda { yield }
 end
 
+# This will be executed before each `step` described in the tests
 def before_each_step(&block)
     $before_each_step = lambda { yield }
 end
 
+# This will be executed after each `step` described in the tests
 def after_each_step(&block)
     $after_each_step = lambda { yield }
 end
 
+# This is to log the description and reset the counter for the tests and steps
 def describe(description)
     $file = $file + 1
     $test = 0
@@ -42,6 +54,7 @@ def describe(description)
     $after_all.call if $after_all
 end
 
+# This is to log the steps declared in the tests
 def step(description)
     $step = $step + 1
     $before_each_step.call if $before_each_step
@@ -50,6 +63,7 @@ def step(description)
     $after_each_step.call if $after_each_step
 end
 
+# This is to log the `it` declared in the tests
 def it(description)
     $test = $test + 1
     $before_each_test.call if $before_each_test

spec/test_find_professionals.rb

@@ -1,3 +1,6 @@
+# This is the actual test file
+# Here I used Page Object Model to declare the locators and use within the tests
+# This test skeleton structure is built to look similar with rspec test structure
 require_relative 'spec_helper.rb'
 require_relative '../pages/home.rb'
 require_relative '../pages/search_listing.rb'
@@ -6,8 +9,10 @@
 require 'yaml'
 include Pages
 
+# Each test file should have one describe block with the text that states the higher level module which is going to be tested
 describe("Find Professionals in Upwork") do
 
+    # Before all block where we need initialize all the pages and load the test data that is going to be used across this file
     before_all do
         @@find_prof_page = Home.new
         @@search_listing = SearchListing.new
@@ -16,12 +21,21 @@
         @@test_data = YAML.load_file(Dir.pwd + '/test-data/find_professionals.yml')
     end
 
+    # After all Make sure the browser driver initialized is quit properly
     after_all do
         @@driver.quit
     end
 
+    # This is added in additional to the rspec's structure
+    # Here you can specify multiple search_key in the test_data yaml file in array format
+    # This test will run iteratively for all the search key's and log the results
     @@test_data['search_keyword'].each do |search_key|
+        # This is where the actual test starts
+        # A file can have multiple `it` statements within a `describe` block
         it("Find professionals using search option in Upwork") do
+            # Each step defines an important action that is made in the browser
+            # Each step will be logged to the console,
+            # So its better to have only the important test steps that has to be noted by manual person here
             step("Run " + Config.browser + " brower with headless as " + Config.headless.to_s) do
                 @@driver = Driver.new
             end
@@ -31,7 +45,7 @@
             step("Navigate to Upwork website - " + Config.url) do
                 @@driver.get(Config.url)
                 if @@captcha.captcha.is_present_with_wait?(10)
-                    sleep(60)
+                    sleep(60) # To handle the captcha page
                     @@captcha.handle_captcha_page
                 end
                 expect_to_equal(@@find_prof_page.find_professionals_and_agencies_text_box.is_present_with_wait?(30), true, "Home page is displayed")
@@ -48,14 +62,18 @@
                     @@driver.clear_cookies
                     @@driver.get(@@test_data["url_with_search_key"] + search_key)
                 end
-                sleep(60) if @@captcha.captcha.is_present_with_wait?(10)
+                sleep(60) if @@captcha.captcha.is_present_with_wait?(10) # To handle the captcha page
                 expect_to_equal(@@search_listing.is_search_listing_displayed?, true, "Search listing page is displayed")
             end
             step("Parsing the first page with search results and storing the results in hash of hash format") do
                 @@result_hash = @@search_listing.parse_results_page_and_store_values
-                Log.info("Search results parsed data -> #{@@result_hash}")
+                Log.info("Search results parsed data -> #{@@result_hash}") # Log.info methods wont be printed in the stdout, one can change the logger level to get these
             end
             step("Validate the results hash along with the search key that is used to get the results") do
+                # Each freelancer's detail is matched with the search key
+                # And if the key word is not matched with any of the attributes, fail log will be printed
+                # Else pass log will be prited for that freelancer with the name
+                # log.info methods will give indepth comparison, if needed one can change the logger level
                 @@result_hash.each do |key, value|
                     pass_result = {}
                     fail_result = {}
@@ -88,9 +106,9 @@
                 end
             end
             step("Click on the random profile from the search result and fetch the freelancer details from the freelancers preview page") do
-                @@profile_count = rand(1..10)
+                @@profile_count = rand(1..10) # clicking on random profile from the list dispalyed
                 @@search_listing.click_on_freelancer_profile(@@profile_count)
-                if !@@profile_preview.is_profile_preview_displayed?
+                if !@@profile_preview.is_profile_preview_displayed? # To handle the captcha page
                     @@driver.quit
                     @@driver = Driver.new
                     @@driver.clear_cookies
@@ -102,14 +120,17 @@
             step("Fetch details from the freelancers profile preview and compare it with the details dispalyed in search results page") do
                 preview_hash = @@profile_preview.create_hash_for_client_details
                 Log.info("Freelancer profile fetched details -> #{preview_hash}")
+                # Following are the assertions for the details fetched from the search list page and the freelancer profile preview page
+                # Each attributes are having different format in the UI, hence while fetching each one will have different structure
+                # Some of them are modifed to make it compatible for comparing
                 expect_to_equal(@@result_hash[@@profile_count][:name], preview_hash[:name], "Profile preview and search listing details match for name with values #{@@result_hash[@@profile_count][:name]} == #{preview_hash[:name]}")
                 expect_to_equal(@@result_hash[@@profile_count][:title], preview_hash[:title], "Profile preview and search listing details match for title with values #{@@result_hash[@@profile_count][:title]} == #{preview_hash[:title]}")
                 expect_to_equal(@@result_hash[@@profile_count][:country], preview_hash[:country], "Profile preview and search listing details match for country with values #{@@result_hash[@@profile_count][:country]} == #{preview_hash[:country]}")
-                expect_to_equal(preview_hash[:earned]&.split(" ")[0], @@result_hash[@@profile_count][:earned]&.split("\n")[0], "Profile preview and search listing details match for earned with values #{@@result_hash[@@profile_count][:earned]} == #{preview_hash[:earned]&.delete("\n")}") if @@result_hash[@@profile_count][:earned]
-                expect_to_equal(@@result_hash[@@profile_count][:overview]&.delete("\n")&.delete(' '), preview_hash[:overview]&.delete("\n")&.delete(' '), "Profile preview and search listing details match for overview with values #{@@result_hash[@@profile_count][:overview]&.delete("\n")} == #{preview_hash[:overview]&.delete("\n")}")
+                expect_to_equal(preview_hash[:earned]&.split(" ")[0], @@result_hash[@@profile_count][:earned]&.split("\n")[0].split(" ")[0], "Profile preview and search listing details match for earned with values #{@@result_hash[@@profile_count][:earned]} == #{preview_hash[:earned]&.delete("\n")}") if @@result_hash[@@profile_count][:earned]
+                expect_to_equal(@@result_hash[@@profile_count][:overview]&.delete("\n")&.delete(' '), preview_hash[:overview]&.delete("\n")&.delete(' ')&.split("lessShowlesstext")[0], "Profile preview and search listing details match for overview with values #{@@result_hash[@@profile_count][:overview]&.delete("\n")} == #{preview_hash[:overview]&.delete("\n")}")
                 expect_to_equal(@@result_hash[@@profile_count][:upskill_tags], preview_hash[:upskill_tags], "Profile preview and search listing details match for upskill_tags with values #{@@result_hash[@@profile_count][:upskill_tags]} == #{preview_hash[:upskill_tags]}")
                 expect_to_equal(@@result_hash[@@profile_count][:price]&.delete(' '), preview_hash[:price]&.delete(' '), "Profile preview and search listing details match for price with values #{@@result_hash[@@profile_count][:price]&.delete(' ')} == #{preview_hash[:price]&.delete(' ')}")
-                expect_to_equal((preview_hash[:success_rate]&.delete("\n")&.delete(' ')&.include? @@result_hash[@@profile_count][:success_rate]&.delete(' ')), true, "Profile preview and search listing details match for success_rate with values #{preview_hash[:success_rate]&.delete("\n")} == #{@@result_hash[@@profile_count][:success_rate]&.delete(' ')}")
+                expect_to_equal((preview_hash[:success_rate]&.delete("\n")&.delete(' ')&.include? @@result_hash[@@profile_count][:success_rate]&.delete(' ')), true, "Profile preview and search listing details match for success_rate with values #{preview_hash[:success_rate]&.delete("\n").to_s} == #{@@result_hash[@@profile_count][:success_rate]&.delete(' ').to_s}")
                 expect_to_equal(@@result_hash[@@profile_count][:associated_with]&.split("\n")[1], preview_hash[:associated_with]&.split("\n")[0], "Profile preview and search listing details match for associated_with with values #{@@result_hash[@@profile_count][:associated_with]&.split("\n")[1]} == #{preview_hash[:associated_with]&.split("\n")[0]}") if @@result_hash[@@profile_count][:associated_with]
             end
         end

test-data/find_professionals.yml

@@ -1,4 +1,5 @@
-search_keyword:
+# Test specific data are declared here
+search_keyword: # On giving multiple key word, same test will be running with different search keys. Duplication of code can be avoided here
   - Automation
 url_with_search_key: https://www.upwork.com/search/profiles/?nbs=1&q=
 url_with_profile_preview: https://www.upwork.com/search/profiles/?nbs=1&q=Automation&profile=~01dabbff50ebecbf93