fastlane-plugin-testappio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45a858285aceb1aa48afb0a85e362a35309aad321f02bd150651009c3c2985c3
+  data.tar.gz: 3d56ec9f6e88bb9596d2ba61870163fb134c17e34045d76b15182be1a084013f
+SHA512:
+  metadata.gz: a9a542f8eb7b7c23eed9d2846650d8a24ee1c55c567499e985f2e92681cdaeaf9f82c4ce91a19310e929531682711d30360a467321a545ba4c5685e317f93191
+  data.tar.gz: 77ae25bcbef573d9d898db7739f66be4ac6d06adacfbd284fab2c7ddaa3d7fa40fb381556eff1bed362d12483f6584074df93d13fd9857740226ad3fa3a39974

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 TestApp.io FZ-LLC
+
+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,86 @@
+# [<img src="https://assets.testapp.io/logo/blue.svg" alt="TestApp.io"/>](https://testapp.io/) Fastlane Plugin
+
+> This is in BETA mode. Your feedback is highly appreciated.
+
+A fastlane plugin to upload both Android & iOS apps to TestApp.io to notify everyone for testing and feedback.
+
+#### Version 1.0
+
+<!-- [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-testappio) -->
+
+- [TestApp.io plugin](#testappio-plugin)
+  - [Getting started](#getting-started)
+  - [TestApp.io actions](#testappio-actions)
+    - [Action **upload_to_testappio**](#action-upload_to_testappio)
+  - [Issues and feedback](#issues-and-feedback)
+  - [Troubleshooting](#troubleshooting)
+  - [Using _fastlane_ plugins](#using-fastlane-plugins)
+  - [About _fastlane_](#about-fastlane)
+
+## Getting started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-testappio`, add it to your project by running:
+
+```bash
+fastlane add_plugin testappio
+```
+
+## TestApp.io actions
+
+Actions provided by the CLI: [ta-cli](https://github.com/testappio/cli)
+
+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`.
+
+To upload after the fastlane `gym` action:
+
+```ruby
+  lane :development do
+    match(type: "development")
+    gym(export_method: "development")
+    upload_to_testappio(
+      api_token: "Your API Token",
+      app_id: "Your App ID",
+      release: "both",
+      apk_file: "/full/path/to/app.apk",
+      ipa_file: "/full/path/to/app.ipa",
+      release_notes: "release notes go here",
+      git_release_notes: true,
+      git_commit_id: false,
+      notify: false
+    )
+  end
+```
+
+### Action **upload_to_testappio**
+
+Upload Android (APK) & iOS (IPA) files to TestApp.io and notify your team members
+
+| Key               | Description                                                                                             | Env Var(s)                  | Default |
+| ----------------- | ------------------------------------------------------------------------------------------------------- | --------------------------- | ------- |
+| api_token         | You can get it from https://portal.testapp.io/settings/api-credentials                                  | TESTAPPIO_API_TOKEN         |         |
+| app_id            | You can get it from your app page in https://portal.testapp.io/apps                                     | TESTAPPIO_APP_ID            |         |
+| release           | It can be either both or android or ios                                                                 | TESTAPPIO_RELEASE           |         |
+| apk_file          | Path to the android apk file                                                                            | TESTAPPIO_ANDROID_PATH      |         |
+| ipa_file          | Path to the ios ipa file                                                                                | TESTAPPIO_IOS_PATH          |         |
+| release_notes     | Manually add the release notes to be displayed for the testers                                          | TESTAPPIO_RELEASE_NOTES     |         |
+| git_release_notes | Collect release notes from the latest git commit message to be displayed for the testers: true or false | TESTAPPIO_GIT_RELEASE_NOTES | true    |
+| git_commit_id     | Include the last commit ID in the release notes (works with both release notes option): true or false   | TESTAPPIO_GIT_COMMIT_ID     | false   |
+| notify            | Send notificaitons to your team members about this release: true or false                               | TESTAPPIO_NOTIFY            | false   |
+
+## Issues and feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+Join our [Slack](https://join.slack.com/t/testappio/shared_invite/zt-pvpoj3l2-epGYwGTaV3~3~0f7udNWoA) channel for feedback and support or you can contact us at support@testapp.io and we'll gladly help you out!
+
+## 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/testappio/actions/upload_to_testappio.rb

@@ -0,0 +1,146 @@
+module Fastlane
+  module Actions
+    class UploadToTestappioAction < Action
+      SUPPORTED_FILE_EXTENSIONS = ["apk", "ipa"]
+      def self.run(params)
+        # Check if ta-cli is installed
+        Helper::TestappioHelper.check_ta_cli
+
+        # read the parameters
+        api_token = params[:api_token]
+        app_id = params[:app_id]
+        apk_file = params[:apk_file]
+        ipa_file = params[:ipa_file]
+        release = params[:release]
+        release_notes = params[:release_notes]
+        git_release_notes = params[:git_release_notes]
+        git_commit_id = params[:git_commit_id]
+        notify = params[:notify]
+
+        validate_file_path(apk_file) unless release == "ios"
+        validate_file_path(ipa_file) unless release == "android"
+
+        command = ["ta-cli"]
+        command.push("publish")
+        command.push("--api_token=#{api_token}")
+        command.push("--app_id=#{app_id}")
+        command.push("--release=#{release}")
+        command.push("--apk=#{apk_file}") unless release == "ios"
+        command.push("--ipa=#{ipa_file}") unless release == "android"
+        command.push("--release_notes=#{release_notes}")
+        command.push("--git_release_notes=#{git_release_notes}")
+        command.push("--git_commit_id=#{git_commit_id}")
+        command.push("--notify=#{notify}")
+        command.push("--source=Fastlane")
+
+        UI.message("Uploading to TestApp.io")
+        Helper::TestappioHelper.call_ta_cli(command)
+        UI.success("Successfully uploaded to TestApp.io!")
+      end
+
+      # Validate file_path.
+      def self.validate_file_path(file_path)
+        UI.user_error!("No file found at '#{file_path}'.") unless File.exist?(file_path)
+
+        # Validate file extension.
+        file_path_parts = file_path.split(".")
+        unless file_path_parts.length > 1 && SUPPORTED_FILE_EXTENSIONS.include?(file_path_parts.last)
+          UI.user_error!("file_path is invalid, only files with extensions " + SUPPORTED_FILE_EXTENSIONS.to_s + " are allowed to be uploaded.")
+        end
+      end
+
+      def self.description
+        "Uploading ipa/apk packages to TestApp.io for testing."
+      end
+
+      def self.default_file_path
+        platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+        if platform == :ios
+          # Shared value for ipa path if it was generated by gym https://docs.fastlane.tools/actions/gym/.
+          return Actions.lane_context[Actions::SharedValues::IPA_OUTPUT_PATH]
+        else
+          # Shared value for apk if it was generated by gradle.
+          return Actions.lane_context[Actions::SharedValues::GRADLE_APK_OUTPUT_PATH]
+        end
+      end
+
+      def self.details
+        "This Fastlane plugin uploads your Android (APK) and iOS (IPA) package to TestApp.io and notify your team members about the new releases if you enable it."
+      end
+
+      def self.available_options
+        # Define all options your action supports.
+
+        # Below a few examples
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "TESTAPPIO_API_TOKEN",
+                                       description: "You can get it from https://portal.testapp.io/settings/api-credentials",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No API token provided. You can get it from https://portal.testapp.io/settings/api-credentials") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :app_id,
+                                       env_name: "TESTAPPIO_APP_ID",
+                                       description: "You can get it from your app page in https://portal.testapp.io/apps",
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :release,
+                                       env_name: "TESTAPPIO_RELEASE",
+                                       description: "It can be either both or android or ios",
+                                       is_string: true,
+                                      default_value: Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]),
+          FastlaneCore::ConfigItem.new(key: :apk_file,
+                                      env_name: "TESTAPPIO_ANDROID_PATH",
+                                      description: "Full path to the Android .apk file",
+                                      optional: true,
+                                      is_string: true,
+                                      default_value: default_file_path),
+          FastlaneCore::ConfigItem.new(key: :ipa_file,
+                                      env_name: "TESTAPPIO_IOS_PATH",
+                                      description: "Full path to the iOS .ipa file",
+                                      optional: true,
+                                      is_string: true,
+                                      default_value: default_file_path),
+          FastlaneCore::ConfigItem.new(key: :release_notes,
+                                      env_name: "TESTAPPIO_RELEASE_NOTES",
+                                      description: "Manually add the release notes to be displayed for the testers",
+                                      optional: true,
+                                      is_string: true),
+          FastlaneCore::ConfigItem.new(key: :git_release_notes,
+                                      env_name: "TESTAPPIO_GIT_RELEASE_NOTES",
+                                      description: "Collect release notes from the latest git commit message to be displayed for the testers: true or false",
+                                      optional: true,
+                                      is_string: false,
+                                      default_value: true),
+          FastlaneCore::ConfigItem.new(key: :git_commit_id,
+                                      env_name: "TESTAPPIO_GIT_COMMIT_ID",
+                                      description: "Include the last commit ID in the release notes (works with both release notes option): true or false",
+                                      optional: true,
+                                      is_string: false,
+                                      default_value: false),
+          FastlaneCore::ConfigItem.new(key: :notify,
+                                      env_name: "TESTAPPIO_NOTIFY",
+                                      description: "Send notificaitons to your team members about this release: true or false",
+                                      optional: true,
+                                      is_string: false,
+                                      default_value: false)
+        ]
+      end
+
+      def self.output
+        nil
+      end
+
+      def self.return_value
+        nill
+      end
+
+      def self.authors
+        ["TestApp.io"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/testappio/helper/testappio_helper.rb

@@ -0,0 +1,62 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class TestappioHelper
+      # Check if `ta_cli` exists, install it if not
+      def self.check_ta_cli
+        unless `which ta-cli`.include?('ta-cli')
+          UI.error("ta-cli not found, installing")
+          UI.command(`curl -Ls https://github.com/testappio/cli/releases/latest/download/install | bash`)
+        end
+      end
+
+      # Handle errors from `ta_cli`, if contains 'Error', the process stops,
+      # otherwise, just print to user console
+      def self.handle_error(errors)
+        fatal = false
+        errors.each do |error|
+          if error
+            if error =~ /Error/
+              UI.error(error.to_s)
+              fatal = true
+            else
+              UI.verbose(error.to_s)
+            end
+          end
+        end
+        UI.user_error!('Error while calling ta-cli') if fatal
+      end
+
+      # Run the given command
+      def self.call_ta_cli(command)
+        UI.message("Starting ta-cli...")
+        require 'open3'
+        if FastlaneCore::Globals.verbose?
+          UI.verbose("ta-cli command:\n\n")
+          UI.command(command.to_s)
+          UI.verbose("\n\n")
+        end
+        final_command = command.map { |arg| Shellwords.escape(arg) }.join(" ")
+        out = []
+        error = []
+        Open3.popen3(final_command) do |stdin, stdout, stderr, wait_thr|
+          while (line = stdout.gets)
+            out << line
+            UI.message(line.strip!)
+          end
+          while (line = stderr.gets)
+            error << line.strip!
+          end
+          exit_status = wait_thr.value
+          unless exit_status.success? && error.empty?
+            handle_error(error)
+          end
+        end
+        out.join
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Testappio
+    VERSION = "1.0.0"
+  end
+end

data/lib/fastlane/plugin/testappio.rb

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

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-testappio
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- TestApp.io
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-16 00:00:00.000000000 Z
+dependencies:
+- !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.204.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.204.3
+- !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.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !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'
+description:
+email: support@testapp.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/testappio.rb
+- lib/fastlane/plugin/testappio/actions/upload_to_testappio.rb
+- lib/fastlane/plugin/testappio/helper/testappio_helper.rb
+- lib/fastlane/plugin/testappio/version.rb
+homepage: https://github.com/testappio/fastlane-plugin-testappio
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Deploy your Android & iOS to TestApp.io
+test_files: []