Merge pull request #20 from Shahnawaz-Sk/master

changes for app automation capability service & report

Author: sushobhit-lt

build.gradle

@@ -30,7 +30,7 @@ plugins {
 
 group = 'org.jenkins-ci.plugins'
 
-version = '1.20.5'
+version = '1.20.6'
 
 description = 'LambdaTest Plugin is used to run automated selenium tests on LambdaTest Cloud'
 

src/main/java/com/lambdatest/jenkins/credential/MagicPlugCredentialsImpl.java

@@ -3,6 +3,7 @@
 import java.io.IOException;
 import java.util.Collections;
 import java.util.List;
+import java.util.logging.Logger;
 
 import javax.annotation.CheckForNull;
 import javax.annotation.Nullable;
@@ -32,15 +33,15 @@ public class MagicPlugCredentialsImpl extends BaseStandardCredentials implements
 	private final String userName;
 	private final Secret accessToken;
 
+	private static final Logger logger = Logger.getLogger(MagicPlugCredentialsImpl.class.getName());
+
 	@DataBoundConstructor
 	public MagicPlugCredentialsImpl(CredentialsScope scope, String id, String description, String userName,
 			String accessToken) throws Exception {
 		super(scope, id, description);
 		try {
-			System.out.println("MagicPlugCredentialsImpl");
 			this.userName = userName;
 			this.accessToken = Secret.fromString(accessToken);
-			System.out.println("Here We can Verify Credentials Also before Adding");
 			if (!CapabilityService.isValidUser(userName, accessToken)) {
 				throw new Exception("Invalid username and access Token");
 			}
@@ -82,7 +83,6 @@ public String getCredentialsPage() {
 
 		public FormValidation doVerifyCredentials(@QueryParameter("userName") final String userName,
 				@QueryParameter("accessToken") final String accessToken) throws IOException, ServletException {
-			System.out.println(userName + ":" + accessToken);
 			if (StringUtils.isBlank(userName) || StringUtils.isBlank(accessToken)) {
 				return FormValidation.error("Please enter valid username and authKey");
 			}

src/main/java/com/lambdatest/jenkins/freestyle/MagicPlugBuildWrapper.java

@@ -1,5 +1,7 @@
 package com.lambdatest.jenkins.freestyle;
 
+import java.io.BufferedReader;
+import java.io.FileReader;
 import java.io.IOException;
 import java.io.Serializable;
 import java.lang.reflect.Field;
@@ -25,6 +27,7 @@
 import com.lambdatest.jenkins.freestyle.api.Constant;
 import com.lambdatest.jenkins.freestyle.api.auth.UserAuthResponse;
 import com.lambdatest.jenkins.freestyle.api.service.CapabilityService;
+import com.lambdatest.jenkins.freestyle.api.service.AppAutomationCapabilityService;
 import com.lambdatest.jenkins.freestyle.data.LocalTunnel;
 import com.lambdatest.jenkins.freestyle.service.LambdaTunnelService;
 import com.lambdatest.jenkins.freestyle.service.LambdaWebSocketTunnelService;
@@ -43,6 +46,8 @@
 public class MagicPlugBuildWrapper extends BuildWrapper implements Serializable {
 
 	private List<JSONObject> seleniumCapabilityRequest;
+	private List<JSONObject> appAutomationCapabilityRequest;
+	private String appId;
 	private String credentialsId;
 	private String username;
 	private Secret accessToken;
@@ -65,7 +70,7 @@ public class MagicPlugBuildWrapper extends BuildWrapper implements Serializable
 	private static final Logger logger = Logger.getLogger(MagicPlugBuildWrapper.class.getName());
 
 	@DataBoundConstructor
-	public MagicPlugBuildWrapper(StaplerRequest req, @CheckForNull List<JSONObject> seleniumCapabilityRequest,
+	public MagicPlugBuildWrapper(StaplerRequest req, @CheckForNull List<JSONObject> seleniumCapabilityRequest, @CheckForNull List<JSONObject> appAutomationCapabilityRequest,
 			@CheckForNull String credentialsId, String choice, boolean useLocalTunnel, LocalTunnel localTunnel,
 			ItemGroup context) throws Exception {
 		try {
@@ -77,6 +82,13 @@ public MagicPlugBuildWrapper(StaplerRequest req, @CheckForNull List<JSONObject>
 				validateTestInput(seleniumCapabilityRequest);
 				this.seleniumCapabilityRequest = seleniumCapabilityRequest;
 			}
+			if (appAutomationCapabilityRequest == null) {
+				// prevent null pointer
+				this.appAutomationCapabilityRequest = new ArrayList<JSONObject>();
+			} else {
+				validateTestInput(appAutomationCapabilityRequest);
+				this.appAutomationCapabilityRequest = appAutomationCapabilityRequest;
+			}
 			// Setting up credentials in both case if input capabilities are there or not
 			this.choice = choice;
 			setLambdaTestCredentials(credentialsId, context);
@@ -160,8 +172,13 @@ public Environment setUp(AbstractBuild build, Launcher launcher, BuildListener l
 		}
 
 		// Create Grid URL
-		this.gridURL = CapabilityService.buildHubURL(this.username, this.accessToken.getPlainText(),"production");
-		logger.info(this.gridURL);
+		if (!CollectionUtils.isEmpty(seleniumCapabilityRequest)) {
+			this.gridURL = CapabilityService.buildHubURL(this.username, this.accessToken.getEncryptedValue(),"production");
+		} else if (!CollectionUtils.isEmpty(appAutomationCapabilityRequest)) {
+			logger.info("appAutomationCR : " + appAutomationCapabilityRequest);
+			this.gridURL = AppAutomationCapabilityService.appAutomationBuildHubURL(this.username, this.accessToken.getEncryptedValue(),"production");
+		}
+		logger.info("grid URL : " + this.gridURL);
 		return new MagicPlugEnvironment(build);
 	}
 
@@ -207,7 +224,17 @@ public void buildEnvVars(Map<String, String> env) {
 				env.put(Constant.LT_BROWSER_VERSION, seleniumCapability.getString(Constant.BROWSER_VERSION));
 				env.put(Constant.LT_RESOLUTION, seleniumCapability.getString(Constant.RESOLUTION));
 			}
+			if (!CollectionUtils.isEmpty(appAutomationCapabilityRequest)) {
+				JSONObject appAutomationCapability = appAutomationCapabilityRequest.get(0);
+				env.put(Constant.LT_PLATFORM_NAME, appAutomationCapability.getString(Constant.PLATFORM_NAME));
+				env.put(Constant.LT_BRAND_NAME, appAutomationCapability.getString(Constant.BRAND_NAME));
+				env.put(Constant.LT_DEVICE_NAME, appAutomationCapability.getString(Constant.DEVICE_NAME));
+				env.put(Constant.LT_DEVICE_VERSION, appAutomationCapability.getString(Constant.DEVICE_VERSION));
+				env.put(Constant.LT_APP_ID, appAutomationCapability.getString(Constant.APP_ID));
+			}
 			env.put(Constant.LT_BROWSERS, createBrowserJSON(seleniumCapabilityRequest));
+			env.put(Constant.LT_BRANDS, createBrandJSON(appAutomationCapabilityRequest));
+			env.put(Constant.LT_DEVICES, createDeviceJSON(appAutomationCapabilityRequest));
 			env.put(Constant.LT_GRID_URL, gridURL);
 			env.put(Constant.LT_BUILD_NAME, buildname);
 			env.put(Constant.LT_BUILD_NUMBER, buildnumber);
@@ -246,40 +273,95 @@ private String createBrowserJSON(List<JSONObject> seleniumCapabilityRequests) {
 			}
 			return config;
 		}
+		private String createDeviceJSON(List<JSONObject> appAutomationCapabilityRequests) {
+			String config = Constant.NOT_AVAILABLE;
+			try {
+				ObjectMapper objectMapper = new ObjectMapper();
+				objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+				config = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(appAutomationCapabilityRequests);
+			} catch (JsonProcessingException e) {
+				logger.warning(e.getMessage());
+			}
+			return config;
+		}
+
+		private String createBrandJSON(List<JSONObject> appAutomationCapabilityRequests) {
+			String config = Constant.NOT_AVAILABLE;
+			try {
+				ObjectMapper objectMapper = new ObjectMapper();
+				objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+				config = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(appAutomationCapabilityRequests);
+			} catch (JsonProcessingException e) {
+				logger.warning(e.getMessage());
+			}
+			return config;
+		}
+
 
 		@Override
 		public boolean tearDown(AbstractBuild build, BuildListener listener) throws IOException, InterruptedException {
 			/*
 			 * Runs after the build
 			 */
+			String buildnumber = String.valueOf(build.getNumber());
+		
 			try {
 				logger.info("tearDown");
-				int x=1;
-				while(x!=-1) {
-					x=stopTunnel();
+				int result = stopTunnel(buildnumber, build.getWorkspace());
+		
+				if (result == -1) {
+					logger.info("Tunnel was not active.");
+				} else {
+					logger.info("Tunnel stopped successfully.");
 				}
 			} catch (Exception e) {
-				logger.warning("Forcefully Tear Down due to :"+e.getMessage());
+				logger.warning("Forcefully Tear Down due to: " + e.getMessage());
 				if (tunnelProcess != null && tunnelProcess.isAlive()) {
 					tunnelProcess.destroy();
 				}
 			}
 			return super.tearDown(build, listener);
-		}
-		
-		private int stopTunnel() throws IOException, InterruptedException {
+		}	
+	
+		private int stopTunnel(String buildnumber, FilePath workspacePath) throws IOException, InterruptedException {
 			if (tunnelProcess != null && tunnelProcess.isAlive()) {
-				logger.info("tunnel is active, going to stop tunnel binary");
+				logger.info("Tunnel is active, going to stop the tunnel binary");
+		
 				if (OSValidator.isWindows()) {
 					tunnelProcess.destroy();
 					logger.info("Windows Tunnel Stopped");
 					return 10;
 				}
-				long tunnelProcessId=getPidOfProcess(tunnelProcess);
+		
+				long tunnelProcessId = getPidOfProcess(tunnelProcess);
+		
+				logger.info("Tunnel is active, with tunnelProcessId: " + tunnelProcessId);
+		
+				if (tunnelProcessId == -1) {
+					String pidFilePath = workspacePath + "/lambda-tunnel/" + buildnumber + ".pid";
+					logger.info(pidFilePath);
+		
+					try (BufferedReader br = new BufferedReader(new FileReader(pidFilePath))) {
+						String pidString = br.readLine();
+		
+						if (pidString != null) {
+							long pid = Integer.parseInt(pidString.trim());
+							stopTunnelProcessUsingPID(pid);
+							return 10;
+						} else {
+							logger.info("PID not found in the file.");
+							return -1;
+						}
+					} catch (IOException e) {
+						logger.info("Error reading PID file: " + e.getMessage());
+						return -1;
+					}
+				}
+		
 				stopTunnelProcessUsingPID(tunnelProcessId);
 				Thread.sleep(2000);
 				return 10;
-			}else {
+			} else {
 				logger.info("Tunnel Stopped");
 				return -1;
 			}
@@ -320,6 +402,21 @@ public List<JSONObject> getSeleniumCapabilityRequest() {
 	public void setSeleniumCapabilityRequest(List<JSONObject> seleniumCapabilityRequest) {
 		this.seleniumCapabilityRequest = seleniumCapabilityRequest;
 	}
+	public List<JSONObject> getAppAutomationCapabilityRequest() {
+		return appAutomationCapabilityRequest;
+	}
+
+	public void setAppAutomationCapabilityRequest(List<JSONObject> appAutomationCapabilityRequest) {
+		this.appAutomationCapabilityRequest = appAutomationCapabilityRequest;
+	}
+
+	public String getAppId() {
+		return appId;
+	}
+
+	public void setAppid(String appId) {
+		this.appId = appId;
+	}
 
 	public String getUsername() {
 		return username;