yordi_tests 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 783043661bdec27c6adf4c9f4d3b1d545d675ef4
-  data.tar.gz: 64fc1f61a1a524e3e61aaedc4931c6dce74523b7
+  metadata.gz: 4208c9db4dd2f22a7c88dce21e4f6250139efe13
+  data.tar.gz: 0a7442b43e80119ea70d342601566a4d298545a5
 SHA512:
-  metadata.gz: 7784cb732fcd3cb3794b3058d39efa00cace7d44dca2778f3a2c09549831997dffa5ce058063f553af65d476f34de4fe7334bb4bf0c2394a61efe5fbead0119f
-  data.tar.gz: 4a2b864d577a4d56f762ca2d57d62226c5e83fa08cee69aeb68f2dc35b0078c7f511621d5961670ab75bf4a8d30f62ed35f385cba8ccf714325079e5af65d002
+  metadata.gz: 5fb1e59529a9fa1e73f6149f35d74a2afec07a1e91627226badd23b9f467a22c3706814740f6b84adaf4b835e1c4f61aae84a96c1af7edc55fa5e70ee5b6a715
+  data.tar.gz: b03cf1c995ddf5c78385eaad2d403deefb3b84cf3fbf436a8d1ab66fa25a99d5d430616eb1d21ee41b013594fde857da05fb277388e88b3c4d1c1fe8245933e6

data/.gitignore

@@ -10,4 +10,5 @@
 /.idea/
 /test/fixtures/
 /test/fixtures/benchmarks/
+/.yordi_tests/
 /test/fixtures/screenshots/

data/lib/yordi_tests.rb

@@ -13,14 +13,22 @@ module YordiTests
 
 
   YORDI_DIR = ENV['YORDI_DIR'].freeze || '.yordi_tests'.freeze
-  BENCHMARKS_PATH = YORDI_DIR + '/benchmarks'.freeze
-  SCREENS_PATH = YORDI_DIR + '/screenshots'.freeze
-  CONFIG_FILE = YORDI_DIR + '/config.json'.freeze
-  REPORT_FILE = YORDI_DIR + '/report.json'.freeze
-  REPORT_HTML = YORDI_DIR + '/report.html'.freeze
+  BENCHMARKS_PATH = File.join(YORDI_DIR, 'benchmarks').freeze
+  SCREENS_PATH = File.join(YORDI_DIR, 'screenshots').freeze
+  CONFIG_FILE = File.join(YORDI_DIR, 'config.json').freeze
+  REPORT_FILE = File.join(YORDI_DIR, 'report.json').freeze
+  REPORT_HTML = File.join(YORDI_DIR, 'report.html').freeze
+
+  # set default value
+  @client = Client
+  @verbose = true
 
   module_function
 
+  def verbose=(v)
+    @verbose = v
+  end
+
   def client=(v)
     @client = v
   end
@@ -29,8 +37,9 @@ module YordiTests
     @client
   end
 
-  # set default value
-  @client = Client
+  def safe_puts(message)
+    puts message if @verbose
+  end
 
   def new_client(apikey)
     client = new

data/lib/yordi_tests/cli.rb

@@ -7,22 +7,21 @@ module YordiTests
 
     desc 'init --api_key', 'Initializes a Yordi test directory at .yordi_tests relative to where you execute the command'
     method_option :api_key, type: :string, aliases: '-k', desc: 'APIKEY from YordiTest.com if you want to sync results online'
+    method_option :force, type: :boolean, aliases: '-f', desc: 'Force re-initialization'
+    method_option :verbose, type: :boolean, default: false, aliases: '-v', desc: 'Suppress console output'
 
     def init
-      puts 'init'
-      if Dir.exist?(YORDI_DIR)
+      YordiTests.verbose = options.verbose
+      YordiTests.safe_puts 'init'
+
+      if DataManager.store? && !options.force
         puts 'Already initialized'
         exit(1)
       end
-      puts "Creating #{YORDI_DIR} directory"
-      DataManager.create_store
 
-      store = DataManager.default_store(options.api_key)
-      puts "Saving store #{CONFIG_FILE}"
-      DataManager.save_store store
+      DataManager.create_store(options.api_key)
 
       return unless options.api_key
-      puts 'Fetching remote store.'
       DataManager.fetch(true, true, nil)
     end
 
