Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use buildService method of io.appium.java_client.service.local.AppiumDriverLocalService class

Best io.appium code snippet using io.appium.java_client.service.local.AppiumDriverLocalService.buildService

InitDriver.java

Source:InitDriver.java

...32	 * @throws MalformedURLException33	 */34	public static AppiumDriver<?> androidConfig(AppiumDriver<?> driver, URL driverUrl) throws MalformedURLException {35		if (Generics.getExecutionEnvironment().equalsIgnoreCase("local")) {36			service = AppiumDriverLocalService.buildService(new AppiumServiceBuilder()37					.usingDriverExecutable(new File(Generics.getPropValueConfig("nodeExecutablePath")))38					.withAppiumJS(new File(Generics.getPropValueConfig("appiumJS_Path"))).withIPAddress("127.0.0.1").usingAnyFreePort());39		}40		DesiredCapabilities capabilities = new DesiredCapabilities();41		capabilities.setCapability("deviceName", "ignored");42		capabilities.setCapability("platformName", "Android");43		capabilities.setCapability("automationName", "UiAutomator2");44		capabilities.setCapability("fullReset", false);45		capabilities.setCapability("noReset", true);46		capabilities.setCapability("newCommandTimeout", Generics.getPropValueConfig("newCommandTimeout_android"));47		capabilities.setCapability(MobileCapabilityType.APP, Generics.getAppPath());48		if (Generics.getExecutionEnvironment().equalsIgnoreCase("local")) {49			driver = Factory.createAndroidDriver(service, capabilities);50		} else {51			driver = Factory.createAndroidDriver(driverUrl, capabilities);52		}53		return driver;54		// driver.manage().timeouts().implicitlyWait(SHORT_TIMEOUT, TimeUnit.SECONDS);55	}56	57	/**58	 * Android Appium Setup59	 * 60	 * @param driver61	 * @param driverUrl62	 * @return63	 * @throws MalformedURLException64	 */65	public static AppiumDriver<?> androidAppLaunch(AppiumDriver<?> driver) throws MalformedURLException {66			service = AppiumDriverLocalService.buildService(new AppiumServiceBuilder()67					.usingDriverExecutable(new File(Generics.getPropValueConfig("nodeExecutablePath")))68					.withAppiumJS(new File(Generics.getPropValueConfig("appiumJS_Path"))).withIPAddress("127.0.0.1").usingAnyFreePort());69		DesiredCapabilities capabilities = new DesiredCapabilities();70		capabilities.setCapability("deviceName", "Android");71		capabilities.setCapability("platformName", "Android");72		capabilities.setCapability("automationName", "UiAutomator2");73		capabilities.setCapability("fullReset", false);74		capabilities.setCapability("noReset", true);75		capabilities.setCapability("newCommandTimeout", Generics.getPropValueConfig("newCommandTimeout_android"));76		capabilities.setCapability("appPackage", Generics.getPropValueConfig("appPackage"));77		capabilities.setCapability("appActivity", Generics.getPropValueConfig("appActivity"));78		driver = new AndroidDriver<AndroidElement>(service, capabilities);79		return driver;80		// driver.manage().timeouts().implicitlyWait(SHORT_TIMEOUT, TimeUnit.SECONDS);81	}82	/**83	 * iOS Appium Setup84	 * 85	 * @param driver86	 * @param platform87	 * @param driverUrl88	 * @return89	 */90	public static AppiumDriver<?> iosConfig(AppiumDriver<?> driver, URL driverUrl) {91		92		if (Generics.getExecutionEnvironment().equalsIgnoreCase("local")) {93			service = AppiumDriverLocalService.buildService(new AppiumServiceBuilder()94					.usingDriverExecutable(new File(Generics.getPropValueConfig("nodeExecutablePath")))95					.withAppiumJS(new File(Generics.getPropValueConfig("appiumJS_Path"))).withIPAddress("127.0.0.1").usingAnyFreePort());96		}97		// Use .ipa for physical device98		99		DesiredCapabilities capabilities = new DesiredCapabilities();100		capabilities.setCapability("platformVersion", "11.3");101		capabilities.setCapability("deviceName", "ignored");102		capabilities.setCapability("app", Generics.getAppPath());103		capabilities.setCapability("platformName", "iOS");104		capabilities.setCapability("automationName", "XCUITest");105		capabilities.setCapability("xcodeOrgId",  Generics.getPropValueConfig("xcodeOrgId"));106		capabilities.setCapability("xcodeSigningId", "iPhone Developer");107		capabilities.setCapability("udid", Generics.getPropValueConfig("udid_ios"));108		capabilities.setCapability("showXcodeLog", true);109		capabilities.setCapability("newCommandTimeout",  Generics.getPropValueConfig("newCommandTimeout_android"));110		capabilities.setCapability("fullReset", false);111		capabilities.setCapability("noReset", true);112		System.out.println("APP PATH IN IOS DRIVER CONFIG : "+Generics.getAppPath());113		if (Generics.getExecutionEnvironment().equalsIgnoreCase("local")) {114			driver = Factory.createIOSDriver(service, capabilities);115		} else {116			driver = Factory.createIOSDriver(driverUrl, capabilities);117		}118		/*119		 * BasePage BasePage = new BasePage(driver);120		 * BasePage.clickNotificationsAllowBtn(20);121		 */		// driver.manage().timeouts().implicitlyWait(SHORT_TIMEOUT, TimeUnit.SECONDS);122		return driver;123	}124	public static void androidAppInstallAndDelete(AppiumDriver<?> driver) {125		AppiumDriverLocalService service1 = AppiumDriverLocalService126				.buildService(new AppiumServiceBuilder().usingDriverExecutable(new File(Generics.getPropValueConfig("nodeExecutablePath")))127						.withAppiumJS(new File(Generics.getPropValueConfig("appiumJS_Path"))).withIPAddress("127.0.0.1").usingAnyFreePort());128		DesiredCapabilities capabilities = new DesiredCapabilities();129		capabilities.setCapability("deviceName", "ignored");130		capabilities.setCapability("platformName", "Android");131		capabilities.setCapability("automationName", "UiAutomator2");132		capabilities.setCapability("fullReset", true);133		capabilities.setCapability(MobileCapabilityType.APP, Generics.getAppPath());134		driver = Factory.createAndroidDriver(service1, capabilities);135		service1.stop();136		// driver.quit();137	}138	139	public static void iosAppInstallAndDelete(AppiumDriver<?> driver) {140		AppiumDriverLocalService service1 = AppiumDriverLocalService141				.buildService(new AppiumServiceBuilder().usingDriverExecutable(new File(Generics.getPropValueConfig("nodeExecutablePath")))142						.withAppiumJS(new File(Generics.getPropValueConfig("appiumJS_Path"))).withIPAddress("127.0.0.1").usingAnyFreePort());143		DesiredCapabilities capabilities = new DesiredCapabilities();144		capabilities.setCapability("deviceName", "ignored");145		capabilities.setCapability("platformName", "ios");146		capabilities.setCapability("automationName", "UiAutomator2");147		capabilities.setCapability("fullReset", true);148		capabilities.setCapability("platformVersion", "11.3");149		capabilities.setCapability("automationName", "XCUITest");150		capabilities.setCapability("xcodeOrgId",  Generics.getPropValueConfig("xcodeOrgId"));151		capabilities.setCapability("xcodeSigningId", "iPhone Developer");152		capabilities.setCapability("udid", Generics.getPropValueConfig("udid_ios"));153		// capabilities.setCapability("showXcodeLog", true);154		155		capabilities.setCapability("app", Generics.getAppPath());...

AppiumServer2.java

Source:AppiumServer2.java

...44		serviceBuilder.usingPort(port);45		DesiredCapabilities dc = new DesiredCapabilities();46		dc.setCapability("deviceName", devicesName);47		serviceBuilder.withCapabilities(dc);48		appiumService = AppiumDriverLocalService.buildService(serviceBuilder);49		50		if (appiumService == null || !appiumService.isRunning()) {51			appiumService.start();52		}53		log.info("AppiumServer is started with " + ipAddress + " " + port +" "+devicesName);54	}55	/**56	 * å¼å¯é»è®¤çAppiumServerï¼é»è®¤ä½¿ç¨4723ç«¯å£57	 */58	public void startDefaultService() {59		AppiumServiceBuilder builder = new AppiumServiceBuilder();60		appiumService = AppiumDriverLocalService.buildService(builder);61//		appiumService = AppiumDriverLocalService.buildDefaultService();62		// åä¸ä¸¤è¡çææä¸æ ·ï¼é»è®¤ä½¿ç¨4723ç«¯å£63		appiumService.start();64		if (appiumService == null || !appiumService.isRunning()) {65			throw new RuntimeException("An appium server node is not started!");66		}67	}68	/**69	 * 70	 * @param ipAddress71	 * @param port72	 * @param capabilities73	 */74	public void startServer(String ipAddress, int port, DesiredCapabilities capabilities) {75		AppiumServiceBuilder builder = new AppiumServiceBuilder();76		builder.withIPAddress(ipAddress);77		builder.usingPort(port);78		if (capabilities != null) {79			builder.withCapabilities(capabilities);80		}81		appiumService = AppiumDriverLocalService.buildService(builder);82		appiumService.start();83		if (appiumService == null || !appiumService.isRunning()) {84			throw new RuntimeException("An appium server node is not started!");85		}86	}87	/**88	 * 89	 * @param ipAddress90	 * @param port91	 * @param logFile92	 * @param arguments93	 */94	public void startServer(String ipAddress, int port, File logFile, ServerArgument... arguments) {95		AppiumServiceBuilder builder = new AppiumServiceBuilder();96		builder.withIPAddress(ipAddress);97		builder.usingPort(port);98		builder.withLogFile(logFile);99		for (ServerArgument argument : arguments) {100			builder.withArgument(argument);101		}102		appiumService = AppiumDriverLocalService.buildService(builder);103		appiumService.start();104		if (appiumService == null || !appiumService.isRunning()) {105			throw new RuntimeException("An appium server node is not started!");106		}107	}108	/**109	 * å³éæå¡110	 */111	public void stopServer() {112		if (appiumService != null) {113			appiumService.stop();114			log.info("AppiumServer has stoped");115		}116	}...

ServerManager.java

Source:ServerManager.java

...30		return AppiumDriverLocalService.buildDefaultService();31	}32	public AppiumDriverLocalService WindowsGetAppiumService(int port) {33		GlobalParams params = new GlobalParams();34		return AppiumDriverLocalService.buildService(35				new AppiumServiceBuilder().usingPort(port).withArgument(GeneralServerFlag.SESSION_OVERRIDE).withLogFile(36						new File("AppiumLogs/" + params.getPlatformName() + "_" + params.getDeviceName() + ".log")));37	}38	public AppiumDriverLocalService MacGetAppiumService(int port) {39		GlobalParams params = new GlobalParams();40		HashMap<String, String> environment = new HashMap<>();41		environment.put("PATH",42				"/Library/Java/JavaVirtualMachines/jdk1.8.0_161.jdk/Contents/Home/bin:/Users/testing/Library/Android/sdk/tools:/Users/testing/Library/Android/sdk/platform-tools:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"43						+ System.getenv("PATH"));44		environment.put("ANDROID_HOME", "/Users/testing/Library/Android/sdk");45		environment.put("JAVA_HOME", "/Library/Java/JavaVirtualMachines/jdk1.8.0_161.jdk/Contents/Home");46		return AppiumDriverLocalService.buildService(new AppiumServiceBuilder()47				.usingDriverExecutable(new File("/usr/local/bin/node"))48				.withAppiumJS(new File("/usr/local/lib/node_modules/appium/build/lib/main.js")).usingPort(port)49				.withArgument(GeneralServerFlag.SESSION_OVERRIDE).withEnvironment(environment).withLogFile(50						new File("AppiumLogs/" + params.getPlatformName() + "_" + params.getDeviceName() + ".log")));51	}52	public void stopServer() {53		getServer().stop();54	}55}...

AppiumServerUtils.java

Source:AppiumServerUtils.java

...42	}43	44	public URL startAppiumServerNoReset() {45		AppiumServiceBuilder builder = new AppiumServiceBuilder();46		AppiumDriverLocalService service = AppiumDriverLocalService.buildService(builder);47		service.start();48		if (service == null || !service.isRunning()) {49			throw new RuntimeException("An appium server node is not started!");50		}51		return service.getUrl();52	}53	public URL startServer() {54		AppiumServiceBuilder builder = new AppiumServiceBuilder();55		builder.withIPAddress(ipAddress);56		builder.usingPort(port);57		builder.withArgument(AndroidServerFlag.BOOTSTRAP_PORT_NUMBER, bp);58		service = AppiumDriverLocalService.buildService(builder);59		service.start();60		if (service == null || !service.isRunning()) {61			throw new RuntimeException("An appium server node is not started!");62		}63		return service.getUrl();64	}65	public AppiumDriverLocalService stopServer(){66		if(service!=null){67			return service;68		}69		return null;70	}71	72	public static void  setAppiumPath() throws IOException{...

AppiumIOSServer.java

Source:AppiumIOSServer.java

...13		return null;14	}15	public static void startAppium() throws InterruptedException {16		/*17		 * AppiumDriverLocalService service = AppiumDriverLocalService.buildService(new18		 * AppiumServiceBuilder() .usingDriverExecutable(new19		 * File("/Applications/Appium.app/Contents/Resources/node/bin/node"))20		 * .withAppiumJS(new File(21		 * "/Applications/Appium.app/Contents/Resources/node_modules/appium/bin/appium.js"22		 * )) .withIPAddress("127.0.0.1") .usingPort(4734)23		 * .withArgument(GeneralServerFlag.ROBOT_ADDRESS, udid as String)24		 * .withArgument(AndroidServerFlag.BOOTSTRAP_PORT_NUMBER, ((port as int) + 2) as25		 * String) .withArgument(SESSION_OVERRIDE) .withLogFile(new26		 * File("build/${device}.log")));27		 */28		Integer port =4743;29		AppiumDriverLocalService service = AppiumDriverLocalService30				.buildService(new AppiumServiceBuilder().usingDriverExecutable(new File("/usr/local/bin/node"))31						.withAppiumJS(new File("/usr/local/bin/appium")).withIPAddress("127.0.0.1").usingPort(port)32						);33		service.start();34		System.out.println("Appium started.");35		Thread.sleep(6000000);36		// service.stop();37		System.out.println("Appium CLOSED");38	}39	40	public static AppiumDriverLocalService startNGetAppium(String  ipAddress, Integer port) throws InterruptedException {41		 42		//port =4743;43		AppiumDriverLocalService service = AppiumDriverLocalService44				.buildService(new AppiumServiceBuilder().usingDriverExecutable(new File("/usr/local/bin/node"))45						.withAppiumJS(new File("/usr/local/bin/appium")).withIPAddress(ipAddress).usingPort(port)46						);47		service.start();48		System.out.println("Appium started at "+ipAddress+":"+port);49		 50		// service.stop();51		return service;52		 53	}54	public static void stopAppium(AppiumDriverLocalService servoce) {55	}56}...

ServicesManager.java

Source:ServicesManager.java

...17            AppiumServiceBuilder builder = new AppiumServiceBuilder();18            builder.withIPAddress("127.0.0.1");19            builder.usingAnyFreePort();20            builder.withLogFile(new File(System.getProperty("user.dir") + "/appiumLogs/" + System.currentTimeMillis() + ".text"));21            appiumService = AppiumDriverLocalService.buildService(builder);22            appiumService.clearOutPutStreams();23            appiumService.start();24            System.out.println("Appium server started at: - " + appiumService.getUrl());25            setAppiumService(appiumService);26            if (appiumService == null) {27                throw new AppiumServerHasNotBeenStartedLocallyException(28                        "An appium server node is not started!");29            }30        } catch (Exception e) {31            e.printStackTrace();32        }33    }34    public void stopAppiumServer() {35        try {...

ServerService.java

Source:ServerService.java

...12	static boolean flag=checkIfServerIsRunnning(4723);13	14	public static AppiumDriverLocalService services(String excutablePath, String jsPath) {15		if(!flag) {16			service = AppiumDriverLocalService.buildService(new AppiumServiceBuilder()17					.usingDriverExecutable(new File(excutablePath)).withAppiumJS(new File(jsPath)));18			service.start();19		}20		return service;21	}22	23	public static void startService() {24	    service.start();25	}26	public static void stopService() {27		service.stop();28	}29 30     //check if server is running...

AppiumServer.java

Source:AppiumServer.java

...12        builder.withLogFile(new File(ConfigPropertiesReader.APPIUM_LOG_FILE));13        builder.withLogFile(new File("appium.log"));14        AppiumDriverLocalService service;15        try{16            service = AppiumDriverLocalService.buildService(builder);17        }catch (Exception e){18            builder.usingDriverExecutable(new File(ConfigPropertiesReader.NODE_PATH));19            builder.withAppiumJS(new File(ConfigPropertiesReader.APPIUM_JS_FILE));20            service = AppiumDriverLocalService.buildService(builder);21        }22        service.start();23        service.clearOutPutStreams();24        return service;25    }26    public static void startAppiumServer(){27        service.start();28    }29    public static void stopAppiumServer(){30        service.stop();31    }32}...

