Unable to start Appium server 1.6 programmatically using AppiumDriverLocalService

[shynkevich-alex]

Description

I've installed node via brew then installed Appium 1.6 using NPM and tried running it with AppiumDriverLocalService.
I wasn't able to run Appium server on one of PC.

Environment

Node version 7.0.0
Appium version 1.6.0

Details

It happens on one machine another works well.
I checked paths of main.js/appium.js etc. and they are the same on both PCs.

Code To Reproduce Issue

private AppiumDriverLocalService service;
private String serverAddress = "0.0.0.0";

DesiredCapabilities serverCapabilities = new DesiredCapabilities();
AppiumServiceBuilder builder = new AppiumServiceBuilder().withCapabilities(serverCapabilities);
builder.usingAnyFreePort();
builder.withIPAddress(serverAddress);
builder.withArgument(GeneralServerFlag.SESSION_OVERRIDE);
builder.withArgument(GeneralServerFlag.LOG_LEVEL, "warn");

service = builder.build();
service.start();

Ecxeption stacktraces

io.appium.java_client.service.local.InvalidServerInstanceException: Invalid server instance exception has occured: There is no installed nodes! Please install node via NPM (https://www.npmjs.com/package/appium#using-node-js) or download and install Appium app (http://appium.io/downloads.html)
Buildiat io.appium.java_client.service.local.AppiumServiceBuilder.findNodeInCurrentFileSystem(AppiumServiceBuilder.java:160)
at io.appium.java_client.service.local.AppiumServiceBuilder.checkAppiumJS(AppiumServiceBuilder.java:305)
at io.appium.java_client.service.local.AppiumServiceBuilder.createArgs(AppiumServiceBuilder.java:386)
at org.openqa.selenium.remote.service.DriverService$Builder.build(DriverService.java:299)
at com.***.appium.helper.DriverManager.createAppiumDriver(DriverManager.java:49)
at com.autotest.runners.BaseRunner.setUp(BaseRunner.java:77)
at com.autotest.runners.advert.AdvertRunner.setUp(AdvertRunner.java:22)
at com.autotest.runners.advert.BannerRunner.setUp(BannerRunner.java:22)
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:498)
at org.testng.internal.MethodInvocationHelper.invokeMethod(MethodInvocationHelper.java:100)
at org.testng.internal.Invoker.invokeConfigurationMethod(Invoker.java:515)
at org.testng.internal.Invoker.invokeConfigurations(Invoker.java:216)
at org.testng.internal.Invoker.invokeConfigurations(Invoker.java:143)
at org.testng.internal.TestMethodWorker.invokeBeforeClassMethods(TestMethodWorker.java:169)
at org.testng.internal.TestMethodWorker.run(TestMethodWorker.java:108)
at org.testng.TestRunner.privateRun(TestRunner.java:753)
at org.testng.TestRunner.run(TestRunner.java:607)
at org.testng.SuiteRunner.runTest(SuiteRunner.java:368)
at org.testng.SuiteRunner.runSequentially(SuiteRunner.java:363)
at org.testng.SuiteRunner.privateRun(SuiteRunner.java:321)
at org.testng.SuiteRunner.run(SuiteRunner.java:270)
at org.testng.SuiteRunnerWorker.runSuite(SuiteRunnerWorker.java:52)
at org.testng.SuiteRunnerWorker.run(SuiteRunnerWorker.java:86)
at org.testng.TestNG.runSuitesSequentially(TestNG.java:1284)
at org.testng.TestNG.runSuitesLocally(TestNG.java:1209)
at org.testng.TestNG.runSuites(TestNG.java:1124)
at org.testng.TestNG.run(TestNG.java:1096)
at com.autotest.Launcher.main(Launcher.java:72)
Caused by: java.io.IOException: /usr/local/lib/node_modules
/var/folders/wk/w9dbkg0x7gbdbcmr2c9pfwnw0000gn/T/get_path_to_default_node5052055597677988693.sh: line 4: shell_session_update: command not found

at io.appium.java_client.service.local.AppiumServiceBuilder.findNodeInCurrentFileSystem(AppiumServiceBuilder.java:161)
... 30 more

[SrinivasanTarget]

@shynkevich-alex It works fine for me everytime with similar setup. Can you change the ip to 127.0.0.1 and give a shot?

[SrinivasanTarget]

@shynkevich-alex Please try setting up the main.js path as well and update us,

AppiumServiceBuilder builder = new AppiumServiceBuilder()
                .withAppiumJS(new File("/usr/local/lib/node_modules/appium/build/lib/main.js"))
                .withArgument(GeneralServerFlag.APP,  path of your app );
        appiumDriverLocalService = builder.build();
        appiumDriverLocalService.start();

Also were you able to run the server manually? Is path of node is setup in PATH on your PC?

[shynkevich-alex]

