fastlane-plugin-testappio 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45a858285aceb1aa48afb0a85e362a35309aad321f02bd150651009c3c2985c3
-  data.tar.gz: 3d56ec9f6e88bb9596d2ba61870163fb134c17e34045d76b15182be1a084013f
+  metadata.gz: d55de14e5648c1807325ebdea9de2ebf7553a9c61d8a8c7e4f58484409c29dc1
+  data.tar.gz: 7d560dce67bef063702fb942b3bbfa508a3a55cf49a98e8b3a7d5e65bb803c1f
 SHA512:
-  metadata.gz: a9a542f8eb7b7c23eed9d2846650d8a24ee1c55c567499e985f2e92681cdaeaf9f82c4ce91a19310e929531682711d30360a467321a545ba4c5685e317f93191
-  data.tar.gz: 77ae25bcbef573d9d898db7739f66be4ac6d06adacfbd284fab2c7ddaa3d7fa40fb381556eff1bed362d12483f6584074df93d13fd9857740226ad3fa3a39974
+  metadata.gz: 57d59c0bd2d320dcec29a97b53a21de3e2cc8290967738dd4591cabfd2317beb03567d8d92823f1bf6b39e10e7e8c4b00a2b23f07ad40408723178ae4dd0f637
+  data.tar.gz: 310cc7eb9e585a5b6dbb2eadb28084b921a8a217a50723abd7c365be3f1d02abee51e7427191a5412e7fdfae19f32b61fbeede3aa090359d153868e08b256f03

data/README.md

@@ -1,86 +1,107 @@
 # [<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.
