1217988 - platformName capability reports compile system's OS name instead of effective, local system name

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, defect)

Description

[Josh Grant :joshin4colours]

User Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:44.0) Gecko/20100101 Firefox/44.0
Build ID: 20151019030227

Steps to reproduce:

Using Selenium WebDriver 2.48.2 with Wires 0.4.2 on a Win 7 machine and Java bindings (Oracle JDK 1.8.0_11) I ran the following code: 

------------------------------------

public class MarionetteTest {

	WebDriver _driver;
	private final String URL = "https://the-internet.herokuapp.com";

	@BeforeClass(alwaysRun = true)
	public void setUpBeforeClass() {
		_driver = new MarionetteDriver();
	}

	/**
	 * Setup method for each test method.
	 * Creates two random accounts (not added) and goes to GLAccounts Page.
	 */

	@BeforeMethod(alwaysRun = true)
	public void setUp() {
		_driver.navigate().to(this.URL);
	}

	/**
	 * Teardown method for each test method. Attempts to log out of Collaborate.
	 */
	@AfterMethod(alwaysRun = true)
	public void tearDown() {
		_driver.manage().deleteAllCookies();
		_driver.navigate().refresh();
	}

	/**
	 * Base teardown method for TOTG Tax test class.
	 */
	@AfterClass(alwaysRun = true)
	public void tearDownAfterClassCollaborate() {
		_driver.quit();
	}

	@Test
	public void openTheInternet() {
		Assert.assertTrue(_driver.findElement(By.xpath(".//a[@href='https://github.com/tourdedave/the-internet']")).isDisplayed());
	}
}


Actual results:

The tests failed at the @BeforeClass step of staring a new MarionetteDriver instance with the following stack trace: 

FAILED CONFIGURATION: @BeforeClass setUpBeforeClass
org.openqa.selenium.WebDriverException: Cannot find firefox binary in PATH. Make sure firefox is installed. OS appears to be: VISTA
Build info: version: '2.48.2', revision: '41bccdd10cf2c0560f637404c2d96164b67d9d67', time: '2015-10-09 13:08:06'
System info: host: 'GRANT7', ip: '192.168.214.56', os.name: 'Windows 7', os.arch: 'amd64', os.version: '6.1', java.version: '1.8.0_11'
Driver info: driver.version: MarionetteDriver
	at org.openqa.selenium.firefox.internal.Executable.<init>(Executable.java:75)
	at org.openqa.selenium.firefox.GeckoDriverService$Builder.createArgs(GeckoDriverService.java:93)
	at org.openqa.selenium.remote.service.DriverService$Builder.build(DriverService.java:299)
	at org.openqa.selenium.firefox.MarionetteDriver.setupService(MarionetteDriver.java:99)
	at org.openqa.selenium.firefox.MarionetteDriver.<init>(MarionetteDriver.java:71)
	at org.openqa.selenium.firefox.MarionetteDriver.<init>(MarionetteDriver.java:45)
	at com.caseware.commons.client.smauto.test.marionette.MarionetteTest.setUpBeforeClass(MarionetteTest.java:28)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:483)
	at org.testng.internal.MethodInvocationHelper.invokeMethod(MethodInvocationHelper.java:85)
	at org.testng.internal.Invoker.invokeConfigurationMethod(Invoker.java:510)
	at org.testng.internal.Invoker.invokeConfigurations(Invoker.java:211)
	at org.testng.internal.Invoker.invokeConfigurations(Invoker.java:138)
	at org.testng.internal.TestMethodWorker.invokeBeforeClassMethods(TestMethodWorker.java:170)
	at org.testng.internal.TestMethodWorker.run(TestMethodWorker.java:104)
	at org.testng.TestRunner.privateRun(TestRunner.java:773)
	at org.testng.TestRunner.run(TestRunner.java:623)
	at org.testng.SuiteRunner.runTest(SuiteRunner.java:359)
	at org.testng.SuiteRunner.runSequentially(SuiteRunner.java:354)
	at org.testng.SuiteRunner.privateRun(SuiteRunner.java:312)
	at org.testng.SuiteRunner.run(SuiteRunner.java:261)
	at org.testng.SuiteRunnerWorker.runSuite(SuiteRunnerWorker.java:52)
	at org.testng.SuiteRunnerWorker.run(SuiteRunnerWorker.java:86)
	at org.testng.TestNG.runSuitesSequentially(TestNG.java:1185)
	at org.testng.TestNG.runSuitesLocally(TestNG.java:1110)
	at org.testng.TestNG.run(TestNG.java:1018)
	at org.testng.remote.RemoteTestNG.run(RemoteTestNG.java:112)
	at org.testng.remote.RemoteTestNG.initAndRun(RemoteTestNG.java:205)
	at org.testng.remote.RemoteTestNG.main(RemoteTestNG.java:176)


