percy-appium-app 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8894474b866e7988f60b776f782f3c04887b4aa626cf2a384f2c97d983a534fc
-  data.tar.gz: 461ea9e2bf18840893f9b805ea93e8005874b4c9ddbcdf447d71e691051a015f
+  metadata.gz: bdb1ff6892c099d297d97844d8dd24985e6be0361e78da39e274d844945ea869
+  data.tar.gz: ba73fd618e623111852a73900165ae0a9315fe5a8ebb768ca4d3eb8d86928db5
 SHA512:
-  metadata.gz: c91b292ad5b7a2ba6d04a64294d539caf6da3a9da7809663625a07f441563d242e00a37025ef2a96bdeafe3f604af7b286709676debeb18ca0834f22590e790c
-  data.tar.gz: e670e5434e2d4ace31348e736134f6976d8fa2bc1548febe7b7d70faeab6f057b833fc1809c84cf1c3b7b5a21922f41d75df3134b4fc7d2167a9354775da8d86
+  metadata.gz: e94a5a62b0a3c82630b63ba011a423978c924bfd31c2ad4de7ea92c1f1a5ce532530a5fcbd2de72f8c89908c404ef353b1ac3c415abb3d3806e6f5eaac125875
+  data.tar.gz: 68fbb5b42c1df5e5b8d39f75debe939d7e76408ff8370e7998f04f60adec7fe37a875504e13b93b9876a39595b67195299d4f4a348407e4064770a5a20e6610d

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -11,7 +11,7 @@ assignees: ''
 
 There are common setup gotchas that happen with Percy's SDKs, it would be worth reading
 the debugging document, which might already answer your question:
-https://docs.percy.io/docs/debugging-sdk
+https://www.browserstack.com/docs/percy/integrate/percy-sdk-workflow#debugging-sdks
 
 ## Reach out to Percy support instead?
 
@@ -43,7 +43,7 @@ If necessary, describe the problem you have been experiencing in more detail.
 ## Debug logs
 
 If you are reporting a bug, _always_ include logs! [Give the "Debugging SDKs"
-document a quick read for how to gather logs](https://docs.percy.io/docs/debugging-sdks#debugging-sdks)
+document a quick read for how to gather logs](https://www.browserstack.com/docs/percy/integrate/percy-sdk-workflow#debugging-sdks)
 
 Please do not trim or edit these logs, often times there are hints in the full
 logs that help debug what is going on.

data/README.md

@@ -181,7 +181,7 @@ $ percy exec -- [ruby test command]
 [percy] Done!
 ```
 
-Refer to docs here: [Percy on Automate](https://docs.percy.io/docs/integrate-functional-testing-with-visual-testing)
+Refer to docs here: [Percy on Automate](https://www.browserstack.com/docs/percy/integrate/functional-and-visual)
 
 ### Migrating Config
 

data/percy/lib/app_percy.rb

@@ -48,6 +48,24 @@ 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
+
+      labels = kwargs[:labels]
+      if labels && !labels.is_a?(String)
+        raise TypeError,
+              'Argument labels 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, labels = 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, labels, 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, labels, th_test_case_execution_id)
       tiles = tiles.map(&:to_h)
       {
         'name' => name,
@@ -133,7 +135,10 @@ 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,
+        'labels' => labels,
+        'th_test_case_execution_id' => th_test_case_execution_id
       }
     end
   end

data/percy/providers/generic_provider.rb

@@ -43,8 +43,12 @@ module Percy
         )
       }
       sync = kwargs.fetch(:sync, nil)
+      test_case = kwargs.fetch(:test_case, nil)
+      labels = kwargs.fetch(:labels, 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, labels, th_test_case_execution_id)
     end
 
     def _get_tag(**kwargs)
@@ -81,7 +85,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 +99,21 @@ 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,
+      labels,
+      th_test_case_execution_id
+    )
+      Percy::CLIWrapper.new.post_screenshots(
+        name, tag, tiles, debug_url, ignored_regions, considered_regions, sync, test_case, labels, 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.7'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/specs/cli_wrapper.rb

@@ -105,8 +105,11 @@ class TestCLIWrapper < Minitest::Test
     name = 'some-name'
     debug_url = 'debug-url'
     sync = false
+    test_case = 'test-case-1'
+    labels = 'app;testing'
+    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, labels, 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 +117,9 @@ 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['labels'], labels
+    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 +131,16 @@ 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, 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['labels']
+    assert_nil response['th_test_case_execution_id']
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-appium-app
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
 - BroswerStack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-29 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib
@@ -202,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Percy visual testing for Ruby Appium Mobile Apps