Add new commands in appium 2.0

Add new commands in
Appium 2.0
Appium Conference 2021
Kazuaki Matsuo (HeadSpin)

About Me
1. Kazuaki Matsuo
○ GitHub: https://github.com/KazuCocoa
2. HeadSpin as a senior software engineer
○ ex-Cookpad, ACCESS as Test/QA/Automation role
3. 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

1. About Appium commands
2. Appium commands in fake driver
3. Calls an Appium command via curl
4. Add commands in a client (Ruby as an example)
Topics

Communication route
Appium
Client
Appium
server
The device under test

Communication route
Appium
Client
Appium
server
WebDriver Protocol
(HTTP/S)
HTTP/S
adb/xcrun etc

Appium Commands
Appium
Client
Appium
server
driver.find_element :accessibility_id, “happy testing”
(A Ruby command to find an element)

Appium Commands
Appium
Client
Appium
server
POST: /session/:sessionId/element
{"using":"accessibility id","value":"happy testing"}

A fake driver
https://github.com/appium/appium/blob/2.0/packages/fake-driver
Test driver in Appium project.
{
"deviceName": "fake device",
"automationName": "fake",
"platformName": "fake",
"app": "/Users/kazu/appiumconf/fakedriver.txt"
}

In the fake driver
static newMethodMap = {
'/session/:sessionId/fakedriver': {
GET: {command: 'getFakeThing'},
POST: {command: 'setFakeThing', payloadParams: {required: ['thing']}}
},
'/session/:sessionId/fakedriverargs': {
GET: {command: 'getFakeDriverArgs'}
},
};
static fakeRoute (req, res) {
res.send(JSON.stringify({fakedriver: 'fakeResponse'}));
}
static async updateServer (expressApp/*, httpServer*/) {
expressApp.all('/fakedriver', FakeDriver.fakeRoute);
}
https://github.com/appium/appium/blob/2.0/packages/fake-driver/lib/driver.js

In the fake driver
},
},
};
}
}
GET: /session/:sessionId/fakedriver
POST: /session/:sessionId/fakedriver + body

In the fake driver
},
},
};
}
}
GET: /session/:sessionId/fakedriver
Any methods: /fakedriver

In the fake driver
},
},
};
}
}
GET: /session/<session id>/fakedriver
POST: /session/<session id>/fakedriver + body

Three commands to use in this session
- GET: /session/:sessionId/fakedriver
- POST: /session/:sessionId/fakedriver + request body
- Payload requires “things” attribute
- Any methods: /fakedriver

Demo with simple “curl” command
- GET: /session/:sessionId/fakedriver
- POST: /session/:sessionId/fakedriver + request body
- Payload requires “things” attribute
- Any methods: /fakedriver
curl -X GET http://localhost:4723/fakedriver
#=> {"fakedriver":"fakeResponse"}

1. Launch an appium server with a fake driver
2. Start a session
3. Add methods
Call a few endpoints in Ruby with Demo

1. Launch an appium server with a fake driver
2. Start a session
3. Add methods
Call a few endpoints in Ruby with Demo
appium --drivers=fake

Start a session
require 'appium_lib_core'
caps = {
deviceName: "fake device",
automationName: "fake",
platformName: "fake",
app: "/Users/kazu/appiumconf/fakedriver.txt"
}
core = Appium::Core.for url: 'http://localhost:4723',
capabilities: caps
driver = core.start_driver

Check a regular command response
- driver.page_source
- It returns the file body of the “app”

Command 1: GET without session id
},
},
};
}
}

Command 1: GET without session id
driver.add_command(
method: :get,
url: '/fakedriver',
name: :get_fakedriver
)
driver.get_fakedriver
#=> {"fakedriver":"fakeResponse"}

Command 2: GET with session id
},
},
};
}
}
GET: /session/<session id>/fakedriver

Command 2: GET with session id
driver.add_command(
method: :get,
url: 'session/:session_id/fakedriver',
name: :get_fakedriver2
)
driver.get_fakedriver2
#=> nil

Command 2: POST with request body
},
},
};
}
}

Command 2: POST with request body
driver.add_command(
method: :post,
name: :post_fakedriver
) do
def post_fakedriver(thing)
execute(:post_fakedriver, {}, { thing: thing })
end
end
driver.post_fakedriver 'happy appium' #=> nil

Command 2: POST with wrong request body
},
},
};
}
}

Command 2: POST with wrong request body
driver.add_command(
method: :post,
name: :post_fakedriver2
) do
def post_fakedriver2(thing)
execute(:post_fakedriver2, {}, { wrong_value: thing })
end
end
driver.post_fakedriver2 'happy appium' #=> nil

Get back to the fake driver again
},
},
};
}
}

1. Appium command behind a client
2. Appium 2.0 allows you to add new commands in
drivers/plugins
3. Client also can add them, or you also can define HTTP
request you want
Summary

As a reference
Other clients
- WebdriverIO
- https://webdriver.io/docs/api/browser/addCommand/
- Appium Java client
- https://github.com/appium/java-client/blob/bcd6881efe53713ea339a3e606dc0bc0
04969908/src/test/java/io/appium/java_client/ios/IOSDriverTest.java#L47-L68
- Appium Python client
- https://github.com/appium/python-client/blob/f8d3a38639557081700a273c5dcc64
1e42112aba/appium/webdriver/webdriver.py#L117
etc
You also can define them using vanilla HTTP client.

Add new commands in appium 2.0

More Related Content

What's hot (20)

Similar to Add new commands in appium 2.0 (20)

More from Kazuaki Matsuo (20)

Recently uploaded (20)

Add new commands in appium 2.0