gridium 1.1.39 → 1.1.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c87afa06bbdeefbfd41eee62c6cc5a5af18698a6
-  data.tar.gz: 4ff0a6d5254bb94cab3325975384e6f0ec20faf6
+  metadata.gz: f26680684a7be03d71d24283694c5fdf8e091d63
+  data.tar.gz: 269bc03184b510b21ea7d09aa0c982e347029879
 SHA512:
-  metadata.gz: e58e927badaab9547d7564c86db383ef913290db08cb41c4595fbc5b683a0e15fed521d34440032e547304699a1d587a38c9b28f64c5606a73dafc229a392799
-  data.tar.gz: 45839f28c4a1ff4972fe5ca5c20aed05481fd07466292302f1dddfae09dc9793c4b329d39841015982a63ad525ca9a8c026d80a3e0903c4dfb4cdb65695dd92f
+  metadata.gz: 320b3b36f28fc2785d3279595e0445f9ca67d4943d63fc79ca9fdcc0c28856c3d957cec333634d38659fd616483a290fa9dcc7b85e0d9c91880193aebae9ad58
+  data.tar.gz: 5a3f4adea5579fd9d6c9382292eb2dfa3a16f4c6c5a461e3ad60453fe470419c6e7d14e1216ec874aec5f2a7fbf09d22324f2f2d8b3b8440982ff122cce48e01

data/docker-compose.yml

@@ -5,7 +5,9 @@ services:
     ports:
       - "4444"
     environment:
-      - GRID_BROWSER_TIMEOUT=30
+      SE_OPTS: -browserTimeout 30
+      JAVA_OPTS: -Xmx1024m
+
   chrome:
     image: selenium/node-chrome-debug:3.1.0
     depends_on:
@@ -15,16 +17,22 @@ services:
       - HUB_PORT_4444_TCP_PORT=4444
       - no_proxy=localhost
       - HUB_ENV_no_proxy=localhost
+    shm_size: 2048M
+    volumes:
+      - /dev/shm:/dev/shm
     ports:
       - "5900:5900"
+
   mustadio:
     image: yetanotherlucas/mustadio
     ports:
       - "3000"
+
   the-internet:
     image: gprestes/the-internet
     ports:
       - "5000"
+
   gridium:
     build: .
     environment:

data/lib/driver.rb

@@ -4,6 +4,7 @@ require 'spec_data'
 
 class Driver
   @@driver = nil
+  @@s3 = nil
 
   def self.reset
     Log.debug("[Gridium::Driver] Driver.reset: #{@@driver}")
@@ -14,15 +15,33 @@ class Driver
     # Ensure the browser is maximized to maximize visibility of element
     # Currently doesn't work with chromedriver, but the following workaround does:
     if @browser_type.eql?(:chrome)
+      driver.manage.window.move_to(0, 0)
       width = driver.execute_script("return screen.width;")
       height = driver.execute_script("return screen.height;")
-      driver.manage.window.move_to(0, 0)
       driver.manage.window.resize_to(width, height)
+      driver.manage.window.move_to(0, 0)
     else
       driver.manage.window.maximize
     end
   end
 
+  def self.s3
+    unless @@s3
+      if Gridium.config.screenshots_to_s3
+        #do stuff
+        s3_project_folder = Gridium.config.project_name_for_s3
+        s3_subfolder = Gridium.config.subdirectory_name_for_s3
+        Log.debug("[Gridium::Driver] configuring s3 to save files to this directory: #{s3_project_folder} in addition to being saved locally")
+        @@s3 = Gridium::GridiumS3.new(s3_project_folder, s3_subfolder)
+        Log.debug("[Gridium::Driver] s3 is #{@@s3}")
+      else
+        Log.debug("[Gridium::Driver] s3 screenshots not enabled in spec_helper; they will be only be saved locally")
+      end
+    end
+
+    @@s3
+  end
+
   def self.driver
     unless @@driver
       Log.debug("[Gridium::Driver]  Driver.driver: instantiating new driver")
@@ -40,19 +59,10 @@ class Driver
       else
         @@driver = Selenium::WebDriver.for(Gridium.config.browser, desired_capabilities: _set_capabilities)
       end
-      if Gridium.config.screenshots_to_s3
-        #do stuff
-        s3_project_folder = Gridium.config.project_name_for_s3
-        s3_subfolder = Gridium.config.subdirectory_name_for_s3
-        Log.debug("[Gridium::Driver] configuring s3 to save files to this directory: #{s3_project_folder} in addition to being saved locally")
-        @s3 = Gridium::GridiumS3.new(s3_project_folder, s3_subfolder)
-        Log.debug("[Gridium::Driver] s3 is #{@s3}")
-      else
-        Log.debug("[Gridium::Driver] s3 screenshots not enabled in spec_helper; they will be only be saved locally")
-        @s3 = nil
-      end
+
       reset
     end
+
     _log_shart #push out logs before doing something with selenium
     @@driver
   rescue StandardError => e
@@ -103,11 +113,6 @@ class Driver
     )
   end
 
-  def self.s3
-    #TODO figure out why I can't just use attr_reader :s3
-    @s3
-  end
-
   def self.driver= driver
     @@driver.quit if @@driver
     @@driver = driver
@@ -264,7 +269,7 @@ class Driver
 
     # Push the screenshot up to S3?
     if Gridium.config.screenshots_to_s3
-      screenshot_path = @s3.save_file(local_path)
+      screenshot_path = s3.save_file(local_path)
       Log.info("[Gridium::Driver] #{filename} uploaded to S3 at '#{screenshot_path}'")
     end
 

data/lib/s3.rb

@@ -1,72 +1,74 @@
 require 'aws-sdk'
-module Gridium
-
-    class GridiumS3
 
-        DELIMITER = "/"
+module Gridium
+  class GridiumS3
+    def initialize(project_name, subdirectory_path='screenshots')
+      Log.debug("[GRIDIUM::S3] initializing GridiumS3 with #{project_name} and #{subdirectory_path}")
+      Aws.config.update({ credentials: Aws::Credentials.new(ENV['S3_ACCESS_KEY_ID'], ENV['S3_SECRET_ACCESS_KEY']) , region: ENV['S3_DEFAULT_REGION']})
+      _validate_string(project_name)
+      _validate_string(subdirectory_path)
 
-        def initialize(project_name, subdirectory_name='screenshots')
-            Log.debug("[GRIDIUM::S3] initializing GridiumS3 with #{project_name} and #{subdirectory_name}")
-            Aws.config.update({ credentials: Aws::Credentials.new(ENV['S3_ACCESS_KEY_ID'], ENV['S3_SECRET_ACCESS_KEY']) , region: ENV['S3_DEFAULT_REGION']})
-            _validate_string(project_name)
-            _validate_string(subdirectory_name)
-            @project_name = _sanitize_string(project_name)
-            @subdirectory_name = _sanitize_string(subdirectory_name)
-            @bucket = Aws::S3::Resource.new().bucket(ENV['S3_ROOT_BUCKET'])
-        end
+      @project_name = _sanitize_string(project_name)
+      @subdirectory_path = _sanitize_string(subdirectory_path)
+      @bucket = Aws::S3::Resource.new.bucket(ENV['S3_ROOT_BUCKET'])
+    end
 
-        def save_file(absolute_path_of_file)
-            Log.debug("[GRIDIUM::S3] attempting to save #{absolute_path_of_file} to s3")
-            _validate_path(absolute_path_of_file)
-            file_name = File.basename(absolute_path_of_file)
-            destination_name = create_s3_name(file_name)
-            begin
-              @bucket.object(destination_name).upload_file(absolute_path_of_file)
-              @bucket.object(destination_name).wait_until_exists
-              _verify_upload(destination_name, absolute_path_of_file)
-              # @bucket.object(s3_name).presigned_url(:get, expires_in: 3600) #uncomment this if public url ends up not working out OPREQ-83850
-              return @bucket.object(destination_name).public_url
-            rescue Aws::S3::Errors::InvalidAccessKeyId
-              Log.error("[GRIDIUM::S3] unable to save file to s3 due to Aws::S3::Errors::InvalidAccessKeyId")
-            rescue Seahorse::Client::NetworkingError => error
-              Log.error("[GRIDIUM::S3] unable to save file to s3 due to underlying network error: #{error}")
-            rescue StandardErrer => error
-              Log.error("[GRIDIUM::S3] unable to save file to s3 due to unexpected error: #{error}")
-            end
-        end
+    # Save local file to S3 bucket
+    # @param [String] local_path
+    # @return [String] s3 public url
+    def save_file(local_path)
+      Log.debug("[GRIDIUM::S3] attempting to save '#{local_path}' to s3")
+      _validate_path(local_path)
+      file_name = File.basename(local_path)
+      destination_name = create_s3_name(file_name)
+      begin
+        @bucket.object(destination_name).upload_file(local_path)
+        @bucket.object(destination_name).wait_until_exists
+        _verify_upload(destination_name, local_path)
+        # @bucket.object(s3_name).presigned_url(:get, expires_in: 3600) #uncomment this if public url ends up not working out OPREQ-83850
+        return @bucket.object(destination_name).public_url
+      rescue Aws::S3::Errors::InvalidAccessKeyId
+        Log.error("[GRIDIUM::S3] unable to save file to s3 due to Aws::S3::Errors::InvalidAccessKeyId")
+      rescue Seahorse::Client::NetworkingError => error
+        Log.error("[GRIDIUM::S3] unable to save file to s3 due to underlying network error: #{error}")
+      rescue StandardErrer => error
+        Log.error("[GRIDIUM::S3] unable to save file to s3 due to unexpected error: #{error}")
+      end
+    end
 
