taf 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81b715c5e4868e003e279e905010ea081b019ccd1ee2b3edfd5621d0e221e41c
-  data.tar.gz: 6ee344aeeac5fbc0b63fd17cccbc19a3bcd756e847f066875f48fa8452b455bf
+  metadata.gz: 58fdfb7b11f94ebd4ecd06d200a119f8241250bcc2f488b3bb94ae5f251546cf
+  data.tar.gz: ff1c43e96ee2c1616c0ed15a3524bd37045000121da45be3eedb64d8ec479eb1
 SHA512:
-  metadata.gz: 5cfbc2cfb744685d699cf1dc47e8b6fba4d01640529f701244460157f761ae99f9091a2387356beae3ce682a6e04417be0dcd0fc98187f0234149589bc93aace
-  data.tar.gz: 1b469c6ce6cf12b778474f4c6c70f109eb1d2c9d827c6d90642a2ecde304363bddee2b1d717b4e0194d73a99984968a72b15cc9312be2d7f9749d5767ed1e0d8
+  metadata.gz: 86db648a0fbf86aa9d05f1ee3470133aca0ff0fdc24399c406fd001376a0277345474203bb191a6606dc3836d44f84f33d257ddf81bbed3424a3baa5115a5233
+  data.tar.gz: 3b9b9ada89869672854e9b1558238c0ccbb4a64ff077bfdef858fc9bda8dd7fc7a4d1b342733e894735427eaa2b4e21378d52b6580115cccef659384d4fd6e3f

data/lib/functions/handlers/base_handler.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+# Base Hanfer file to contain all shared login functions
 module TestSteps
   require_relative '../../taf_config.rb'
   module Handlers
+    # All Login functions function.
     class Base
       def self.register(name)
         TestSteps.handlers[name.to_s] = self

data/lib/functions/handlers/browser_back.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Browser Back function.
     class BrowserBack < Base
       register :browser_back
 

data/lib/functions/handlers/browser_forward.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Browser Forward function.
     class BrowserForward < Base
       register :browser_forward
 

data/lib/functions/handlers/browser_quit.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Browser Quit function.
     class BrowserQuit < Base
       register :browser_quit
 

data/lib/functions/handlers/browser_refresh.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Browser Refresh function.
     class BrowserRefresh < Base
       register :browser_refresh
 

data/lib/functions/handlers/capture_alert.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Capture Alert function.
     class CaptureAlert < Base
       register :capture_alert
 

data/lib/functions/handlers/check_box.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Check Box function.
     class CheckBox < Base
       register :check_box
 

data/lib/functions/handlers/check_boxdata.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Check Box Data function.
     class CheckBoxdata < Base
       register :check_box_data
 

data/lib/functions/handlers/check_browser_title.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Check Browser Title function.
     class CheckTitle < Base
       register :check_browser_title
 

data/lib/functions/handlers/check_logs.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Check a log file function.
     class CheckLogs < Base
       register :check_log_file
 

data/lib/functions/handlers/check_screendata.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Check Screendata text function.
     class CheckScreendata < Base
       register :check_screen_data
 

data/lib/functions/handlers/check_url.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Check URL function.
     class CheckUrl < Base
       register :check_url
 

data/lib/functions/handlers/click_button.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Click Button function.
     class ClickButton < Base
       register :click_button
 

data/lib/functions/handlers/execute_system_command.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Execute System Command function.
     class ExecuteSystemCommand < Base
       register :execute_system_command
 

data/lib/functions/handlers/handle_browser_window.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Handle Browser Window function.
     class HandleBrowserWindow < Base
       register :handle_browser_window
 

data/lib/functions/handlers/ipause.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Pause the test function.
     class Ipause < Base
       register :ipause
 

data/lib/functions/handlers/list_all_dropdowns_values.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # List all Dropdown Values function.
     class ListAllDropdownValues < Base
       register :list_all_dropdown_values
 

data/lib/functions/handlers/login.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Logins function.
     class Login < Base
       register :login
 

data/lib/functions/handlers/open_url.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Open URL function.
     class OpenUrl < Base
       register :open_url
 

data/lib/functions/handlers/ping_test.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Png Test function.
     class PingTest < Base
       register :ping_test
 

data/lib/functions/handlers/radio_button.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Radio Button function.
     class RadioButton < Base
       register :radio_button
 

data/lib/functions/handlers/select_dropdown.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Select Dropdown function.
     class SelectDropdown < Base
       register :select_dropdown
 
@@ -14,7 +15,8 @@ module TestSteps
         locate2 = step_attributes[:locate2]
 
         Browser.b.select_list("#{locate}": dropdown).wait_until(&:exists?)
-        Browser.b.select_list("#{locate}": dropdown).option("#{locate2}": value2.to_s).select
+        Browser.b.select_list("#{locate}": dropdown).option("#{locate2}":
+                                                          value2.to_s).select
         MyLog.log.info("Dropdown item: #{value2} has been selected")
         true
       rescue StandardError

