Kobiton plugin helps users to run automation test on Kobiton devices, remotely and automatically from XL Release platform. Kobiton plugin can apply for uses:

• Users indie using Kobiton services
• User hosting a private server
• On-Premises

For the current version, Kobiton plugin just supports executing test through tasks in a Release job in XL Release.

From the plugin, we provided features to execute automation test easier:

• Get list available devices: Filter and fetch data of devices that users can access in Kobiton
• Request execute test: Request and execute test on provided devices data and test script in Kobiton system
• Wait for execution: Fetch result and log from the requested test

Kobiton Username and API key are required for authenticating with Kobiton System to executing a test.

If you don't have a Kobiton account, visit https://portal.kobiton.com/register to create one.

To get your Kobiton Username and API Key, please follow instructions at IV. Configure Test Script for Kobiton section on our blog

For executing a test, Kobiton plugin requires test script to be stored in git repository and Kobiton must have permission to access and clone the script to local for executing.

Note: All of your private information such as test scripts, ssh key, etc. will be deleted after processing is completed.

• For user using test script in public repository: Use the HTTP link directly to the git input field (we will show in the `request executing test task)

• For user using test script in private repository: Kobiton requires a ssh key (private key) to authenticate with git.

  • The ssh key must be authenticated with git repository and it should not contain passphrase.

  If you do not know how to authenticate the key with git, please follow the guide from Github create SSH key instruction and Github adding the key to account instruction

1. In the XL Release home page, go to Settings > Shared configuration > Kobiton: Server >

2. Fill all information to identify Kobiton servers

   Section	Description
   Title	Enter the name of your Kobiton Server Example: Kobiton
   Kobiton Username	Enter your Kobiton username
   Kobiton API Key	Enter API key of your Kobiton account
   Kobiton API Url	Enter the URL of Kobiton API: https://api.kobiton.com For on-premise or private hosting user, you can enter your host URL here.
   Executor Server Url	Enter the URL connect to Executor Server: https://executor.kobiton.com For on-premise or private hosting user, you can enter your host URL here.

When all fills are filled as above, you can test the connection with Kobiton Server by pressing the button.

3. Only if it notices Kobiton Server is available as below, which means all your information is correct and XL Release can connect to Kobiton. Please press Save button to apply the config.

   

Note:

• When an error is shown that cannot connect to API or Executor server, please make sure your information is correct and you are available to access the internet.

• If you make everything right but cannot access to Kobiton Server, please contact us for more detail.

• From home page choose > Release. Choose any release that you want to run Kobiton plugin, if you haven't had a release yet, choose > New release to create one.

• In each release we will see the phase widget in the release. Choose > Add task > Manual > Kobiton and you will see all the Kobiton plugin there.

  

The full detail of the plugin will show in the below sessions. Kobiton Plugin now supports 3 tasks on XL Release environment:

This task will help to fetch all available (online) devices data that the user can access. The data can pass as the environment for other tasks to be consumed.

• Input properties:

For more details of Custom Params, we can select specific devices properties such as device name, device model, device udid, etc. Take an example, we want to select only Galaxy S8 devices, we can specify in the field as:

• Output properties: If you want to use the output from this task to the next task, you need to create a variable to save the list of devices.

Note: please choose some specific devices by using custom params. Because the next task will pick all devices in this output to execute test one by one.

Step	Image
Type in textbox the variable's name you want to save
Click at the row below ${} Create a new varaible of type key-value map to create varaible
Result

When properties are filled, update your task's information as you need: start date, due date, assignees, watchers, etc.

Finally, you just close the task window, it will autosave.

This is the task used for requesting Kobiton server to execute your test.

• List available devices: place the output of task 1 (if exist) to this section.

  Step	Description
  Click the button
  Input exactly variable you created in task 1 in the textbox
  Result

• Input properties:

The commands YAML syntax should be:

commands:
- The first command
- The second command
- ...

Note: The location for commands will be at the test script folder that just added, so you do not need to perform command "cd ${your-test-script}" to go to your test script

Example:

• Output properties: You will need to store the output in a variable for the use of getting test execution result and logs.

Step	Image
Type in textbox the variable's name you want to save
Click at the row below ${} Create a new varaible of type key-value map to create varaible
Result

This task will collect the result from "Request Execute test" task to let you know the automated test is pass or fail.

• Input properties

• Output properties

The result of the test execution:

Assume the environment is Mac OS

• Install Homebrew

  • Install Jython:

    brew install jython

  • Install Gradle:

    brew install gradle

• Install JDK 1.7

  gradle clean build

• Copy the jar file from build/libs into your plugins folder.

• Kobiton
• Kobiton docs
• Kobiton API docs

If you have any issue or further information, follow steps below to request Kobiton for support.

1. Go to https://portal.kobiton.com
2. In the navigation bar at the top of the page, click Support.

3. Fill in all necessary information and click Submit.