watchdoge 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c995950dde2c446b458210461e4d03b32a78d065a025fbd2e42392c28a6a67a
-  data.tar.gz: 429647c25c17feab2e9d28bb70033d9fec91e7889dec358fc077f36cd97da72e
+  metadata.gz: 71714f5bc076271d8af037b38803c0cf9a9c7cd6e5c175797f745dc2fd252a23
+  data.tar.gz: ec97e6dc2ee067065bc421381494053f60a8cee1b2045555149638f1dc1c5da9
 SHA512:
-  metadata.gz: 03b3eb8808e20dbaf82f96c19b2c25370a1145b2f2866c85e3d7357d331249d14be692f2a37d30a69dc00bb4ce42d64a0409a82cc869395372d9b178131e1d23
-  data.tar.gz: 4f0270dbc0c3f3f1c20bc39a55b1716d814ac0a3bb6b95cb874b817f7961c873edf82987c919841f3ef72f2484098ef75480e23d2aa7cbbc495e61f77392657f
+  metadata.gz: 3aef4519d9442b54a1bf4f80ac7bb18423e65989be58007bcc591fe8db556676423c4c14e834f05c80bab2aac8eeda360ef70e1f0a3102912d2d027b34ba77ad
+  data.tar.gz: 8710792cc8b2d9cad0bd75be198dfda0c87a16d754a31abd4bffaed3bbc811149bea92b7b566136debec686d60ac2c1039e69f0ac8cc9f353fed44f6a254cab0

data/.gitignore

@@ -1,3 +1,5 @@
 .doge_cookie/
 .webdrivers/
 lib/test.rb
+lib/compare
+*.gem

data/lib/watchdoge/compare/dsl.rb

@@ -0,0 +1,53 @@
+module WatchDoge
+  module Compare
+    module DSL
+      def use browser
+        puts "[use] browser #{browser}"
+        @worker.close
+        @worker = WatchDoge::Worker.new @scenario_name, browser: browser
+      end
+
+      def sign_in_as resoruce
+        puts "[sign_in_as] #{resoruce}"
+        sign_in_proc.call(@worker, resoruce)
+        yield(@worker)
+        puts "sign_out #{resoruce}"
+        sign_out_proc.call(@worker, resoruce)
+      end
+
+      def compare path, **kwargs
+        path = URI.join(WatchDoge.configuration.compare_host, path).to_s
+        @reference_file_name =
+          if kwargs[:with]
+            kwargs[:with]
+          else
+            path.gsub(/^.*(\\|\/)/, '')
+          end
+
+        puts "[compare] #{path} #{'[with]'+ @reference_file_name if kwargs[:with] }"
+
+        @setup_proc.call if @setup_proc
+
+        args = {
+          before: nil
+        }.merge(kwargs)
+
+        args[:before].call if args[:before]
+
+        @worker.goto path
+
+        @compare_proc.call(@worker)
+
+        @teardown_proc.call if @teardown_proc
+      end
+
+      def setup
+        @setup_proc = -> { yield }
+      end
+
+      def teardown
+        @teardown_proc = -> { yield }
+      end
+    end
+  end
+end

data/lib/watchdoge/compare/utils.rb

@@ -0,0 +1,34 @@
+require 'digest'
+
+module WatchDoge
+  module Compare
+    module Utils
+      def load_png input
+        raise 'Invalid Input' unless input.respond_to? :length
+
+        png_magic = ["89", "50", "4E", "47"]
+
+        is_png_blob =
+          (input.length > 3 && input[0..3].each_byte.map {|t| t.to_s(16).upcase} == png_magic)
+
+        if is_png_blob
+          ChunkyPNG::Image.from_blob input
+        else
+          ChunkyPNG::Image.from_file input
+        end
+      end
+
+      def compare_dir
+        WatchDoge.configuration.compare_dir
+      end
+
+      def scenarios_dir
+        "#{compare_dir}/scenarios"
+      end
+
+      def reference_dir
+        "#{compare_dir}/reference"
+      end
+    end
+  end
+end

data/lib/watchdoge/compare.rb

@@ -0,0 +1,76 @@
+module WatchDoge
+  module Compare
+    Dir["#{File.expand_path File.dirname(__FILE__)}/compare/*.rb"].each {|file| require file }
+
+    class Manager
+      extend WatchDoge::Compare::Utils
+      include WatchDoge::Compare::DSL
+
+      class << self
+        def compare_reference
+          @@compare_flag = :compare_reference
+          run_all_scenarios
+        end
+        def make_reference
+          @@compare_flag = :make_reference
+          run_all_scenarios
+        end
+
+        private
+
+        def run_all_scenarios
+          Dir["#{scenarios_dir}/*"].each do |scenario_path|
+            mgr = self.new scenario_path
+            mgr.eval_scenario
+          end
+        end
+      end
+
+      def initialize scenario_path
+        @scenario_path = scenario_path
+        @scenario_name = File.basename scenario_path, '.rb'
+
+        case @@compare_flag
+        when :make_reference
+          @compare_proc = -> (worker) {
+            puts "  -> with make reference on worker #{worker}"
+            worker.fullpage_screenshot.save reference_image
+          }
+        when :compare_reference
+          @compare_proc = -> (worker) {
+            puts "  -> with co,pare reference on worker #{worker}"
+            reference_image = self.class.load_png self.reference_image
+            cycle_image = self.class.load_png worker.fullpage_screenshot.png
+            diff = WatchDoge::ImageDiff.diff(cycle_image, reference_image)
+            WatchDoge::Notification.push diff if diff
+          }
+        end
+
+        @setup_proc = nil
+        @teardown_proc = nil
+
+        @worker = WatchDoge::Worker.new @scenario_name
+        @_authorized = false
+      end
+
+      def eval_scenario
+        puts "scenario: #{@scenario_name} begin"
+        eval File.read(@scenario_path)
+        @worker.close
+        puts "scenario: #{@scenario_name} end\n"
+        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
+    end
+  end
+end

data/lib/watchdoge/configuration.rb

@@ -3,21 +3,33 @@ require 'watir'
 module WatchDoge
   class Configuration
     attr_accessor :base_dir
+
     attr_accessor :web_drivers_dir
     attr_accessor :engine
+    attr_accessor :browser
     attr_accessor :cookie_pool
+
     attr_accessor :notifications
 
+    attr_accessor :compare_host
+    attr_accessor :compare_dir
+    attr_accessor :user_authentication
+
     def initialize
-      @base_dir = File.expand_path(File.dirname(__FILE__) + '/..')
+      @base_dir =
+        if defined?(Rails)
+          Rails.root.to_s
+        else
+          Dir.pwd
+        end
 
       @web_drivers_dir = @base_dir + "/.webdrivers"
+      @engine = Watir::Browser
+      @browser = :firefox
 
       # cuurently using local fs, probably support NoSQL also maybe?
       @cookie_pool = @base_dir + '/.doge_cookie'
 
-      @engine = Watir::Browser
-
       @notifications = {
         # slack: {
         #   incoming_url: SLACK_WEBHOOK
@@ -33,6 +45,22 @@ module WatchDoge
         #   auth_token: 'AUTH_TOKEN'
         # }
       }
+
+      @compare_host = ''
+
+      @compare_dir =
+        if defined?(Rails)
+          @base_dir + "/test/watchdoge"
+        else
+          @base_dir + "/watchdoge"
+        end
+
+      @user_authentication = {
+        sign_in: -> (worker, resource) {
+        },
+        sign_out: -> (worker, resource) {
+        }
+      }
     end
   end
 end

data/lib/watchdoge/image_diff.rb

@@ -1,26 +1,29 @@
 module WatchDoge
   module ImageDiff
-    OPACITY = 0.6
+    OPACITY = 0.7
     HIGHLIGHT_COLOR = "#F163FF#{(OPACITY * 256).to_i.to_s(16).upcase}"
 
     class << self
-      def diff input_image, golden_image
-        return nil if input_image.pixels.hash == golden_image.pixels.hash
+      def diff input_image, reference_image
+        return nil if input_image.pixels.hash == reference_image.pixels.hash
 
         input_image.height.times do |y|
           pixels = input_image.row(y)
 
-          if y >= golden_image.height
+          if y >= reference_image.height
             pixels.each_with_index do |pixel, x|
               input_image.compose_pixel(x, y, HIGHLIGHT_COLOR)
             end
           else
-            golden_pixels = golden_image.row(y)
+            reference_pixels = reference_image.row(y)
 
