percy-appium-app 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b85f47e434a501c80e0bf46e7c32699099517b75a6db8c63ce3b50887a68cea5
-  data.tar.gz: 405d12bc2a4d8369821b2828ef408f6266fe4c644d5c111028cd18670facefc3
+  metadata.gz: 3b46a8c2b5a23c5a4171481451b2769eb6c60954ba7a9f1d43ad8d7ac72dc47a
+  data.tar.gz: 0e3480e5bebad1e1d3354792d818709f43b9040e8aee7b52ecb3f80af688db82
 SHA512:
-  metadata.gz: 336482f05ae03ca94a8afd4d7f770f9df9c2279b70a84be32c4d1c7a201830cef8b8dbadf8c6a3ead2732838adc6bb8b34a49adc1de1b2635bc93325f9b1cb90
-  data.tar.gz: 2fd10faace0a45f16470860f8945d39ab8c1a789453779cc8f8bede44492567c1665f726d06aad856984cc10875c370f6146e2d53a7097e5f80343a7d3db6ee9
+  metadata.gz: e139e6eac3e362ddeeadb9a36653e2a17dd2c2a85acdbb73e2f486afea8ee098b35db88127d35d95882beda8a825392f87ab1462e75da81709fb1f01824df974
+  data.tar.gz: 199703de73702fb3125607f6588a1abbeb146af01993d4d63b66b8dcc5fcf7607a5db18ee31d0008c18269c44db198dbf1fd6170a62c98bdcd972b7b3f66eefd

data/percy/common/common.rb

@@ -2,14 +2,13 @@
 
 require 'dotenv/load'
 
-PERCY_LOGLEVEL = ENV['PERCY_LOGLEVEL']
-PERCY_DEBUG = PERCY_LOGLEVEL == 'debug'
-LABEL = "[\e[35m#{PERCY_DEBUG ? 'percy:ruby' : 'percy'}\e[39m]"
 
 def log(message, on_debug: nil)
-  return unless on_debug.nil? || (on_debug.is_a?(TrueClass) && PERCY_DEBUG)
+  return unless on_debug.nil? || (on_debug.is_a?(TrueClass) && percy_debug)
 
-  puts "#{LABEL} #{message}"
+  label = "[\e[35m#{percy_debug ? 'percy:ruby' : 'percy'}\e[39m]"
+
+  puts "#{label} #{message}"
 end
 
 def hashed(object)
@@ -17,3 +16,7 @@ def hashed(object)
 
   object
 end
+
+def percy_debug
+  ENV['PERCY_LOGLEVEL'] == 'debug'
+end

data/percy/lib/app_percy.rb

@@ -48,6 +48,18 @@ module Percy
               'Argument orientation should be a String and portrait/landscape'
       end
 
+      test_case = kwargs[:test_case]
+      if test_case && !test_case.is_a?(String)
+        raise TypeError,
+              'Argument test_case should be a String'
+      end
+
+      th_test_case_execution_id = kwargs[:th_test_case_execution_id]
+      if th_test_case_execution_id && !th_test_case_execution_id.is_a?(String)
+        raise TypeError,
+              'Argument th_test_case_execution_id should be a String'
+      end
+
       @provider.screenshot(name, **kwargs)
     end
 

data/percy/lib/cli_wrapper.rb

@@ -49,8 +49,9 @@ module Percy
     end
 
     def post_screenshots(name, tag, tiles, external_debug_url = nil, ignored_elements_data = nil,
-                        considered_elements_data = nil, sync = nil)
-      body = request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data, sync)
+                         considered_elements_data = nil, sync = nil, test_case = nil, th_test_case_execution_id = nil)
+      body = request_body(name, tag, tiles, external_debug_url, ignored_elements_data,
+                          considered_elements_data, sync, test_case, th_test_case_execution_id)
       body['client_info'] = Percy::Environment.get_client_info
       body['environment_info'] = Percy::Environment.get_env_info
 
@@ -124,7 +125,8 @@ module Percy
       data
     end
 
-    def request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data, sync)
+    def request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data, sync,
+                     test_case, th_test_case_execution_id)
       tiles = tiles.map(&:to_h)
       {
         'name' => name,
@@ -133,7 +135,9 @@ module Percy
         'ignored_elements_data' => ignored_elements_data,
         'external_debug_url' => external_debug_url,
         'considered_elements_data' => considered_elements_data,
-        'sync' => sync
+        'sync' => sync,
+        'test_case' => test_case,
+        'th_test_case_execution_id' => th_test_case_execution_id
       }
     end
   end

data/percy/metadata/metadata.rb

@@ -103,7 +103,10 @@ module Percy
       return @device_info unless @device_info.empty?
 
       @device_info = DEVICE_INFO[device_name.downcase] || {}
-      log("#{device_name.downcase} does not exist in config.") if @device_info.empty?
+      if @device_info.empty?
+        log("#{device_name.downcase} does not exist in config. Making driver call to get the device info.",
+            on_debug: true)
+      end
       @device_info
     end
   end

data/percy/providers/generic_provider.rb

@@ -43,8 +43,11 @@ module Percy
         )
       }
       sync = kwargs.fetch(:sync, nil)
+      test_case = kwargs.fetch(:test_case, nil)
+      th_test_case_execution_id = kwargs.fetch(:th_test_case_execution_id, nil)
 
-      _post_screenshots(name, tag, tiles, get_debug_url, ignore_regions, consider_regions, sync)
+      _post_screenshots(name, tag, tiles, get_debug_url, ignore_regions, consider_regions,
+                        sync, test_case, th_test_case_execution_id)
     end
 
     def _get_tag(**kwargs)
@@ -81,7 +84,8 @@ module Percy
       header_height = 0
       footer_height = 0
       [
-        Percy::Tile.new(status_bar_height, nav_bar_height, header_height, footer_height, filepath: path, fullscreen: fullscreen)
+        Percy::Tile.new(status_bar_height, nav_bar_height, header_height, footer_height, filepath: path,
+                                                                                         fullscreen: fullscreen)
       ]
     end
 
@@ -94,8 +98,20 @@ module Percy
       elements_array
     end
 
-    def _post_screenshots(name, tag, tiles, debug_url, ignored_regions, considered_regions, sync)
-      Percy::CLIWrapper.new.post_screenshots(name, tag, tiles, debug_url, ignored_regions, considered_regions, sync)
+    def _post_screenshots(
+      name,
+      tag,
+      tiles,
+      debug_url,
+      ignored_regions,
+      considered_regions,
+      sync,
+      test_case,
+      th_test_case_execution_id
+    )
+      Percy::CLIWrapper.new.post_screenshots(
+        name, tag, tiles, debug_url, ignored_regions, considered_regions, sync, test_case, th_test_case_execution_id
+      )
     end
 
     def _write_screenshot(png_bytes, directory)

data/percy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Percy
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.8'.freeze
 end

data/specs/cli_wrapper.rb

@@ -105,8 +105,10 @@ class TestCLIWrapper < Minitest::Test
     name = 'some-name'
     debug_url = 'debug-url'
     sync = false
+    test_case = 'test-case-1'
+    th_test_case_execution_id = 'uuid-1231231'
     response = @cli_wrapper.request_body(name, tag, [tile], debug_url, @ignored_elements_data,
-                                         @considered_elements_data, sync)
+                                         @considered_elements_data, sync, test_case, th_test_case_execution_id)
     assert_equal response['name'], name
     assert_equal response['external_debug_url'], debug_url
     assert_equal response['tag'], tag
@@ -114,6 +116,8 @@ class TestCLIWrapper < Minitest::Test
     assert_equal response['ignored_elements_data'], @ignored_elements_data
     assert_equal response['considered_elements_data'], @considered_elements_data
     assert_equal response['sync'], sync
+    assert_equal response['test_case'], test_case
+    assert_equal response['th_test_case_execution_id'], th_test_case_execution_id
   end
 
   def test_request_body_when_optional_values_are_null
@@ -125,13 +129,15 @@ class TestCLIWrapper < Minitest::Test
     considered_elements_data = nil
     sync = nil
     response = @cli_wrapper.send(:request_body, name, tag, [tile], debug_url, ignored_elements_data,
-                                 considered_elements_data, sync)
+                                 considered_elements_data, sync, nil, nil)
     assert_equal response['name'], name
-    assert_equal response['external_debug_url'], debug_url
+    assert_nil response['external_debug_url']
     assert_equal response['tag'], tag
     assert_equal response['tiles'], [tile.to_h]
     assert_nil response['ignored_elements_data']
     assert_nil response['considered_elements_data']
     assert_nil response['sync']
+    assert_nil response['test_case']
+    assert_nil response['th_test_case_execution_id']
   end
 end

data/specs/metadata.rb

@@ -28,11 +28,39 @@ class TestMetadata < Minitest::Test
     ENV['PERCY_LOGLEVEL'] = 'debug'
   end
 
-  def test_get_device_info_device_not_present
+  def test_get_device_info_device_not_present_when_log_level_is_debug
+    # redirecting the standard output temporarily and capture the output in a string. 
+    captured_output = StringIO.new
+    $stdout = captured_output
+    ENV['PERCY_LOGLEVEL'] = 'debug'
     device_name = 'Some Phone 123'
-    assert_output(/#{Regexp.escape(device_name.downcase)} does not exist in config\./) do
-      @metadata.get_device_info(device_name)
-    end
+    @metadata.get_device_info(device_name)
+    # Restore standard output
+    $stdout = STDOUT
+
+    # Get the captured output as a string
+    output = captured_output.string
+    regex_pattern = /#{Regexp.escape(device_name.downcase)} does not exist in config\. Making driver call to get the device info\./
+
+    assert_match(regex_pattern, output)
+    ENV['PERCY_LOGLEVEL'] = nil
+  end
+
+  def test_get_device_info_device_not_present_when_log_level_is_info
+    # redirecting the standard output temporarily and capture the output in a string. 
+    captured_output = StringIO.new
+    $stdout = captured_output
+    ENV['PERCY_LOGLEVEL'] = nil
+    device_name = 'Some Phone 123'
+    @metadata.get_device_info(device_name)
+
+    # Restore standard output
+    $stdout = STDOUT
+
+    # Get the captured output as a string
+    output = captured_output.string
+
+    assert_equal(output, '')
   end
 
   def test_metadata_get_orientation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-appium-app
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - BroswerStack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib