fastlane-plugin-lambdatest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c29d18b65ecf78e982c1fb33779bc322dc9ae2333f82abd22b5cdb55fdb929e
+  data.tar.gz: 7d99ee13cc4608d156e6b61de36d9aa357da2f3ef353b4c33e85541f7e7166f3
+SHA512:
+  metadata.gz: 3d6da40b7f481dee047c1788ed5a2d9ba9107415d5a541ac80e2a55ab0a2a3998cc44f2f3a32122c3d68f9a14f2ed6c42ebbaf1588132c7cdc448d32645a0a5f
+  data.tar.gz: 1039cc02f134c81f014713edf66a3fa24042625621d3683f38936ec13febe1f7a2267067880d286b8b424e7ae91342dbaabbec86f84e8fbc793a0d2a72e6eadc

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 lambdatest <pawanr@lambdatest.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,68 @@
+# lambdatest plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-lambdatest)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-lambdatest`, add it to your project by running:
+
+```bash
+fastlane add_plugin lambdatest
+```
+
+## About lambdatest
+
+Upload apps to lambdatest for testing.
+
+**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
+In order to configure the plugin add below action in your Fastfile.
+
+```
+upload_to_lambdatest(
+    lt_username: ENV["LT_USERNAME"],
+    lt_access_key: ENV["LT_ACCESS_KEY"],
+    file_path: "app_file_path"
+  )
+```
+
+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`.
+
+Once the app is uploaded , the app_url of the app will be stored in an environment variable, "APP_URL" and it can be accessed in your tests in the following way :
+
+```
+String app = System.getenv("APP_URL"); // Get app url from environment variable.
+capabilities.setCapability("app", app); // Add app url to driver capability.
+```
+
+**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/lambdatest/actions/upload_to_lambdatest.rb

@@ -0,0 +1,118 @@
+require 'fastlane/action'
+require_relative '../helper/lambdatest_helper'
+require 'json'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      APP_URL ||= :APP_URL
+    end
+    class UploadToLambdatestAction < Action
+
+      UPLOAD_API_ENDPOINT = "https://manual-api.lambdatest.com/app/upload/realDevice"
+      SUPPORTED_FILE_EXTENSIONS = ["apk", "ipa", "aab"]
+
+      def self.run(params)
+        lt_username = params[:lt_username] # Required
+        lt_access_key = params[:lt_access_key] # Required
+        file_path = params[:file_path].to_s # Required
+
+        validate_file_path(file_path)
+
+        UI.message("Started Uploading app to Lambdatest...")
+
+        lt_app_url = Helper::LambdatestHelper.upload_file(lt_username, lt_access_key, file_path, UPLOAD_API_ENDPOINT)
+
+        # Set 'APP_URL' environment variable, if app upload was successful. 
+        ENV['APP_URL'] = lt_app_url
+      
+
+        UI.success("Successfully uploaded app " + file_path + " to Lambdatest with app_url : " + lt_app_url + " ✅ ")
+
+        UI.success("Setting Environment variable APP_URL = " + lt_app_url)
+
+        # Setting APP_URL in SharedValues, which can be used by other fastlane actions.
+        Actions.lane_context[SharedValues::APP_URL] = lt_app_url
+      end
+
+      # Validate file_path.
+      def self.validate_file_path(file_path)
+        UI.user_error!("file not 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!("Invalid file extension, only files with extensions " + SUPPORTED_FILE_EXTENSIONS.to_s + " are allowed to be uploaded.")
+        end
+      end
+
+      def self.description
+        "LambdaTest fastlane plugin for android and ios apps."
+      end
+
+      def self.authors
+        ["Pawan Rai"]
+      end
+
+      def self.details
+        "Uploads IPA and APK files to Lambdatest for test."
+      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.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :lt_username,
+                                       description: "Lambdatest's username",
+                                       optional: false,
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No LT username given.") if value.to_s.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :lt_access_key,
+                                       description: "Lambdatest's access token",
+                                       optional: false,
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No lt_access_key given.") if value.to_s.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :file_path,
+                                       description: "app file path",
+                                       optional: true,
+                                       is_string: true,
+                                       default_value: default_file_path)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+
+      def self.output
+        [
+          ['APP_URL', 'App URL of uploaded app.']
+        ]
+      end
+
+      def self.example_code
+        [
+          'upload_to_lambdatest',
+          'upload_to_lambdatest(
+            lt_username: ENV["LT_USERNAME"],
+            lt_access_key: ENV["LT_ACCESS_KEY"],
+            file_path: "path_to_app_file"
+           )'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/lambdatest/helper/lambdatest_helper.rb

@@ -0,0 +1,66 @@
+require 'fastlane_core/ui/ui'
+require 'rest-client'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class LambdatestHelper
+      # class methods that you define here become available in your action
+      # as `Helper::LambdatestHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the Lambdatest plugin helper!")
+      end
+
+      # Uploads file to Lambdatest
+      # Params :
+      # +lt_username+:: Lambdatest's username.
+      # +lt_access_key+:: Lambdatest's access key.
+      # +custom_id+:: Custom id for app upload.
+      # +file_path+:: Path to the file to be uploaded.
+      # +url+:: Lambdatest's app upload endpoint.
+      def self.upload_file(lt_username, lt_access_key, file_path, url, custom_id = nil)
+        payload = {
+          name: "xyz",
+          appFile: File.new(file_path, 'rb')
+        }
+
+        unless custom_id.nil?
+          payload[:data] = '{ "custom_id": "' + custom_id + '" }'
+        end
+
+        headers = {
+          "User-Agent" => "fastlane_plugin_lambdatest"
+        }
+        begin
+          response = RestClient::Request.execute(
+            method: :post,
+            url: url,
+            user: lt_username,
+            password: lt_access_key,
+            payload: payload,
+            headers: headers
+          )
+          response_json = JSON.parse(response.to_s)
+          
+          if !response_json["custom_id"].nil?
+            return response_json["custom_id"]
+          else
+            return response_json["app_url"]
+          end
+        rescue RestClient::ExceptionWithResponse => err
+          begin
+            error_response = JSON.parse(err.response.to_s)["message"]
+          rescue
+            error_response = "Internal server error"
+          end
+          # Give error if upload failed.
+          UI.user_error!("App upload failed!!! Reason : #{error_response}")
+        rescue StandardError => error
+          UI.user_error!("App upload failed!!! Reason : #{error.message}")
+        end
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/lambdatest.rb

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

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-lambdatest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- LambdaTest
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !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.96.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.96.1
+description:
+email: support@lambdatest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/lambdatest.rb
+- lib/fastlane/plugin/lambdatest/actions/upload_to_lambdatest.rb
+- lib/fastlane/plugin/lambdatest/helper/lambdatest_helper.rb
+- lib/fastlane/plugin/lambdatest/version.rb
+homepage: https://github.com/LambdaTest/lambdatest-fastlane-plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key:
+specification_version: 4
+summary: fastlane plugin to upload app to lambdatest
+test_files: []