Manage appium dependencies with -appium-home in appium 2.0

Manage appium dependencies
with
--appium-home in Appium 2.0
Appium Conference 2021
Kazuaki Matsuo (HeadSpin)

About Me
● Kazuaki Matsuo
○ GitHub: https://github.com/KazuCocoa
● HeadSpin as a senior software engineer
○ ex-Cookpad, ACCESS as Test/QA/Automation role
● Maintained Appium project and around
○ Appium server in the appium repository
○ Clients (e.g. Ruby, Python, Dart etc)
○ Appium-flutter-driver in appium-userland organization

Topics
1. Installing drivers/plugins via appium 2.0 commands
2. --appium-home argument
3. Customize the place to install, make it portable
4. --plugins and --drivers arguments

Appium driver/plugin install command
- Appium 2.0 allows you to install multiple drivers/plugins
- E.g.
- appium driver install xcuitest
- appium driver install uiautomator2
- appium plugin install images
- appium plugin install ——source=npm appium-fake-driver
- Demo
- Try to install xcuitest

When appium 2.0 runs (no arguments)
[Appium] Welcome to Appium v2.0.0-beta.13 (REV 61661f100e22a46a7e368cfb6a7f7fb815a659ed)
[Appium] Non-default server args:
[Appium] tmpDir: /var/folders/y6/524wp8fx0xj5q1rf6fktjrb00000gn/T
[Appium] Attempting to load driver xcuitest...
[Appium] Attempting to load driver uiautomator2...
[Appium] Appium REST http interface listener started on 0.0.0.0:4723
[Appium] Available drivers:
[Appium] - xcuitest@3.53.1 (automationName 'XCUITest')
[Appium] - uiautomator2@1.67.0 (automationName 'UiAutomator2')
[Appium] Available plugins:
[Appium] - fake@0.2.0
[Appium] - images@1.2.1
[Appium] No plugins activated. Use the --plugins flag with names of plugins to activate

Loading drivers...

Show available drivers/plugins

In ~/.appium
- By default
- ~/.appium (macOS, Linux)
~/.appium/
/extensions.yaml
/@appium/images-plugin
/fake-plugin
/appium-uiautomator2-driver
/appium-xcuitest-driver

drivers:
xcuitest:
automationName: XCUITest
platformNames:
- iOS
mainClass: XCUITestDriver
pkgName: appium-xcuitest-driver
version: 3.53.1
installPath: appium-xcuitest-driver
installType: npm
installSpec: xcuitest
...
plugins:
images:
mainClass: ImageElementPlugin
pkgName: "@appium/images-plugin"
version: 1.2.2
installPath: "@appium/images-plugin"
installType: npm
installSpec: images
...
schemaRev: 2
What is extensions.yaml?

% appium --appium-home=/Users/kazuaki/appiumconf/session1
Yes, Appium has an argument to customize the direction.
Can they move to other places…?

Yes, Appium has an argument to customize the direction.
Can they move to other places…?
[Appium] Welcome to Appium v2.0.0-beta.13
[Appium] No drivers have been installed. Use the "appium driver" command to
install the one(s) you want to use.
[Appium] No plugins have been installed. Use the "appium plugin" command to
install the one(s) you want to use.

% appium driver install xcuitest --appium-home=/Users/kazuaki/appiumconf/session1
Attempting to find and install driver 'xcuitest'
✔ Installing 'xcuitest' using NPM install spec 'appium-xcuitest-driver'
Driver xcuitest@3.53.1 successfully installed
- automationName: XCUITest
- platformNames: ["iOS"]
When you install a new driver with the --appium-home
argument…
Install a new driver

When you install a new driver with the --appium-home
argument…
And run the command again...
[Appium] No plugins have been installed. Use the "appium plugin" command to install the
one(s) you want to use.

Take a look at the --appium-home internal
ls /Users/kazuaki/appiumconf/session1
appium-xcuitest-driver extensions.yaml

drivers:
xcuitest:
automationName: XCUITest
platformNames:
- iOS
mainClass: XCUITestDriver
pkgName: appium-xcuitest-driver
version: 3.53.1
installPath: appium-xcuitest-driver
installType: npm
installSpec: xcuitest
plugins: {}
schemaRev: 2
Inside of extensions.yaml

% mkdir /Users/kazuaki/appiumconf/session1-1
% cp -r ls /Users/kazuaki/appiumconf/session1 /Users/kazuaki/appiumconf/session1-1
Then, you can load the new place with --appium-home ...
Copy the --appium-home in another place...

% appium --appium-home=/Users/kazuaki/appiumconf/session1-1

% appium --appium-home=/Users/kazuaki/appiumconf/session1-1
[Appium] No plugins have been installed. Use the "appium plugin" command to install the
one(s) you want to use.

● Share particular drivers/plugins in other hosts
○ Should care the installation platform like macOS/Linux/Windows
○ Can share the home onto a host which has limited network access
● Manage multiple versions on a host
○ (show an example of install xcuitest v 3.50.1)
A few beneﬁts

Appium loads available drivers by default
% appium

% appium --drivers=xcuitest
--drivers=xcuitest to load only the driver

--drivers=xcuitest to load only the driver
% appium --drivers=xcuitest
[Appium] drivers: {
[Appium] 0: xcuitest
[Appium] }

% appium --drivers=xcuitest --plugins=images
With both --drivers and --plugins

With both --drivers and --plugins
% appium --drivers=xcuitest --plugins=images
[Appium] Attempting to load plugin images...
[Appium] drivers: {
[Appium] 0: xcuitest
[Appium] }
[Appium] plugins: {
[Appium] 0: images
[Appium] }
[Appium] - images@1.2.2 (ACTIVE)

1. Where appium installs drivers/plugins by default
2. --appium-home to customize the installation direction
3. The home structure
4. --drivers and --plugins arguments
Summary

Manage appium dependencies with -appium-home in appium 2.0

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to Manage appium dependencies with -appium-home in appium 2.0

Similar to Manage appium dependencies with -appium-home in appium 2.0 (20)

More from Kazuaki Matsuo

More from Kazuaki Matsuo (20)

Recently uploaded

Recently uploaded (20)

Manage appium dependencies with -appium-home in appium 2.0