fastlane-plugin-snapshot_test 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 677b83e869da2e53021b30471eeb9ad5cf968cb827bd2b1ea74a7b87b94a8a15
-  data.tar.gz: c735fc43fdfcd87bef3707d19347a8fe8e44282b485ab824ce8f86ff6ed6ee9c
+  metadata.gz: f1188ae451fe6c78b6970a1a5fa6c42671b48059e586a8acf11d4288a89b3e8b
+  data.tar.gz: 9604828f6e2a7c1698924af5b4aaada7dc9245334b981a0ad10bd4c4d288bfea
 SHA512:
-  metadata.gz: ce859b31c9271be29b000512d1d4938636ac35b0d86b86702dacd4d54eeef9af110dc564fe30a1611cae088caf82f714f202dd3ea3f6be53de1c08532ae1021a
-  data.tar.gz: 7a8ebd24adc7f168bff622945d6c557a1d27d11266f885cf74a2b66c1f51f927e05131cd6ebfec47ce9a18772c49039dd4b9b0f574293939e1a8ee51d487ff27
+  metadata.gz: 59978bdbdc886ea6afe9202064490ca43f12a401597f0df89c6ffd622f87e06e54c909fe1b3786326d78a5698d6b4976a2c89532bceb441d465b66694e06508e
+  data.tar.gz: 42e652f5cf57d497238a7fcb8ea39b0f44c1a5fc61b76c5b23d9dc4ef62a76ead3dfa3cb765543b768afde19de14eac610bbf15134836ec3dbad191715b18b0b

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Moyuru Aizawa <lvla0805@gmail.com>
+Copyright (c) 2019 CyberAgent, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -20,6 +20,18 @@ compare screenshots with previous commit's screenshots.
 
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
 
+In case of `screenshot_dir` like below,
+
+```
+.screenshot
+  ├ Nexus6
+  |  ├ MainPage.jpg
+  |  └ SubPage.jpg
+  └ Nexus6P
+     ├ MainPage.jpg
+     └ SubPage.jpg
+```
+
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

data/lib/fastlane/plugin/snapshot_test/actions/compatibility/screenshot_notifier.rb

@@ -1,4 +1,5 @@
 require 'fastlane/action'
+
 require_relative '../../helper/helper'
 
 module Fastlane
@@ -160,6 +161,20 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :android
       end
+
+      def self.example_code
+        ['screenshot_notifier(
+            gcloud_service_key_file: "fastlane/client-secret.json",
+            screenshot_bucket: "cats-firebase",
+            screenshot_dir: ".screenshot",
+            github_owner: "cats-oss",
+            github_repository: "android",
+            github_pr_number: ENV["CI_PULL_REQUEST"][/(?<=https:\/\/github.com\/cats-oss\/android\/pull\/)(.*)/],
+            github_api_token: ENV["DANGER_GITHUB_API_TOKEN"],
+            image_length: 100
+        )']
+      end
+
     end
   end
 end

data/lib/fastlane/plugin/snapshot_test/actions/regression/compare_snapshot.rb

@@ -49,17 +49,17 @@ module Fastlane
         bucket = params[:snapshot_bucket]
         commit_hash = Helper.get_current_commit_hash
 
-        message = <<-EOS
-## Snapshot Test Result
-Commit Hash: #{commit_hash}
+        message = <<~EOS
+          ## Snapshot Test Result
+          Commit Hash: #{commit_hash}
 
-#{summary_table(result[:new_items], result[:deleted_items], result[:changed_items], result[:passed_items])}
+          #{summary_table(result[:new_items], result[:deleted_items], result[:changed_items], result[:passed_items])}
 
-#{changed_items_table(result[:changed_items], bucket, commit_hash, params[:working_dir], params[:image_length])}
+          #{changed_items_table(result[:changed_items], bucket, commit_hash, params[:working_dir], params[:image_length])}
 
-#{new_items_table(result[:new_items], bucket, commit_hash, params[:working_dir], params[:image_length])}
+          #{new_items_table(result[:new_items], bucket, commit_hash, params[:working_dir], params[:image_length])}
 
-#{deleted_items_list(result[:deleted_items])}
+        #{deleted_items_list(result[:deleted_items])}
         EOS
 
         GitHubNotifier.fold_comments(
@@ -80,14 +80,14 @@ Commit Hash: #{commit_hash}
       end
 
       def self.summary_table(new_items, deleted_items, changed_items, passed_items)
-        <<-EOS
-### Summary
-|  | Count |
-| --- | --- |
-| New Screenshots | #{new_items.size} |
-| Deleted Screenshots | #{deleted_items.size} |
-| Changed Screenshots | #{changed_items.size} |
-| Passed Screenshots | #{passed_items.size} |
+        <<~EOS
+          ### Summary
+          |  | Count |
+          | --- | --- |
+          | New Screenshots | #{new_items.size} |
+          | Deleted Screenshots | #{deleted_items.size} |
+          | Changed Screenshots | #{changed_items.size} |
+          | Passed Screenshots | #{passed_items.size} |
         EOS
       end
 
@@ -222,6 +222,22 @@ Commit Hash: #{commit_hash}
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        ['pr_number = ENV["CI_PULL_REQUEST"] != nil ? ENV["CI_PULL_REQUEST"][/(?<=https:\/\/github.com\/cats-oss\/android\/pull\/)(.*)/] : nil
+        compare_snapshot(
+            gcloud_service_key_file: "fastlane/client-secret.json",
+            snapshot_bucket: "cats-android-snapshot",
+            working_dir: ".snapshot_test",
+            screenshot_dir: ".screenshot/shamu-22-ja_JP-portrait",
+            github_owner: "cats-oss",
+            github_repository: "android",
+            github_pr_number: pr_number,
+            github_api_token: ENV["DANGER_GITHUB_API_TOKEN"],
+            image_length: 100
+      )']
+      end
+
     end
   end
 end

data/lib/fastlane/plugin/snapshot_test/actions/regression/upload_snapshot.rb

@@ -58,6 +58,16 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        ['upload_snapshot(
+            gcloud_service_key_file: "fastlane/client-secret.json",
+            snapshot_bucket: "cats-android-snapshot",
+            working_dir: ".snapshot_test",
+            screenshot_dir: ".screenshot/shamu-22-ja_JP-portrait"
+        )']
+      end
+
     end
   end
 end

data/lib/fastlane/plugin/snapshot_test/actions/take_screenshot.rb

@@ -116,6 +116,31 @@ module Fastlane
           hash_obj[property] = default
         end
       end
+
+      def self.example_code
+        ['take_screenshot(
+            project_id: "cats-firebase",
+            gcloud_service_key_file: "fastlane/client-secret.json",
+            devices: [
+              {
+                  model: "shamu",
+                  version: "22",
+                  locale: "ja_JP",
+                  orientation: "portrait"
+              },
+              {
+                  model: "Pixel2",
+                  version: "28"
+              }
+            ],
+            app_apk: "tools/app-snapshot-debug.apk",
+            app_test_apk: "app/build/outputs/apk/androidTest/snapshot/debug/installedapp-snapshot-debug-androidTest.apk",
+            firebase_test_lab_results_bucket: "cats-android-firebase-instrumented-test",
+            timeout: "10m",
+            download_dir: ".screenshot"
+        )']
+      end
+
     end
   end
 end

data/lib/fastlane/plugin/snapshot_test/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module SnapshotTest
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-snapshot_test
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Moyuru Aizawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2019-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry