watchdoge 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31dedfc4a4c2e9534672ab388d89afeccb56e9855b5e14e9c454f9b4b0750670
-  data.tar.gz: c91210715bedf6187b55e543ff95f82a4390457bd9a4c83026c36d1ab130175b
+  metadata.gz: db9eab410f530c1dd00de8bfb39a4cfaa86d3e41aa86105d776c47e8c68ad9cb
+  data.tar.gz: 3196f93d3121f1aaafe6a4dfea5fc702dfbe54c4a985dfdd6b4f08abc3e515af
 SHA512:
-  metadata.gz: aead7efe871204a654be431a18eacbd5eb1b22e299f0f2eb6d941022d58826fb0cb5024623dff704758558a07a2531c6d3e825409a0f5d4c74b66b5115ee29b4
-  data.tar.gz: e255c5c965a8a3dcaa8709a762a07127d9aa6850b3f06ecacfb67dac9accca785fd4a84e48fd53bb0988b738a27b0a29a6ca06a714f1e39dd26e3fe3201f2a00
+  metadata.gz: ef68aed278dc48dd7eac239a9c91bbaf532b010f4bb28f4c32ddbd3c57d3dd271a26e7c087e86bf2d7b64abe37dc73a2c51c1990e3a73882ce41f05bdbc9f2ea
+  data.tar.gz: a9d02b67e9534ccf26047f4eb260b738251a68a92971fa7333689220dc13e1c4b089c36b0d507c950543cc3fbeff5d7adc3beb3602c32ecb373102fa868e7197

data/lib/watchdoge/notification/base.rb

@@ -0,0 +1,35 @@
+require 'pry'
+require 'net_http_ssl_fix'
+
+require 'chunky_png'
+require 'json'
+require 'net/http'
+require 'net/http/post/multipart'
+require 'uri'
+
+module WatchDoge
+  module Notification
+    class Base
+      def initialize opt
+        @message_queue = []
+      end
+
+      def push message
+        @message_queue << message
+      end
+
+      def flush
+        @message_queue.each do |message|
+          case message
+          when String
+            puts message
+          when ChunkyPNG::Image
+            File.write 'image.png', message.to_blob
+          when WatchDoge::PixelTest
+            File.write 'image.png', message.diff.to_blob
+          end
+        end
+      end
+    end
+  end
+end

data/lib/watchdoge/notification/gitlab_repo.rb

@@ -9,40 +9,47 @@ require 'uri'
 
 module WatchDoge
   module Notification
-    class GitlabRepo
+    class GitlabRepo < WatchDoge::Notification::Base
       def initialize opt
+        super
+
         @host = opt[:host] || ENV['CI_API_V4_URL']
         @project_id = opt[:project_id] || ENV['CI_PROJECT_ID']
         @source_branch = opt[:source_branch] || ENV['CI_COMMIT_REF_NAME']
 
         @private_token = opt[:private_token]
-
-        @message_queue = []
-      end
-
-      def push message
-        @message_queue << message
       end
 
       def flush
-        @message_queue.each do |message|
-          iid = get_latest_request_iid
-
-          return if iid.nil?
-
-          case message
-          when String
-            post_discussion request_iid: iid, message: message
-          when ChunkyPNG::Image
-            image_blob = message.to_blob
-            res = upload_image image_blob
-            image_link = "![image](#{ENV['CI_PROJECT_URL']}#{res['url']})"
-            post_discussion request_iid: iid, message: image_link
-
-          # TODO: should add WatchDoge::Diff as pair of before/after iamges
-          # when WatchDoge::Diff
+        iid = get_latest_request_iid
+
+        @message_queue = [] if iid.nil?
+
+        table = markdown_table do |table_context|
+          @message_queue.each do |message|
+            case message
+            when String
+              post_discussion request_iid: iid, message: message
+            when ChunkyPNG::Image
+              upload_link = upload_image message
+              link = md_img_link upload_link
+
+              post_discussion request_iid: iid, message: link
+            when WatchDoge::PixelTest
+              before = md_img_link upload_image(message.before)
+              after = md_img_link upload_image(message.after)
+              diff = md_img_link upload_image(message.diff)
+
+              table_context << markdown_table_row(before, after, diff)
+            end
           end
+
+          table_context
         end
+
+        @message_queue = []
+
+        post_discussion request_iid: iid, message: table
       end
 
       def post_discussion request_iid:, message:
@@ -54,11 +61,11 @@ module WatchDoge
                        "PRIVATE-TOKEN": @private_token
       end
 
-      def upload_image blob
+      def upload_image image
         uri = project_uri "/uploads"
 
         req = Net::HTTP::Post::Multipart.new uri.path, {
-          file: UploadIO.new(StringIO.new(blob), 'image/png', 'image.png')
+          file: UploadIO.new(StringIO.new(image.to_blob), 'image/png', 'image.png')
         }
 
         req.add_field("PRIVATE-TOKEN", @private_token)
@@ -67,7 +74,7 @@ module WatchDoge
           res = http.request(req).body
         end
 
-        JSON.parse(res)
+        JSON.parse(res)['url']
       end
 
       def get_latest_request_iid
@@ -87,6 +94,10 @@ module WatchDoge
 
       private
 
+      def md_img_link link
+        "![image](#{ENV['CI_PROJECT_URL']}#{link})"
+      end
+
       # markdown_table do |context|
       def markdown_table
         "<table>
@@ -99,6 +110,14 @@ module WatchDoge
         </table>"
       end
 
+      def markdown_table_row before, after, diff
+        "<tr>
+          <td>#{before}</td>
+          <td>#{after}</td>
+          <td>#{diff}</td>
+         </tr>"
+      end
+
       def project_uri path
         URI(@host + "/projects/#{@project_id}#{path}")
       end

data/lib/watchdoge/notification/mattermost.rb

@@ -8,15 +8,11 @@ module WatchDoge
   module Notification
     class Mattermost
       def initialize args
+        super
+
         @host = args[:host]
         @channel_id = args[:channel_id]
         @auth_token = args[:auth_token]
-
-        @message_queue = []
-      end
-
-      def push message
-        @message_queue << message
       end
 
       def flush
@@ -26,6 +22,8 @@ module WatchDoge
             post matter_most_meta(message)
           when ChunkyPNG::Image
             post_file matter_most_meta(message)
+          when WatchDoge::PixelTest
+            post_file matter_most_meta(message.diff)
           end
         end
       end

data/lib/watchdoge/notification/slack_webhook.rb

@@ -1,19 +1,10 @@
-require 'chunky_png'
-require 'json'
-require 'net/http'
-require 'uri'
-
 module WatchDoge
   module Notification
     class SlackWebhook
       def initialize opt
-        @incoming_url = opt[:incoming_url]
-
-        @message_queue = []
-      end
+        super
 
-      def push message
-        @message_queue << message
+        @incoming_url = opt[:incoming_url]
       end
 
       def flush
@@ -36,6 +27,14 @@ module WatchDoge
         when ChunkyPNG::Image
           data = ['data:image/png;base64,', message.to_blob].pack('A*m').gsub(/\n/, '')
 
+          {
+            attachments: [{
+              image_url: data
+            }]
+          }
+        when WatchDoge::PixelTest
+          data = ['data:image/png;base64,', message.diff.to_blob].pack('A*m').gsub(/\n/, '')
+
           {
             attachments: [{
               image_url: data

data/lib/watchdoge/notification.rb

@@ -21,6 +21,8 @@
 # end
 
 # built-in sources
+require 'watchdoge/notification/base'
+
 require 'watchdoge/notification/slack_webhook'
 require 'watchdoge/notification/mattermost'
 require 'watchdoge/notification/gitlab_repo'
@@ -51,7 +53,9 @@ module WatchDoge
       def sources
         @sources ||= WatchDoge.configuration.notifications
 
-        raise "can't find notification sources in configuration" if @sources.empty?
+        @sources = {
+          base: {}
+        } if @sources.empty?
 
         @sources.each do |klass_sym, source_args|
           sources_map[klass_sym] ||=

data/lib/watchdoge/pixel_test.rb

@@ -0,0 +1,61 @@
+# generating diff image of two input image
+
+# usage:
+#   diff_image = WatchDoge::PixelTest.diff(chunky_png_image, another_chunky_png_image)
+#   WatchDoge::PixelTest.new diff_image, before:
+
+# spec:
+#   1. input only accept ChunkyPNG::Image, output image is also ChunkyPNG::Image
+#   2. able to testing RGBA pixel by pixel. then blending with mask color if diff detected
+
+# todo: should improve testing boundary for more accurate diff imagenot.
+
+module WatchDoge
+  class PixelTest
+    def self.diff input_image, reference_image, opacity: 0.7, mask_base_color: "#F163FF"
+      return nil if input_image.pixels.hash == reference_image.pixels.hash
+
+      mask_color = mask_base_color.concat (opacity * 256).to_i.to_s(16).upcase
+
+      dup_input_image = input_image.dup
+
+      input_image.height.times do |y|
+        pixels = input_image.row(y)
+
+        if y >= reference_image.height
+          pixels.each_with_index do |pixel, x|
+            dup_input_image.compose_pixel(x, y, mask_color)
+          end
+        else
+          reference_pixels = reference_image.row(y)
+
+          next if (pixels.hash == reference_pixels.hash)
+
+          pixels.each_with_index do |pixel, x|
+            if pixels[x] != reference_pixels[x]
+              dup_input_image.compose_pixel(x, y, reference_pixels[x])
+              dup_input_image.compose_pixel(x, y, mask_color)
+            end
+          end
+        end
+      end
+
+      dup_input_image
+    end
+
+    attr_reader :diff
+    attr_reader :before
+    attr_reader :after
+
+    def initialize input, reference
+      @before = reference
+      @after = input
+
+      @diff = self.class.diff input, reference
+    end
+
+    def diff?
+      @diff
+    end
+  end
+end

data/lib/watchdoge/regression/dsl.rb

@@ -63,15 +63,10 @@ module WatchDoge
           when :regression
             puts "  -> compare reference images on worker #{@worker}"
             reference_image = WatchDoge::Regression::Utils.load_png self.reference_image
-            cycle_image = WatchDoge::Regression::Utils.load_png @worker.screenshot.png
-            diff = WatchDoge::ImageDiff.diff(cycle_image, reference_image)
-            if diff
-              if ENV['WATCHDOGE_DEBUG']
-                WatchDoge::Notification.push cycle_image
-                WatchDoge::Notification.push reference_image
-              end
-              WatchDoge::Notification.push diff
-            end
+            input_image = WatchDoge::Regression::Utils.load_png @worker.screenshot.png
+            pixel_test = WatchDoge::PixelTest.new(input_image, reference_image)
+
+            WatchDoge::Notification.push pixel_test if pixel_test.diff?
           end
         end
 

data/lib/watchdoge/regression.rb

@@ -32,6 +32,7 @@ module WatchDoge
           end
 
           WatchDoge.hooks.after_regression.each { |t| t.call }
+          WatchDoge::Notification.flush
         end
       end
 

data/lib/watchdoge/version.rb

@@ -1,4 +1,4 @@
 # Version of WatchDoge
 module WatchDoge
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

data/lib/watchdoge.rb

@@ -4,7 +4,7 @@ require 'watchdoge/configuration'
 require 'watchdoge/cookie_pool'
 require 'watchdoge/worker'
 require 'watchdoge/notification'
-require 'watchdoge/image_diff'
+require 'watchdoge/pixel_test'
 require 'watchdoge/regression'
 require 'watchdoge/rails/railtie' if defined?(Rails)
 require 'watchdoge/rails/generator' if defined?(Rails)

data/watchdoge.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'watchdoge'
-  s.version     = '0.1.8'
+  s.version     = '0.1.9'
   s.date        = '2019-07-22'
   s.summary     = "dogi"
   s.description = "WatchDoge is Ruby on Rails friendly frontend regression test tool"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watchdoge
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Shen Lee
@@ -114,11 +114,12 @@ files:
 - lib/watchdoge.rb
 - lib/watchdoge/configuration.rb
 - lib/watchdoge/cookie_pool.rb
-- lib/watchdoge/image_diff.rb
 - lib/watchdoge/notification.rb
+- lib/watchdoge/notification/base.rb
 - lib/watchdoge/notification/gitlab_repo.rb
 - lib/watchdoge/notification/mattermost.rb
 - lib/watchdoge/notification/slack_webhook.rb
+- lib/watchdoge/pixel_test.rb
 - lib/watchdoge/rails/generator.rb
 - lib/watchdoge/rails/railtie.rb
 - lib/watchdoge/regression.rb

data/lib/watchdoge/image_diff.rb

@@ -1,47 +0,0 @@
-# generating diff image of two input image
-
-# usage:
-#   diff_image = WatchDoge::ImageDiff.diff(chunky_png_image, another_chunky_png_image)
-
-# spec:
-#   1. input only accept ChunkyPNG::Image, output image is also ChunkyPNG::Image
-#   2. able to testing RGBA pixel by pixel. then blending with mask color if diff detected
-
-# todo: should improve testing boundary for more accurate diff imagenot.
-
-module WatchDoge
-  module ImageDiff
-    class << self
-      def diff input_image, reference_image, opacity: 0.7, mask_base_color: "#F163FF"
-        return nil if input_image.pixels.hash == reference_image.pixels.hash
-
-        mask_color = mask_base_color.concat (opacity * 256).to_i.to_s(16).upcase
-
-        dup_input_image = input_image.dup
-
-        input_image.height.times do |y|
-          pixels = input_image.row(y)
-
-          if y >= reference_image.height
-            pixels.each_with_index do |pixel, x|
-              dup_input_image.compose_pixel(x, y, mask_color)
-            end
-          else
-            reference_pixels = reference_image.row(y)
-
-            next if (pixels.hash == reference_pixels.hash)
-
-            pixels.each_with_index do |pixel, x|
-              if pixels[x] != reference_pixels[x]
-                dup_input_image.compose_pixel(x, y, reference_pixels[x])
-                dup_input_image.compose_pixel(x, y, mask_color)
-              end
-            end
-          end
-        end
-
-        dup_input_image
-      end
-    end
-  end
-end