-        def create_s3_name(file_name)
-            _validate_string(file_name)
-            file_name = _sanitize_string(file_name)
-            joined_name = [@project_name, @subdirectory_name, file_name].join(DELIMITER)
-            joined_name
-        end
+    def create_s3_name(file_name)
+      _validate_string(file_name)
+      file_name = _sanitize_string(file_name)
+      [@project_name, @subdirectory_path, file_name].join("/")
+    end
 
-        def _sanitize_string(input_string)
-            #remove left/right whitespace, split and join to collapse contiguous white space, replace whitespace and non-period special chars with underscore
-            input_string = input_string.strip().split.join(" ").gsub(/[^\w.]/i, '_')
-            input_string
-        end
+    #
+    # @note Strips whitespace, split and join to collapse contiguous white space,
+    #       replace whitespace and special chars (not '.', '/') with an underscore
+    #
+    def _sanitize_string(input_string)
+      input_string.strip.split.join(" ").gsub(/[^\w.\/]/i, '_')
+    end
 
-        def _validate_string(input_string)
-            Log.debug("[GRIDIUM::S3] attempting to validate #{input_string} for use as a name")
-            if input_string.empty? or input_string.strip().empty? then
-                raise(ArgumentError, "[GRIDIUM::S3] empty and/or whitespace file names are not wanted here.")
-            end
-        end
+    def _validate_string(input_string)
+      Log.debug("[GRIDIUM::S3] attempting to validate #{input_string} for use as a name")
+      if input_string.empty? || input_string.strip.empty?
+        raise(ArgumentError, "[GRIDIUM::S3] empty and/or whitespace file names are not wanted here.")
+      end
+    end
 
-        def _validate_path(path_to_file)
-            Log.debug("[GRIDIUM::S3]  attempting to validate #{path_to_file} as a legitimate path")
-            if not File.exist? path_to_file then
-                raise(ArgumentError, "[GRIDIUM::S3] this path doesn't resolve #{path_to_file}")
-            end
-        end
+    def _validate_path(path_to_file)
+      Log.debug("[GRIDIUM::S3]  attempting to validate #{path_to_file} as a legitimate path")
+      unless File.exist? path_to_file
+        raise(ArgumentError, "[GRIDIUM::S3] this path doesn't resolve #{path_to_file}")
+      end
+    end
 
-        def _verify_upload(s3_name, local_absolute_path)
-            upload_size = @bucket.object(s3_name).content_length
-            local_size = File.size local_absolute_path
-            Log.debug("[GRIDIUM::S3] file upload verified: #{upload_size == local_size}. upload size is #{upload_size} and local size is #{local_size}")
-            upload_size == local_size
-        end
+    def _verify_upload(s3_name, local_absolute_path)
+      upload_size = @bucket.object(s3_name).content_length
+      local_size = File.size local_absolute_path
+      Log.debug("[GRIDIUM::S3] file upload verified: #{upload_size == local_size}. upload size is #{upload_size} and local size is #{local_size}")
+      upload_size == local_size
     end
+  end
 end

data/lib/testrail.rb

@@ -65,13 +65,17 @@ module Gridium
           message = rspec_test.exception.message
           screenshot_url = rspec_test.metadata[:screenshot_url]
           if screenshot_url
-            message << "\n - Screenshot: #{screenshot_url}"
+            message << "\n - Screenshot: #{screenshot_url}\n"
           end
 
           # add backtrace to test case
           bt_search_re = rspec_test.metadata[:backtrace_regex] || 'sitetestui'
           bt = rspec_test.exception.backtrace.grep(/#{bt_search_re}/)
-          message << "\n\n # " + bt.join("\n # ") unless bt.empty?
+          message << "\n\n -> " + bt.join("\n -> ") unless bt.empty?
+
+          # replace rspec backtick (`): special formatting for TestRail
+          # http://docs.gurock.com/testrail-userguide/userguide-editor
+          message.gsub!('`', "'")
         else
           status = CONFIG[:pass]
           message = 'Test Passed.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gridium
 version: !ruby/object:Gem::Version
-  version: 1.1.39
+  version: 1.1.42
 platform: ruby
 authors:
 - Seth Urban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler