gridium 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b91d81fa156a7dc96a667a0b561606460278b3ac
-  data.tar.gz: 465307a7f3ba4a61058b6ae975a8e810a6a60b32
+  metadata.gz: fa53796b32752f73131f570064f809f00b36a88e
+  data.tar.gz: 34520a57779e259536f90e1e3b24ada51300d910
 SHA512:
-  metadata.gz: 909233a4baf760f869e58f250d722f71a23f2fbe43aef707b863a3cef0b1acb45c659362b12470a0c970679345b158e265059a0a4633aca5837f4b4548cb4b10
-  data.tar.gz: 2fb66af2f69fd101d132670d9b0c8e6c627aed212ab03283f7acdd7ad43f05a8d2993a54c9e65e241c1341bad3a193a9624121d84fc56eb37696cd934174fe89
+  metadata.gz: 4930494ce2ef104a66f3d7db02ec1c4fe71c7af813a8c9302a9b4c421a9e48209bc07755b9950f26147a901625739446d357dd3835d810b573980e86942894ad
+  data.tar.gz: e2a3a6dcc023cfb15a0492696f33af1b5a02be824c4e1eba2b7e19fee54c86e24d18fd387deccfbde5317f463d6f6443cbb1a7162c7a48e3e4ab14481f301e5e

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 
 Gridium is built to support the Page Object Design pattern for automated User Interface tests.  Gridium works best when page objects are abstracted from the test files.  While Rspec is preferred, you should still be able to use Gridium with other test runners.  
 
-In order to use Gridium, you will first need to need to add it to your automtion suite.  Gridium comes with Selenium and is currently configured to run tests on Firefox only.  Future updates will be available to run tests on other browsers and Selenium Grid.
+In order to use Gridium, you will first need to need to add it to your automation suite.  Gridium comes with Selenium and is currently configured to run tests on Firefox only.  Future updates will be available to run tests on other browsers and Selenium Grid.
 
 #### Spec Helper
 To get started using Gridium add the Gem to your automated test library.  Include the following section in your `spec_helper.rb` file:
@@ -40,6 +40,10 @@ Gridium.configure do |config|
   config.highlight_verifications = true
   config.highlight_duration = 0.100
   config.screenshot_on_failure = false
+  config.screenshots_to_s3 = false
+  config.project_name_for_s3 = 'gridium'
+  config.subdirectory_name_for_s3 = '' #rely on GridiumS3 default
+  config.testrail = false
 end
 ```
 
@@ -48,7 +52,10 @@ Additionally, there are some options that should be configured in the `Rspec.con
 ```ruby
 RSpec.configure do |config|
 include Gridium
+tr = Gridium::TestRail.new  #this would only work if Gridium.config.testrail is set to true
   config.before :all do
+    # Set up new testrail run
+    tr.add_run("Test Run Name", "Test Run description")
     # Create the test report root directory
     report_root_dir = File.expand_path(File.join(Gridium.config.report_dir, 'spec_reports'))
     Dir.mkdir(report_root_dir) if not File.exist?(report_root_dir)
@@ -70,6 +77,15 @@ include Gridium
     Spec_data.load_suite_state
     Spec_data.load_spec_state
   end #end before:all
+
+  config.after :example, testrail_id: proc { |value| !value.nil? } do |example|
+    tr.add_case(example) #Add the results of the case to TestRail
+  end
+
+  config.after :all do
+    tr.close_run #closes out the TestRun
+  end
+
 end #end Rspec.config
 ```
 
@@ -86,14 +102,40 @@ You may be saying to yourself - 'Holy Crap that's a lot of settings!'.  Yeah.  I
 `config.visible_elements_only = true`: With this enabled Gridium will only find VISIBLE elements on the page.  Hidden elements or non-enabled elements will not be matched.  
 `config.log_level = :debug`: There are a few levels here `:debug` `:info` `:warn` `:error` and `:fatal`.  Your Gridium tests objects can have different levels of logging.  Adjusting this setting will turn those log levels on or off depending on your needs at the time.  
 `config.highlight_verifications = true`: Will highlight the element Gridium finds in the browser.  This makes watching tests run easier to follow, although it does slow the test execution time down.  Recommend this is turned off for automated tests running in Jenkins or headless mode.  
