Mango - Fastlane plugin

A fastlane plugin that runs Android tasks on a specified Docker image. Can be used for orchestrating android tasks on a CI system.

Running Android tests, especially Espresso on a continuous integration environment like Jenkins can be a hassle. You need to boot, manage and destroy an Android Virtual Device (AVD) during the test run. This is why we, the mobile releases team at XING, built this plugin. It spins up a specified Docker image and runs a given task on it.

Another requirement we had was to run on a clean environment, which is why Mango also helps us to run our unit test and more. For an example check out the example Fastfile

In order to use this plugin you will need to to have Docker installed on the machine you are using. Documentation on how to set it up properly on a Linux (ubuntu) machine can be found here.

If you need an Android Virtual Device (AVD) to run your tests (for example Espresso, Calabash or Appium), it's necessary to check that your CPU supports kvm virtualisation. We already experienced that it doesn't fully work on macOS and are using Linux for that.

This project is a fastlane plugin. To get started with fastlane-plugin-mango, add it to your project by running:

fastlane add_plugin mango

After installing this plugin you have access to one additional action (mango) in your Fastfile.

So a lane in your Fastfile could look similar to this for Espresso tests:

desc "Run espresso tests on docker images"
  lane :Espresso_Tests do
     run_dockerized_task(
       container_name: "espresso_container",
       port_factor: options[:port_factor],
       docker_image: "joesss/mango-docker:latest",
       container_timeout: 120,
       android_task: "./gradlew connectedAndroidTest",
       post_actions: "adb logcat -d > logcat.txt",
       pull_latest_image: true          
     )
   end

or to this for unit tests or other gradle tasks(some of the variables are optional):

desc "Run unit tests on docker images"
  lane :example do
    run_dockerized_task(
      container_name: "emulator_#{options[:port_factor]}",
      port_factor: options[:port_factor],
      docker_image: 'joesss/mango-base:latest',
      android_task: './gradlew testDebug',
      post_actions: 'adb logcat -d > logcat.txt',
      bundle_install: true,
      core_amount: '8',
      workspace_dir: '/root/tests/espresso-tests',
      docker_registry_login: "docker login -u='USER' -p='PASS' some.docker.com",
      pull_latest_image: true,
      pre_action: 'echo $GIT_BRANCH > /root/.branch',
      vnc_enabled: false,
      environment_variables: options[:environment_variables] ? options[:environment_variables].split(' ') : ''
    )
  end

Now you can call this new lane by calling bundle exec fastlane Espresso_Tests.

The Plugin will start up the given docker_image, execute the given android_task and afterwards execute the post_actions.

The mango action has plenty of options to configure it.

🎁 Bug reports and pull requests for new features are most welcome!

👷🏼 We are looking forward to your pull request, we'd love to help!

You can help by doing any of the following:

• Reviewing pull requests
• Bringing ideas for new features
• Answering questions on issues
• Improving documentation

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

For any other issues and feedback about this plugin, please submit it to this repository.

If you have trouble using plugins, check out the Plugins Troubleshooting guide.

The fastlane plugin is available as open source under the terms of the MIT License.

Check out the example Fastfile to see how to use this plugin. Try it by cloning the repo, running fastlane install_plugins and bundle exec fastlane test.

To run both the tests and code style validation, run

rake

To automatically fix many of the styling issues, use

rubocop -a

For more information about how the fastlane plugin system works, check out the Plugins documentation.

fastlane is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out fastlane.tools.