fastlane-plugin-saucelabs 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 630500a71605b851cfb589ac405a07224fa59f53c5662b06e99a8e9299636a51
+  data.tar.gz: 997c24e1a95370d16a4c92b1a54a39d670fdf0fe356d03181983942883525eec
+SHA512:
+  metadata.gz: a5e52b334958665f2350cf226768dc07aa94b42c67a824162ae3e33844ecaa51c062c7890d2e7ebff186f8cc45cc4f5c52a7008b9471d6a8520ac1da698698af
+  data.tar.gz: 2587f5419680e6d76ae720dc5b9526ca91bad027720db59b1ff94de69d58895cd48a12b1fc6b83e8361aa2be2efd123478ad450eabbea3df6fc2e7032ee6d401

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 ivan kat <cloudkats@gmail.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,67 @@
+# saucelabs plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-saucelabs)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-saucelabs`, add it to your project by running:
+
+```bash
+fastlane add_plugin saucelabs
+```
+
+## About saucelabs
+
+Sauce Labs android & ios configuraiton
+
+**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
+
+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`.
+
+**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).
+
+## Resources
+
+- [SauceLabs Status page](https://status.saucelabs.com/)
+- [SauceLabs API](https://docs.saucelabs.com/dev/api/index.html)
+
+## TODO
+
+- [ ] Support folders
+- [ ] Configure uploaded version
+- [X] Support mulitple regions to upload
+- [ ] Retry logic
+- [ ] Timeout logic
+- [X] Update description
+- [ ] Test key functionality

data/lib/fastlane/plugin/saucelabs/actions/saucelabs_upload_action.rb

@@ -0,0 +1,183 @@
+require 'fastlane/action'
+require_relative '../helper/saucelabs_helper'
+
+module Fastlane
+  module Actions
+
+    module SharedValues
+      SAUCE_USERNAME = :SAUCE_USERNAME
+      SAUCE_ACCESS_KEY = :SAUCE_ACCESS_KEY
+      SAUCE_REGION = :SAUCE_REGION
+      SAUCE_ITEM_NAME = :SAUCE_ITEM_NAME
+      SAUCE_ITEM_KIND = :SAUCE_ITEM_KIND
+      SAUCE_ITEM_ID = :SAUCE_ITEM_ID
+      SAUCE_ITEM_SIZE = :SAUCE_ITEM_SIZE
+      SAUCE_ITEM_REGION = :SAUCE_ITEM_REGION
+    end
+
+    class SaucelabsUploadAction < Action
+      #noinspection RubyResolve
+      def self.run(params)
+        UI.message("The saucelabs plugin is working!")
+        file = params[:file]
+        region = params[:region]
+        username = params[:user_name]
+        apikey = params[:api_key]
+        app_name = params[:app_name]
+        app_description = params[:app_description]
+
+        if file.to_s.length == 0
+          UI.user_error!("Couldn't find build file at path #{file}` ❌")
+        end
+
+        upload(payload: file,
+               app_name: app_name,
+               app_description: app_description,
+               user_name: username,
+               api_key: apikey,
+               region: region)
+      end
+
+      def self.upload(payload:, app_name:, app_description:, user_name:, api_key:, region:)
+        UI.message("Starting \"#{app_name}\" upload to Sauce Labs...")
+
+        begin
+          result = Helper::SaucelabsHelper.upload(
+            payload: payload,
+            app_name: app_name,
+            app_description: app_description,
+            user_name: user_name,
+            api_key: api_key,
+            region: region)
+
+          if result and result.is_a?(Hash)
+            Actions.lane_context[SharedValues::SAUCE_ITEM_NAME] = result[:name] if result.has_key?(:name)
+            Actions.lane_context[SharedValues::SAUCE_ITEM_KIND] = result[:kind] if result.has_key?(:kind)
+            Actions.lane_context[SharedValues::SAUCE_ITEM_ID] = result[:id] if result.has_key?(:id)
+            Actions.lane_context[SharedValues::SAUCE_ITEM_SIZE] = result[:size] if result.has_key?(:size)
+            Actions.lane_context[SharedValues::SAUCE_ITEM_REGION] = result[:region] if result.has_key?(:region)
+          end
+          UI.message("Upload \"#{app_name}\" ✅")
+        rescue => exception
+          UI.user_error!("Failed to upload ❌. #{exception.to_s}")
+        end
+      end
+
+      def self.description
+        "Sauce labs android & ios Fastlane plugin"
+      end
+
+      def self.authors
+        ["@CloudKats https://github.com/cloudkats"]
+      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 ios&android artifacts to Sauce Labs https://docs.saucelabs.com/"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :file,
+                                       env_name: "",
+                                       description: "zip file for the upload",
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         if value
+                                           UI.user_error!("Could not find file to upload \"#{file}\" ") unless File.exist?(value) || Helper.test?
+                                           accepted_formats = %w(.api .ipa)
+                                           file_ext = Helper::SaucelabsHelper.file_extname(accepted_formats, value)
+                                           # UI.user_error!("Extension not supported for \"#{file}\" ") unless accepted_formats.include? file_ext
+                                         end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :app_name,
+                                       env_name: "SAUCE_APP_NAME",
+                                       description: "App name as found in the App's URL in Sauce Labs",
+                                       default_value: Actions.lane_context[SharedValues::SAUCE_ITEM_NAME],
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No App name given, pass using `app_name: 'app name'`") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :app_description,
+                                       description: "App description as it found in \"item.description\" Sauce Labs",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :user_name,
+                                       env_name: "SAUCE_USERNAME",
+                                       description: "The Sauce Labs API uses basic auth username to authenticate requests",
+                                       default_value: Actions.lane_context[SharedValues::SAUCE_USERNAME],
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No API username given, pass using `username: 'sauce user name'`") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "SAUCE_ACCESS_KEY",
+                                       description: "The Sauce Labs API uses API keys to authenticate requests",
+                                       default_value: Actions.lane_context[SharedValues::SAUCE_ACCESS_KEY],
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No API key given, pass using `apikey: 'sauce access key'`") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :region,
+                                       env_name: "SAUCE_REGION",
+                                       description: "Api endpoint region e.g. 'us', 'us-west-1', 'eu' or 'eu-central-1' ",
+                                       default_value: Actions.lane_context[SharedValues::SAUCE_REGION],
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         accepted_formats = %w[us us-west-1 eu-central-1 eu]
+                                         UI.user_error!("Only \"us\", \"eu\", \"us-west-1\" and \"eu-central-1\", types are allowed, you provided \"#{value}\"") unless accepted_formats.include? value || Helper.test?
+                                       end)
+        ]
+      end
+
+      def self.output
+        [
+          ['SAUCE_USERNAME', 'Contains API user name'],
+          ['SAUCE_REGION', 'Contains API region'],
+          ['SAUCE_ITEM_NAME', 'Contains item name'],
+          ['SAUCE_ITEM_SIZE', 'Contains item size'],
+          ['SAUCE_ITEM_ID', 'Contains item id in uuid format'],
+          ['SAUCE_ITEM_KIND', 'Contains item kind e.g., android or ios'],
+          ['SAUCE_ITEM_REGION', 'Contains region where item is uploaded']
+        ]
+      end
+
+      def self.example_code
+        [
+          'saucelabs_upload(
+            user_name: "user name",
+            api_key:  "api key",
+            app_name: "Android.artifact.apk",
+            file: "app/build/outputs/apk/debug/app-debug.apk",
+            region: "eu"
+          )',
+          'saucelabs_upload(
+            user_name: "user name",
+            api_key:  "api key",
+            app_name: "iOS.artifact.ipa",
+            file: "app.ipa",
+            description
+            region: "us-west-1"
+          )'
+        ]
+      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/saucelabs/helper/file_upload.rb

@@ -0,0 +1,115 @@
+require "uri"
+require "net/http"
+#TODO: test all the methods
+
+class SauceHttp
+  def initialize(ui, username, apikey, region)
+    @UI = ui
+    encoded_auth = Base64::strict_encode64(username + ":" + apikey)
+    @basic_auth_key = "Basic #{encoded_auth}"
+    endpoints = {
+      'us' => "https://api.us-west-1.saucelabs.com",
+      'us-west-1' => "https://api.us-west-1.saucelabs.com",
+      'eu' => "https://api.eu-central-1.saucelabs.com",
+      'eu-central-1' => "https://api.eu-central-1.saucelabs.com"
+    }
+    @region = case region
+              when 'eu' then "eu-central-1"
+              when 'us' then "us-west-1"
+              else region
+              end
+    @endpoint = endpoints[region]
+    @UI.message("DEBUG: BASE URL #{@endpoint}") if ENV['DEBUG']
+  end
+
+  def is_access_authorized(resource_path = 'team-management/v1/teams/')
+    @UI.message("DEBUG: GET(authorization) #{@endpoint}/#{resource_path}") if ENV['DEBUG']
+    https, url = request_prepare(resource_path)
+    request = Net::HTTP::Get.new(url)
+    request["Authorization"] = @basic_auth_key
+    response = https.request(request)
+    response.kind_of?(Net::HTTPOK)
+    unless response.kind_of?(Net::HTTPOK)
+      raise "Auth Error, provided invalid username or token"
+    end
+  end
+
+  def is_available(resource_path = 'rest/v1/info/status')
+    @UI.message("DEBUG: GET(platform status) #{@endpoint}/#{resource_path}") if ENV['DEBUG']
+    https, url = request_prepare(resource_path)
+    request = Net::HTTP::Get.new(url)
+    response = https.request(request)
+    body = JSON.parse(response.body)
+    unless response.kind_of?(Net::HTTPOK) && body['service_operational']
+      raise "Service #{@endpoint}/#{resource_path} is not operational. #{body['status_message']}"
+    end
+  end
+
+  def upload(app_name, app_description, payload, size, resource_path = 'v1/storage/upload')
+    @UI.message("DEBUG: POST(artifact upload) #{@endpoint}/#{resource_path}") if ENV['DEBUG']
+
+    https, url = request_prepare(resource_path)
+    request = Net::HTTP::Post.new(url)
+    request["Authorization"] = @basic_auth_key
+    request['Content-Length'] = size
+    request['Accept'] = '*/*'
+    form_data = [['payload', payload], ['name', app_name]]
+    request.set_form form_data, "multipart/form-data"
+    response = https.request(request)
+    body = JSON.parse(response.body)
+
+    case response.code.to_i
+    when 406
+      raise "#{body['title']}. #{body['detail']}"
+    end
+
+    item = body['item']
+    if app_description and !app_description.to_s.strip.empty?
+      update_description(item['id'], app_description)
+    end
+
+    {
+      id: item['id'],
+      kind: item['kind'],
+      name: item['name'],
+      size: size,
+      region: @region
+    }
+  end
+
+  def update_description(id, app_description)
+    resource_path = "v1/storage/files/#{id}"
+    @UI.message("DEBUG: PUT(artifact update) #{@endpoint}/#{resource_path}/#{id}") if ENV['DEBUG']
+    @UI.message("DEBUG: PUT(artifact update) app description #{app_description}") if ENV['DEBUG']
+
+    https, url = request_prepare(resource_path)
+    request = Net::HTTP::Put.new(url)
+    request["Authorization"] = @basic_auth_key
+    request["Content-Type"] = "application/json"
+    request.body = JSON.dump({
+                               "item": {
+                                 "description": app_description
+                               }
+                             })
+
+    response = https.request(request)
+
+    unless response.kind_of?(Net::HTTPOK)
+      body = JSON.parse(response.body)
+      case response.code.to_i
+      when 404
+        raise "#{body['title']}. #{body['detail']}"
+      end
+      raise "Unhandled exception. #{body}"
+    end
+  end
+
+  private
+
+  def request_prepare(resource_path)
+    url = URI("#{@endpoint}/#{resource_path}")
+    https = Net::HTTP.new(url.host, url.port)
+    https.use_ssl = true
+    [https, url]
+  end
+end

