fastlane-plugin-snapshot_test 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a098870c72f522fd964d25677e67ea4261bc7dd9d2fe8cacaa129a82b2d98c21
-  data.tar.gz: a71eb32a3d7680fed8ec459704df16ecf41c7944106cf9a20eee9df513e16eae
+  metadata.gz: 369ce048fb4948441d4f3c47f4f22ff8a9c650b20cb8885f89ee1f82793928eb
+  data.tar.gz: f0582347d70ebc8e36c8d9230b7e530229e4d99b15e0e1e4ce8053d65f2a7ae2
 SHA512:
-  metadata.gz: dadc72f1ac54582138ee9e54c40970ec727e0b99329e8f402e6c063cc5c559d12cbe8b7b904edb878e888e3cb3e5700677a0b9ab088788ca99cb63f49dda8a54
-  data.tar.gz: a1694820bd772d51179d2f61be4556a3bd67a2f0896f5c22d7808723efe8e8fc6700333566683627b79c0c3ed32c5fa5c8b9458588a3cb2800732d1c2223572f
+  metadata.gz: 3c90e1cb6ebff04d0a7196683bcc848771c2e899e3e7d4f71ad5d5ea669d80473a78c84dcdff439c748d18218a52b4dc30d6fcf7c98ef96e993bdb37a55c35df
+  data.tar.gz: 5d1923dc1562593e98a55586b05ffc5699d4c8bdf20aa64b7fcc2ba4baf89065febcb1701543512b89e01b10a4b204bb5261780f5c5404ccffb727aca02263e7

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

@@ -0,0 +1,165 @@
+require 'fastlane/action'
+require_relative '../../helper/helper'
+
+module Fastlane
+  module Actions
+    class ScreenshotNotifierAction < Action
+      def self.run(params)
+        Helper.authenticate(params[:gcloud_service_key_file])
+        commit_hash = Helper.get_current_commit_hash
+
+        UI.message "Upload screenshots to cloud storage"
+        Action.sh "gsutil -m rsync -d -r #{params[:screenshot_dir]} gs://#{params[:screenshot_bucket]}/#{commit_hash}"
+
+        UI.message "Delete previous PR comments"
+        GitHubNotifier.delete_comments(
+            params[:github_owner],
+            params[:github_repository],
+            params[:github_pr_number],
+            "## Screenshots of each devices",
+            params[:github_api_token]
+        )
+
+        UI.message "Post screenshots as PR comments"
+        screenshot_dir = params[:screenshot_dir]
+        devices = Dir.chdir("#{screenshot_dir}") do
+          Dir.glob("*").select { |path| FileTest.directory? path }.sort
+        end
+        if devices.empty?
+          UI.message("That screenshot dir is empty")
+          return
+        end
+
+        header = "<tr><td>Screen Name</td>\n#{devices.map { |device| "<td>#{device}</td>\n" }.inject(&:+)}</tr>"
+        rows = Dir.glob("#{screenshot_dir}/#{devices[0]}/*.jpg")
+                   .map { |path| File.basename(path) }
+                   .map { |file_name|
+                     cells = devices.map { |device|
+                       file_path = "#{screenshot_dir}/#{device}/#{file_name}"
+                       next "<td></td>" unless File.exist?(file_path)
+                       ratio = Helper.calc_aspect_ratio(file_path)
+                       is_portrait = ratio >= 1.0
+                       size_attr = if params[:image_length] != nil
+                                     if is_portrait
+                                       height = params[:image_length]
+                                       width = height / ratio
+                                       "height=\"#{height}px\" width=\"#{width}px\""
+                                     else
+                                       width = params[:image_length] * ratio
+                                       height = width * ratio
+                                       "height=\"#{height}px\" width=\"#{width}px\""
+                                     end
+                                   else
+                                     ""
+                                   end
+
+                       url = object_url(params[:screenshot_bucket], "#{commit_hash}/#{device}/#{file_name}")
+                       "<td><img src=\"#{url}\" #{size_attr}/></td>\n"
+                     }.inject(&:+)
+                     "<tr><td>#{file_name}</td>\n#{cells}</tr>\n"
+                   }.inject(&:+)
+
+        table = "<table>#{header}#{rows}</table>"
+        comment = if params[:fold_result]
+                    "## Screenshots of each devices\n\n"\
+                    "<details>"\
+                    "<summary>Open</summary>"\
+                    "#{table}"\
+                    "</details>"
+                  else
+                    "## Screenshots of each devices\n\n"\
+                    "#{table}"
+                  end
+        UI.message comment
+        GitHubNotifier.put_comment(
+            params[:github_owner],
+            params[:github_repository],
+            params[:github_pr_number],
+            comment,
+            params[:github_api_token]
+        )
+      end
+
+      def self.object_url(bucket, path)
+        Helper.firebase_object_url(bucket, path)
+      end
+
+      def self.description
+        "Post Screenshots to Pull Request"
+      end
+
+      def self.details
+        "Post Screenshots to Pull Request"
+      end
+
+      def self.available_options
+        [
+            FastlaneCore::ConfigItem.new(key: :gcloud_service_key_file,
+                                         env_name: "GCLOUD_SERVICE_KEY_FILE",
+                                         description: "File path containing the gcloud auth key. Default: Created from GCLOUD_SERVICE_KEY environment variable",
+                                         type: String,
+                                         optional: false),
+            FastlaneCore::ConfigItem.new(key: :screenshot_bucket,
+                                         env_name: "SCREENSHOT_BUCKET",
+                                         description: "Bucket name to store screenshots",
+                                         type: String,
+                                         optional: false),
+            FastlaneCore::ConfigItem.new(key: :screenshot_dir,
+                                         env_name: "SCREENSHOT_DIR",
+                                         description: "Directory that has screenshots",
+                                         type: String,
+                                         optional: false),
+            FastlaneCore::ConfigItem.new(key: :fold_result,
+                                         env_name: "FOLD_RESULT",
+                                         description: "Fold screenshots table",
+                                         type: Boolean,
+                                         optional: false,
+                                         default_value: false),
+            FastlaneCore::ConfigItem.new(key: :github_owner,
+                                         env_name: "GITHUB_OWNER",
+                                         description: "Owner name",
+                                         type: String,
+                                         optional: false),
+            FastlaneCore::ConfigItem.new(key: :github_repository,
+                                         env_name: "GITHUB_REPOSITORY",
+                                         description: "Repository name",
+                                         type: String,
+                                         optional: false),
+            FastlaneCore::ConfigItem.new(key: :github_pr_number,
+                                         env_name: "GITHUB_PR_NUMBER",
+                                         description: "Pull request number",
+                                         type: String,
+                                         optional: false),
+            FastlaneCore::ConfigItem.new(key: :github_api_token,
+                                         env_name: "GITHUB_API_TOKEN",
+                                         description: "GitHub API Token",
+                                         type: String,
+                                         optional: false),
+            FastlaneCore::ConfigItem.new(key: :image_length,
+                                         env_name: "IMAGE_LENGTH",
+                                         description: "Length px of the long side of screenshots",
+                                         is_string: false,
+                                         optional: true)
+        ]
+      end
+
+      def self.output
+        # Define the shared values you are going to provide
+        # Example
+        []
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.authors
+        ["MoyuruAizawa"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/snapshot_test/actions/{snapshot_test_action.rb → regression/compare_snapshot_action.rb}

@@ -1,10 +1,13 @@
-require_relative '../helper/github_notifier'
-require_relative '../helper/helper'
+require 'fastlane/action'
+
+require_relative '../../helper/comparator'
+require_relative '../../helper/github_notifier'
+require_relative '../../helper/helper'
 require 'json'
 
 module Fastlane
   module Actions
-    class SnapshotTestAction < Action
+    class CompareSnapshotAction < Action
       def self.run(params)
         Helper.authenticate(params[:gcloud_service_key_file])
 
@@ -32,7 +35,7 @@ module Fastlane
         `rm -rf #{working_dir}/diff`
         `mkdir #{working_dir}/diff`
         result = Comparator.compare_dir("#{working_dir}/expected", "#{working_dir}/actual", "#{working_dir}/diff", params[:fuzz])
-        open("#{working_dir}/result.json", "w") {|io| io.puts(JSON.pretty_generate(result))}
+        open("#{working_dir}/result.json", "w") { |io| io.puts(JSON.pretty_generate(result)) }
         Action.sh "gsutil -m rsync -d -r #{working_dir} gs://#{snapshot_bucket}/#{Helper.get_current_commit_hash}"
 
         UI.message result
@@ -46,18 +49,18 @@ module Fastlane
         bucket = params[:snapshot_bucket]
         commit_hash = Helper.get_current_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])}
-
-#{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])}
-
-#{deleted_items_list(result[:deleted_items])}
-        EOS
+        message = <<-USAGE.strip_heredoc
+          ## Snapshot Test Result
+          Commit Hash: #{commit_hash}
+  
+          #{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])}
+  
+          #{new_items_table(result[:new_items], bucket, commit_hash, params[:working_dir], params[:image_length])}
+  
+          #{deleted_items_list(result[:deleted_items])}
+        USAGE
 
         GitHubNotifier.fold_comments(
             params[:github_owner],
@@ -92,7 +95,7 @@ Commit Hash: #{commit_hash}
         return "" if changed_items.empty?
 
         header = "<tr><td></td><td>Before</td><td>After</td><td>Diff</td></tr>"
-        cells = changed_items.map {|item|
+        cells = changed_items.map { |item|
           size_attr = generate_size_attr("#{working_dir}/actual/#{item}", image_height)
 
           before = "<img src=\"#{object_url(bucket, commit_hash, item, "expected")}\" #{size_attr} />"
@@ -107,9 +110,9 @@ Commit Hash: #{commit_hash}
       def self.new_items_table(new_items, bucket, commit_hash, working_dir, image_height)
         return "" if new_items.empty?
 
-        rows = new_items.each_slice(3).map {|oneline_items|
-          labels = oneline_items.map {|item| "<td>#{item}</td>"}.inject(&:+)
-          imgs = oneline_items.map {|item|
+        rows = new_items.each_slice(3).map { |oneline_items|
+          labels = oneline_items.map { |item| "<td>#{item}</td>" }.inject(&:+)
+          imgs = oneline_items.map { |item|
             size_attr = generate_size_attr("#{working_dir}/actual/#{item}", image_height)
             "<td><img src=\"#{object_url(bucket, commit_hash, item, "actual")}\" #{size_attr} /></td>"
           }.inject(&:+)
@@ -122,7 +125,7 @@ Commit Hash: #{commit_hash}
       def self.deleted_items_list(deleted_items)
         return "" if deleted_items.empty?
 
-        "### Deleted Screenshots\n<details><summary>Open</summary>\n\n#{deleted_items.map {|item| "- #{item}\n"}.inject(&:+)}</details>\n"
+        "### Deleted Screenshots\n<details><summary>Open</summary>\n\n#{deleted_items.map { |item| "- #{item}\n" }.inject(&:+)}</details>\n"
       end
 
       def self.object_url(bucket, commit_hash, item_name, image_type)
@@ -151,7 +154,7 @@ Commit Hash: #{commit_hash}
       end
 
       def self.authors
-        ["Moyuru Aizawa"]
+        ["MoyuruAizawa"]
       end
 
       def self.available_options

data/lib/fastlane/plugin/snapshot_test/actions/{save_snapshot_action.rb → regression/upload_snapshot_action.rb}

@@ -1,8 +1,10 @@
-require_relative '../helper/helper'
+require 'fastlane/action'
+
+require_relative '../../helper/helper'
 
 module Fastlane
   module Actions
-    class SaveSnapshotAction < Action
+    class UploadSnapshotAction < Action
       def self.run(params)
         Helper.authenticate(params[:gcloud_service_key_file])
 
@@ -17,11 +19,11 @@ module Fastlane
       end
 
       def self.description
-        "Save Snapshot"
+        "Upload Snapshot"
       end
 
       def self.details
-        "Save Snapshot"
+        "Upload Snapshot"
       end
 
       def self.available_options

data/lib/fastlane/plugin/snapshot_test/actions/{screenshot_action.rb → take_screenshot_action.rb}

@@ -1,6 +1,8 @@
+require 'fastlane/action'
+
 module Fastlane
   module Actions
-    class ScreenshotAction < Action
+    class TakeScreenshotAction < Action
       def self.run(params)
         download_dir = params[:download_dir]
 

data/lib/fastlane/plugin/snapshot_test/helper/comparator.rb

@@ -11,15 +11,15 @@ module Fastlane
 
     def self.compare_dir(expected_dir, actual_dir, diff_dir, fuzz)
       UI.message "Compare #{expected_dir} and #{actual_dir}"
-      expect_items = Dir.glob("#{expected_dir}/*.jpg").map {|path| File.basename(path)}
-      actual_items = Dir.glob("#{actual_dir}/*.jpg").map {|path| File.basename(path)}
+      expect_items = Dir.glob("#{expected_dir}/*.jpg").map { |path| File.basename(path) }
+      actual_items = Dir.glob("#{actual_dir}/*.jpg").map { |path| File.basename(path) }
 
       new_items = actual_items - expect_items
       deleted_items = expect_items - actual_items
       passed_items = []
       changed_items = []
 
-      (actual_items & expect_items).each {|fileName|
+      (actual_items & expect_items).each { |fileName|
         is_passed = compare("#{actual_dir}/#{fileName}", "#{expected_dir}/#{fileName}", "#{diff_dir}/#{fileName}", fuzz)
         if is_passed
           passed_items << fileName

data/lib/fastlane/plugin/snapshot_test/helper/github_notifier.rb

@@ -8,8 +8,8 @@ module Fastlane
     def self.fold_comments(github_owner, github_repository, github_pr_number, comment_prefix, summary, github_api_token)
       res = get_comments(github_owner, github_repository, github_pr_number, github_api_token)
       JSON.parse(res.body)
-          .select {|comment| comment["body"].start_with?(comment_prefix)}
-          .each {|comment|
+          .select { |comment| comment["body"] != nil && comment["body"].start_with?(comment_prefix) }
+          .each { |comment|
             body = "<details><summary>#{summary}</summary>\n#{comment["body"]}\n\n</details>\n"
             patch_comment(github_owner, github_repository, comment["id"], body, github_api_token)
           }
@@ -18,8 +18,8 @@ module Fastlane
     def self.delete_comments(github_owner, github_repository, github_pr_number, comment_prefix, github_api_token)
       res = get_comments(github_owner, github_repository, github_pr_number, github_api_token)
       JSON.parse(res.body)
-          .select {|comment| comment["body"].start_with?(comment_prefix)}
-          .each {|comment| delete_comment(github_owner, github_repository, comment["id"], github_api_token)}
+          .select { |comment| comment["body"] != nil && comment["body"].start_with?(comment_prefix) }
+          .each { |comment| delete_comment(github_owner, github_repository, comment["id"], github_api_token) }
     end
 
     def self.get_comments(github_owner, github_repository, github_pr_number, github_api_token)
@@ -31,7 +31,7 @@ module Fastlane
       req["Content-Type"] = "application/json"
       req["Authorization"] = "token #{github_api_token}"
 
-      res = Net::HTTP.start(uri.hostname, uri.port, {use_ssl: uri.scheme = "https"}) {|http| http.request(req)}
+      res = Net::HTTP.start(uri.hostname, uri.port, {use_ssl: uri.scheme = "https"}) { |http| http.request(req) }
       UI.message "#{res.code}\n#{res.body}"
 
       res
@@ -47,7 +47,7 @@ module Fastlane
       req["Authorization"] = "token #{github_api_token}"
       req.body = {:body => body}.to_json
 
-      res = Net::HTTP.start(uri.hostname, uri.port, {use_ssl: uri.scheme = "https"}) {|http| http.request(req)}
+      res = Net::HTTP.start(uri.hostname, uri.port, {use_ssl: uri.scheme = "https"}) { |http| http.request(req) }
       UI.message "#{res.code}\n#{res.body}"
 
       res
@@ -63,7 +63,7 @@ module Fastlane
       req["Authorization"] = "token #{github_api_token}"
       req.body = {:body => body}.to_json
 
-      res = Net::HTTP.start(uri.hostname, uri.port, {use_ssl: uri.scheme = "https"}) {|http| http.request(req)}
+      res = Net::HTTP.start(uri.hostname, uri.port, {use_ssl: uri.scheme = "https"}) { |http| http.request(req) }
       UI.message "#{res.code}\n#{res.body}"
 
       res
@@ -78,7 +78,7 @@ module Fastlane
       req["Content-Type"] = "application/json"
       req["Authorization"] = "token #{github_api_token}"
 
-      res = Net::HTTP.start(uri.hostname, uri.port, {use_ssl: uri.scheme = "https"}) {|http| http.request(req)}
+      res = Net::HTTP.start(uri.hostname, uri.port, {use_ssl: uri.scheme = "https"}) { |http| http.request(req) }
       UI.message "#{res.code}\n#{res.body}"
 
       res

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

@@ -20,9 +20,9 @@ module Fastlane
     def self.find_base_commit_hash(bucket_name, base_branch, current_branch)
       base_commit_hash = Action.sh("git merge-base origin/#{base_branch} #{current_branch}").chomp!
       dirs = `gsutil ls gs://#{bucket_name}/ | grep -e "/$"`.split("\n")
-                 .map {|s| s[/(?<=gs:\/\/#{bucket_name}\/)(.*)(?=\/)/]}
+                 .map { |s| s[/(?<=gs:\/\/#{bucket_name}\/)(.*)(?=\/)/] }
       hashes = Action.sh("git log origin/#{base_branch} --pretty=%H").split("\n")
-      hashes[hashes.index(base_commit_hash)..-1].each {|hash|
+      hashes[hashes.index(base_commit_hash)..-1].each { |hash|
         if dirs.include?(hash)
           return hash
         end
@@ -36,6 +36,7 @@ module Fastlane
 
     def self.calc_aspect_ratio(imagePath)
       width, height = FastImage.size(imagePath)
+      UI.message "Image(#{imagePath}) size #{width} * #{height}"
       height / width.to_f
     end
   end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module SnapshotTest
-    VERSION = "0.1.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-snapshot_test
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Moyuru Aizawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2019-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -145,9 +145,10 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/snapshot_test.rb
-- lib/fastlane/plugin/snapshot_test/actions/save_snapshot_action.rb
-- lib/fastlane/plugin/snapshot_test/actions/screenshot_action.rb
-- lib/fastlane/plugin/snapshot_test/actions/snapshot_test_action.rb
+- lib/fastlane/plugin/snapshot_test/actions/compatibility/screenshot_notifier_action.rb
+- lib/fastlane/plugin/snapshot_test/actions/regression/compare_snapshot_action.rb
+- lib/fastlane/plugin/snapshot_test/actions/regression/upload_snapshot_action.rb
+- lib/fastlane/plugin/snapshot_test/actions/take_screenshot_action.rb
 - lib/fastlane/plugin/snapshot_test/helper/comparator.rb
 - lib/fastlane/plugin/snapshot_test/helper/github_notifier.rb
 - lib/fastlane/plugin/snapshot_test/helper/helper.rb
@@ -171,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Compare snapshots