Hi @SrinivasanTarget ,
I've checked your code and it works for me.
Thank you a lot.

But I thought that path should be set by default. And it was reason why I didn't try it)
Am I wrong?

And yes, I was able run appium server manually in terminal.

[TikhomirovSergey]

@shynkevich-alex
It should work by default if you have installed appium node globally via npm.

Another way is described here:
https://github.com/appium/java-client/blob/master/docs/The-starting-of-an-app-using-Appium-node-server-started-programmatically.md#fyi. You can add the APPIUM_BINARY_PATH and define the full path to the main.js.

[shynkevich-alex]

cool, thank you guys
I am closing issue.

[surikiran]

@SrinivasanTarget I am trying to follow your code but unable to understand " .withArgument(GeneralServerFlag.APP, path of your app );" do U mean Appium app of Android/iOS app which we use for testing besides how can we do parallel execution here as I am trying to start server with the below code
AppiumServiceBuilder builder = new AppiumServiceBuilder ( )
.usingDriverExecutable ( new File (
Path to my node.exe file ) )
.withAppiumJS ( new File (
path to my main.js file ) ) ;
.withArgument ( GeneralServerFlag.ROBOT_ADDRESS ,
device udid )
.withArgument ( GeneralServerFlag.ROBOT_PORT ,
device Port )
.usingPort (appium port )
.withArgument ( GeneralServerFlag.LOG_LEVEL ,
"warn" ) ;
return service = builder.build ( ) ;
I am trying to start appium server for more than one Android device to do parallel execution but server did not start. Please help......

[SrinivasanTarget]

@surikiran please visit https://github.com/saikrishna321/AppiumTestDistribution for parallel execution.

[aaronbriel]

If anybody runs into this issue but is looking for a simple module to resolve it, I've created one called appium-controller that starts and stops appium in the background programmatically (mac or windows).

[KaranKKK]

i want to start the appium server programatically
I am using
APPIUM_VERSION-----1.6.5
XCODE_VERSION------8.1.2
MAC OS VERSION-----10.11.16
JAVA ------------------1.8

Can any one help me out
Thanks in advance...

[naddeoa]

I just sank a few hours into this myself. For me, the issue was my IntelliJ enivonrment. When launching it from my desktop on Linux (Ubuntu MATE), the selenium java client couldn't find my npm install because the output of the script get_path_to_default_node.sh had a bunch of extra non-whitespace characters at the end of it. This was the output

/home/me/node-v8.9.0-linux-x64/lib/node_modules

[H[2J

Since the java client library takes the output and throws it into a File.exists(), it thought I didn't have node installed. The solution was to stop launching IntelliJ from my desktop environment and start launching it from a terminal where it properly inherited the environment that I expect. This issue never happened to me when running my code on the command line, only when run from within IntelliJ.

I have more details in a Stack Overflow post: https://unix.stackexchange.com/questions/402582/script-output-has-mysterious-trailing-characters-when-executed-in-a-specific-env. Hopefully someone can tell me why this would ever happen at all. Clearly, my desktop environment isn't using the exact same PATH that I was expecting, but I don't know what else could be different that would result in the trailing characters.

I am still facing the issue with the below code

AppiumServiceBuilder builder = new AppiumServiceBuilder()
.withAppiumJS(new File("/usr/local/lib/node_modules/appium/build/lib/main.js"));
// .withArgument(GeneralServerFlag.APP, path of your app );
builder.build().start();

console o/p :

Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/commons/validator/routines/InetAddressValidator
at io.appium.java_client.service.local.AppiumServiceBuilder.createArgs(AppiumServiceBuilder.java:398)
at org.openqa.selenium.remote.service.DriverService$Builder.build(DriverService.java:342)
at io.appium.java_client.service.local.AppiumDriverLocalService.buildService(AppiumDriverLocalService.java:76)
at ReadLogs.StartAppiumServer.main(StartAppiumServer.java:13)
Caused by: java.lang.ClassNotFoundException: org.apache.commons.validator.routines.InetAddressValidator
at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:335)
at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
... 4 more

Please help !

[varthikeyan]

I am getting below error in "service.start()". Someone please help?

(node:1400) Warning: To load an ES module, set "type": "module" in the package.json or use the .mjs extension.
C:\Users\HP\AppData\Roaming\npm\node_modules\appium\lib\main.js:4
import { init as logsinkInit } from './logsink';
^^^^^^

SyntaxError: Cannot use import statement outside a module
at wrapSafe (internal/modules/cjs/loader.js:1053:16)
at Module._compile (internal/modules/cjs/loader.js:1101:27)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:1157:10)
at Module.load (internal/modules/cjs/loader.js:985:32)
at Function.Module._load (internal/modules/cjs/loader.js:878:14)
at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:71:12)
at internal/main/run_main_module.js:17:47