-`config.highlight_duration = 0.100`: How long should the element be highlighted (in miliseconds) before the action is performed on the element.  
+`config.highlight_duration = 0.100`: How long should the element be highlighted (in milliseconds) before the action is performed on the element.  
 `config.screenshot_on_failure = false`: Take a screenshot on failure.  On or off. Obviously.  
+`config.screenshots_to_s3 = false`: This option allows users to save screenshots to an s3 bucket.  AWS S3 buckets need to be setup and configured in AWS.  Environment variables needs to be set for S3.  See environment variables section.
+`config.project_name_for_s3 = 'GRIDIUM'`: This will be appended to the filename in the front of the file. Should not contain spaces.
+`config.subdirectory_name_for_s3 = 'TEST NAME'`: This will be the directory in S3 root to store the files.  Used primarily to differentiate between project artifacts in the same s3 bucket.
+`config.testrail = true`: This to enable TestRail integration. With this turned on, test results will be updated in your TestRail instance.
+
+##### Environment variables
+
+S3 Features require the following Environment variables be set on the machine running the Gridium Test:
+
+```
+S3_ACCESS_KEY_ID
+S3_SECRET_ACCESS_KEY
+S3_DEFAULT_REGION
+S3_ROOT_BUCKET
+```
+
+For TestRail Integration the following Environment variables are required:
+
+```
+GRIDIUM_TR_URL
+GRIDIUM_TR_USER
+GRIDIUM_TR_PW
+GRIDIUM_TR_PID
+```
+
 
 ##### Rspec Configuration Options:  
-The first bit of the Rspec configuration section is used to set up a log file directory.  I like to have log files kept in seperate dated directories.  However, that may not be needed depending on your preference.  If you choose to use a single directory for your log files, you will need to make sure that the log file name is unique, as screenshots are saved into the same directory.  Whichever method you prefer, you will need to setup the Gridium Log Device.  
-`Log.add_device(File.open(File.join(current_run_report_dir, "spec_logging_output.log"), File::WRONLY | File::APPEND | File::CREAT))`: This tells Gridium where to write the logs to for any paticular test run.
+The first bit of the Rspec configuration section is used to set up a log file directory.  I like to have log files kept in separate dated directories.  However, that may not be needed depending on your preference.  If you choose to use a single directory for your log files, you will need to make sure that the log file name is unique, as screenshots are saved into the same directory.  Whichever method you prefer, you will need to setup the Gridium Log Device.  
+`Log.add_device(File.open(File.join(current_run_report_dir, "spec_logging_output.log"), File::WRONLY | File::APPEND | File::CREAT))`: This tells Gridium where to write the logs to for any particular test run.
+
+The following is used for throughout the test execution and displayed in the logs to quickly access how many of each particular failure your tests are discovering.  This can be used for quick metrics and climate checks of your application under test.
 
-The following is used for throughout the test execution and displayed in the logs to quickly access how many of each paticular failure your tests are discovering.  This can be used for quick metrics and climate checks of your aplication under test.
 ```ruby
 # Reset Suite statistics
 $verifications_total = 0
@@ -105,11 +147,11 @@ Spec_data.load_suite_state
 Spec_data.load_spec_state
 ```
 
-##Page Objects
+## Page Objects
 
 Page objects are required for Gridium.  Page objects abstract the functionality of the page away from the test.  There's a million reasons why page objects are the way to go.  Not the least of all is that it helps you maintain your tests.
 
-####Sample Page Object
+#### Sample Page Object
 ```ruby
 include Gridium
 class LoginPage < Page
@@ -129,22 +171,22 @@ class LoginPage < Page
 end
 ```
 