buildService

Using AI Code Generation

1import java.io.File;2import java.io.IOException;3import java.net.URL;4import java.util.concurrent.TimeUnit;5import org.openqa.selenium.By;6import org.openqa.selenium.Platform;7import org.openqa.selenium.WebDriver;8import org.openqa.selenium.WebElement;9import org.openqa.selenium.remote.DesiredCapabilities;10import org.openqa.selenium.remote.RemoteWebDriver;11import io.appium.java_client.android.AndroidDriver;12import io.appium.java_client.service.local.AppiumDriverLocalService;13import io.appium.java_client.service.local.AppiumServiceBuilder;14import io.appium.java_client.service.local.flags.GeneralServerFlag;15public class appium {16	public static void main(String[] args) throws IOException, InterruptedException {17		AppiumDriverLocalService service = AppiumDriverLocalService.buildService(new AppiumServiceBuilder().usingDriverExecutable(new File("C:/Program Files (x86)/Appium/node.exe")).withAppiumJS(new File("C:/Program Files (x86)/Appium/node_modules/appium/bin/appium.js")).withIPAddress("

buildService

Using AI Code Generation

1package com.appium;2import java.io.File;3import java.io.IOException;4import java.net.URL;5import org.openqa.selenium.remote.DesiredCapabilities;6import io.appium.java_client.android.AndroidDriver;7import io.appium.java_client.service.local.AppiumDriverLocalService;8import io.appium.java_client.service.local.AppiumServiceBuilder;9public class AppiumServer {10	public static void main(String[] args) throws IOException, InterruptedException {11		AppiumDriverLocalService service = AppiumDriverLocalService.buildService(new AppiumServiceBuilder().usingDriverExecutable(new File("C:\\Program Files (x86)\\Appium\\node.exe")).withAppiumJS(new File("C:\\Program Files (x86)\\Appium\\node_modules\\appium\\bin\\appium.js")));12		service.start();13		Thread.sleep(5000);14		DesiredCapabilities dc = new DesiredCapabilities();15		dc.setCapability("deviceName", "Android Emulator");16		dc.setCapability("platformName", "Android");17		dc.setCapability("platformVersion", "9.0");18		dc.setCapability("appPackage", "com.android.calculator2");19		dc.setCapability("appActivity", "com.android.calculator2.Calculator");

buildService

Using AI Code Generation

1import io.appium.java_client.service.local.AppiumDriverLocalService;2import io.appium.java_client.service.local.AppiumServiceBuilder;3import java.io.File;4import java.util.logging.Level;5import org.openqa.selenium.remote.DesiredCapabilities;6public class AppiumService {7public static void main(String[] args) {8DesiredCapabilities cap = new DesiredCapabilities();9cap.setCapability("noReset", "false");10AppiumDriverLocalService service = AppiumDriverLocalService.buildService(new AppiumServiceBuilder().usingDriverExecutable(new File("C:\\Program Files (x86)\\Appium\\node.exe")).withAppiumJS(new File("C:\\Program Files (x86)\\Appium\\node_modules\\appium\\bin\\appium.js")).withIPAddress("

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.