@springworks/android-plankan v9.6.0

ANDROID PLANKAN

A frame work for automated android click tests

See the #plankan channel at Slack or the Splunk Dashboard for more info.

Table of contents

• Dependencies
• Installation
• Commands
• For Devs
  • Set up
  • Run tests
  • Deployment
• Upcoming features

Dependencies

• ADB (Android Debug Bridge, a part of the Android SDK) how to install
• Nodejs I think we usually recommend installing it via nvm, ask a team-mate
• appium npm i -g appium

Installation

npm i -g @springworks/android-plankan

Run with plankan

Commands

To run a single script

plankan --script login

For Devs

If you wan't to add code to the project or edit scripts etc.

The actual test scripts that performs clicks in the apps is in the scripts folder: /src/appium/scripts/

Set up

Use git-crypt to decrypt the encrypted files in the config folder. Ask a team mate if you haven't done it before. Then install the node project with

npm i

Run tests

This chapter describes how to test the actual plankan frame work that runs on the raspberry pies(including a lot of things as downloading the apps from github, posting to slack and splunk, reinstalling the apps etc). The click tests are included in this tests and can also be run separatley.

Run all Unit tests

Testing the code without doing any real calls to splunk, slack, github, connected devices etc.

npm run test

Run all Acceptance tests

Testing the code with real calls to splunk, slack, github, connected devices etc. Check the slack channel #plankan-acc-test

npm run acceptance-test

Run the plank tool in acceptance test environment

Will run the plankan tool, but post slack and splunk messages to the acceptance channels instead of the real ones.

slack: #plankan-acc-test in splunk

Splunk Dashboard

npm run build;node ./build/cli/plankan.js --config ./config/acceptance.json

Deployment

Deploy with np and update the Raspberry Pi with the Slack command plankbot upgrade in the #plankan Slack channel. Install np with

npm i -g np

Upcoming features

Trello board