-Notice that to use Gridium functionality, Gridium needs to be included at the top of the page object definition.  Also notice that the LoginPage inherits from the Gridium `Page`.  The `Page` object in gridium provides methods that emulate some of Capybara's API.  For more information checkout the `lib/page.rb`.
+Notice that to use Gridium functionality, Gridium needs to be included at the top of the page object definition.  Also notice that the LoginPage inherits from the Gridium `Page`.  The `Page` object in Gridium provides methods that emulate some of Capybara's API.  For more information checkout the `lib/page.rb`.
 
 Page object are made up of Elements.  The methods on the page object tells the test how interact with the elements.  For example, the Login method shown in the example sets the Username field, the password field and then clicks the login button.  
 
 This action will return a new page, that our test is setup to handle.
 
-##Elements
+## Elements
 
 Elements are the building blocks of page objects.  Elements are anything that a user, or a test would care about on the page.  To create a new Element, you will need three things:  
-*Element Name - A human readable string used to identify the element to the tester.  Used primarily in the log file.  
-*Locator Type - `:css` `:xpath` `:link` `:link_text` `:id` `:class` `:class_name` `:name` `:tag_name` are all valid.  
-*Locator - This is the chosen locator Type string to find the element.  
+* Element Name - A human readable string used to identify the element to the tester.  Used primarily in the log file.  
+* Locator Type - `:css` `:xpath` `:link` `:link_text` `:id` `:class` `:class_name` `:name` `:tag_name` are all valid.  
+* Locator - This is the chosen locator Type string to find the element.  
 
 It's important to remember that Elements are not actually found on the page, until an action is attempted.  Only then will the element be attempted to be located.
 
