fastlane-plugin-waldo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38abd1a8b884b3bdd003f0a47c67ee37c095cc45
+  data.tar.gz: 5e9efe73fa5af9e54c7a79ff5a0d9d23b8da4878
+SHA512:
+  metadata.gz: 3967b095cfdc94934e33a5e50d99fe04627713fcf5525ece4cbe2f87bc9178151de361b2fde7af01cf0b8c2975eef44d0618524999999818c872f5d0c8ca5f40
+  data.tar.gz: af042c5e7bf2d08f643543311b035a438660eed2d464c0a74af1a0e927e93352ef22c2c85c33c8003ac78c04ce658218fc839dbe66a4bae98d4ebf3787ef04bd

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Amolo Atelier, Inc.
+
+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,90 @@
+# Waldo `fastlane` plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-waldo)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
+get started with `fastlane-plugin-waldo`, add it to your project by running:
+
+```bash
+fastlane add_plugin waldo
+```
+
+## About Waldo
+
+[Waldo](https://www.waldo.io) provides fast, reliable, and maintainable tests
+for the most critical flows in your app. This plugin provides a `waldo` action
+which allows you to upload an iOS or Android build to Waldo for processing.
+
+## Usage
+
+To get started, first obtain an API key and an application ID from Waldo for
+your app. These are used to authenticate with the Waldo backend on each call.
+
+### Uploading an iOS Build
+
+Build a new IPA for your app. If you use `gym` (aka `build_ios_app`) to build
+your IPA, `waldo` will automatically find and upload the generated IPA.
+
+```ruby
+gym
+waldo(api_key: '0123456789abcdef0123456789abcdef',
+      application_id: 'app-0123456789abcdef')
+```
+
+> **Note:** You _must_ specify the Waldo API key and application ID key.
+
+If for some reason you do _not_ use `gym` to build your IPA, you will need to
+explicitly specify the IPA path to `waldo`:
+
+```ruby
+waldo(ipa_path: '/path/to/YourApp.ipa',
+      api_key: '0123456789abcdef0123456789abcdef',
+      application_id: 'app-0123456789abcdef')
+```
+
+### Uploading an Android Build
+
+Build a new APK for your app. If you use `gradle` to build your APK, `waldo`
+will automatically find and upload the generated APK.
+
+```ruby
+gradle(task: 'assemble',
+       build_type: 'Release')
+waldo(api_key: '0123456789abcdef0123456789abcdef',
+      application_id: 'app-0123456789abcdef')
+```
+
+> **Note:** You _must_ specify the Waldo API key and application ID key.
+
+If for some reason you do _not_ use `gradle` to build your APK, you will need
+to explicitly specify the APK path to `waldo`:
+
+```ruby
+waldo(apk_path: '/path/to/YourApp.apk',
+      api_key: '0123456789abcdef0123456789abcdef',
+      application_id: 'app-0123456789abcdef')
+```
+
+## 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/waldo/actions/waldo_action.rb

@@ -0,0 +1,111 @@
+module Fastlane
+  module Actions
+    class WaldoAction < Action
+      def self.run(params)
+        params.values   # validate all inputs
+
+        platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+
+        if platform == :android
+          UI.user_error!("You must pass an APK path to the Waldo action") unless params[:apk_path]
+        elsif platform == :ios || platform.nil?
+          UI.user_error!("You must pass an IPA path to the Waldo action") unless params[:ipa_path]
+        end
+
+        UI.user_error!("You must pass an API key to the Waldo action") unless params[:api_key]
+        UI.user_error!("You must pass an application ID to the Waldo action") unless params[:application_id]
+
+        FastlaneCore::PrintTable.print_values(config: params,
+                                              title: "Summary for waldo #{Fastlane::Waldo::VERSION.to_s}")
+
+        Helper::WaldoHelper.upload_build(params)
+      end
+
+      def self.authors
+        ["eBardX"]
+      end
+
+      def self.available_options
+        platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+
+        if platform == :android
+          apk_path_default = Dir["*.apk"].last || Dir[File.join("app", "build", "outputs", "apk", "app-release.apk")].last
+        elsif platform == :ios || platform.nil?
+          ipa_path_default = Dir["*.ipa"].sort_by { |x| File.mtime(x) }.last
+        end
+
+        [
+          # iOS-specific
+          FastlaneCore::ConfigItem.new(key: :ipa_path,
+                                       env_name: "WALDO_IPA_PATH",
+                                       description: "Path to your IPA file. Optional if you use the _gym_ or _xcodebuild_ action",
+                                       default_value: Actions.lane_context[Actions::SharedValues::IPA_OUTPUT_PATH] || ipa_path_default,
+                                       default_value_dynamic: true,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Unable to find IPA file at path '#{value.to_s}'") unless File.exist?(value)
+                                       end),
+          # Android-specific
+          FastlaneCore::ConfigItem.new(key: :apk_path,
+                                       env_name: "WALDO_APK_PATH",
+                                       description: "Path to your APK file. Optional if you use the _gradle_ action",
+                                       default_value: Actions.lane_context[Actions::SharedValues::GRADLE_APK_OUTPUT_PATH] || apk_path_default,
+                                       default_value_dynamic: true,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Unable to find APK file at path '#{value.to_s}'") unless File.exist?(value)
+                                       end),
+          # General
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "WALDO_API_KEY",
+                                       description: "Waldo API key",
+                                       optional: true,
+                                       sensitive: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No API key for Waldo given, pass using `api_key: 'key'`") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :application_id,
+                                       env_name: "WALDO_APPLICATION_ID",
+                                       description: "Waldo application ID",
+                                       optional: true,
+                                       sensitive: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No application ID for Waldo given, pass using `application_id: 'id'`") unless value && !value.empty?
+                                       end)
+        ]
+      end
+
+      def self.category
+        :testing
+      end
+
+      def self.description
+        "Upload a new build to [Waldo](https://www.waldo.io)"
+      end
+
+      def self.example_code
+        [
+          'waldo',
+          'waldo(
+            api_key: "...",
+            application_id: "..."
+          )',
+          'waldo(
+            apk_path: "./MyApp.apk",
+            api_key: "...",
+            application_id: "..."
+          )',
+          'waldo(
+            ipa_path: "./MyApp.ipa",
+            api_key: "...",
+            application_id: "..."
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:android, :ios].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/waldo/helper/waldo_helper.rb

@@ -0,0 +1,112 @@
+require 'net/http'
+
+module Fastlane
+  module Helper
+    class WaldoHelper
+      def self.upload_build(params)
+        UI.success('Uploading the build to Waldo. This could take a while…')
+
+        begin
+          variant_name = Actions.lane_context[Actions::SharedValues::GRADLE_BUILD_TYPE]
+          uri_string = 'https://api.waldo.io/versions'
+
+          uri_string += "?variantName=#{variant_name}" if variant_name
+
+          uri = URI(uri_string)
+
+          request = build_request(uri, params)
+
+          dump_request(request) if FastlaneCore::Globals.verbose?
+
+          Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+            http.read_timeout = 120   # 2 minutes
+
+            parse_response(http.request(request))
+          end
+        rescue Net::ReadTimeout
+          UI.user_error!("Upload to Waldo timed out!")
+        rescue => exc
+          UI.user_error!("Something went wrong uploading to Waldo: #{exc.inspect.to_s}")
+        ensure
+          request.body_stream.close if request && request.body_stream
+        end
+      end
+
+      def self.build_request(uri, params)
+        platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+
+        if platform == :android
+          body_path = params[:apk_path]
+          flavor = "Android"
+        elsif platform == :ios || platform.nil?
+          body_path = params[:ipa_path]
+          flavor = "iOS"
+        end
+
+        request = Net::HTTP::Post.new(uri.request_uri)
+
+        request['Authorization'] = "Upload-Token #{params[:api_key]}"
+        request['Transfer-Encoding'] = 'chunked'
+        request['User-Agent'] = "Waldo fastlane/#{flavor} v#{Fastlane::Waldo::VERSION}"
+
+        request.body_stream = WaldoReadIO.new(body_path)
+        request.content_type = 'application/octet-stream'
+
+        request
+      end
+
+      def self.dump_request(request)
+        len = request.body ? request.body.length : 0
+
+        puts "Request: #{request.method} #{request.path} (#{len} bytes)"
+
+        request.each_capitalized do |key, value|
+          puts "  #{key}: #{value}"
+        end
+
+        puts "-------"
+      end
+
+      def self.dump_response(response)
+        puts "Response: #{response.code} #{response.message} (#{response.body.length} bytes)"
+
+        response.each_capitalized do |key, value|
+          puts "  #{key}: #{value}"
+        end
+
+        puts "#{response.body}"
+      end
+
+      def self.parse_response(response)
+        dump_response(response) if FastlaneCore::Globals.verbose?
+
+        case response.code.to_i
+        when 200..299
+          UI.success('Build successfully uploaded to Waldo!')
+        when 401
+          UI.user_error!("API key is invalid or missing!")
+        else
+          UI.user_error!("Build failed to upload to Waldo: #{response.code} #{response.message}")
+        end
+      end
+    end
+
+    class WaldoReadIO
+      def initialize(path)
+        @fp = File.open(path)
+      end
+
+      def close
+        @fp.close
+      end
+
+      def read(length = nil, outbuf = nil)
+        if result = @fp.read(length, outbuf)
+          result.force_encoding('BINARY') if result.respond_to?(:force_encoding)
+        end
+
+        result
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/waldo.rb

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

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-waldo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- J. G. Pusey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.95'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.95.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.95'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.95.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: 
+email: john@waldo.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/waldo.rb
+- lib/fastlane/plugin/waldo/actions/waldo_action.rb
+- lib/fastlane/plugin/waldo/helper/waldo_helper.rb
+- lib/fastlane/plugin/waldo/version.rb
+homepage: https://github.com/waldoapp/fastlane-plugin-waldo
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Upload build to Waldo
+test_files: []