fastlane-plugin-automated_test_emulator_run 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27d7e221e465ab83b1e9991ca29fcd58c8e27f9c
+  data.tar.gz: 697384557f846ccd443ee9532c016a75cf34878a
+SHA512:
+  metadata.gz: c4faef2ed69687f843726f91b83d617d10ace7e931549a95e6f23d9f9029d864883cb2386f75ce49c303f63634eea284d5f336bfac5a54b101073bbd3ad8b583
+  data.tar.gz: 50b66be6a3383eb8344b0af1b56059c786d7ee6f4801c7de25054220118c43f48f994284cdfdadd7932460ad5513e3ef9b50329b064122df2def431122c59561

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kamil Krzyk <krzyk.kamil@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,52 @@
+# automated_test_emulator_run plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-automated_test_emulator_run)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-automated_test_emulator_run`, add it to your project by running:
+
+```bash
+fastlane add_plugin automated_test_emulator_run
+```
+
+## About automated_test_emulator_run
+
+Allows to wrap gradle task or shell command that runs integrated tests that prepare and starts single AVD before test run. After tests are finished, emulator is killed and deleted.
+
+**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/automated_test_emulator_run.rb

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

data/lib/fastlane/plugin/automated_test_emulator_run/actions/automated_test_emulator_run_action.rb

@@ -0,0 +1,206 @@
+require 'open3'
+require 'tempfile'
+
+module Fastlane
+  module Actions
+     module SharedValues
+     end
+
+    class AutomatedTestEmulatorRunAction < Action
+      def self.run(params)
+        gradle = Helper::GradleHelper.new(gradle_path: Dir["./gradlew"].last)
+      
+        Action.sh("clear")
+
+        UI.message("The automated_test_emulator_run plugin is working!")
+
+        # Create output file
+        file = Tempfile.new('emulator_output')
+        UI.message(["Created temp file for emulator output", file.path].join(" ").yellow)
+
+        # Find unused port
+        port = getUnusedTcpPort
+        UI.message(["Open port found", port].join(" ").yellow)
+
+        # Set up params 
+        UI.message("Preparing parameters...".yellow)
+        avd_name = "--name \"#{params[:avd_name]}\""
+        target_id = "--target \"#{params[:target_id]}\""
+        avd_abi = "--abi #{params[:avd_abi]}" unless params[:avd_abi].nil?
+        avd_tag = "--tag #{params[:avd_tag]}" unless params[:avd_tag].nil?
+        avd_create_options = params[:avd_create_options] unless params[:avd_create_options].nil?
+        avd_initdata = "-wipe-data -initdata #{params[:initdata_snapshot_path]}" unless params[:initdata_snapshot_path].nil?
+        avd_port = ["-port", port].join(" ")
+        sdkRoot = getSdkRoot(params)
+
+        # Set up commands
+        UI.message("Setting up run commands".yellow)
+        create_avd_command = [sdkRoot + "/tools/android", "create avd", avd_name, target_id, avd_abi, avd_tag, avd_create_options].join(" ")
+        get_devices_command = sdkRoot + "/tools/android list avd".chomp
+        start_avd_command = [sdkRoot + "/tools/emulator", avd_port, "-avd #{params[:avd_name]}", avd_initdata, "-gpu on -no-boot-anim &>#{file.path} &"].join(" ")
+        shell_command = "#{params[:shell_command]}" unless params[:shell_command].nil?
+        gradle_task = "#{params[:gradle_task]}" unless params[:gradle_task].nil?
+
+        # Get Available Devices
+        UI.message("Getting avaliable devices".yellow)
+        devices = Action.sh(get_devices_command)
+
+        # Delete avd if one already exists for clean state.
+        unless devices.match(/#{params[:avd_name]}/).nil?
+           UI.message("Deleting existing AVD to create fresh one".yellow)
+           Action.sh(sdkRoot + "/tools/android delete avd -n #{params[:avd_name]}")
+        end
+
+        # Creating AVD
+        UI.message("Creating AVD...".yellow)
+        Action.sh(create_avd_command)
+
+        # Starting AVD
+        UI.message("Starting AVD....".yellow)
+        begin
+          Action.sh(start_avd_command)
+          waitFor_emulatorBoot(sdkRoot, port)
+
+          UI.message("Starting tests".green)
+          begin
+            unless shell_command.nil?
+              UI.message("Using shell command".green)
+              Action.sh(shell_command)
+            end
+
+            unless gradle_task.nil?
+              UI.message("Using gradle task".green)
+              gradle.trigger(task: params[:gradle_task], flags: params[:gradle_flags], serial: nil)
+            end
+          ensure 
+            waitFor_emulatorStop(sdkRoot, port, params, file)
+          end
+        ensure
+          file.close
+          file.unlink
+        end
+      end
+
+      def self.getUnusedTcpPort 
+        min_port = 5556
+        max_port = 5586
+
+        port = min_port
+        while port < max_port  do
+           unless system(["lsof -i:", port].join(""), out: '/dev/null')
+              break
+           end
+           port +=1
+        end
+        return port
+      end
+
+      def self.getSdkRoot(params)
+        dirs = "#{params[:sdk_path]}".split(':')
+        sdkRoot = ""
+        dirs.each do |dir|
+          if dir.include? "sdk"
+              sdkEndPos = dir.index("sdk") + "sdk".length
+              sdkRoot = dir.slice(0, sdkEndPos)
+              break
+          end
+        end
+        return sdkRoot
+      end
+
+      def self.waitFor_emulatorBoot(sdkRoot, port)
+        UI.message("Waiting for emulator to finish booting.....".yellow)
+        loop do
+          stdout, _stdeerr, _status = Open3.capture3(sdkRoot + ["/platform-tools/adb -s emulator-", port].join("") + " shell getprop sys.boot_completed")
+
+          if stdout.strip == "1"
+            break
+          end
+        end
+        UI.message("Emulator Booted!".green)
+      end
+
+      def self.waitFor_emulatorStop(sdkRoot, port, params, file)
+        adb = Helper::AdbHelper.new(adb_path: sdkRoot + "/platform-tools/adb")
+        temp = File.open(file.path).read
+
+        UI.message("Shutting down emulator...".green)
+        adb.trigger(command: "emu kill", serial: "emulator-#{port}")
+
+        UI.message("Deleting emulator....".green)
+        Action.sh(sdkRoot + "/tools/android delete avd -n #{params[:avd_name]}")
+      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_create_options,
+                                     env_name: "AVD_CREATE_OPTIONS",
+                                     description: "Other avd options, used during avd creation, 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: :initdata_snapshot_path,
+                                     env_name: "INIT_DATA_PATH",
+                                     description: "The path to userdata-qemu which will be used to initialize AVD status",
+                                     is_string: true,
+                                     optional: true),
+          FastlaneCore::ConfigItem.new(key: :sdk_path,
+                                     env_name: "SDK_PATH",
+                                     description: "The path to your android sdk directory (root)",
+                                     is_string: true,
+                                     default_value: ENV['PATH'],
+                                     optional: true),
+          FastlaneCore::ConfigItem.new(key: :shell_command,
+                                     env_name: "SHELL_COMMAND",
+                                     description: "The shell command you want to execute",
+                                     is_string: true,
+                                     conflicting_options: [:gradle_task], 
+                                     optional: true),
+          FastlaneCore::ConfigItem.new(key: :gradle_task,
+                                     env_name: "GRADLE_TASK",
+                                     description: "The gradle task you want to execute",
+                                     is_string: true,
+                                     conflicting_options: [:shell_command],
+                                     optional: true),
+          FastlaneCore::ConfigItem.new(key: :gradle_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,
+                                     conflicting_options: [:shell_command],
+                                     is_string: true),
+        ]
+      end
+
+      def self.description
+        "Starts single emulator before running tests."
+      end
+
+      def self.authors
+        ["joshrlesch, modified by F1sherKK"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/automated_test_emulator_run/helper/automated_test_emulator_run_helper.rb

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

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

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

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-automated_test_emulator_run
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kamil Krzyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-28 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.98.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.98.0
+description: 
+email: krzyk.kamil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/automated_test_emulator_run.rb
+- lib/fastlane/plugin/automated_test_emulator_run/actions/automated_test_emulator_run_action.rb
+- lib/fastlane/plugin/automated_test_emulator_run/helper/automated_test_emulator_run_helper.rb
+- lib/fastlane/plugin/automated_test_emulator_run/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.5.1
+signing_key: 
+specification_version: 4
+summary: Allows to wrap gradle task or shell command that runs integrated tests that
+  prepare and starts single AVD before test run. After tests are finished, emulator
+  is killed and deleted.
+test_files: []