watchdoge 0.0.22 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31cb08ec084f6a87288b884292874e815e92eef470404399230d08d22f8f4b33
-  data.tar.gz: 10a605d5e1c650c3952fd7402971f138cfc77adae9ea86433cd7d537579c9352
+  metadata.gz: 72caecca4e8bfaadd19424e647b0ddc3ff408b7d44b6f50c3941cd15fc2efcf5
+  data.tar.gz: df63f75a199c4840f3c5e8b175c264c11210952ec608a7b1397494c33f0a124f
 SHA512:
-  metadata.gz: b948cf7d631da31077c429d2b1eb653d15af77087cc2582d863930083f3c679a08c128f4a15c36a39747b34338fc036489e02b696348d30e7977b6546e0aa281
-  data.tar.gz: b6ea1174d59ee36afd315a8a0de8c3c21976471a36a158101858c73f405ad85b008cee33856fbacd1c4a8d583b2274dd62424fb8c6d116d0bd48c398b0f24f24
+  metadata.gz: 2da1305c69374b490a4f7e06a8055e4994bfd9651263aba4e764eb9454027ce318673c531e031a2f6858623981d3e8cc059937fa8e4fa76616766017a86c2266
+  data.tar.gz: f53c2328b8479be6dd9e0379dc6deb47d2b40b7699970eaa62b5fe198929771bcefbb95322c2951e165e84c301c90daff5be8302e9290b5744492071062db294

data/lib/watchdoge/configuration.rb

@@ -2,6 +2,24 @@ require 'watir'
 
 module WatchDoge
   class Configuration
+    class Hooks
+      attr_accessor :sign_in
+      attr_accessor :sign_out
+      attr_accessor :before_regression
+      attr_accessor :after_regression
+      attr_accessor :before_scenario
+      attr_accessor :after_scenario
+
+      def initialize
+        @sign_in = -> (worker, resource) {}
+        @sign_out = -> (worker, resource) {}
+        @before_regression  = -> {}
+        @after_regression   = -> {}
+        @before_scenario = -> {}
+        @after_scenario  = -> {}
+      end
+    end
+
     attr_accessor :base_dir
 
     attr_accessor :web_drivers_dir
@@ -12,9 +30,13 @@ module WatchDoge
 
     attr_accessor :notifications
 
-    attr_accessor :compare_host
-    attr_accessor :compare_dir
-    attr_accessor :user_authentication
+    attr_accessor :host
+    attr_accessor :regression_dir
+
+    attr_accessor :hooks
+
+    attr_accessor :chrome_version
+    attr_accessor :firefox_version
 
     def initialize
       @base_dir = Dir.pwd
@@ -44,21 +66,19 @@ module WatchDoge
         # }
       }
 
-      @compare_host = ''
+      @host = ''
 
-      @compare_dir =
+      @regression_dir =
         if defined?(Rails)
           @base_dir + "/test/watchdoge"
         else
           @base_dir + "/watchdoge"
         end
 
-      @user_authentication = {
-        sign_in: -> (worker, resource) {
-        },
-        sign_out: -> (worker, resource) {
-        }
-      }
+      @hooks = WatchDoge::Configuration::Hooks.new
+
+      @chrome_version = nil
+      @firefox_version = nil
     end
   end
 end

data/lib/watchdoge/install.rb

@@ -2,12 +2,39 @@ require 'net_http_ssl_fix'
 require 'webdrivers'
 
 module WatchDoge
-  class << self
-    def install_webdriver
-      Webdrivers.install_dir = configuration.web_drivers_dir
+  class InstallManager
+    attr_reader :driver
+    attr_reader :install_version
+    attr_reader :install_path
 
-      Webdrivers::Geckodriver.update
-      Webdrivers::Chromedriver.update
+    def initialize browser
+      @driver =
+        case browser
+        when :chrome
+          Webdrivers::Chromedriver
+        when :firefox
+          Webdrivers::Geckodriver
+        end
+
+      @install_version = (eval "WatchDoge.configuration.#{browser}_version") || @driver.latest_version.to_s
+
+      @install_path = "#{WatchDoge.configuration.web_drivers_dir}/#{browser}/#{@install_version}/"
+      Webdrivers.install_dir = @install_path
+
+      @driver.required_version = @install_version
+
+      @driver.update
+
+      klass = "Selenium::WebDriver::#{browser.to_s.split('_').collect(&:capitalize).join}::Service".constantize
+      binary =
+        case browser
+        when :chrome
+          "chromedriver"
+        when :firefox
+          "geckodriver"
+        end
+
+      klass.driver_path = "#{@install_path}/#{binary}"
     end
   end
 end

data/lib/watchdoge/notification.rb

@@ -18,12 +18,8 @@ module WatchDoge
       private
 
       def get_source_class source_sym
-        case source_sym
-        when :slack
-          WatchDoge::Notification::Slack
-        when :matter_most
-          WatchDoge::Notification::MatterMost
-        end
+        klass = source_sym.to_s.split('_').collect(&:capitalize).join
+        "WatchDoge::Notification::#{klass}".constantize
       end
     end
   end

data/lib/watchdoge/rails/generator.rb

@@ -3,11 +3,12 @@ module WatchDoge
     namespace 'watchdoge'
     argument :secenario
 
+
     def create_watchdoge_file
       configuration = WatchDoge.configuration
-      create_file "#{configuration.cookie_pool}/.placeholder"
+      empty_directory "#{configuration.cookie_pool}"
 
-      create_file "#{configuration.compare_dir}/scenarios/#{secenario}.rb", <<~DSL
+      create_file "#{configuration.regression_dir}/scenarios/#{secenario}.rb", <<~DSL
         # use :chrome
 
         # compare 'some url'
@@ -19,7 +20,7 @@ module WatchDoge
         #
       DSL
 
-      create_file "#{configuration.compare_dir}/reference/#{secenario}/.placeholder"
+      empty_directory "#{configuration.regression_dir}/reference/#{secenario}"
     end
   end
 end

data/lib/watchdoge/rails/railtie.rb

@@ -10,11 +10,11 @@ module WatchDoge
         end
         desc "generating reference images"
         task :make_reference => :environment do
-          WatchDoge::Compare::Manager.make_reference
+          WatchDoge::Regression::Manager.make_reference
         end
         desc "scrap screenshots and compare with reference images"
-        task :compare => :environment do
-          WatchDoge::Compare::Manager.compare_reference
+        task :regression => :environment do
+          WatchDoge::Regression::Manager.regression
         end
       end
     end

data/lib/watchdoge/{compare → regression}/dsl.rb

@@ -1,5 +1,5 @@
 module WatchDoge
-  module Compare
+  module Regression
     module DSL
       def use browser
         puts "[use] browser #{browser}"
@@ -8,11 +8,15 @@ module WatchDoge
       end
 
       def sign_in_as resoruce
+
         puts "[sign_in_as] #{resoruce}"
-        sign_in_proc.call(@worker, resoruce)
+        WatchDoge.hooks.sign_in.call(@worker, resoruce)
+
+        return unless block_given?
+
         yield(@worker)
         puts "sign_out #{resoruce}"
-        sign_out_proc.call(@worker, resoruce)
+        WatchDoge.hooks.sign_out.call(@worker, resoruce)
       end
 
       def with_viewport **kwargs
@@ -22,7 +26,7 @@ module WatchDoge
       end
 
       def compare path, **kwargs
-        path = URI.join(WatchDoge.configuration.compare_host, path).to_s
+        path = URI.join(WatchDoge.configuration.host, path).to_s
 
         @reference_file_name =
           if kwargs[:with]
@@ -50,7 +54,7 @@ module WatchDoge
         end
 
         @worker.resize_by_document(@view_port) do
-          @compare_proc.call(@worker)
+          @regression_proc.call(@worker)
         end
 
         @teardown_proc.call if @teardown_proc

data/lib/watchdoge/{compare → regression}/utils.rb

@@ -1,7 +1,7 @@
 require 'digest'
 
 module WatchDoge
-  module Compare
+  module Regression
     module Utils
       def load_png input
         raise 'Invalid Input' unless input.respond_to? :length
@@ -18,16 +18,16 @@ module WatchDoge
         end
       end
 
-      def compare_dir
-        WatchDoge.configuration.compare_dir
+      def regression_dir
+        WatchDoge.configuration.regression_dir
       end
 
       def scenarios_dir
-        "#{compare_dir}/scenarios"
+        "#{regression_dir}/scenarios"
       end
 
       def reference_dir
-        "#{compare_dir}/reference"
+        "#{regression_dir}/reference"
       end
     end
   end

data/lib/watchdoge/{compare.rb → regression.rb}

@@ -1,43 +1,49 @@
 module WatchDoge
-  module Compare
-    Dir["#{File.expand_path File.dirname(__FILE__)}/compare/*.rb"].each {|file| require file }
+  module Regression
+    Dir["#{File.expand_path File.dirname(__FILE__)}/regression/*.rb"].each {|file| require file }
 
     class Manager
-      extend WatchDoge::Compare::Utils
-      include WatchDoge::Compare::DSL
+      extend WatchDoge::Regression::Utils
+      include WatchDoge::Regression::DSL
 
       class << self
-        def compare_reference
-          @@compare_flag = :compare_reference
-          run_all_scenarios
+        def regression
+          run_all_scenarios :regression
         end
         def make_reference
-          @@compare_flag = :make_reference
-          run_all_scenarios
+          run_all_scenarios :make_reference
         end
 
         private
 
-        def run_all_scenarios
+        def run_all_scenarios regression_flag
+          WatchDoge.hooks.before_regression.call
+
           Dir["#{scenarios_dir}/*"].each do |scenario_path|
-            mgr = self.new scenario_path
+            WatchDoge.hooks.before_scenario.call
+
+            mgr = self.new scenario_path, regression_flag: regression_flag
             mgr.eval_scenario