-            next if (pixels.hash == golden_pixels.hash)
+            next if (pixels.hash == reference_pixels.hash)
 
             pixels.each_with_index do |pixel, x|
-              input_image.compose_pixel(x, y, HIGHLIGHT_COLOR) if pixels[x] != golden_pixels[x]
+              if pixels[x] != reference_pixels[x]
+                input_image.compose_pixel(x, y, reference_pixels[x])
+                input_image.compose_pixel(x, y, HIGHLIGHT_COLOR)
+              end
             end
           end
         end

data/lib/watchdoge/install.rb

@@ -3,13 +3,11 @@ require 'webdrivers'
 
 module WatchDoge
   class << self
-    def install
+    def install_webdriver
       Webdrivers.install_dir = configuration.web_drivers_dir
 
-      # TODO: Support other browser maybe?
       Webdrivers::Geckodriver.update
-
-      Dir.mkdir configuration.cookie_pool unless File.directory? configuration.cookie_pool
+      Webdrivers::Chromedriver.update
     end
   end
 end

data/lib/watchdoge/rails/generator.rb

@@ -0,0 +1,23 @@
+module WatchDoge
+  class WatchDogeGenerator < Rails::Generators::Base
+    namespace 'watchdoge'
+    argument :secenario
+
+    def create_watchdoge_file
+      configuration = WatchDoge.configuration
+      create_file "#{configuration.cookie_pool}/.placeholder"
+
+      create_file "#{configuration.compare_dir}/scenarios/#{secenario}.rb", <<~DSL
+        # compare 'some url'
+        # compare 'some url', with: 'some'
+
+        # sign_in_as 'resource' do
+        #   compare 'some url', with: 'test'
+        # end
+        #
+      DSL
+
+      create_file "#{configuration.compare_dir}/reference/#{secenario}/.placeholder"
+    end
+  end
+end

data/lib/watchdoge/rails/railtie.rb

@@ -0,0 +1,22 @@
+require "rails"
+
+module WatchDoge
+  class WatchDogeTask < Rails::Railtie
+    rake_tasks do
+      namespace :watchdoge do
+        desc "install web drivers"
+        task :install_webdrivers => :environment do
+          WatchDoge.install_webdriver
+        end
+        desc "generating reference images"
+        task :make_reference => :environment do
+          WatchDoge::Compare::Manager.make_reference
+        end
+        desc "scrap screenshots and compare with reference images"
+        task :compare => :environment do
+          WatchDoge::Compare::Manager.compare_reference
+        end
+      end
+    end
+  end
+end

data/lib/watchdoge/version.rb

@@ -1,3 +1,3 @@
 module WatchDoge
-  Version = '0.0.3'
+  Version = '0.0.4'
 end

data/lib/watchdoge/worker.rb

@@ -26,10 +26,10 @@ module WatchDoge
       default_opt = {
         width: 1024,
         height: 768,
-        headless: true
+        headless: true,
+        browser: WatchDoge.configuration.browser
       }.merge(opt)
-
-      @core = WatchDoge.configuration.engine.new :firefox, default_opt
+      @core = WatchDoge.configuration.engine.new default_opt[:browser], default_opt
 
       # for generate uri hash
       @landed_page = nil

data/lib/watchdoge.rb

@@ -6,6 +6,9 @@ require 'watchdoge/cookie_pool'
 require 'watchdoge/worker'
 require 'watchdoge/notification'
 require 'watchdoge/image_diff'
+require 'watchdoge/compare'
+require 'watchdoge/rails/railtie' if defined?(Rails)
+require 'watchdoge/rails/generator' if defined?(Rails)
 
 module WatchDoge
   class << self

data/watchdoge.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'watchdoge'
-  s.version     = '0.0.3'
+  s.version     = '0.0.4'
   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.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Shen Lee
@@ -112,6 +112,9 @@ 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
@@ -119,9 +122,10 @@ files:
 - lib/watchdoge/notification.rb
 - lib/watchdoge/notification/matter_most.rb
 - lib/watchdoge/notification/slack.rb
+- lib/watchdoge/rails/generator.rb
+- lib/watchdoge/rails/railtie.rb
 - lib/watchdoge/version.rb
 - lib/watchdoge/worker.rb
-- watchdoge-0.0.2.gem
 - watchdoge.gemspec
 homepage: 
 licenses: