fastlane-plugin-instrumented_tests 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31b360d1f17a6faaee098e20bff2d1dbea23f8ae
+  data.tar.gz: 0f516c84dfa5a5008259064533f70d1d9f07886e
+SHA512:
+  metadata.gz: d12292168548763b03e6e8a3f94f2e7a78af77e242eb5506c6a7e2d7d693eb6b4b5ab34c712ca9d374ff7b9b21c7f6d86c55e1c9d50982c00d2cad5edef649f2
+  data.tar.gz: 4663d7c996f1bed6f73529036de6aa56dcc48ab7be5bc7a541dc39d5730e09933f76acd44ec0839be0764496228b7fd7bd8d6839af171039a4ee6d2236f5926f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Silviu Paragina <silviu.paragina@mready.net>
+
+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,60 @@
+# instrumented_tests plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-instrumented_tests)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-instrumented_tests`, add it to your project by running:
+
+```bash
+fastlane add_plugin instrumented_tests
+```
+
+## About instrumented_tests
+
+Run instrumented tests for android. 
+
+This basically creates and boots an emulator before running an gradle commands so that you can run instrumented tests against that emulator. After the gradle command is executed, the avd gets shut down and deleted. This is really helpful on CI services, keeping them clean and always having a fresh avd for testing.
+
+## 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`. 
+
+Creates and boots avd device before running gradle command.
+
+```ruby
+instrumented_tests(
+  avd_name: "Nexus_10",
+  target_id: "2",
+  task: "cleanTest createMockDebugCoverageReport --continue",
+)
+```
+
+## 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/instrumented_tests.rb

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

data/lib/fastlane/plugin/instrumented_tests/actions/instrumented_tests_action.rb

@@ -0,0 +1,153 @@
+require 'open3'
+require 'tempfile'
+
+module Fastlane
+  module Actions
+    module SharedValues
+    end
+
+    class InstrumentedTestsAction < Action
+      def self.run(params)
+        gradle = Helper::GradleHelper.new(gradle_path: Dir["./gradlew"].last)
+        file = Tempfile.new('emulator_output')
+
+        # Set up params
+        avd_name = "--name \"#{params[:avd_name]}\""
+        target_id = "--target #{params[:target_id]}"
+        avd_options = params[:avd_options] unless params[:avd_options].nil?
+        avd_abi = "--abi #{params[:avd_abi]}" unless params[:avd_abi].nil?
+        avd_tag = "--tag #{params[:avd_tag]}" unless params[:avd_tag].nil?
+        create_avd = ["#{params[:sdk_path]}/tools/android", "create avd", avd_name, target_id, avd_abi, avd_tag, avd_options].join(" ")
+        start_avd = ["#{params[:sdk_path]}/tools/emulator", "-avd #{params[:avd_name]}", "-gpu on -no-boot-anim &>#{file.path} &"]
+        devices = `#{params[:sdk_path]}/tools/android list avd`.chomp
+
+        # Delete avd if one already exists for clean state.
+        unless devices.match(/#{params[:avd_name]}/).nil?
+          Action.sh("#{params[:sdk_path]}/tools/android delete avd -n #{params[:avd_name]}")
+        end
+
+        Helper.log.info("Creating AVD...".yellow)
+        Action.sh(create_avd)
+
+        Helper.log.info("Starting AVD....".yellow)
+        begin
+          Action.sh(start_avd)
+
+          # Wait for device to be fully
+          boot_emulator
+
+          Helper.log.info("Executing gradle command...".green)
+          begin
+            gradle.trigger(task: params[:task], flags: params[:flags], serial: nil)
+          ensure
+            stop_emulator
+          end
+        ensure
+          file.close
+          file.unlink
+        end
+      end
+
+      def self.boot_emulator
+        Helper.log.info("Waiting for emulator to finish booting.....".yellow)
+        loop do
+          stdout, _stdeerr, _status = Open3.capture3("#{params[:sdk_path]}/platform-tools/adb shell getprop sys.boot_completed")
+
+          if stdout.strip == "1"
+            Helper.log.info("Emulator Booted!".green)
+            break
+          end
+        end
+      end
+
+      def self.stop_emulator
+        adb = Helper::AdbHelper.new(adb_path: "#{params[:sdk_path]}/platform-tools/adb")
+        temp = File.open(file.path).read
+        port = temp.match(/console on port (\d+),/)
+
+        if port
+          port = port[1]
+        else
+          Helper.log.info("Could not find emulator port number, using default port.".yellow)
+          port = "5554"
+        end
+
+        Helper.log.info("Shutting down emulator...".green)
+        adb.trigger(command: "emu kill", serial: "emulator-#{port}")
+
+        Helper.log.info("Deleting emulator....".green)
+        Action.sh("#{params[:sdk_path]}/tools/android delete avd -n #{params[:avd_name]}")
+      end
+
+      def self.description
+        "Run android instrumented tests via a gradle command againts a newly created avd"
+      end
+
+      def self.details
+        [
+          "Instrumented tests need a emulator or real device to execute against.",
+          "This action will check for a specific avd and created, wait for full boot,",
+          "run gradle command, then deleted that avd on each run."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :avd_name,
+                                       env_name: "AVD_NAME",
+                                       description: "Name of the avd to be created",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :target_id,
+                                       env_name: "TARGET_ID",
+                                       description: "Target id of the avd to be created, get list of installed target by running command 'android list targets'",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :avd_options,
+                                       env_name: "AVD_OPTIONS",
+                                       description: "Other avd options in the form of a <option>=<value> list, i.e \"--scale 96dpi --dpi-device 160\"",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :avd_abi,
+                                       env_name: "AVD_ABI",
+                                       description: "The ABI to use for the AVD. The default is to auto-select the ABI if the platform has only one ABI for its system images",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :avd_tag,
+                                       env_name: "AVD_TAG",
+                                       description: "The sys-img tag to use for the AVD. The default is to auto-select if the platform has only one tag for its system images",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :sdk_path,
+                                       env_name: "SDK_PATH",
+                                       description: "The path to your android sdk directory",
+                                       is_string: true,
+                                       default_value: ENV['SDK_PATH'],
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :flags,
+                                       env_name: "GRADLE_FLAGS",
+                                       description: "All parameter flags you want to pass to the gradle command, e.g. `--exitcode --xml file.xml`",
+                                       optional: true,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :task,
+                                       env_name: "GRADLE_TASK",
+                                       description: "The gradle task you want to execute",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.return_value
+        "The output from the test execution."
+      end
+
+      def self.authors
+        ["joshrlesch"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/instrumented_tests/helper/instrumented_tests_helper.rb

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

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

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

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-instrumented_tests
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Silviu Paragina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-04 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.96.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.96.0
+description: 
+email: silviu.paragina@mready.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fastlane/plugin/instrumented_tests/actions/instrumented_tests_action.rb
+- lib/fastlane/plugin/instrumented_tests/helper/instrumented_tests_helper.rb
+- lib/fastlane/plugin/instrumented_tests/version.rb
+- lib/fastlane/plugin/instrumented_tests.rb
+- README.md
+- LICENSE
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: New action to run instrumented tests for android. This basically creates
+  and boots an emulator before running an gradle commands so that you can run instrumented
+  tests against that emulator. After the gradle command is executed, the avd gets
+  shut down and deleted. This is really helpful on CI services, keeping them clean
+  and always having a fresh avd for testing.
+test_files: []