nakal 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94bdb39bc573fb44a15573607687333b0c5a9d84
-  data.tar.gz: 8e737f7832ab3efa90f91849e6a71625849a9ce1
+  metadata.gz: 2081d156847ef0890647c56f615825ab1c2f26d1
+  data.tar.gz: 2ef66d48ea906defc31b87d6304f047264c9ae02
 SHA512:
-  metadata.gz: fdcef019fb259b6d895f3840de1622772c41b22202ac792556d0b2b8a02d8e2c831967ba0b14871a80708945e1cf35823effe1833fcf60c388701f703f6a6040
-  data.tar.gz: b47b1087ff877b5aa4ebe3273884bd74d73e6439403bba15b87b4ef1c0d4da75f7ceed374eb580e8b841c4d17b22b1d38637ddbee310908beb7cd2a4d0abaf06
+  metadata.gz: 8226e331bf26bc2c99c518fd92dc4e7b9e25b8ccb6583f7a448192d33f639a00163279517b82b9618bd81f79d92c66ac6baf6e4fdbe3c09ffbfda1047d1e7e84
+  data.tar.gz: ae13c3bbdbd7b0303321a1ebbf61f50ebdfb9f12e92de3c13c84a485b40c2a49084569fc2a78de14f614a27427a8ac5c48d44aeee08dbbe4c2a8b439e656b88b

data/README.md

@@ -40,17 +40,16 @@ Now, execute your test by passing env variable NAKAL_MODE=build to build the bas
 once baseline is built, next execution onwards, start using environment variable NAKAL_MODE=compare to compare against baseline.
 any difference will be put in the same directory with image file named "current_screen_name_diff.png"
 
-## Important
+If You want to organize baseline nicely, you can even specify sub-paths in #nakal_execute like this:
 
-* This works best when your tests are running against mocked data
-* If test data keeps changing for each test, use diff_metric (output of nakal_execute method above) to determine if the change is acceptable.
+	diff_metric = nakal_execute("feature/sub_feature/current_screen_name")
 
 For setting custom directory, use:  
 
 	Nakal.directory= "<desired_directory>"
 	Nakal.device_name = "nexus7"
 
-For cropping the notification bar OR scroll bar, create a config/nakal.yml file in execution directory
+For cropping the notification bar OR scroll bar, create a config/nakal.yml file in execution directory.
 
 eg:
 
@@ -61,6 +60,8 @@ put these contents in your nakal.yml file inside config/nakal.yml
 	 right: 18
 	 left: 0
 	 bottom: 0
+	 screen_name_to_be_masked: {mask_region: [66,424,340,478]}
+	 feature/sub_feature/current_screen_name: {mask_region_1: [66,424,340,478],mask_region_2: [76,524,440,578]}
 
 	nexus7:
 	 top: 74
@@ -72,10 +73,25 @@ put these contents in your nakal.yml file inside config/nakal.yml
 	 top: 30
 	 right: 6
 	 left: 0
-	 bottom: 0  
+	 bottom: 0
+	 screen_name_to_be_masked: {mask_region: [66,424,340,478]}
+     feature/sub_feature/current_screen_name: {mask_region_1: [66,424,340,478],mask_region_2: [76,524,440,578]}
 	 
-## ToDo  
-1. Put a logic to wait for screen to load until it is matching the baseline. Timeout after certain time and fail.
+## Note
+1. There is implicit wait of 30 sec until current screen matches baseline. This timeout can be changed by setting:  
+	
+		Nakal.timeout = new_timeout_value
+
+
+2. you can specify the areas of a screen you want to mask/ignore while comparing in nakal.yml as below:
+
+		samsung_galaxy_s3:
+		 top: 50
+		 right: 18
+		 left: 0
+		 bottom: 0
+		 screen_name_to_be_masked: {mask_region_1: [66,424,340,478],mask_region_2: [76,524,440,578]}
+
 	 
 ## Contributing
 

data/lib/nakal/base_screen.rb

@@ -27,11 +27,25 @@ module Nakal
       end
 
       def compare screen
-        diff_img, diff_metric = self.strip.compare_channel(screen.strip, Magick::RootMeanSquaredErrorMetric)
+        diff_img, diff_metric = self.apply_mask.strip.compare_channel(screen.apply_mask.strip, Magick::RootMeanSquaredErrorMetric)
         diff_screen = Nakal.current_platform::Screen.new("#{@name}_diff", :none, diff_img)
         return diff_screen, diff_metric
       end
 
+      def apply_mask
+        image_mask_params = Nakal.default_crop_params[Nakal.device_name][image_relative_path.gsub("_current", "")]
+        return self if image_mask_params.nil?
+        image_mask_params.each do |region, params|
+          gc = Magick::Draw.new.fill('black').rectangle(*params)
+          gc.draw @image
+        end
+        self
+      end
+
+      def image_relative_path
+        Nakal.image_relative_dir.eql?(".") ? @name : "#{Nakal.image_relative_dir}/#{@name}"
+      end
+
       def delete!
         FileUtils.rm "#{Nakal.image_location}/#{@name}.png"
       end

data/lib/nakal/version.rb

@@ -1,3 +1,3 @@
 module Nakal
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/nakal.rb

@@ -12,14 +12,15 @@ module Nakal
 
   class<<self
     attr_accessor :device_name, :directory, :platform, :image_location, :default_crop_params
-    attr_accessor :diff_screens, :embed_screenshot, :timeout
+    attr_accessor :diff_screens, :embed_screenshot, :timeout, :image_relative_dir
 
     def configure
       yield self
     end
 
-    def create_image_dir dir
-      @image_location = "#{@directory}/#{@device_name}/#{dir}"
+    def create_image_dir image_relative_dir
+      @image_relative_dir = image_relative_dir
+      @image_location = "#{@directory}/#{@device_name}/#{image_relative_dir}"
       FileUtils.mkdir_p @image_location unless File.directory?(@image_location)
     end
 

data/spec/nakal/android/screen_spec.rb

@@ -5,7 +5,7 @@ require 'nakal'
 Nakal.platform = :android
 Nakal.directory= "spec/resources/droid"
 Nakal.device_name = "samsung_galaxy_s3"
-Nakal.create_image_dir "xx"
+Nakal.create_image_dir "feature"
 
 module Nakal::Android
   class Screen
@@ -71,13 +71,33 @@ describe Nakal::Android::Screen do
   describe "#compare" do
     it "compares two screens" do
       Nakal.default_crop_params = {"samsung_galaxy_s3" => {"top" => 50, "right" => 0, "left" => 0, "bottom" => 0}}
-      changed_screen = Nakal::Android::Screen.new("changed_home_screen", :load)
+      changed_screen = Nakal::Android::Screen.new("home_screen_current", :load)
       diff_screen, diff_metric = @screen.compare(changed_screen)
       expect(diff_metric.round(6)).to eq 0.062555
       expect(diff_screen).to be_an_instance_of Nakal::Android::Screen
       expect(diff_screen.name).to eql "home_screen_diff"
       diff_screen.save
     end
+
+    it "compares two screens by ignoring specified region" do
+      Nakal.default_crop_params = {"samsung_galaxy_s3" => {"top" => 50, "right" => 0, "left" => 0, "bottom" => 0,
+                                                           "feature/home_screen" => {"cam_icon1" => [66, 852, 206, 996]}}}
+      @screen = Nakal::Android::Screen.new("home_screen", :load)
+      changed_screen = Nakal::Android::Screen.new("home_screen_current", :capture)
+      diff_screen, diff_metric = @screen.compare(changed_screen)
+      expect(diff_metric.round(5)).to eq 0.05189
+      diff_screen.save
+    end
+
+    it "compares two screens by ignoring all specified region" do
+      Nakal.default_crop_params = {"samsung_galaxy_s3" => {"top" => 50, "right" => 0, "left" => 0, "bottom" => 0,
+                                                           "feature/home_screen" => {"cam_icon1" => [66, 852, 206, 996], "cam_icon2" => [210, 228, 340, 392],"clock" => [364, 484, 672, 770]}}}
+      @screen = Nakal::Android::Screen.new("home_screen", :load)
+      changed_screen = Nakal::Android::Screen.new("home_screen_current", :capture)
+      diff_screen, diff_metric = @screen.compare(changed_screen)
+      expect(diff_metric).to eq 0.0
+      diff_screen.save
+    end
   end
 
   after(:all) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nakal
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Rajdeep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -91,8 +91,9 @@ files:
 - lib/nakal/version.rb
 - nakal.gemspec
 - spec/nakal/android/screen_spec.rb
-- spec/resources/changed_home_screen.png
+- spec/resources/.DS_Store
 - spec/resources/home_screen.png
+- spec/resources/home_screen_current.png
 - spec/spec_helper.rb
 homepage: https://github.com/rajdeepv/nakal
 licenses:
@@ -114,13 +115,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Automated visual regression testing of android and ios apps with appoum/calabash
   or any other tool
 test_files:
 - spec/nakal/android/screen_spec.rb
-- spec/resources/changed_home_screen.png
+- spec/resources/.DS_Store
 - spec/resources/home_screen.png
+- spec/resources/home_screen_current.png
 - spec/spec_helper.rb