+> 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.
+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)
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-testappio) [![Gem Version](https://badge.fury.io/rb/fastlane-plugin-testappio.svg)](https://badge.fury.io/rb/fastlane-plugin-testappio)
 
 ## 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:
+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
 ```
 
+## Configuration
+
+_More info here: [https://help.testapp.io/ta-cli](https://help.testapp.io/ta-cli/)_
+
+| 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 at [https://portal.testapp.io/apps](https://portal.testapp.io/apps?action=select-for-integrations) | 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 options): true or false                               | TESTAPPIO_GIT_COMMIT_ID     | false   |
+| notify            | Send notifications to your team members about this release: true or false                                                            | TESTAPPIO_NOTIFY            | false   |
+
 ## TestApp.io actions
 
-Actions provided by the CLI: [ta-cli](https://github.com/testappio/cli)
+Actions provided by the CLI: [ta-cli](https://help.testapp.io/ta-cli/)
+
+Check out the [example Fastfile](https://github.com/testappio/fastlane-plugin-testappio/blob/main/fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
 
-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:
 
-To upload after the fastlane `gym` action:
+##### iOS
 
 ```ruby
-  lane :development do
-    match(type: "development")
-    gym(export_method: "development")
+  lane :beta do
+
+    increment_build_number
+    match(type: "adhoc")
+    gym(export_method: "ad-hoc")
+
     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",
+      release_notes: "My release notes here...",
       git_release_notes: true,
       git_commit_id: false,
-      notify: false
+      notify: true
     )
+
+    clean_build_artifacts #optional
+
   end
 ```
 
-### Action **upload_to_testappio**
+##### Android
 
-Upload Android (APK) & iOS (IPA) files to TestApp.io and notify your team members
+```ruby
+  lane :beta do
 
-| 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   |
+    increment_version_code #[Optional] fastlane add_plugin increment_version_code
 
-## Issues and feedback
+    gradle(task: "clean assembleDebug") #or clean assembleRelease
 
-For any other issues and feedback about this plugin, please submit it to this repository.
+    upload_to_testappio(
+      api_token: "Your API Token", #You can get it from https://portal.testapp.io/settings/api-credentials
+      app_id: "Your App ID", #You can get it from your app page in https://portal.testapp.io/apps
+      release_notes: "My release notes here...",
+      git_release_notes: true,
+      git_commit_id: false,
+      notify: true
+    )
 
-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!
+  end
+```
 
 ## Troubleshooting
 
 If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
 
-## Using _fastlane_ plugins
+## Using _Fastlane_ plugins
+
+Check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/) for more information about how the plugin system works.
+
+## About _Fastlane_
+
+_Fastlane_ is the easiest way to automate beta deployments and releases for iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
+
+---
+
+## Feedback & Support
+
+Developers built [TestApp.io](https://testapp.io) to solve the pain of app distribution & feedback for mobile app development teams.
 
-For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+Join our [community](https://help.testapp.io/faq/join-our-community/) for feedback and support.
 
-## About _fastlane_
+Check out our [Help Center](https://help.testapp.io/) for more info and other integrations.
 
-_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).
+Happy releasing 🎉

data/lib/fastlane/plugin/testappio/actions/upload_to_testappio.rb

@@ -2,11 +2,15 @@ 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
+        # Check if `ta_cli` exists, install it if not
+        unless Helper::TestappioHelper.check_ta_cli
+          UI.error("Error detecting ta-cli")
+          return
+        end
+
         api_token = params[:api_token]
         app_id = params[:app_id]
         apk_file = params[:apk_file]
@@ -16,36 +20,42 @@ module Fastlane
         git_release_notes = params[:git_release_notes]
         git_commit_id = params[:git_commit_id]
         notify = params[:notify]
+        self_update = params[:self_update]
+
+        # Check if ta-cli needs to be updated
+        unless Helper::TestappioHelper.check_update(self_update)
+          UI.error("Error updating ta-cli")
+          return
+        end
 
         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 = ["ta-cli", "publish",
+                   "--api_token=#{api_token}",
+                   "--app_id=#{app_id}",
+                   "--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")
+
+        command += ["--release_notes=#{release_notes}",
+                    "--git_release_notes=#{git_release_notes}",
+                    "--git_commit_id=#{git_commit_id}",
+                    "--notify=#{notify}",
+                    "--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.")
+        file_ext = File.extname(file_path).delete('.')
+        unless SUPPORTED_FILE_EXTENSIONS.include?(file_ext)
+          UI.user_error!("file_path is invalid, only files with extensions #{SUPPORTED_FILE_EXTENSIONS} are allowed to be uploaded.")
         end
       end
 
@@ -81,7 +91,7 @@ module Fastlane
                                        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",
+                                       description: "You can get it from your app page in https://portal.testapp.io/apps?action=select-for-integrations",
                                        is_string: false),
           FastlaneCore::ConfigItem.new(key: :release,
                                        env_name: "TESTAPPIO_RELEASE",
@@ -122,7 +132,13 @@ module Fastlane
                                       description: "Send notificaitons to your team members about this release: true or false",
                                       optional: true,
                                       is_string: false,
-                                      default_value: false)
+                                      default_value: false),
+          FastlaneCore::ConfigItem.new(key: :self_update,
+                                      env_name: "TESTAPPIO_SELF_UPDATE",
+                                      description: "Automatically update ta-cli if a new version is available or required: true or false",
+                                      optional: true,
+                                      is_string: false,
+                                      default_value: true)
         ]
       end
 

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

@@ -5,29 +5,86 @@ module Fastlane
 
   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')
+        unless system('which ta-cli > /dev/null 2>&1')
           UI.error("ta-cli not found, installing")
-          UI.command(`curl -Ls https://github.com/testappio/cli/releases/latest/download/install | bash`)
+
+          unless system('curl -Ls https://github.com/testappio/cli/releases/latest/download/install | bash')
+            UI.error("Error installing ta-cli")
+            return false
+          end
+        end
+
+        return true
+      end
+
+      # Check if there is an update available for `ta_cli`, and install it if necessary
+      def self.check_update(self_update)
+        require 'open3'
+
+        version_output = `ta-cli version`
+        UI.verbose(version_output)
+
+        if version_output.include?("breaking changes")
+          if self_update
+            UI.message("Updating ta-cli due to breaking changes...")
+          else
+            UI.user_error!("Update necessary due to breaking changes. Please update ta-cli manually or set self_update to true")
+            return false
+          end
+        elsif version_output.include?("New version available")
+          if self_update
+            UI.message("Updating ta-cli...")
+          else
+            UI.error("New version available, but skipping update as self_update is set to false.")
+            return true
+          end
+        else
+          UI.success("ta-cli is already up-to-date")
+          return true
+        end
+
+        update_command = "curl -Ls https://github.com/testappio/cli/releases/latest/download/install | bash"
+        update_output, update_errors, update_status = Open3.capture3(update_command)
+        UI.verbose(update_output)
+
+        if update_output.include?("ta-cli successfully installed") || update_output.include?("ta-cli has been updated")
+          version_output = `ta-cli version`
+          UI.verbose(version_output)
+
+          if version_output.include?("Update necessary due to breaking changes") || version_output.include?("New version available")
+            UI.user_error!("Error updating ta-cli: the version is still outdated")
+            return false
+          else
+            UI.success("ta-cli has been updated successfully")
+            return true
+          end
+        else
+          UI.user_error!("Error updating ta-cli: #{update_output}")
+          return false
         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
+
+        if errors.any? { |e| e =~ /Error/ }
+          UI.user_error!('Error while calling ta-cli')
+        elsif errors.any?
+          UI.user_error!("Error while calling ta-cli: #{errors.join(', ')}")
+        end
       end
 
       # Run the given command
@@ -45,18 +102,17 @@ module Fastlane
         Open3.popen3(final_command) do |stdin, stdout, stderr, wait_thr|
           while (line = stdout.gets)
             out << line
-            UI.message(line.strip!)
+            UI.message(line.strip!) if FastlaneCore::Globals.verbose? && !line.strip.empty?
           end
           while (line = stderr.gets)
             error << line.strip!
           end
           exit_status = wait_thr.value
-          unless exit_status.success? && error.empty?
-            handle_error(error)
-          end
+          handle_error(error) unless exit_status.success?
         end
         out.join
       end
+
     end
   end
 end

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

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

metadata

@@ -1,33 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-testappio
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - TestApp.io
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: fastlane
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.204'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.204.3
@@ -35,6 +38,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.204'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.204.3
@@ -42,58 +48,58 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -112,45 +118,45 @@ dependencies:
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.1
 - !ruby/object:Gem::Dependency
   name: rubocop-require_tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description:
+        version: '0.21'
+description: 
 email: support@testapp.io
 executables: []
 extensions: []
@@ -166,7 +172,7 @@ homepage: https://github.com/testappio/fastlane-plugin-testappio
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -174,15 +180,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.4.12
+signing_key: 
 specification_version: 4
 summary: Deploy your Android & iOS to TestApp.io
 test_files: []