gridium 0.1.21 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf751acc7432fc7e919c8bc1d1f74f8b5a21029e
-  data.tar.gz: 558a5a0eedbc3437dee61396a694269bb1e842d7
+  metadata.gz: 6756e4e593e9c99a266fe4bfb1c1c1f3a4412743
+  data.tar.gz: a7923e3514793d68fb2b60297a8792cfd0225d0e
 SHA512:
-  metadata.gz: f39e4d62c68af7a47d4809d634305af954366dacdd2d24302bb54352295fc6d4581cf4255924f3d15dfa6ee0c287a99dbc8f17ae1da3ae6a8cb0a2ca8aec6d2f
-  data.tar.gz: ac3e6e2828465e3934df04647f07e9f40182f03b1199494da87acd7f12f925a9824d12b8cb7e59da1db4482f0889bc48a1a19ec0069a3db8c0cf83554a218403
+  metadata.gz: e07a44f3e1b61c6799b1ff4e323c4ce78b80df02ec0415456e925cc00364baf1cfbc632f9a92380e5d30f7fab38d64c89bab7651d76ab459bb91a229930394b7
+  data.tar.gz: aa89e4c7e8fa3f84bff99f9adde4ba50850291a470457529fb02336d146ac141353b090ebb7270767b44d348aac27d39df6b5c4b79702f75360465679180427b

data/Gemfile

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in gridium.gemspec
 gemspec
 
-gem 'rspec-mocks'
+gem 'rspec-mocks'
+gem 'aws-sdk', '~> 2'

data/lib/driver.rb

@@ -11,6 +11,7 @@ class Driver
     driver.manage.timeouts.page_load = Gridium.config.page_load_timeout
     driver.manage.timeouts.implicit_wait = Gridium.config.element_timeout
 
+    # Ensure the browser is maximized to maximize visibility of element
     # 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)
@@ -24,9 +25,9 @@ class Driver
   end
 
   def self.driver
-    Log.debug("=====> Driver.driver: #{@@driver}")
     begin
       unless @@driver
+        Log.debug("=====> Driver.driver: instantiating new driver")
         @browser_type = Gridium.config.browser
         ##Adding support for remote browsers
         if Gridium.config.browser_source == :remote
@@ -40,6 +41,17 @@ class Driver
         else
           @@driver = Selenium::WebDriver.for(Gridium.config.browser)
         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("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("s3 is #{@s3}")
+        else
+          Log.debug("s3 screenshots not enabled in spec_helper; they will be only be saved locally")
+          @s3 = nil
+        end
         reset
       end
       @@driver
@@ -51,6 +63,12 @@ class Driver
     end
   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
@@ -180,9 +198,19 @@ class Driver
     timestamp = Time.now.strftime("%Y_%m_%d__%H_%M_%S")
     screenshot_path = File.join($current_run_dir, "screenshot__#{timestamp}__#{type}.png")
     driver.save_screenshot(screenshot_path)
+    _save_to_s3_if_configured(screenshot_path)
     SpecData.screenshots_captured.push("screenshot__#{timestamp}__#{type}.png")   # used by custom_formatter.rb for embedding in report
+    screenshot_path
   end
 
+  def self._save_to_s3_if_configured(screenshot_path)
+    if Gridium.config.screenshots_to_s3
+      url = @s3.save_file(screenshot_path)
+      Log.info("#{screenshot_path} saved to #{url}")
+    end
+  end
+
+
   def self.list_open_windows
     handles = driver.window_handles
     Log.debug("List of active windows:")

data/lib/gridium.rb

@@ -7,6 +7,7 @@ require 'element'
 require 'element_extensions'
 require 'element_verification'
 require 'page'
+require 's3'
 
 module Gridium
   class << self
@@ -20,7 +21,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
+    attr_accessor :highlight_verifications, :highlight_duration, :screenshot_on_failure, :screenshots_to_s3, :project_name_for_s3, :subdirectory_name_for_s3
 
     def initialize
       @report_dir = Dir.home
@@ -35,6 +36,9 @@ module Gridium
       @highlight_verifications = false
       @highlight_duration = 0.100
       @screenshot_on_failure = false
+      @screenshots_to_s3 = false
+      @project_name_for_s3 = 'gridium'
+      @subdirectory_name_for_s3 = '' #rely on GridiumS3 default
     end
   end
 end

data/lib/gridium/version.rb

@@ -1,3 +1,3 @@
 module Gridium
-  VERSION = "0.1.21"
+  VERSION = "0.2.0"
 end

data/lib/log.rb

@@ -86,6 +86,7 @@ module Gridium
         @@devices ||= []
         log.attach(device)
         @@devices << device
+        log.add(log.level, "device added: #{File.absolute_path(device)}")
       end
 
       def close
@@ -134,7 +135,6 @@ module Gridium
             "#{base_msg} X #{msg}\n"
           end
         end
-
         logger
       end # initialize_logger
     end # class << self

data/lib/s3.rb

@@ -0,0 +1,70 @@
+require 'aws-sdk'
+module Gridium
+
+
+    class GridiumS3
+
+        ACCESS_KEY_ID = ENV['S3_ACCESS_KEY_ID']
+        SECRET_ACCESS_KEY = ENV['S3_SECRET_ACCESS_KEY']
+        DEFAULT_REGION = ENV['S3_DEFAULT_REGION']
+        ROOT_BUCKET = ENV['S3_ROOT_BUCKET']
+        DELIMITER = "/"
+
+
+        def initialize(project_name, subdirectory_name='screenshots')
+            Log.debug("initializing GridiumS3 with #{project_name} and #{subdirectory_name}")
+            Aws.config.update({ credentials: Aws::Credentials.new(ACCESS_KEY_ID, SECRET_ACCESS_KEY) ,region: 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(ROOT_BUCKET)
+        end
+
+        def save_file(absolute_path_of_file)
+            Log.debug("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)
+            @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
+            @bucket.object(destination_name).public_url
+        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 _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
+
+        def _validate_string(input_string)
+            Log.debug("attempting to validate #{input_string} for use as a name") 
+            if input_string.empty? or input_string.strip().empty? then
+                raise(ArgumentError, "empty and/or whitespace file names are not wanted here.")
+            end
+        end
+
+        def _validate_path(path_to_file)
+            Log.debug("attmepting to validate #{path_to_file} as a legitimate path")
+            if not File.exist? path_to_file then
+                raise(ArgumentError, "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("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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gridium
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.2.0
 platform: ruby
 authors:
 - Seth Urban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - lib/gridium/version.rb
 - lib/log.rb
 - lib/page.rb
+- lib/s3.rb
 - lib/spec_data.rb
 homepage: http://github.com/sethuster/gridium
 licenses: