fastlane-plugin-screenshot_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ffa76f65c4d14cfeec1c37d5add43cd0983532f942cb53acd5b8cc319367f2fa
+  data.tar.gz: 3da1f83f3206b4fe18d014c83a8c5505c34b95b8817fc322cd19afd5f9b76eae
+SHA512:
+  metadata.gz: 31b9bbcf59b34fce031c196fd44dc156557586351f2ecf425d00a478390ab1c63456374dc2ae7d558841db6936df4844056e544b8d07374d2591b96a3c4417e5
+  data.tar.gz: d36ded2a517f76f34afed9d66ab8438e4c692ab456a77079c2e5c4373eb51b17ea3d5d315966c8de218f1fb059de8867d2aeed399ca7c1e4a4ec39356bb22271

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 CATS Open Source Softwares
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# screenshot_notifier plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-screenshot_notifier)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-screenshot_notifier`, add it to your project by running:
+
+```bash
+fastlane add_plugin screenshot_notifier
+```
+
+This plugin depends Firebase Cloud Storage to store snapshots. If you don't have a Firebase account, see [this](https://github.com/cats-oss/fastlane-plugin-firebase_test_lab_android#if-you-are-not-current-user-of-firebase) and create a bucket.
+
+## About screenshot_notifier
+
+Post screenshots to a pull request
+
+## Example
+
+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
+```
+
+this plugin generates following table of screenshots.
+
+| Screen Name | Nexus6 | Nexus6P |
+| --- | --- | --- |
+| MainPage.jpg | (Screenshot) | (Screenshot) |
+| SubPage.jpg | (Screenshot) | (Screenshot) |
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/screenshot_notifier.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/screenshot_notifier/version'
+
+module Fastlane
+  module ScreenshotNotifier
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::ScreenshotNotifier.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/screenshot_notifier/actions/screenshot_notifier_action.rb

@@ -0,0 +1,159 @@
+require 'fastlane/action'
+require_relative '../helper/screenshot_notifier_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
+        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|
+                       ratio = Helper.calc_aspect_ratio("#{screenshot_dir}/#{device}/#{file_name}")
+                       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/screenshot_notifier/helper/github_notifier.rb

@@ -0,0 +1,87 @@
+require 'fastlane_core/ui/ui'
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Fastlane
+  module GitHubNotifier
+    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"] != 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)
+          }
+    end
+
+    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"] != 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)
+      api_url = "https://api.github.com/repos/#{github_owner}/#{github_repository}/issues/#{github_pr_number}/comments"
+      UI.message "get comments #{api_url}"
+
+      uri = URI.parse(api_url)
+      req = Net::HTTP::Get.new(uri)
+      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)}
+      UI.message "#{res.code}\n#{res.body}"
+
+      res
+    end
+
+    def self.put_comment(github_owner, github_repository, github_pr_number, body, github_api_token)
+      api_url = "https://api.github.com/repos/#{github_owner}/#{github_repository}/issues/#{github_pr_number}/comments"
+      UI.message "put comment #{api_url}"
+
+      uri = URI.parse(api_url)
+      req = Net::HTTP::Post.new(uri)
+      req["Content-Type"] = "application/json"
+      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)}
+      UI.message "#{res.code}\n#{res.body}"
+
+      res
+    end
+
+    def self.patch_comment(github_owner, github_repository, comment_id, body, github_api_token)
+      api_url = "https://api.github.com/repos/#{github_owner}/#{github_repository}/issues/comments/#{comment_id}"
+      UI.message "patch comment #{api_url}"
+
+      uri = URI.parse(api_url)
+      req = Net::HTTP::Patch.new(uri)
+      req["Content-Type"] = "application/json"
+      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)}
+      UI.message "#{res.code}\n#{res.body}"
+
+      res
+    end
+
+    def self.delete_comment(github_owner, github_repository, comment_id, github_api_token)
+      api_url = "https://api.github.com/repos/#{github_owner}/#{github_repository}/issues/comments/#{comment_id}"
+      UI.message "delete comment #{api_url}"
+
+      uri = URI.parse(api_url)
+      req = Net::HTTP::Delete.new(uri)
+      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)}
+      UI.message "#{res.code}\n#{res.body}"
+
+      res
+    end
+  end
+end

data/lib/fastlane/plugin/screenshot_notifier/helper/screenshot_notifier_helper.rb

@@ -0,0 +1,25 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+  module Helper
+    def self.authenticate(gcloud_key_file)
+      UI.message "Authenticate with GCP"
+      Action.sh("gcloud auth activate-service-account --key-file #{gcloud_key_file}")
+    end
+
+    def self.get_current_commit_hash
+      Action.sh("git rev-parse HEAD").chomp!
+    end
+
+    def self.firebase_object_url(bucket, path)
+      "https://firebasestorage.googleapis.com/v0/b/#{bucket}/o/#{CGI.escape(path)}?alt=media"
+    end
+
+    def self.calc_aspect_ratio(imagePath)
+      width, height = FastImage.size(imagePath)
+      UI.message "Image(#{imagePath}) size #{width} * #{height}"
+      height / width.to_f
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module ScreenshotNotifier
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-screenshot_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Moyuru Aizawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.121.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.121.1
+description: 
+email: lvla0805@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/screenshot_notifier.rb
+- lib/fastlane/plugin/screenshot_notifier/actions/screenshot_notifier_action.rb
+- lib/fastlane/plugin/screenshot_notifier/helper/github_notifier.rb
+- lib/fastlane/plugin/screenshot_notifier/helper/screenshot_notifier_helper.rb
+- lib/fastlane/plugin/screenshot_notifier/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Post screenshots to a pull request
+test_files: []