add appium prefix in create session and fix find_elements for W3C #196

KazuCocoa · 2017-12-30T16:51:03Z

What do I do in this PR

Add appium: prefix for capabilities except for items defined by W3C
Add forceMjsonwp capability to force request format MJSONWP format.
- By default, the client send {'firstMatch': [{}], 'alwaysMatch': always_match} style
- We can remove this process after finishing migrating from MJSONWP to W3C completely.
Change some logic from WebDriver's w3c spec
- find_element/s related methos since in W3C, id is convert to css selector style
- https://github.com/appium/python-client/pull/196/files#diff-30b129e415d9d5342e47b17ebdea5536R194
Change some test cases to work the latest appium server(1.7.2)

Run with W3C

[debug] [MJSONWP] Responding to client with driver.getSize() result: {"width":93,"height":33}
[HTTP] <-- GET /wd/hub/session/a92ddc72-1b53-47b1-a34b-0a55bdca5ca4/element/4680CB2D-24F2-4CC7-844D-917A6D607AE4/size 200 206 ms - 85
[HTTP] --> POST /wd/hub/session {"capabilities":{"firstMatch":[{}],"alwaysMatch":{"appium:deviceName":"iPhone 6s","platformName":"iOS","appium:platformVersion":"10.3","appium:app":"/Users/kazuaki/GitHub/python-client/test/apps/UICatalog.app.zip","appium:automationName":"XCUITest","appium:allowTouchIdEnroll":true}},"desiredCapabilities":{"deviceName":"iPhone 6s","platformName":"iOS","platformVersion":"10.3","app":"/Users/kazuaki/GitHub/python-client/test/apps/UICatalog.app.zip","automationName":"XCUITest","allowTouchIdEnroll":true}}
[debug] [MJSONWP] Calling AppiumDriver.createSession() with args: [{"deviceName":"iPhone 6s","platformName":"iOS","platformVersion":"10.3","app":"/Users/kazuaki/GitHub/python-client/test/apps/UICatalog.app.zip","automationName":"XCUITest","allowTouchIdEnroll":true},null,{"firstMatch":[{}],"alwaysMatch":{"appium:deviceName":"iPhone 6s","platformName":"iOS","appium:platformVersion":"10.3","appium:app":"/Users/kazuaki/GitHub/python-client/test/apps/UICatalog.app.zip","appium:automationName":"XCUITest","appium:allowTouchIdEnroll":true}}]
[debug] [BaseDriver] Event 'newSessionRequested' logged at 1515072504260 (22:28:24 GMT+0900 (JST))
[Appium] Creating new XCUITestDriver (v2.63.0) session
[Appium] Capabilities:
[Appium]   deviceName: iPhone 6s
[Appium]   platformName: iOS
[Appium]   platformVersion: 10.3
[Appium]   app: /Users/kazuaki/GitHub/python-client/test/apps/UICatalog.app.zip
[Appium]   automationName: XCUITest
[Appium]   allowTouchIdEnroll: true
[BaseDriver] The following capabilities were provided, but are not recognized by appium: allowTouchIdEnroll.
[BaseDriver] Session created with session id: 422d1dd0-5ff8-4778-b0db-2d19e4d6a44c

set 'forceMjsonwp': True

[HTTP] <-- DELETE /wd/hub/session/7d0e0141-8bff-48ea-99cd-e8bae0f3362d 200 279 ms - 76
[HTTP] --> POST /wd/hub/session {"desiredCapabilities":{"deviceName":"iPhone 6s","platformName":"iOS","platformVersion":"10.3","app":"/Users/kazuaki/GitHub/python-client/test/apps/UICatalog.app.zip","automationName":"XCUITest","allowTouchIdEnroll":true}}
[debug] [MJSONWP] Calling AppiumDriver.createSession() with args: [{"deviceName":"iPhone 6s","platformName":"iOS","platformVersion":"10.3","app":"/Users/kazuaki/GitHub/python-client/test/apps/UICatalog.app.zip","automationName":"XCUITest","allowTouchIdEnroll":true},null,null]
[debug] [BaseDriver] Event 'newSessionRequested' logged at 1515075790469 (23:23:10 GMT+0900 (JST))
[Appium] Creating new XCUITestDriver (v2.63.0) session
[Appium] Capabilities:
[Appium]   deviceName: iPhone 6s
[Appium]   platformName: iOS
[Appium]   platformVersion: 10.3
[Appium]   app: /Users/kazuaki/GitHub/python-client/test/apps/UICatalog.app.zip
[Appium]   automationName: XCUITest
[Appium]   allowTouchIdEnroll: true
[BaseDriver] The following capabilities were provided, but are not recognized by appium: allowTouchIdEnroll.
[BaseDriver] Session created with session id: 3a5d313d-e482-4292-a273-c741d406fbcf

      response = {
        status: 0, # To make bridge.dialect == :oss
        sessionId: '1234567890',
        value: {
          capabilities: {
            device: 'iphone',
            browserName: 'UICatalog',
            sdkVersion: '10.3.1',
            CFBundleIdentifier: 'com.example.apple-samplecode.UICatalog'
          }
        }
      }.to_json

And if the response is like the below, it comes from Ruby client's test code, the drivers work as the W3C driver.

      response = {
        value: {
          sessionId: '1234567890',
          capabilities: {
            device: 'iphone',
            browserName: 'UICatalog',
            sdkVersion: '10.3.1',
            CFBundleIdentifier: 'com.example.apple-samplecode.UICatalog'
          }
        }
      }.to_json

The above's response depends on the response. Meanwhile, Appium 1.7.2-beta3~5 support both formats. In the environment, clients should send only { "desiredCapabilities": {...} } to get MJSONWP style's response. (Finally, W3C create session was disabled for Appium 1.7.2 though.)

Thus, I define forceMjsonwp to manage the request format to handle the response. We can remove the flag safely in the future because each client sends { "desiredCapabilities": {...}, "capabilities": { ... } } format by default.

BTW, I found some missing commands and locators in W3C module. I'm not sure Java Client, but I think we also cover them for W3C.

Exist, but some command's paths are changed issue
Missing commands ruby client
converted locators ruby client

SrinivasanTarget · 2018-01-05T16:33:03Z

Yes, the client should send both types of capabilities as a compatibility measure

👍

that payload doesn't look correct

Yes @jlipps Looks like a bug. Will fix in upcoming release. @KazuCocoa looking at your links java-client also misses few of them. Will figure out those first. Thanks for letting us know.

@TikhomirovSergey FYI

KazuCocoa · 2018-01-23T02:15:31Z

📝
I'll merge this after self-review again, later.

NozomiIto · 2018-01-24T23:25:17Z

I'm waiting for this fix to be released! (since now python client does not work with Appium1.8.0-beta maybe due to this problem)

dpgraham · 2018-01-25T16:50:04Z

@NozomiIto This probably won't fix the problem. Do you have error logs?

NozomiIto · 2018-01-25T23:19:10Z

@dpgraham Thanks.

Appium server 1.8.0-beta log:

https://gist.github.com/NozomiIto/3c12eefec788a9d6a87bfdf5d3d82f8d

Python client0.26 log:
https://gist.github.com/NozomiIto/81b2795e6772e1f5b2a63a5246a650f8

My Python code:

from appium import webdriver
import time

desired_caps = {}
desired_caps['platformName'] = 'iOS'
desired_caps['platformVersion'] = '11.2'
desired_caps['deviceName'] = 'iPhone 8'
desired_caps['automationName'] = 'XCUITest'
desired_caps['bundleId'] = 'com.apple.camera'
desired_caps['showXcodeLog'] = 'true'
driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)

But when I install Python client from the master HEAD, this error is resolved.
I thought this problem is similar to appium/appium#10055 and this fix would resolve the problem.

dpgraham · 2018-01-25T23:27:17Z

@NozomiIto Looks like you were right, and it is a client issue. It's sending incomplete capabilities. However, the next upcoming beta will have a workaround for that.

Appium on the master branch currently has that fix and we'll probably publish a new beta later today or tomorrow.

NozomiIto · 2018-01-25T23:35:28Z

@dpgraham Thank you so much!

KazuCocoa added 2 commits December 30, 2017 00:33

add appium prefix in create session

a8160a8

fix find_elements by w3c for Appium

eb2278e

mykola-mokhnach reviewed Dec 30, 2017

View reviewed changes

introduce forceMjsonwp

2ffa61a

mykola-mokhnach requested a review from dpgraham January 3, 2018 16:37

KazuCocoa added 2 commits January 4, 2018 20:32

refine a bit

a3eaebb

fix some tests

3bbeb5b

KazuCocoa changed the title ~~[WIP]add appium prefix in create session and fix find_elements for W3C~~ add appium prefix in create session and fix find_elements for W3C Jan 4, 2018

update the docset

d77735f

KazuCocoa mentioned this pull request Jan 12, 2018

Document Appium W3C implementation for Appium stakeholders appium/appium#9952

Closed

Merge branch 'master' into add_appium_prefix

05e44b9

KazuCocoa merged commit f37733d into appium:master Jan 23, 2018

KazuCocoa deleted the add_appium_prefix branch January 24, 2018 14:13

tangzhoutz mentioned this pull request Jul 30, 2018

Proxy error happens when we run test in Chrome Driver following W3C protocol #234

Closed

+                  always_match = {}
+                  if caps.get('proxy') and caps['proxy'].get('proxyType'):
+                      caps['proxy']['proxyType'] = caps['proxy']['proxyType'].lower()
+                  for k, v in caps.items():

+                  for k, v in caps.items():
+                      if v and k in _OSS_W3C_CONVERSION:
+                          always_match[_OSS_W3C_CONVERSION[k]] = v.lower() if k == 'platform' else v
+                      if k in _W3C_CAPABILITY_NAMES or ':' in k:

+                          new_opts = copy.deepcopy(moz_opts)
+                          new_opts['profile'] = profile
+                          always_match['moz:firefoxOptions'] = new_opts
+                  return {"firstMatch": [{}], "alwaysMatch": always_match}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add appium prefix in create session and fix find_elements for W3C #196

add appium prefix in create session and fix find_elements for W3C #196

KazuCocoa commented Dec 30, 2017 •

edited

Loading

mykola-mokhnach Dec 30, 2017

KazuCocoa Jan 4, 2018 •

edited

Loading

mykola-mokhnach Dec 30, 2017

mykola-mokhnach Dec 30, 2017

mykola-mokhnach Dec 30, 2017

dpgraham commented Jan 4, 2018

SrinivasanTarget commented Jan 4, 2018

jlipps commented Jan 4, 2018

KazuCocoa commented Jan 5, 2018 •

edited

Loading

SrinivasanTarget commented Jan 5, 2018 •

edited

Loading

KazuCocoa commented Jan 23, 2018

NozomiIto commented Jan 24, 2018

dpgraham commented Jan 25, 2018

NozomiIto commented Jan 25, 2018

dpgraham commented Jan 25, 2018

NozomiIto commented Jan 25, 2018

		@@ -48,6 +98,43 @@ def __init__(self, command_executor='http://127.0.0.1:4444/wd/hub',
		By.ANDROID_UIAUTOMATOR = MobileBy.ANDROID_UIAUTOMATOR
		By.ACCESSIBILITY_ID = MobileBy.ACCESSIBILITY_ID

add appium prefix in create session and fix find_elements for W3C #196

add appium prefix in create session and fix find_elements for W3C #196

Conversation

KazuCocoa commented Dec 30, 2017 • edited Loading

What do I do in this PR

related

mykola-mokhnach Dec 30, 2017

Choose a reason for hiding this comment

KazuCocoa Jan 4, 2018 • edited Loading

Choose a reason for hiding this comment

mykola-mokhnach Dec 30, 2017

Choose a reason for hiding this comment

mykola-mokhnach Dec 30, 2017

Choose a reason for hiding this comment

mykola-mokhnach Dec 30, 2017

Choose a reason for hiding this comment

dpgraham commented Jan 4, 2018

SrinivasanTarget commented Jan 4, 2018

jlipps commented Jan 4, 2018

KazuCocoa commented Jan 5, 2018 • edited Loading

SrinivasanTarget commented Jan 5, 2018 • edited Loading

KazuCocoa commented Jan 23, 2018

NozomiIto commented Jan 24, 2018

dpgraham commented Jan 25, 2018

NozomiIto commented Jan 25, 2018

dpgraham commented Jan 25, 2018

NozomiIto commented Jan 25, 2018

KazuCocoa commented Dec 30, 2017 •

edited

Loading

KazuCocoa Jan 4, 2018 •

edited

Loading

KazuCocoa commented Jan 5, 2018 •

edited

Loading

SrinivasanTarget commented Jan 5, 2018 •

edited

Loading