-##Helper Blog Posts:
+## Helper Blog Posts:
 [Beginner's Guide to Automated Testing](http://www.electricsheepdreams.com/2014/12/4/a-beginners-guide-to-automated-test-design)  
 [How to build Xpath locators](http://www.electricsheepdreams.com/2014/12/4/1wq9pbds8m9vktez0qc2w0r0xxlhp6)  
 [Browser Tools and Plugins](http://www.electricsheepdreams.com/2014/12/4/su5lssyi84k4ycrmuaceuswbf9ojwr)  
@@ -159,4 +201,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/sethus
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/gridium.gemspec

@@ -30,6 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~>2.3"
+  spec.add_development_dependency "dotenv", "~>2.1"
 
   spec.add_runtime_dependency "selenium-webdriver", ">= 2.50.0", "< 3"
   spec.add_runtime_dependency "oily_png", "~> 1.2"

data/lib/gridium/version.rb

@@ -1,3 +1,3 @@
 module Gridium
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/gridium.rb

@@ -8,6 +8,7 @@ require 'element_extensions'
 require 'element_verification'
 require 'page'
 require 's3'
+require 'testrail'
 
 module Gridium
   class << self
@@ -22,6 +23,7 @@ module Gridium
   class Config
     attr_accessor :report_dir, :browser_source, :target_environment, :browser, :url, :page_load_timeout, :element_timeout, :visible_elements_only, :log_level
     attr_accessor :highlight_verifications, :highlight_duration, :screenshot_on_failure, :screenshots_to_s3, :project_name_for_s3, :subdirectory_name_for_s3
+    attr_accessor :testrail
 
     def initialize
       @report_dir = Dir.home
@@ -39,6 +41,8 @@ module Gridium
       @screenshots_to_s3 = false
       @project_name_for_s3 = 'gridium'
       @subdirectory_name_for_s3 = '' #rely on GridiumS3 default
+      @testrail = false
     end
   end
+
 end

data/lib/testrail.rb

@@ -0,0 +1,116 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module Gridium
+	class TestRail
+		ENV_ERROR = "Environment Variable not set!"
+
+    #TestRail Statuses
+    PASSED = 1
+    BLOCKED = 2
+    UNTESTED = 3
+    RETEST = 4
+    FAILED = 5
+
+		def initialize
+      if Gridium.config.testrail
+        @url = ENV['GRIDIUM_TR_URL'].empty? || ENV['GRIDIUM_TR_URL'].nil? ? ENV_ERROR : ENV['GRIDIUM_TR_URL'] + '/index.php?/api/v2/'
+        @user = ENV['GRIDIUM_TR_USER'].empty? || ENV['GRIDIUM_TR_USER'].nil? ? ENV_ERROR : ENV['GRIDIUM_TR_USER']
+        @password = ENV['GRIDIUM_TR_PW'].empty? || ENV['GRIDIUM_TR_PW'].nil? ? ENV_ERROR : ENV['GRIDIUM_TR_PW']
+        @pid = ENV['GRIDIUM_TR_PID'].empty? || ENV['GRIDIUM_TR_PID'].nil? ? ENV_ERROR : ENV['GRIDIUM_TR_PID']
+      end
+		end
+
+    def add_run(name, desc)
+      if Gridium.config.testrail
+        Log.debug("[GRIDIUM::TestRail] Creating Test Run: name: #{name} desc: #{desc}")
+        if name.nil? || name.empty? then
+          raise(ArgumentError, "Empty Run Name - Run name is required")
+        end
+        r = _send_request('POST', "add_run/#{@pid}", {:name => name, :description => desc, :include_all => false})
+        Log.debug("Result: #{r}")
+        unless r["id"].nil?
+          @runid = r["id"]
+        end
+      end
+    end
+
+    def close_run
+      if Gridium.config.testrail
+        Log.debug("[GRIDIUM::TestRail] Closing RunID: #{@runid}")
+        unless @runid.nil?
+          r = _send_request('POST', "close_run/#{@runid}", nil)
+        end
+      end
+    end
+
+    def add_case(rspec_test)
+      if Gridium.config.testrail
+        Log.debug("[GRIDIUM::TestRail] Adding case: #{rspec_test} for RunID: #{@runid}")
+        if rspec_test.nil? then
+          raise(ArgumentError, "No test data was passed in.")
+        end
+        unless @runid.nil?
+          r = _send_request('POST', "update_run/#{@runid}", {:case_ids => [rspec_test.metadata[:testrail_id]]})
+          if rspec_test.exception
+            status = FAILED
+            message = rspec_test.exception.message
+          else
+            status = PASSED
+            message = ''
+          end
+          r = _send_request(
+            'POST',
+            "add_result_for_case/#{@runid}/#{rspec_test.metadata[:testrail_id]}",
+            status_id: status,
+            comment: message
+          )
+        end
+      end
+    end
+
+
+    private
+		def _send_request(method, uri, data)
+			url = URI.parse(@url + uri)
+			if method == 'POST'
+				request = Net::HTTP::Post.new(url.path + '?' + url.query)
+				request.body = JSON.dump(data)
+			else
+				request = Net::HTTP::Get.new(url.path + '?' + url.query)
+			end
+			request.basic_auth(@user, @password)
+			request.add_field('Content-Type', 'application/json')
+
+			conn = Net::HTTP.new(url.host, url.port)
+			if url.scheme == 'https'
+				conn.use_ssl = true
+				conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+			end
+			response = conn.request(request)
+
+			if response.body && !response.body.empty?
+				result = JSON.parse(response.body)
+			else
+				result = {}
+			end
+
+			if response.code != '200'
+				if result && result.key?('error')
+					error = '"' + result['error'] + '"'
+				else
+					error = 'No additional error message received'
+				end
+				raise APIError.new('TestRail API returned HTTP %s (%s)' %
+					[response.code, error])
+			end
+
+			result
+		end
+	end
+
+	class APIError < StandardError
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gridium
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Seth Urban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +160,7 @@ files:
 - lib/page.rb
 - lib/s3.rb
 - lib/spec_data.rb
+- lib/testrail.rb
 homepage: http://github.com/sethuster/gridium
 licenses:
 - MIT
@@ -153,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: This Gem is used to make building Selenium Tests without Capybara Easier.