data/lib/functions/handlers/send_special_keys.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Send a Special Key function.
     class SendSpecialKeys < Base
       register :send_special_keys
 

data/lib/functions/handlers/write_box_data.rb

@@ -4,6 +4,7 @@ require_relative 'base_handler'
 
 module TestSteps
   module Handlers
+    # Write box data function.
     class WriteBoxdata < Base
       register :write_box_data
 
@@ -12,11 +13,11 @@ module TestSteps
         value = step_attributes[:testvalue2]
         locate = step_attributes[:locate]
 
-        text = ENV[value.to_s] || step_attributes[:testvalue2]
-        WriteBoxdata.input_value(box, text, locate)
+        txt = ENV[value.to_s] || step_attributes[:testvalue2]
+        WriteBoxdata.input_value(box, txt, locate)
       end
 
-      def self.input_value(box, text, locate)
+      def self.input_value(box, txt, locate)
         found_box = [
           Browser.b.textarea("#{locate}": box).exist?,
           Browser.b.text_field("#{locate}": box).exist?,
@@ -29,18 +30,18 @@ module TestSteps
         return unless index
 
         if index.zero?
-          Browser.b.textarea("#{locate}": box).wait_until(&:exists?).set text
-          (Browser.b.textarea("#{locate}": box).text == text)
+          Browser.b.textarea("#{locate}": box).wait_until(&:exists?).set txt
+          (Browser.b.textarea("#{locate}": box).text == txt)
         elsif index == 1
-          Browser.b.text_field("#{locate}": box).wait_until(&:exists?).set text
-          (Browser.b.text_field("#{locate}": box).text == text)
+          Browser.b.text_field("#{locate}": box).wait_until(&:exists?).set txt
+          (Browser.b.text_field("#{locate}": box).text == txt)
         elsif index == 2
-          Browser.b.iframe("#{locate}": box).wait_until(&:exists?).send_keys text
+          Browser.b.iframe("#{locate}": box).wait_until(&:exists?).send_keys txt
         end
-        MyLog.log.info("Textbox: #{box} has correct value: #{text}")
+        MyLog.log.info("Textbox: #{box} has correct value: #{txt}")
         true
       rescue StandardError
-        MyLog.log.warn("Textbox: #{box} has the incorrect value: #{text}")
+        MyLog.log.warn("Textbox: #{box} has the incorrect value: #{txt}")
         false
       rescue StandardError
         MyLog.log.warn("Textbox: #{box} does not exist")

data/lib/main.rb

@@ -11,7 +11,7 @@ module Main
   require_relative './taf_config.rb'
 
   begin
-    # variables to manage the failure reporting
+     # variables to manage the failure reporting
      $testStepPasses = 0
      $testStepFailures   = 0
      $testStepNotrun     = 0

data/lib/report/report.rb

@@ -22,7 +22,8 @@ module Report
 
     step = {
       'id' => test_step_idx,
-      'classname' => "SuiteID: #{$testId} Test Step: #{test_step_idx} #{test_desc}",
+      'classname' => "SuiteID: #{$testId} Test Step: #{test_step_idx} "\
+      "#{test_desc}",
       'name' => test_desc,
       'file' => test_file_name
     }
@@ -49,7 +50,8 @@ module Report
       $testStepFailures += 1
       MyLog.log.info "Test #{test_step_idx} has FAILED ".red
       failstep = {
-        'message' => "SuiteID: #{$testId} Test Step: #{test_step_idx} Test has FAILED - Check logs",
+        'message' => "SuiteID: #{$testId} Test Step: #{test_step_idx} Test has"\
+         ' FAILED - Check logs',
         'type' => 'FAILURE',
         'file' => test_file_name
       }
@@ -66,7 +68,8 @@ module Report
       $testStepNotrun += 1
       MyLog.log.info "Test #{test_step_idx} no checks performed ".blue
       skipstep = {
-        'message' => "SuiteID: #{$testId} Test Step: #{test_step_idx} No checks performed - Check logs",
+        'message' => "SuiteID: #{$testId} Test Step: #{test_step_idx} No"\
+          ' checks performed - Check logs',
         'type' => 'SKIPPED',
         'file' => test_file_name
       }

data/lib/utils/logger.rb

@@ -7,7 +7,7 @@
 # 1.0 - Baseline
 #
 # logger.rb - logger file
-
+# Logger function.
 module MyLog
   require_relative '../taf_config.rb'
   def self.log

data/lib/version.rb

@@ -3,7 +3,7 @@
 module Taf
   # This module holds the TAF version information.
   module Version
-    STRING = '0.3.2'
+    STRING = '0.3.3'
 
     MSG = '%<version>s (using Parser %<parser_version>s, running on ' \
           '%<ruby_engine>s %<ruby_version>s %<ruby_platform>s)'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taf
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Andy Perrett
@@ -164,7 +164,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.16'
-description: Test Automation Framework (TAF) to allow simple test web automation -
+description: Test Automation Framework (TAF) to allow simple testweb automation -
   external use
 email: 
 executables: