fastlane-plugin-aws_device_farm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cce46e2ac22ec1565b4e0138937c51f03338882
+  data.tar.gz: aefcb8f44f0ade00a4671c6ea13d3b995615b73b
+SHA512:
+  metadata.gz: 03a1e55318a56e4dfbc393100324eceb7a07f2181eacddc8223c9de680baa18104819b28cc891e270f212ee45857987bddfa068ca8c6f0d775120b6b506e388f
+  data.tar.gz: a8ca81a261c65329662bd280cdea930c593b05505279b6f6e09b486b6ec53c810dcb46110469cc52d40180ccbe670685fe1777f26bef3f917a5b5f0aea9a30ef

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Helmut Januschka <h.januschka@krone.at>
+
+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,52 @@
+# aws_device_farm plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-aws_device_farm)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-aws_device_farm`, add it to your project by running:
+
+```bash
+fastlane add_plugin aws_device_farm
+```
+
+## About aws_device_farm
+
+Run UI Tests on AWS Devicefarm
+
+**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://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/aws_device_farm.rb

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

data/lib/fastlane/plugin/aws_device_farm/actions/aws_device_farm_action.rb

@@ -0,0 +1,240 @@
+require 'aws-sdk'
+
+module Fastlane
+  module Actions
+    class AwsDeviceFarmAction < Action
+      def self.run(params)
+        Actions.verify_gem!('aws-sdk')
+        UI.message 'Preparing the upload to the device farm.'
+
+        # Instantiate the client.
+        @client = ::Aws::DeviceFarm::Client.new()
+
+        # Fetch the project
+        project = fetch_project params[:name]
+        raise "Project '#{params[:name]}' not found." if project.nil?
+
+        # Fetch the device pool.
+        device_pool = fetch_device_pool project, params[:device_pool]
+        raise "Device pool '#{params[:device_pool]}' not found. 🙈" if device_pool.nil?
+
+        # Create the upload.
+        path   = File.join Dir.pwd, params[:binary_path]
+        type   = File.extname(path) == '.apk' ? 'ANDROID_APP' : 'IOS_APP'
+        upload = create_project_upload project, path, type
+
+        # Upload the application binary.
+        UI.message 'Uploading the application binary. ☕️'
+        upload upload, path
+
+        # Upload the test package if needed.
+        test_upload = nil
+        if params[:test_binary_path]
+          test_path = File.join Dir.pwd, params[:test_binary_path]
+          if type == "ANDROID_APP"
+            test_upload = create_project_upload project, test_path, 'INSTRUMENTATION_TEST_PACKAGE'
+          else
+            
+            test_upload = create_project_upload project, test_path, 'XCTEST_UI_TEST_PACKAGE'
+          end
+
+          # Upload the test binary.
+          UI.message 'Uploading the test binary. ☕️'
+          upload test_upload, test_path
+
+          # Wait for test upload to finish.
+          UI.message 'Waiting for the test upload to succeed. ☕️'
+          test_upload = wait_for_upload test_upload
+          raise 'Test upload failed. 🙈' unless test_upload.status == 'SUCCEEDED'
+        end
+
+        # Wait for upload to finish.
+        UI.message 'Waiting for the application upload to succeed. ☕️'
+        upload = wait_for_upload upload
+        raise 'Binary upload failed. 🙈' unless upload.status == 'SUCCEEDED'
+
+        # Schedule the run.
+        run = schedule_run project, device_pool, upload, test_upload, type
+
+        # Wait for run to finish.
+        if params[:wait_for_completion]
+          UI.message 'Waiting for the run to complete. ☕️'
+          run = wait_for_run run
+          raise "#{run.message} 🙈" unless %w(PASSED WARNED).include? run.result
+
+          UI.message 'Successfully tested the application on the AWS device farm. ✅'.green
+        else
+          UI.message 'Successfully scheduled the tests on the AWS device farm. ✅'.green
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Upload the application to the AWS device farm.'
+      end
+
+      def self.details
+        'Upload the application to the AWS device farm.'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key:         :name,
+            env_name:    'FL_AWS_DEVICE_FARM_NAME',
+            description: 'Define the name of the device farm project',
+            is_string:   true,
+            optional:    false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key:         :binary_path,
+            env_name:    'FL_AWS_DEVICE_FARM_PATH',
+            description: 'Define the path of the application binary (apk or ipa) to upload to the device farm project',
+            is_string:   true,
+            optional:    false,
+            verify_block: proc do |value|
+              path = File.join Dir.pwd, value
+              raise "Application binary not found at path '#{path}'. 🙈".red unless File.exist?(path)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key:         :test_binary_path,
+            env_name:    'FL_AWS_DEVICE_FARM_TEST_PATH',
+            description: 'Define the path of the test binary (apk) to upload to the device farm project',
+            is_string:   true,
+            optional:    true,
+            verify_block: proc do |value|
+              path = File.join Dir.pwd, value
+              raise "Test binary not found at path '#{path}'. 🙈".red unless File.exist?(path)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key:         :path,
+            env_name:    'FL_AWS_DEVICE_FARM_PATH',
+            description: 'Define the path of the application binary (apk or ipa) to upload to the device farm project',
+            is_string:   true,
+            optional:    false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key:         :device_pool,
+            env_name:    'FL_AWS_DEVICE_FARM_POOL',
+            description: 'Define the device pool you want to use for running the applications',
+            is_string:   true,
+            optional:    false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key:           :wait_for_completion,
+            env_name:      'FL_AWS_DEVICE_FARM_WAIT_FOR_COMPLETION',
+            description:   'Wait for the scheduled run to complete',
+            is_string:     false,
+            optional:      true,
+            default_value: true
+          )
+        ]
+      end
+
+      def self.output
+        []
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ["fousa/fousa", "hjanuschka"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios || platform == :android
+      end
+
+      private
+
+      POLLING_INTERVAL = 10
+
+      def self.fetch_project(name)
+        projects = @client.list_projects.projects
+        projects.detect { |p| p.name == name }
+      end
+
+      def self.create_project_upload(project, path, type)
+        @client.create_upload({
+          project_arn:  project.arn,
+          name:         File.basename(path),
+          content_type: 'application/octet-stream',
+          type:         type
+        }).upload
+      end
+
+      def self.upload(upload, path)
+        url = URI.parse(upload.url)
+        contents = File.open(path, 'rb').read
+        Net::HTTP.start(url.host) do |http|
+          http.send_request("PUT", url.request_uri, contents, { 'content-type' => 'application/octet-stream' })
+        end
+      end
+
+      def self.fetch_upload_status(upload)
+        @client.get_upload({
+          arn:  upload.arn
+        }).upload
+      end
+
+      def self.wait_for_upload(upload)
+        upload = fetch_upload_status upload
+        while upload.status == 'PROCESSING'
+          sleep POLLING_INTERVAL
+          upload = fetch_upload_status upload
+        end
+
+        upload
+      end
+
+      def self.fetch_device_pool(project, device_pool)
+        device_pools = @client.list_device_pools({
+          arn: project.arn
+        })
+        device_pools.device_pools.detect { |p| p.name == device_pool }
+      end
+
+      def self.schedule_run(project, device_pool, upload, test_upload, type)
+        # Prepare the test hash depening if you passed the test apk.
+        test_hash = { type: 'BUILTIN_FUZZ' }
+        if test_upload
+          test_hash[:type]             = 'XCTEST_UI'
+          if type == "ANDROID_APP"
+            test_hash[:type]             = 'INSTRUMENTATION'
+          end
+          test_hash[:test_package_arn] = test_upload.arn
+        end
+
+        @client.schedule_run({
+          project_arn:     project.arn,
+          app_arn:         upload.arn,
+          device_pool_arn: device_pool.arn,
+          test:            test_hash
+        }).run
+      end
+
+      def self.fetch_run_status(run)
+        @client.get_run({
+          arn:  run.arn
+        }).run
+      end
+
+      def self.wait_for_run(run)
+        while run.status != 'COMPLETED'
+          sleep POLLING_INTERVAL
+          run = fetch_run_status run
+        end
+        UI.message "The run ended with result #{run.result}."
+
+        run
+      end
+    end
+  end
+end
+

data/lib/fastlane/plugin/aws_device_farm/helper/aws_device_farm_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class AwsDeviceFarmHelper
+      # class methods that you define here become available in your action
+      # as `Helper::AwsDeviceFarmHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the aws_device_farm plugin helper!")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-aws_device_farm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Helmut Januschka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-10 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+  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: 1.105.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.105.0
+description: 
+email: h.januschka@krone.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/aws_device_farm.rb
+- lib/fastlane/plugin/aws_device_farm/actions/aws_device_farm_action.rb
+- lib/fastlane/plugin/aws_device_farm/helper/aws_device_farm_helper.rb
+- lib/fastlane/plugin/aws_device_farm/version.rb
+homepage: 
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Run UI Tests on AWS Devicefarm
+test_files: []