Expected results:

The code should've executed as written with the MarionetteDriver creating a new instance and preferably successfully completing the given @Test methods. 

Furthermore, there appears to be a discrepancy in these lines: 

org.openqa.selenium.WebDriverException: Cannot find firefox binary in PATH. Make sure firefox is installed. OS appears to be: VISTA
Build info: version: '2.48.2', revision: '41bccdd10cf2c0560f637404c2d96164b67d9d67', time: '2015-10-09 13:08:06'
System info: host: 'GRANT7', ip: '192.168.214.56', os.name: 'Windows 7', os.arch: 'amd64', os.version: '6.1', java.version: '1.8.0_11'

Comment 1

[Andreas Tolfsen ❲:ato❳]

As far as I can tell WebDriver leaves the platformName capabilities to be implementation defined in https://w3c.github.io/webdriver/webdriver-spec.html#dfn-processing-capabilities.  This means Marionette is conformant.

We get the OS value from Services.jsm's appinfo property, which is documented in nsIXULRuntime.idl ( https://dxr.mozilla.org/mozilla-central/source/xpcom/system/nsIXULRuntime.idl?from=xpcom%2Fsystem%2FnsIXULRuntime.idl#41) to be:

   * A string tag identifying the current operating system. This is taken
   * from the OS_TARGET configure variable. It will always be available.

I imagine OS_TARGET is set by the machine that compiled your binary, which would be a Windows 7 machine, rather than your local system's actual computed OS.

It may be that what we want to look at is the "appVersion" or "oscpu" system properties described in https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/NsIPropertyBag.

Comment 2

[Andreas Tolfsen ❲:ato❳]

Attachment: MozReview Request: Bug 1217988: Use current system OS for platformName capability

Bug 1217988: Use current system OS for platformName capability

Services.appinfo is populated by the target compile system's OS name,
taken from the OS_TARGET configure variable.

By using Services.sysinfo instead, we are returning the effective current
local system's operating system, which is similar to what is found in
Gecko's UA string.

r=dburns

Comment 3

[Andreas Tolfsen ❲:ato❳]

Comment on attachment 8685464 [details]
MozReview Request: Bug 1217988: Use current system OS for platformName capability

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/24793/diff/1-2/

Comment 4

[David Burns :automatedtester]

Comment on attachment 8685464 [details]
MozReview Request: Bug 1217988: Use current system OS for platformName capability

https://reviewboard.mozilla.org/r/24793/#review22355

Comment 5

[David Burns :automatedtester]

https://reviewboard.mozilla.org/r/24793/#review22357

Comment 6

[David Burns :automatedtester]

https://reviewboard.mozilla.org/r/24793/#review22359

Comment 7

[Pulsebot]

https://hg.mozilla.org/integration/mozilla-inbound/rev/de2c852c9853

Comment 8

[Josh Grant :joshin4colours]

After discussion with :ato, I used the Firefox build from the installer from Treeherder here: 

http://archive.mozilla.org/pub/firefox/try-builds/[e-mail]-e765987f3004ae3c5691fee31bbc15562bac8baf/try-win64/

The WebDriverException above "org.openqa.selenium.WebDriverException: Cannot find firefox binary in PATH. Make sure firefox is installed. OS appears to be: VISTA" is no longer being thrown. All OS related values appear to be correct for the given platform. 

However I'm still getting a UnreachableBrowserException despite Firefox being invoked.

Comment 9

[Pulsebot]

Backout:
https://hg.mozilla.org/integration/mozilla-inbound/rev/1ccee4541e2d

Comment 10

[Andreas Tolfsen ❲:ato❳]

try: https://treeherder.mozilla.org/#/jobs?repo=try&revision=b7357fb1687d

Comment 11

[Andreas Tolfsen ❲:ato❳]

try: https://treeherder.mozilla.org/#/jobs?repo=try&revision=45b26856c59f

Comment 12

[Andreas Tolfsen ❲:ato❳]

Comment on attachment 8685464 [details]
MozReview Request: Bug 1217988: Use current system OS for platformName capability

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/24793/diff/1-2/

Comment 13

[Andreas Tolfsen ❲:ato❳]

try: https://treeherder.mozilla.org/#/jobs?repo=try&revision=52b05d8b9b17

Comment 14

[Andreas Tolfsen ❲:ato❳]

try: https://treeherder.mozilla.org/#/jobs?repo=try&revision=2c60883dc0a7

Comment 15

[Pulsebot]

https://hg.mozilla.org/integration/mozilla-inbound/rev/4c82ee66b1f8

Comment 16

[Phil Ringnalda (:philor)]

https://hg.mozilla.org/mozilla-central/rev/4c82ee66b1f8