+
+            WatchDoge.hooks.after_scenario.call
           end
+
+          WatchDoge.hooks.after_regression.call
         end
       end
 
-      def initialize scenario_path
+      def initialize scenario_path, regression_flag:
         @scenario_path = scenario_path
-        @scenario_name = File.basename scenario_path, '.rb'
+        @scenario_name = File.basename @scenario_path, '.rb'
 
-        case @@compare_flag
+        case regression_flag
         when :make_reference
-          @compare_proc = -> (worker) {
+          @regression_proc = -> (worker) {
             puts "  -> make reference images on worker #{worker}"
             worker.screenshot.save reference_image
           }
-        when :compare_reference
-          @compare_proc = -> (worker) {
+        when :regression
+          @regression_proc = -> (worker) {
             puts "  -> compare reference images on worker #{worker}"
             reference_image = self.class.load_png self.reference_image
             cycle_image = self.class.load_png worker.screenshot.png
@@ -68,13 +74,6 @@ module WatchDoge
         puts ""
       end
 
-      def sign_in_proc
-        WatchDoge.configuration.user_authentication[:sign_in]
-      end
-      def sign_out_proc
-        WatchDoge.configuration.user_authentication[:sign_out]
-      end
-
       def reference_image
         self.class.reference_dir + "/#{@scenario_name}/#{@reference_file_name}.png"
       end

data/lib/watchdoge/version.rb

@@ -1,3 +1,3 @@
 module WatchDoge
-  Version = '0.0.22'
+  Version = '0.1.0'
 end

data/lib/watchdoge/worker.rb

@@ -20,6 +20,7 @@ module WatchDoge
       @landed_page = nil
 
       # flag that cookie is loaded
+      @cookie_autosafe = false
       @cookie_loaded = false
 
       @width = default_opt[:width]
@@ -85,8 +86,6 @@ module WatchDoge
     private
     # callbacks before/after init
     def _before_initialize
-      Selenium::WebDriver::Firefox::Service.driver_path = WatchDoge.configuration.web_drivers_dir + "/geckodriver"
-      Selenium::WebDriver::Chrome::Service.driver_path = WatchDoge.configuration.web_drivers_dir + "/chromedriver"
       @http = Selenium::WebDriver::Remote::Http::Default.new
       @browser = WatchDoge.configuration.browser
     end
@@ -119,7 +118,9 @@ module WatchDoge
       @cookie_loaded
     end
     def _save_cookie
-      @core.cookies.save WatchDoge::CookiePool.source(@uuid, @landed_page)
+      if @cookie_autosafe
+        @core.cookies.save WatchDoge::CookiePool.source(@uuid, @landed_page)
+      end
     end
     def _load_cookie
       source = WatchDoge::CookiePool.source(@uuid, @landed_page)

data/lib/watchdoge.rb

@@ -6,7 +6,7 @@ require 'watchdoge/cookie_pool'
 require 'watchdoge/worker'
 require 'watchdoge/notification'
 require 'watchdoge/image_diff'
-require 'watchdoge/compare'
+require 'watchdoge/regression'
 require 'watchdoge/rails/railtie' if defined?(Rails)
 require 'watchdoge/rails/generator' if defined?(Rails)
 
@@ -16,6 +16,10 @@ module WatchDoge
       configuration.base_dir
     end
 
+    def hooks
+      configuration.hooks
+    end
+
     def configure(&block)
       yield(configuration)
       configuration
@@ -25,7 +29,7 @@ module WatchDoge
       @_configuration ||= Configuration.new
     end
 
-    def load_configuration
+    def initialize!
       path = ENV['WATCHDOGE_CONFIG'] ||
         if defined?(Rails)
           "#{Dir.pwd}/config/watchdoge.rb"
@@ -37,5 +41,3 @@ module WatchDoge
     end
   end
 end
-
-WatchDoge.load_configuration

data/watchdoge.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'watchdoge'
-  s.version     = '0.0.22'
+  s.version     = '0.1.0'
   s.date        = '2019-07-22'
   s.summary     = "dogi"
   s.description = "A collection of web test tools"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watchdoge
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.1.0
 platform: ruby
 authors:
 - Shen Lee
@@ -112,9 +112,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - lib/watchdoge.rb
-- lib/watchdoge/compare.rb
-- lib/watchdoge/compare/dsl.rb
-- lib/watchdoge/compare/utils.rb
 - lib/watchdoge/configuration.rb
 - lib/watchdoge/cookie_pool.rb
 - lib/watchdoge/image_diff.rb
@@ -124,6 +121,9 @@ files:
 - lib/watchdoge/notification/slack.rb
 - lib/watchdoge/rails/generator.rb
 - lib/watchdoge/rails/railtie.rb
+- lib/watchdoge/regression.rb
+- lib/watchdoge/regression/dsl.rb
+- lib/watchdoge/regression/utils.rb
 - lib/watchdoge/version.rb
 - lib/watchdoge/worker.rb
 - watchdoge.gemspec