@@ -34,16 +33,19 @@ module YordiTests
     method_option :sync_failures, type: :boolean, default: false, aliases: '-f', desc: 'Push only failed screens to YordiTests.com for evaluation.'
     method_option :filenames, type: :array, aliases: '-i', desc: 'Only test these specific files'
     method_option :screens, type: :array, aliases: '-s', desc: 'Give the files a name other than there filename in the report (best used with -i option)'
+    method_option :verbose, type: :boolean, default: false, aliases: '-v', desc: 'Suppress console output'
 
     def test(path_to_screens)
-      puts "Testing #{path_to_screens} name: #{options.name}, clean_dir: #{options.clean_dir}, sync_all: #{options.sync_all}, sync_failures: #{options.sync_failures}, filenames: #{options.filenames}, screens: #{options.screens}"
-
+      YordiTests.verbose = options.verbose
+      YordiTests.safe_puts "Testing #{path_to_screens} name: #{options.name}, clean_dir: #{options.clean_dir}, sync_all: #{options.sync_all}, sync_failures: #{options.sync_failures}, filenames: #{options.filenames}, screens: #{options.screens}"
       DataManager.run_test(path_to_screens, options.name, options.clean_dir, options.sync_all, options.sync_failures, options.filenames, options.screens)
     end
 
     desc 'make_report', 'Regenerate a Yordi report based on json report'
 
+    method_option :verbose, type: :boolean, default: false, aliases: '-v', desc: 'Suppress console output'
     def make_report
+      YordiTests.verbose = options.verbose
       DataManager.generate_report
     end
 
@@ -51,9 +53,11 @@ module YordiTests
     method_option :benchmarks, type: :boolean, default: false, aliases: '-b', desc: 'Fetch benchmarks'
     method_option :masks, type: :boolean, default: false, aliases: '-m', desc: 'Fetch masks'
     method_option :screens, type: :array, aliases: '-s', desc: 'Only fetch items associated with this list of screen names'
+    method_option :verbose, type: :boolean, default: false, aliases: '-v', desc: 'Suppress console output'
 
     def fetch
-      puts "Fetching with options benchmarks: #{options.benchmarks}, masks: #{options.masks}, screens: #{options.screens}"
+      YordiTests.verbose = options.verbose
+      YordiTests.safe_puts "Fetching with options benchmarks: #{options.benchmarks}, masks: #{options.masks}, screens: #{options.screens}"
       DataManager.fetch(options.benchmarks, options.masks, options.screens)
     end
 
@@ -61,9 +65,11 @@ module YordiTests
     method_option :benchmarks, type: :boolean, default: false, aliases: '-b', desc: 'Push benchmarks'
     method_option :masks, type: :boolean, default: false, aliases: '-m', desc: 'Push masks'
     method_option :screens, type: :array, aliases: '-s', desc: 'Only push items associated with this list of screen names'
+    method_option :verbose, type: :boolean, default: false, aliases: '-v', desc: 'Suppress console output'
 
     def push(path_to_screens)
-      puts "test #{path_to_screens}"
+      YordiTests.verbose = options.verbose
+      YordiTests.safe_puts "test #{path_to_screens}"
     end
 
 

data/lib/yordi_tests/data_manager.rb

@@ -1,74 +1,89 @@
 require 'yordi_tests'
-require 'yordi_tests/local_store'
+require 'yordi_tests/data_store'
 require 'yordi_tests/image_compare'
 require 'yordi_tests/generators/report'
 module YordiTests
   module DataManager
     module_function
 
-    def default_store(apikey)
-      {title: 'YordiTests', apikey: apikey, test_benchmarks: []}
+    # Create Store
+    #
+    #   Called during init process on the CLI
+    #
+    def create_store(apikey)
+      YordiTests.safe_puts "Initializing #{YORDI_DIR} "
+      verify_directories
+      store = {title: 'YordiTests', apikey: apikey, test_benchmarks: []}
+      YordiTests.safe_puts "Saving store #{CONFIG_FILE}"
+      save_store store
     end
 
-    def create_store
-      Dir.mkdir(YORDI_DIR) unless Dir.exist? YORDI_DIR
-    end
+    # Fetch
+    #
+    #  used in the fetch command from the CLI
+    #
+    def fetch(get_benchmarks, get_masks, screens)
+      verify_directories
+      local_store = DataStore.new(read_store)
 
-    def read_store
-      read_json(CONFIG_FILE)
-    end
+      ## no api key
+      return unless local_store.apikey
 
-    def read_report
-      read_json(REPORT_FILE)
-    end
+      client = YordiTests.client
+      client.apikey = local_store.apikey
 
-    def read_json(path)
-      if File.exist? path
-        file = File.read path
-        JSON(file)
-      else
-        puts "No file at: #{path} did you call initialize this directory"
-      end
+      YordiTests.safe_puts 'Fetching remote store.'
+      remote_data = client.fetch_application
 
+      ## no remote store
+      return unless remote_data
+
+      remote_store = DataStore.new(remote_data)
+
+      local_store.update_root_data(remote_store.title, remote_store.apikey)
+      replace_benchmarks(client, local_store, remote_store, screens) if get_benchmarks
+      replace_masks(local_store, remote_store, screens) if get_masks
+
+      save_store local_store.data
     end
 
-    def save_store(store_hash)
-      File.open(CONFIG_FILE, 'w') {|file| file.write(store_hash.to_json)}
+    # Generate a report
+    #
+    #  Used in the make_report command from the CLI
+    #
+    def generate_report
+      YordiTests::Generators::Report.start([REPORT_HTML, read_report])
     end
 
-    # Test entry from the CLI
+    # RunTest
+    #
+    #  Used in the test command from the CLI
     def run_test(path_to_screens, name, clean_dir, sync_all, sync_failures, filenames, screens)
-      local_store = LocalStore.new(read_store)
+      verify_directories
+      store = DataStore.new(read_store)
       if filenames
         files = []
         filenames.each do |filename|
-          files << path_to_screens + '/' + filename
+          files << File.join(path_to_screens, filename)
         end
       else
-        files = Dir.glob(path_to_screens + '/*.png').sort
+        files = Dir.glob(File.join(path_to_screens, '*.png')).sort
       end
-
-      Dir.mkdir(BENCHMARKS_PATH) unless Dir.exist? BENCHMARKS_PATH
-      Dir.mkdir(SCREENS_PATH) unless Dir.exist? SCREENS_PATH
       responses = []
       files.each_with_index do |item, index|
-        puts "Testing #{item}"
-        screenname = (!screens.nil? && screens.size > index) ? screens[index] : File.basename(item, '.*')
-        benchmark = local_store.benchmark_by_screenname(screenname)
+        YordiTests.safe_puts "Testing #{item}"
+        screenname = !screens.nil? && screens.size > index ? screens[index] : File.basename(item, '.*')
+        benchmark = store.benchmark_by_screenname(screenname)
         local_name = benchmark.nil? ? sanitize(screenname) + File.extname(item) : benchmark[LOCAL_FILENAME]
-        benchmark_path = BENCHMARKS_PATH + '/' + local_name
-        screenshot_path = SCREENS_PATH + '/' + local_name
+        benchmark_path = File.join(BENCHMARKS_PATH, local_name)
+        screenshot_path = File.join(SCREENS_PATH, local_name)
         FileUtils.copy item, screenshot_path
         if benchmark.nil?
           FileUtils.copy item, benchmark_path
-          benchmark = {SCREENNAME => screenname,
-                       MASKED_AREA => nil,
-                       FILENAME => local_name,
-                       LOCAL_FILENAME => local_name}
-          local_store.update_benchmark(benchmark)
-          save_store local_store.data
+          benchmark = store.add_benchmark(screenname, local_name)
+          save_store store.data
         end
-        global_mask = local_store.get(MASKED_AREA)
+        global_mask = store.get(MASKED_AREA)
         screen_mask = benchmark.nil? ? nil : benchmark[MASKED_AREA]
         response = ImageCompare.perform(benchmark_path, screenshot_path, global_mask, screen_mask)
         response[SCREENNAME] = screenname
@@ -77,80 +92,80 @@ module YordiTests
         File.delete item if clean_dir
       end
       report_hash = {name: name, tests: responses}
-      File.open(REPORT_FILE, 'w') {|file| file.write(report_hash.to_json)}
+      save_report(report_hash)
 
       # sync with yorditests.com if desired
-      sync_with_yordi local_store, sync_all, sync_failures if sync_all || sync_failures
+      sync_with_yordi store, sync_all, sync_failures if sync_all || sync_failures
       generate_report
     end
 
-    def generate_report
-      # generate report
-      YordiTests::Generators::Report.start([REPORT_HTML, read_report])
+    # helper functions
 
+    def store?
+      Dir.exist? YORDI_DIR
     end
 
-    def sync_with_yordi(store, sync_all, sync_failures)
-      # sync with remote
-      puts 'Syncing with YordiTests'
-      report = read_report
-      client = YordiTests.client
-      client.apikey = store.apikey if store.apikey
-      if !report.nil? && !report['tests'].empty?
-        reports = report['tests']
-        failures = 0
-        if sync_failures
-          reports.each do |item|
-            failures += 1 unless item['passed']
-          end
-        end
+    def read_store
+      read_json(CONFIG_FILE)
+    end
 
-        if sync_all || failures > 0
-          client.start report['name']
-          reports.each do |item|
-            next unless sync_all || !item['passed']
-            puts item[SCREENNAME]
-            benchmark = store.benchmark_by_screenname(item[SCREENNAME])
-            filename = SCREENS_PATH + '/' + benchmark[LOCAL_FILENAME]
-            client.upload filename, item[SCREENNAME]
-          end
-          client.stop
-        end
+    def read_report
+      read_json(REPORT_FILE)
+    end
+
+    def read_json(path)
+      if File.exist? path
+        file = File.read path
+        JSON(file)
+      else
+        YordiTests.safe_puts "No file at: #{path} did you call initialize this directory"
       end
+
     end
 
-    # Fetch entry from the CLI
-    def fetch(get_benchmarks, get_masks, screens)
-      local_store = LocalStore.new(read_store)
-      ## no api key
-      return unless local_store.apikey
+    def save_report(store_hash)
+      save_data(REPORT_FILE, store_hash)
+    end
 
-      client = YordiTests.client
-      client.apikey = local_store.apikey
-      remote_data = client.fetch_application
+    def save_store(store_hash)
+      save_data(CONFIG_FILE, store_hash)
+    end
 
-      ## no remote store
-      return unless remote_data
+    def save_data(file_path, hash)
+      File.open(file_path, 'w') {|file| file.write(hash.to_json)}
+    end
 
-      remote_store = LocalStore.new(remote_data)
 
-      update_store_base(local_store, remote_store)
-      replace_benchmarks(client, local_store, remote_store, screens) if get_benchmarks
-      replace_masks(local_store, remote_store, screens) if get_masks
+    def sync_with_yordi(store, sync_all, sync_failures)
+      # sync with remote
+      return unless store.apikey
+      YordiTests.safe_puts 'Syncing with YordiTests'
+      report = read_report
+      return if report.nil? || report['tests'].empty?
+      reports = report['tests']
 
-      save_store local_store.data
-    end
+      client = YordiTests.client
+      client.apikey = store.apikey
 
-    def update_store_base(local_store, remote_store)
-      local_store.put(TITLE, remote_store.get(TITLE))
-      local_store.put(APIKEY, remote_store.apikey)
+      # filter out passed tests if failures syncing is on
+      if sync_failures && !sync_all
+        reports = reports.reject {|item| item['passed']}
+      end
+
+      return unless sync_all || !reports.empty?
+
+      client.start report['name']
+      reports.each do |item|
+        YordiTests.safe_puts "Uploading #{item[SCREENNAME]}"
+        benchmark = store.benchmark_by_screenname(item[SCREENNAME])
+        filename = File.join(SCREENS_PATH, benchmark[LOCAL_FILENAME])
+        client.upload filename, item[SCREENNAME]
+      end
+      client.stop
     end
 
     def replace_benchmarks(client, local_store, remote_store, screens)
-      # no api key
-      screens = remote_store.all_screens unless screens
-
-      Dir.mkdir(BENCHMARKS_PATH) unless Dir.exist? BENCHMARKS_PATH
+      screens ||= remote_store.all_screens
 
       screens.each do |screen|
         benchmark = remote_store.benchmark_by_screenname(screen)
@@ -159,11 +174,11 @@ module YordiTests
         benchmark[LOCAL_FILENAME] = sanitize(screen) + File.extname(benchmark[FILENAME])
 
         # download benchmark
-        puts "Downloading #{screen}"
+        YordiTests.safe_puts "Downloading #{screen}"
         benchmark_image = client.fetch_benchmark(screen)
 
         # update store to reflex file name of benchmark
-        file_path = "#{BENCHMARKS_PATH}/#{benchmark[LOCAL_FILENAME]}"
+        file_path = File.join(BENCHMARKS_PATH, benchmark[LOCAL_FILENAME])
         File.open(file_path, 'w') {|file| file.write(benchmark_image)}
         local_store.update_benchmark(benchmark)
       end
@@ -172,15 +187,20 @@ module YordiTests
     def replace_masks(local_store, remote_store, screens)
       # global mask
       local_store.put(MASKED_AREA, remote_store.get(MASKED_AREA))
-      screens = remote_store.all_screens unless screens
+      screens ||= remote_store.all_screens
       screens.each do |screen|
         benchmark = remote_store.benchmark_by_screenname(screen)
         # download benchmark
-        puts "Update mask for #{screen}"
+        YordiTests.safe_puts "Update mask for #{screen}"
         local_store.update_mask(benchmark) if benchmark
       end
     end
 
+    def verify_directories
+      Dir.mkdir(YORDI_DIR) unless Dir.exist? YORDI_DIR
+      Dir.mkdir(BENCHMARKS_PATH) unless Dir.exist? BENCHMARKS_PATH
+      Dir.mkdir(SCREENS_PATH) unless Dir.exist? SCREENS_PATH
+    end
 
     def sanitize(filename)
       # Remove any character that aren't 0-9, A-Z, or a-z

data/lib/yordi_tests/{local_store.rb → data_store.rb}

@@ -8,7 +8,7 @@ module YordiTests
   LOCAL_FILENAME = 'local_filename'.freeze
   TITLE = 'title'.freeze
 
-  class LocalStore
+  class DataStore
 
     def initialize(json_store)
       @store = json_store
@@ -17,6 +17,9 @@ module YordiTests
     def apikey
       get(APIKEY)
     end
+    def title
+      get(TITLE)
+    end
 
     def data
       @store
@@ -27,7 +30,8 @@ module YordiTests
     end
 
     def get(key)
-      @store[key]
+      return @store[key].dup unless @store[key].nil?
+      nil
     end
 
     def all_screens
@@ -37,6 +41,10 @@ module YordiTests
       end
       screens
     end
+    def update_root_data(title, apikey)
+      put(TITLE, title)
+      put(APIKEY, apikey)
+    end
 
     def update_benchmark(benchmark)
       benchmark_pos = benchmark_pos_by_screenname(benchmark[SCREENNAME])
@@ -49,12 +57,21 @@ module YordiTests
       end
     end
 
+    def add_benchmark(screenname, local_name)
+      benchmark = {SCREENNAME => screenname,
+                   MASKED_AREA => nil,
+                   FILENAME => local_name,
+                   LOCAL_FILENAME => local_name}
+      @store[BENCHMARKS] << benchmark.dup
+      benchmark
+    end
+
     def update_mask(benchmark)
       benchmark_pos = benchmark_pos_by_screenname(benchmark[SCREENNAME])
       if benchmark_pos < 0
         @store[BENCHMARKS] << benchmark.dup
       else
-        @store[BENCHMARKS][benchmark_pos][MASKED_AREA] = benchmark[MASKED_AREA]
+        @store[BENCHMARKS][benchmark_pos][MASKED_AREA] = benchmark[MASKED_AREA].dup unless benchmark[MASKED_AREA].nil?
       end
     end
 

data/lib/yordi_tests/generators/report.html.erb

@@ -89,7 +89,7 @@
 
       <td>
         <b>Result</b><br/>
-        <img style="width:100%" src="benchmarks/<%= item['local_filename'] %>"/>
+        <img style="width:100%" src="screenshots/<%= item['local_filename'] %>"/>
 
       </td>
     </tr>

data/lib/yordi_tests/image_compare.rb

@@ -1,7 +1,6 @@
 require 'yordi_tests'
 require 'mini_magick'
 require 'securerandom'
-require 'yordi_tests/local_store'
 module YordiTests
   module ImageCompare
     module_function

data/lib/yordi_tests/version.rb

@@ -1,3 +1,3 @@
 module YordiTests
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yordi_tests
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Brian OQR
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-10 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -115,10 +115,10 @@ files:
 - lib/yordi_tests/cli.rb
 - lib/yordi_tests/client.rb
 - lib/yordi_tests/data_manager.rb
+- lib/yordi_tests/data_store.rb
 - lib/yordi_tests/generators/report.html.erb
 - lib/yordi_tests/generators/report.rb
 - lib/yordi_tests/image_compare.rb
-- lib/yordi_tests/local_store.rb
 - lib/yordi_tests/version.rb
 - yordi_tests.gemspec
 homepage: https://www.yorditests.com