data/lib/fastlane/plugin/saucelabs/helper/saucelabs_helper.rb

@@ -0,0 +1,37 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class SaucelabsHelper
+      # class methods that you define here become available in your action
+      # as `Helper::SaucelabsHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the saucelabs plugin helper!")
+      end
+
+      # basic utility method to upload a file and set a description,
+      def self.upload(payload:, app_name:, app_description:, user_name:, api_key:, region:)
+        http = SauceHttp.new(UI, user_name, api_key, region)
+        begin
+          # http.is_available
+          http.is_access_authorized
+          size = File.size(payload).to_s
+          payload_data = File.open(payload, "rb")
+          return http.upload(app_name, app_description, payload_data, size)
+        rescue => exception
+          raise exception.to_s
+        end
+      end
+
+      # basic utility method to check file types that Sauce Labs will accept,
+      def self.file_extname(formats, path)
+        formats.each do |suffix|
+          return suffix if path.to_s.downcase.end_with? suffix.downcase
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Saucelabs
+    VERSION = File.read("version").strip
+  end
+end

data/lib/fastlane/plugin/saucelabs.rb

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

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-saucelabs
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- ivan kat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-26 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.194.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.194.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.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: cloudkats@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/saucelabs.rb
+- lib/fastlane/plugin/saucelabs/actions/saucelabs_upload_action.rb
+- lib/fastlane/plugin/saucelabs/helper/file_upload.rb
+- lib/fastlane/plugin/saucelabs/helper/saucelabs_helper.rb
+- lib/fastlane/plugin/saucelabs/version.rb
+homepage: https://github.com/cloudkats/fastlane-plugin-saucelabs
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Sauce Labs android & ios configuraiton
+test_files: []