fastlane-plugin-checks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e53f0bf24653288d90b48cd516107f9a1151bc4d11f22eda6eb21273907c730
+  data.tar.gz: 305a234ad41be4613d79ccdd7b3b56f04540f4889d8d7cae8930d44e13980b3c
+SHA512:
+  metadata.gz: 8320e00ecdb4686bfe72775111895450947462d248ba3ad53e97477885866a69777add3033510827e155c0e54cd94162d82f2636c4ab1ebb1dade615de7ec520
+  data.tar.gz: 8faab11217afddca2b184a3c892a7719ccf2cbb3c3975ccd34719bbbeafc902a1e13b9eeb02724d888fee1456222340bfbdf8ba3f6754359b86a542aa919a1be

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,84 @@
+# checks plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-checks)
+
+## Getting Started
+
+This project is a [*fastlane*](https://github.com/fastlane/fastlane) plugin for
+[Checks](https://checks.google.com). To get started with
+`fastlane-plugin-checks`, add it to your project by running:
+
+```bash
+fastlane add_plugin checks
+```
+
+## About upload_to_checks
+
+Minimum way to use upload_to_checks with the required parameters:
+
+```
+upload_to_checks(
+  account_id: "<your Checks account ID>",
+  app_id: "<your Checks app ID>",
+  binary_path: "<path to your .apk/.aab/.ipa>",
+  service_account_file_path: "<path to your service account JSON>",
+)
+```
+
+List of all parameters:
+
+## Variables
+
+Name                      | Type    | Default | Description
+:-----------------------: | :-----: | :-----: | :---------:
+service_account_file_path | string  | –       | Path to your serviceaccount.json file. Please refer to [Authenticate Google Checks](https://developers.google.com/checks/guide/integrate/cli/install-checks-cli#authenticate-service) with a service account to generate a service account.
+account_id                | string  | –       | Google Checks account ID from [Checks settings page](https://checks.area120.google.com/console/settings)
+app_id                    | string  | –       | Google Checks application ID
+binary_path               | string  | –       | path to the application binary file: .apk, .aab or .ipa
+generate_report           | boolean | true    | If `false` the action won't upload and run the report for binary_path. It is useful to test your authentication and other paramaters.
+wait_for_report           | boolean | true    | If `false` the action won't wait for the report completion and the build will keep going.
+severity_threshold        | string  | –       | Valid values are: `PRIORITY` `POTENTIAL` `OPPORTUNITY`
+fail_on                   | string  | –       | if `all` then action will fail if there are any failed checks following `severity_threshold` condition. It won't fail by default.
+operation_id              | string  | –       | For development and testing purposes. If an upload is already in progress, or you want to analyse an existing upload.
+
+## 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`.
+
+## 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/checks/actions/upload_to_checks.rb

@@ -0,0 +1,133 @@
+# Copyright 2024 Google LLC
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'fastlane_core/ui/ui'
+require 'fastlane/action'
+require 'tty-spinner'
+require 'json'
+require 'pry'
+
+require_relative '../helper/credentials'
+require_relative '../helper/checks_service'
+require_relative '../helper/report_parser'
+require_relative '../options'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+  module Actions
+    class UploadToChecksAction < Action
+      def self.run(params) # rubocop:disable Metrics/PerceivedComplexity
+        # required parameters
+        service_account_file_path = params[:service_account_file_path]
+        project_id = params[:project_id]
+        account_id = params[:account_id]
+        app_id = params[:app_id]
+        binary_path = params[:binary_path]
+
+        # optional parameters
+        fail_on = params[:fail_on]
+        operation_id = params[:operation_id]
+        generate_report = params[:generate_report]
+        wait_for_report = params[:wait_for_report]
+        severity_threshold = params[:severity_threshold]
+
+        credentials = Fastlane::Checks::Credentials.new(key_file_path: service_account_file_path)
+        service = Fastlane::Checks::GoogleChecksService.new(credentials, project_id, account_id, app_id)
+
+        if generate_report
+          if operation_id.nil?
+            upload_spinner = TTY::Spinner.new("[:spinner] Uploading #{binary_path} to Google Checks...", format: :dots)
+            upload_spinner.auto_spin
+            begin
+              upload_response = service.upload_binary(binary_path)
+            rescue StandardError => e
+              UI.error(e)
+              UI.abort_with_message!("Error while uploading binary")
+            end
+            upload_spinner.success("Done")
+          end
+
+          if wait_for_report == false
+            UI.success("Skipping waiting for the report. Please visit https://checks.google.com to see the report.")
+          else
+            if operation_id.nil?
+              operation_id = Fastlane::Checks::GoogleChecksService.operation_id_from_name(upload_response["name"])
+            end
+
+            waiting_spinner = TTY::Spinner.new("[:spinner] Waiting for the report for operation id=#{operation_id}", format: :dots)
+            waiting_spinner.auto_spin
+
+            report_id, operation_response = service.wait_for_report(operation_id)
+
+            if report_id.nil?
+              waiting_spinner.error("Done")
+              UI.abort_with_message!("Failed to fetch the report")
+            else
+              waiting_spinner.success("Done")
+              report_response = service.report(report_id)
+              report_parser = Fastlane::Checks::ReportParser.new(severity_threshold)
+              failing_checks = report_parser.parse(report_response)
+              if failing_checks.empty? # rubocop:disable Metrics/BlockNesting
+                UI.success("No issues  # rubocop:disable Metrics/BlockNestingdetected")
+                UI.success("Report console URL: #{operation_response['response']['resultsUri']}")
+              else
+                UI.error("#{failing_checks.length} issues detected:")
+                failing_checks.each do |check|
+                  UI.error("Type: #{check['type']}. Details: #{check}")
+                end
+                if fail_on == 'all' # rubocop:disable Metrics/BlockNesting
+                  UI.test_failure!("Report console URL: #{operation_response['response']['resultsUri']}")
+                else
+                  UI.important("Report console URL: #{operation_response['response']['resultsUri']}")
+                end
+              end
+            end
+          end
+        else
+          response = service.apps_list
+          UI.message(response)
+        end
+      end
+
+      def self.description
+        "upload to checks"
+      end
+
+      def self.authors
+        ["boertel"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "upload to checks your mobile app"
+      end
+
+      def self.available_options
+        Fastlane::Checks::Options.available_options
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/checks/helper/checks_service.rb

@@ -0,0 +1,109 @@
+# Copyright 2024 Google LLC
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'faraday'
+require 'googleauth'
+
+module Fastlane
+  module Checks
+    class GoogleChecksService
+      BASE_URL = "https://checks.googleapis.com"
+      OAUTH_SCOPES = ["https://www.googleapis.com/auth/checks"]
+      DEFAULT_TIMEOUT = 45 * 60 # 30 minutes
+      CHECK_OPERATION_INTERVAL = 60 # 1 minute
+
+      private_constant :BASE_URL
+      private_constant :DEFAULT_TIMEOUT
+      private_constant :CHECK_OPERATION_INTERVAL
+
+      def initialize(credentials, project_id, account_id, app_id)
+        @account_id = account_id
+        @app_id = app_id
+        @auth = credentials.get_google_credential(OAUTH_SCOPES)
+        @project_id ||= @auth.project_id
+
+        default_headers = @auth.apply({})
+        default_headers["X-Goog-User-Project"] = @project_id
+        @connection = Faraday.new(url: BASE_URL, headers: default_headers)
+      end
+
+      def apps_list
+        get("/v1alpha/accounts/#{@account_id}/apps/")
+      end
+
+      def upload_binary(binary_path)
+        binary_data = File.binread(binary_path)
+        path = "/upload/v1alpha/accounts/#{@account_id}/apps/#{@app_id}/reports:analyzeUpload"
+        response = @connection.post(path) do |req|
+          req.headers['X-Goog-Upload-Protocol'] = 'raw'
+          req.headers['Content-Type'] = 'application/octet-stream'
+          req.body = binary_data
+        end
+        handle_response(response)
+      end
+
+      def check_operation(operation_id)
+        get("/v1alpha/accounts/#{@account_id}/apps/#{@app_id}/operations/#{operation_id}")
+      end
+
+      def report(report_id)
+        params = {
+          "fields" => "name,checks(type,state,severity)"
+        }
+        get("/v1alpha/accounts/#{@account_id}/apps/#{@app_id}/reports/#{report_id}", params)
+      end
+
+      def get(path, params = {})
+        response = @connection.get(path, params)
+        handle_response(response)
+      end
+
+      def wait_for_report(operation_id)
+        started_at = Time.now
+        operation_response = nil
+        loop do
+          operation_response = check_operation(operation_id)
+          has_timeout = Time.now - started_at > DEFAULT_TIMEOUT
+          break if operation_response["done"] || has_timeout
+
+          sleep(CHECK_OPERATION_INTERVAL)
+        end
+        if operation_response["response"]
+          [
+            GoogleChecksService.report_id_from_name(operation_response["response"]["name"]),
+            operation_response
+          ]
+        end
+      end
+
+      def self.operation_id_from_name(name)
+        name.split("/").last
+      end
+
+      def self.report_id_from_name(name)
+        name.split("/").last
+      end
+
+      private
+
+      def handle_response(response)
+        if response.success?
+          JSON.parse(response.body)
+        else
+          raise "HTTP request to checks.google.com failed with\nstatus: #{response.status}\nbody:\n#{response.body}"
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/checks/helper/credentials.rb

@@ -0,0 +1,41 @@
+# Copyright 2024 Google LLC
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'googleauth'
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+  module Checks
+    class Credentials
+      def initialize(key_file_path: nil)
+        @key_file_path = key_file_path
+      end
+
+      def get_google_credential(scopes)
+        File.open(File.expand_path(@key_file_path), "r") do |file|
+          options = {
+            json_key_io: file,
+            scope: scopes
+          }
+          begin
+            return Google::Auth::ServiceAccountCredentials.make_creds(options)
+          rescue StandardError => e
+            UI.abort_with_message!("Failed to read service account file: #{e.message}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/checks/helper/report_parser.rb

@@ -0,0 +1,50 @@
+# Copyright 2024 Google LLC
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Fastlane
+  module Checks
+    class ReportParser
+      OPPORTUNITY = "OPPORTUNITY"
+      POTENTIAL = "POTENTIAL"
+      PRIORITY = "PRIORITY"
+
+      public_constant :OPPORTUNITY, :POTENTIAL, :PRIORITY
+
+      def initialize(severity_threshold)
+        @severity_threshold = severity_threshold
+      end
+
+      def is_severity_included_in_threshold(severity)
+        case @severity_threshold
+        when OPPORTUNITY
+          return severity == PRIORITY || severity == POTENTIAL || severity == OPPORTUNITY
+        when POTENTIAL
+          return severity == PRIORITY || severity == POTENTIAL
+        when PRIORITY
+          return severity == PRIORITY
+        end
+      end
+
+      def parse(report)
+        failing_checks = []
+        report["checks"].each do |check|
+          if check['state'] == "FAILED" && is_severity_included_in_threshold(check['severity'])
+            failing_checks << check
+          end
+        end
+        return failing_checks
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/checks/options.rb

@@ -0,0 +1,80 @@
+# Copyright 2024 Google LLC
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'fastlane_core/ui/ui'
+require 'fastlane_core/configuration/config_item'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+  module Checks
+    class Options
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :service_account_file_path,
+                                       description: "Path to your service account json file. Please refer to https://developers.google.com/checks/guide/integrate/cli/install-checks-cli#authenticate-service to get your private key JSON file",
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                                       UI.user_error!("Could not find file at path '#{value}'") unless File.exist?(value)
+                                                     end),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       description: "Google Cloud Platform project name",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :account_id,
+                                       description: "Google Checks Account Id",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :app_id,
+                                       description: "Google Checks App Id",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :operation_id,
+                                       description: "Operation ID",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :severity_threshold,
+                                       description: "severity threshold. Possible values: PRIORITY, POTENTIAL, OPPORTUNITY",
+                                       default_value: "PRIORITY",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Invalid value '#{value}'") unless ['PRIORITY', 'POTENTIAL', 'OPPORTUNITY'].include?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :binary_path,
+                                       description: "Path to the app",
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("App file not found at path '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :generate_report,
+                                       description: "skip generating report",
+                                       default_value: true,
+                                       type: Fastlane::Boolean),
+          FastlaneCore::ConfigItem.new(key: :wait_for_report,
+                                       description: "Wait for report to complete",
+                                       default_value: true,
+                                       type: Fastlane::Boolean),
+          FastlaneCore::ConfigItem.new(key: :fail_on,
+                                       description: "action will fail if the report contains issues with severity equal or higher than the specified value. Possible values: all, never",
+                                       default_value: "never",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Invalid value '#{value}'") unless ['all', 'never'].include?(value)
+                                       end)
+        ]
+      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/checks/version.rb

@@ -0,0 +1,19 @@
+# Copyright 2024 Google LLC
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Fastlane
+  module Checks
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/checks.rb

@@ -0,0 +1,30 @@
+# Copyright 2024 Google LLC
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'fastlane/plugin/checks/version'
+
+module Fastlane
+  module Checks
+    # 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::Checks.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,248 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-checks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sherzat Aitbayev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.217.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.217.0
+- !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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-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: webmock
+  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'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/checks.rb
+- lib/fastlane/plugin/checks/actions/upload_to_checks.rb
+- lib/fastlane/plugin/checks/helper/checks_service.rb
+- lib/fastlane/plugin/checks/helper/credentials.rb
+- lib/fastlane/plugin/checks/helper/report_parser.rb
+- lib/fastlane/plugin/checks/options.rb
+- lib/fastlane/plugin/checks/version.rb
+homepage: https://github.com/google-checks/checks-fastlane-plugin
+licenses:
+- Apache-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Fastlane plugin for Checks (checks.google.com)
+test_files: []