nakal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b58e8fd157ff12dbc901782576a6c6712dbff0b
+  data.tar.gz: f2f11543cbf0490454a7237a36d6060e1068859b
+SHA512:
+  metadata.gz: f8b03d49e871bb584525fa755ee0e73399eafef017c780292c623d557b807c3525ea2085825fdca66576fa31cfea2f83eca532052878d761816f808aa75549f1
+  data.tar.gz: 4b5f096c624c6ce67ccec04d3c7f05e5b0704719679ec4be00ce923beee9ef5f360b0fe3449cd9def43050b0c548f544c862960199fb5d3c515fb04c63f5a378

data/.gitignore

@@ -0,0 +1,18 @@
+.idea/*
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_install_on_use_flag=1
+rvm --create use ruby-2.1.1@nakal

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'pry'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rajdeep
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Nakal
+
+Automated visual testing of Android/iOS applications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nakal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nakal
+
+## Usage
+
+If you are using cucumber, include following Lines in your env.rb
+
+require "nakal/cucumber"
+
+Nakal.platform = :android
+Nakal.directory= "baseline_images/droid"
+Nakal.device_name = "samsung_galaxy_s3"
+
+and then put this line in your code where you want comparison to begin:
+
+nakal_execute("current_screen_name")
+
+
+While executing, pass env variable NAKAL_MODE=build to build the baseline images
+
+once baseline is built, next execution onwards, start using environment variable NAKAL_MODE=compare to compare against baseline
+
+This is currently beta and implemented for android only. iOs is work in progress
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/nakal/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/nakal.rb

@@ -0,0 +1,40 @@
+require "nakal/version"
+require 'rmagick'
+require 'fileutils'
+require 'yaml'
+require_relative 'nakal/base_screen'
+require_relative 'nakal/android/screen'
+require_relative 'nakal/ios/screen'
+
+module Nakal
+
+  class<<self
+    attr_accessor :device_name, :directory, :platform, :image_location, :img_dir_created, :default_crop_params
+    attr_accessor :diff_screens, :embed_screenshot
+
+    def configure
+      yield self
+    end
+
+    def create_image_dir
+      unless @img_dir_created
+        @image_location ||= "#{@directory}/#{@device_name}"
+        FileUtils.mkdir_p @image_location unless File.directory?(@image_location)
+        @img_dir_created =true
+      end
+    end
+
+    def current_platform
+      Object.const_get("Nakal::#{Nakal.platform.capitalize}")
+    end
+
+  end
+end
+
+Nakal.configure do |config|
+  config.device_name = "default_device"
+  config.directory = "baseline_images"
+  config.default_crop_params = (YAML.load(File.open './config/nakal.yml') rescue {})
+  config.embed_screenshot = false
+  config.diff_screens = []
+end

data/lib/nakal/android/adb.rb

@@ -0,0 +1,22 @@
+module Nakal
+  module Android
+    class ADB
+      class << self
+        attr_accessor :connected_devices
+
+        def connected_devices
+          @connected_devices ||= `adb devices`.scan(/\n(.*)\t/).flatten
+        end
+
+        def first_device
+          connected_devices.first
+        end
+
+        def multiple_devices_connected?
+          connected_devices.size > 1
+        end
+
+      end
+    end
+  end
+end

data/lib/nakal/android/screen.rb

@@ -0,0 +1,16 @@
+require_relative 'adb'
+module Nakal
+  module Android
+    class Screen < Common::BaseScreen
+
+      private
+
+      def capture
+        device_arg = ADB.multiple_devices_connected? ? "-s #{ENV['ADB_DEVICE_ARG']}" : ""
+        `adb #{device_arg} shell  screencap -p /sdcard/#{@name}.png`
+        `adb #{device_arg} pull /sdcard/#{@name}.png #{Nakal.image_location}`
+      end
+
+    end
+  end
+end

data/lib/nakal/base_screen.rb

@@ -0,0 +1,56 @@
+module Nakal
+  module Common
+    class BaseScreen
+
+      attr_accessor :image, :name
+
+      def initialize file_name, mode = :load, image = nil
+        @name = file_name
+        if mode.eql?(:capture)
+          capture
+          load_image_from_file
+        elsif mode.eql?(:load)
+          load_image_from_file
+        else
+          @image=image
+        end
+      end
+
+      def strip
+        crop_params = Nakal.default_crop_params[Nakal.device_name]
+        if crop_params.nil?
+          @image
+        else
+          width = @image.columns
+          height = @image.rows
+          x_start = crop_params["left"]
+          y_start = crop_params["top"]
+          width_to_consider = width-crop_params["right"]-x_start
+          height_to_consider = height-crop_params["bottom"]-y_start
+          @image.crop(x_start, y_start, width_to_consider, height_to_consider)
+        end
+      end
+
+      def compare screen
+        diff_img, diff_metric = self.strip.compare_channel(screen.strip, Magick::RootMeanSquaredErrorMetric)
+        diff_screen = Nakal.current_platform::Screen.new("#{@name}_diff", :none, diff_img)
+        return diff_screen, diff_metric
+      end
+
+      def delete!
+        FileUtils.rm "#{Nakal.image_location}/#{@name}.png"
+      end
+
+      def save
+        @image.write("#{Nakal.image_location}/#{@name}.png")
+      end
+
+      private
+
+      def load_image_from_file
+        @image = Magick::Image.read("#{Nakal.image_location}/#{@name}.png")[0]
+      end
+
+    end
+  end
+end

data/lib/nakal/cucumber.rb

@@ -0,0 +1,13 @@
+require_relative 'dsl'
+
+World(Nakal::DSL)
+
+Before do
+  Nakal.diff_screens = []
+end
+
+After do
+  if Nakal.diff_screens.size > 0
+    raise "following screens do not match: \n #{Nakal.diff_screens}"
+  end
+end

data/lib/nakal/dsl.rb

@@ -0,0 +1,40 @@
+require 'nakal'
+
+module Nakal
+  module DSL
+
+    def current_screen_vs_base_image image_file_name
+      orignal_screen = Nakal.current_platform::Screen.new(image_file_name, :load)
+      current_screen = Nakal.current_platform::Screen.new("#{image_file_name}_current", :capture)
+      diff_screen, diff_metric = orignal_screen.compare(current_screen)
+      if diff_metric==0
+        current_screen.delete!
+      else
+        p "difference = #{diff_metric}"
+        diff_screen.save
+        Nakal.diff_screens << image_file_name
+        embed_screenshots image_file_name if Nakal.embed_screenshot == true
+      end
+      diff_metric
+    end
+
+    def embed_screenshots image_file_name
+      embed("#{image_file_name}.png", 'image/png', "#{image_file_name}")
+      embed("#{image_file_name}_current.png", 'image/png', "#{image_file_name}_current")
+      embed("#{image_file_name}_diff.png", 'image/png', "#{image_file_name}_diff")
+    end
+
+    def capture_screen image_name
+      Nakal.current_platform::Screen.new(image_name, :capture)
+    end
+
+    def nakal_execute image_name, params = {:delay => nil, :replace_baseline => false}
+      return if ENV['NAKAL_MODE'].nil?
+      Nakal.create_image_dir
+      sleep params[:delay] unless params[:delay].nil?
+      capture_screen(image_name) if (ENV['NAKAL_MODE'] == "build") || (params[:replace_baseline] == true)
+      current_screen_vs_base_image(image_name) if ENV['NAKAL_MODE'] == "compare" && params[:replace_baseline] != true
+    end
+  end
+
+end

data/lib/nakal/ios/screen.rb

@@ -0,0 +1,13 @@
+module Nakal
+  module Ios
+    class Screen < Common::BaseScreen
+
+      private
+
+      def capture
+        raise "******** please implement me! ********"
+      end
+
+    end
+  end
+end

data/lib/nakal/version.rb

@@ -0,0 +1,3 @@
+module Nakal
+  VERSION = "0.0.1"
+end

data/nakal.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nakal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nakal"
+  spec.version       = Nakal::VERSION
+  spec.authors       = ["Rajdeep"]
+  spec.email         = ["mail.rajvarma@gmail.com"]
+  spec.summary       = "Visual regression testing of android and ios apps"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/rajdeepv/nakal"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rmagick', "~>2.15.2"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/nakal/android/screen_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'nakal'
+
+`rm -rf spec/resources/droid`
+Nakal.platform = :android
+Nakal.directory= "spec/resources/droid"
+Nakal.device_name = "samsung_galaxy_s3"
+Nakal.create_image_dir
+
+module Nakal::Android
+  class Screen
+    def capture
+      `cp spec/resources/*.png #{Nakal.image_location}`
+    end
+  end
+end
+
+describe Nakal::Android::Screen do
+
+  before(:all) do
+    @screen = Nakal::Android::Screen.new("home_screen", :capture)
+  end
+
+  describe "#new" do
+    it "creates new screen by capturing it" do
+      expect(@screen).to be_an_instance_of Nakal::Android::Screen
+    end
+
+    it "creates new screen object using an image file" do
+      new_screen = Nakal::Android::Screen.new("home_screen", :load)
+      expect(new_screen.name).to eq "home_screen"
+      expect(new_screen.image).to be_an_instance_of Magick::Image
+    end
+
+    it "throws error if new screen is created using invalid file" do
+      expect { Nakal::Android::Screen.new("invalid_image", :load) }.to raise_error(Magick::ImageMagickError)
+    end
+  end
+
+  describe "#strip" do
+    it "does not crop image when no params are given" do
+      Nakal.default_crop_params = {}
+      expect(@screen.strip.rows).to eq 1280
+      expect(@screen.strip.columns).to eq 720
+    end
+
+    it "crops the image as per nakal.yml params" do
+      Nakal.default_crop_params = {"samsung_galaxy_s3" => {"top" => 50, "right" => 18, "left" => 12, "bottom" => 15},
+                                   "nexus7" => {"top" => 74, "right" => 20, "left" => 0, "bottom" => 0}}
+
+      device_params = Nakal.default_crop_params[Nakal.device_name]
+      expected_rows = @screen.image.rows - device_params["top"] - device_params["bottom"]
+      expected_columns = @screen.image.columns - device_params["left"] - device_params["right"]
+      expect(@screen.strip.rows).to eq (expected_rows)
+      expect(@screen.strip.columns).to eq (expected_columns)
+    end
+  end
+
+  describe "#save,#delete" do
+    it "can create,save and delete a screen using image object" do
+      Nakal.default_crop_params = {"samsung_galaxy_s3" => {"top" => 450, "right" => 180, "left" => 12, "bottom" => 15}}
+      image = @screen.strip
+      new_screen = Nakal::Android::Screen.new("new_home_screen", nil, image)
+      new_screen.save
+      expect(File.exist?('./spec/resources/droid/samsung_galaxy_s3/new_home_screen.png')).to eq true
+      new_screen.delete!
+      expect(File.exist?('./spec/resources/droid/samsung_galaxy_s3/new_home_screen.png')).to eq false
+    end
+  end
+
+  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)
+      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
+  end
+
+  after(:all) do
+    `rm -rf #{Nakal.image_location}/*.png`
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,97 @@
+require 'pry'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: nakal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rajdeep
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Visual regression testing of android and ios apps
+email:
+- mail.rajvarma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nakal.rb
+- lib/nakal/android/adb.rb
+- lib/nakal/android/screen.rb
+- lib/nakal/base_screen.rb
+- lib/nakal/cucumber.rb
+- lib/nakal/dsl.rb
+- lib/nakal/ios/screen.rb
+- lib/nakal/version.rb
+- nakal.gemspec
+- spec/nakal/android/screen_spec.rb
+- spec/resources/changed_home_screen.png
+- spec/resources/home_screen.png
+- spec/spec_helper.rb
+homepage: https://github.com/rajdeepv/nakal
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Visual regression testing of android and ios apps
+test_files:
+- spec/nakal/android/screen_spec.rb
+- spec/resources/changed_home_screen.png
+- spec/resources/home_screen.png
+- spec/spec_helper.rb
+has_rdoc: