fastlane-plugin-accessibility_test 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42f17b7ed13f8635921271d919a2cd82ca81c900
+  data.tar.gz: 7118da68aae6a03277e8167a4db453ef4ceb7407
+SHA512:
+  metadata.gz: d6a7343e61be863dea59f6b25a0dbba39fb3d6993e09d9262c5e0a70bfa6281435dbed17f2e11b025df0d7647909d286b57cf63e178d2fb33ccb994248206a94
+  data.tar.gz: a055ca9cd34639467a2d32255b0025a5e50d5e37c258b959cb84e3f9d8b1309d1a2d9c9ea2be0e02687994d3c8b20356c57f4eb73564734b6eed30d52036af2c

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Takeshi Tsukamoto <itometeam@gmail.com>
+
+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,52 @@
+# accessibility_test plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-accessibility_test)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-accessibility_test`, add it to your project by running:
+
+```bash
+fastlane add_plugin accessibility_test
+```
+
+## About accessibility_test
+
+Accessibility test with Firebase Test Lab for Android.
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## 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`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## 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/accessibility_test.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/accessibility_test/version'
+
+module Fastlane
+  module AccessibilityTest
+    # 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::AccessibilityTest.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/accessibility_test/actions/accessibility_test_action.rb

@@ -0,0 +1,197 @@
+# coding: utf-8
+require_relative '../helper/accessibility_evaluation_pb'
+require_relative '../helper/github_notifier'
+require_relative '../helper/helper'
+
+module Fastlane
+  module Actions
+    class AccessibilityTestAction < Action
+      def self.run(params)
+        download_dir = params[:download_dir]
+        firebase_test_lab_results_bucket = params[:firebase_test_lab_results_bucket] == nil ? "#{params[:project_id]}_test_results" : params[:firebase_test_lab_results_bucket]
+        firebase_test_lab_results_dir = "firebase_test_result_#{DateTime.now.strftime('%Y-%m-%d-%H:%M:%S')}"
+        devices = params[:devices]
+        device_names = devices.map(&method(:device_name))
+        results = []
+
+        Fastlane::Actions::FirebaseTestLabAndroidAction.run(
+            project_id: params[:project_id],
+            gcloud_service_key_file: params[:gcloud_service_key_file],
+            type: "robo",
+            devices: devices,
+            app_apk: params[:app_apk],
+            console_log_file_name: "#{download_dir}/firebase_os_test_console.log",
+            timeout: params[:timeout],
+            notify_to_slack: false,
+            extra_options: "--results-bucket #{firebase_test_lab_results_bucket} --results-dir #{firebase_test_lab_results_dir} --no-record-video"
+        )
+
+        UI.message "Fetch screenshots and accessibility meta data from Firebase Test Lab results bucket"
+        device_names.each do |device_name|
+          `mkdir -p #{download_dir}/#{device_name}`
+          Action.sh "gsutil -m rsync -d -r gs://#{firebase_test_lab_results_bucket}/#{firebase_test_lab_results_dir}/#{device_name}/artifacts #{download_dir}/#{device_name}"
+        end
+
+        UI.message "Execute accessibility check"
+        executable = File.expand_path('../../../../../bin/accessibility-analyzer.jar', __FILE__)
+        device_names.each do |device_name|
+          Action.sh "java -jar #{executable} --target=#{download_dir}/#{device_name}"
+        end
+
+        UI.message "Push screenshots and accessibility meta data from Firebase Test Lab results bucket"
+        device_names.each do |device_name|
+          `mkdir -p #{download_dir}/#{device_name}`
+          Action.sh "gsutil -m rsync -d -r #{download_dir}/#{device_name} gs://#{firebase_test_lab_results_bucket}/#{firebase_test_lab_results_dir}/#{device_name}/artifacts"
+        end
+
+        UI.message "Extract test result"
+        device_names.each do |device_name|
+          entries = Dir::entries("#{download_dir}/#{device_name}")
+          entries = entries.select { |entry| entry =~ /accessibility[0-9]+_check_result[0-9]+.meta/ }
+          for entry in entries do
+            filePath = "#{download_dir}/#{device_name}/#{entry}"
+            File.open(filePath, "r") do |file|
+              proto = Proto::AccessibilityHierarchyCheckResultProto.decode(file.read())
+              results.push(
+                {
+                  title: proto.title,
+                  message: proto.message,
+                  image: Helper.firebase_object_url(firebase_test_lab_results_bucket, "#{firebase_test_lab_results_dir}/#{device_name}/artifacts/#{File.basename(filePath, ".meta")}.png")
+                }
+              )
+            end
+          end
+        end
+
+        UI.message "Notify to GitHub"
+        notify_github(params, results)
+      end
+
+      def self.notify_github(params, results)
+        return if params[:github_pr_number] == nil
+
+        summary = results.empty? ? "### :white_check_mark: All test passed" : "### :x: #{results.length} error found."
+        cells = results.map {|result|
+          "|<img src=\"#{result[:image]}\">|**#{result[:title]}**<br/>#{result[:message]}|\n"
+        }.inject(&:+)
+
+        message = <<-EOS
+## Accessibility Test Result
+#{summary}
+
+|Screenshot|message|
+|-|-|
+#{cells}
+        EOS
+
+        UI.message message
+        GitHubNotifier.put_comment(
+            params[:github_owner],
+            params[:github_repository],
+            params[:github_pr_number],
+            message,
+            params[:github_api_token]
+        )
+      end
+
+      def self.device_name(device)
+        "#{device[:model]}-#{device[:version]}-#{device[:locale]}-#{device[:orientation]}"
+      end
+
+      def self.description
+        "Accessibility test with Firebase Test Lab for Android."
+      end
+
+      def self.details
+        "Accessibility test with Firebase Test Lab for Android."
+      end
+
+      def self.authors
+        ["Takeshi Tsukamoto"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "PROJECT_ID",
+                                       description: "Your Firebase project id",
+                                       type: String,
+                                       optional: false),
+          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: :devices,
+                                       env_name: "DEVICES",
+                                       description: "Devices to test the app on",
+                                       type: Array,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Devices have to be at least one") if value.empty?
+                                         value.each do |device|
+                                           check_has_property(device, :model)
+                                           check_has_property(device, :version)
+                                           set_default_property(device, :locale, "en_US")
+                                           set_default_property(device, :orientation, "portrait")
+                                         end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :app_apk,
+                                       env_name: "APP_APK",
+                                       description: "The path for your android app apk",
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :timeout,
+                                       env_name: "TIMEOUT",
+                                       description: "The max time this test execution can run before it is cancelled. Default: 5m (this value must be greater than or equal to 1m)",
+                                       type: String,
+                                       optional: true,
+                                       default_value: "5m"),
+          FastlaneCore::ConfigItem.new(key: :firebase_test_lab_results_bucket,
+                                       env_name: "FIREBASE_TEST_LAB_RESULTS_BUCKET",
+                                       description: "Name of Firebase Test Lab results bucket",
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :download_dir,
+                                       env_name: "DOWNLOAD_DIR",
+                                       description: "Target directory to download screenshots from firebase",
+                                       type: String,
+                                       optional: 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: true),
+          FastlaneCore::ConfigItem.new(key: :github_api_token,
+                                       env_name: "GITHUB_API_TOKEN",
+                                       description: "GitHub API Token",
+                                       type: String,
+                                       optional: false),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+
+      def self.check_has_property(hash_obj, property)
+        UI.user_error!("Each device must have #{property} property") unless hash_obj.key?(property)
+      end
+
+      def self.set_default_property(hash_obj, property, default)
+        unless hash_obj.key?(property)
+          hash_obj[property] = default
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/accessibility_test/helper/accessibility_evaluation_pb.rb

@@ -0,0 +1,30 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: AccessibilityEvaluation.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("AccessibilityEvaluation.proto", :syntax => :proto2) do
+    add_message "proto.AccessibilityHierarchyCheckResultProto" do
+      optional :source_check_class, :string, 1
+      optional :result_id, :int32, 2
+      optional :result_type, :enum, 3, "proto.ResultTypeProto"
+      optional :hierarchy_source_id, :int64, 4
+      optional :title, :string, 6
+      optional :message, :string, 7
+    end
+    add_enum "proto.ResultTypeProto" do
+      value :UNKNOWN, 0
+      value :ERROR, 1
+      value :WARNING, 2
+      value :INFO, 3
+      value :NOT_RUN, 4
+      value :SUPPRESSED, 5
+    end
+  end
+end
+
+module Proto
+  AccessibilityHierarchyCheckResultProto = Google::Protobuf::DescriptorPool.generated_pool.lookup("proto.AccessibilityHierarchyCheckResultProto").msgclass
+  ResultTypeProto = Google::Protobuf::DescriptorPool.generated_pool.lookup("proto.ResultTypeProto").enummodule
+end

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

@@ -0,0 +1,24 @@
+require 'fastlane_core/ui/ui'
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Fastlane
+  module GitHubNotifier
+    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
+  end
+end

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

@@ -0,0 +1,9 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  module Helper
+    def self.firebase_object_url(bucket, path)
+      "https://firebasestorage.googleapis.com/v0/b/#{bucket}/o/#{CGI.escape(path)}?alt=media"
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-accessibility_test
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takeshi Tsukamoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-03 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.130.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.130.0
+description: 
+email: itometeam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/bin/accessibility-analyzer.jar
+- lib/fastlane/plugin/accessibility_test.rb
+- lib/fastlane/plugin/accessibility_test/actions/accessibility_test_action.rb
+- lib/fastlane/plugin/accessibility_test/helper/accessibility_evaluation_pb.rb
+- lib/fastlane/plugin/accessibility_test/helper/github_notifier.rb
+- lib/fastlane/plugin/accessibility_test/helper/helper.rb
+- lib/fastlane/plugin/accessibility_test/version.rb
+homepage: https://github.com/cats-oss/fastlane-plugin-accessibility_test
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Accessibility test with Firebase Test Lab for Android.
+test_files: []