fastlane-plugin-browserstack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ccb7886b844e0140c328aa55be44dba043bf1f34e35d5ca5ac8fd08b52139e52
+  data.tar.gz: 77374e5968af3c0d59b8bab572cd30cba18907dea3652a78a44f4d1e80dc2492
+SHA512:
+  metadata.gz: b86a0abf7a9af9cadb98000cfcb4244026675499da55be47f752cc4a66ec454aed14fb4d04eef737a540ad8287df4b986c14af9257d16057b60fb657347adbdf
+  data.tar.gz: cc186b6bc2d13757a7db57863243e6a36bc9b7f92c936f25250bb4bb203fd26141908f414b5b737987e127eac03581e4c74d274f6523c7bd5f5208af2bd5a4e2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 BrowserStack
+
+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,49 @@
+# browserstack-fastlane-plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-browserstack)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-browserstack`, add it to your project by running:
+
+```bash
+fastlane add_plugin browserstack
+```
+
+## About browserstack
+
+Uploads IPA and APK files to BrowserStack for automation testing.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by including that in your project's Fastfile, 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/browserstack.rb

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

data/lib/fastlane/plugin/browserstack/actions/upload_to_browserstack_app_automate_action.rb

@@ -0,0 +1,117 @@
+require 'fastlane/action'
+require_relative '../helper/browserstack_helper'
+require 'json'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      BROWSERSTACK_APP_ID ||= :BROWSERSTACK_APP_ID
+    end
+    class UploadToBrowserstackAppAutomateAction < Action
+      SUPPORTED_FILE_EXTENSIONS = ["apk", "ipa"]
+      UPLOAD_API_ENDPOINT = "https://api-cloud.browserstack.com/app-automate/upload"
+
+      def self.run(params)
+        browserstack_username = params[:browserstack_username] # Required
+        browserstack_access_key = params[:browserstack_access_key] # Required
+        file_path = params[:file_path].to_s # Required
+
+        validate_file_path(file_path)
+
+        UI.message("Uploading app to BrowserStack AppAutomate...")
+
+        browserstack_app_id = Helper::BrowserstackHelper.upload_file(browserstack_username, browserstack_access_key, file_path, UPLOAD_API_ENDPOINT)
+
+        # Set 'BROWSERSTACK_APP_ID' environment variable, if app upload was successful.
+        ENV['BROWSERSTACK_APP_ID'] = browserstack_app_id
+
+        UI.success("Successfully uploaded app " + file_path + " to BrowserStack AppAutomate with app_url : " + browserstack_app_id)
+
+        UI.success("Setting Environment variable BROWSERSTACK_APP_ID = " + browserstack_app_id)
+
+        # Setting app id in SharedValues, which can be used by other fastlane actions.
+        Actions.lane_context[SharedValues::BROWSERSTACK_APP_ID] = browserstack_app_id
+      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 apk and ipa are allowed to be uploaded.")
+        end
+      end
+
+      def self.description
+        "Uploads IPA and APK files to BrowserStack AppAutomate for running automated tests."
+      end
+
+      def self.authors
+        ["Hitesh Raghuvanshi"]
+      end
+
+      def self.details
+        "Uploads IPA and APK files to BrowserStack AppAutomate for running automated tests."
+      end
+
+      def self.output
+        [
+          ['BROWSERSTACK_APP_ID', 'App id of uploaded app.']
+        ]
+      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: :browserstack_username,
+                                       description: "BrowserStack's username",
+                                       optional: false,
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No browserstack_username given.") if value.to_s.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :browserstack_access_key,
+                                       description: "BrowserStack's access key",
+                                       optional: false,
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No browserstack_access_key given.") if value.to_s.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :file_path,
+                                       description: "Path to the app file",
+                                       optional: true,
+                                       is_string: true,
+                                       default_value: default_file_path)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'upload_to_browserstack_app_automate',
+          'upload_to_browserstack_app_automate(
+            browserstack_username: ENV["BROWSERSTACK_USERNAME"],
+            browserstack_access_key: ENV["BROWSERSTACK_ACCESS_KEY"],
+            file_path: "path_to_apk_or_ipa_file"
+           )'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/browserstack/helper/browserstack_helper.rb

@@ -0,0 +1,46 @@
+require 'fastlane_core/ui/ui'
+require 'rest-client'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class BrowserstackHelper
+      # class methods that you define here become available in your action
+      # as `Helper::BrowserstackHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the browserstack plugin helper!")
+      end
+
+      # Uploads file to BrowserStack
+      # Params :
+      # +browserstack_username+:: BrowserStack's username.
+      # +browserstack_access_key+:: BrowserStack's access key.
+      # +file_path+:: Path to the file to be uploaded.
+      # +url+:: BrowserStack's app upload endpoint.
+      def self.upload_file(browserstack_username, browserstack_access_key, file_path, url)
+        begin
+          response = RestClient::Request.execute(
+            method: :post,
+            url: url,
+            user: browserstack_username,
+            password: browserstack_access_key,
+            payload: {
+              multipart: true,
+              file: File.new(file_path, 'rb')
+            }
+          )
+        rescue RestClient::ExceptionWithResponse => err
+          error_response = err.response
+        end
+
+        # Return app_url if file was uploaded successfully.
+        return JSON.parse(response.to_s)["app_url"] unless response.nil?
+
+        # Give error if upload failed.
+        UI.user_error!("App upload failed!!! Reason : " + JSON.parse(error_response.to_s)["error"]) unless error_response.nil?
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-browserstack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BrowserStack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-13 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@browserstack.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/browserstack.rb
+- lib/fastlane/plugin/browserstack/actions/upload_to_browserstack_app_automate_action.rb
+- lib/fastlane/plugin/browserstack/helper/browserstack_helper.rb
+- lib/fastlane/plugin/browserstack/version.rb
+homepage: https://github.com/browserstack/browserstack-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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Uploads IPA and APK files to BrowserStack for automation testing.
+test_files: []