Merge pull request #235 from MicroFocus/octane-dev-latest

Octane defect fixes 5.7.3

Author: grount

pom.xml

@@ -470,7 +470,7 @@
 		<dependency>
 			<artifactId>integrations-sdk</artifactId>
 			<groupId>com.hpe.adm.octane.ciplugins</groupId>
-			<version>2.0.38</version>
+			<version>2.0.40</version>
 		</dependency>
 
 		<!--BUILDER providers integration-->

src/main/java/com/microfocus/application/automation/tools/octane/CIJenkinsServicesImpl.java

@@ -58,8 +58,10 @@
 import com.microfocus.application.automation.tools.octane.model.processors.projects.AbstractProjectProcessor;
 import com.microfocus.application.automation.tools.octane.model.processors.projects.JobProcessorFactory;
 import com.microfocus.application.automation.tools.octane.tests.TestListener;
+import com.microfocus.application.automation.tools.octane.tests.junit.JUnitExtension;
 import hudson.ProxyConfiguration;
 import hudson.console.PlainTextConsoleOutputStream;
+import hudson.matrix.MatrixConfiguration;
 import hudson.model.*;
 import hudson.security.ACLContext;
 import jenkins.model.Jenkins;
@@ -75,6 +77,8 @@
 import java.io.*;
 import java.net.URL;
 import java.net.URLDecoder;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
 import java.util.*;
 import java.util.function.BiConsumer;
 import java.util.function.Function;
@@ -111,13 +115,13 @@ public void suspendCIEvents(boolean suspend) {
 
 	@Override
 	public File getAllowedOctaneStorage() {
-		return new File(Jenkins.getInstance().getRootDir(), "userContent");
+		return new File(Jenkins.get().getRootDir(), "userContent");
 	}
 
 	@Override
 	public CIProxyConfiguration getProxyConfiguration(URL targetUrl) {
 		CIProxyConfiguration result = null;
-		ProxyConfiguration proxy = Jenkins.getInstance().proxy;
+		ProxyConfiguration proxy = Jenkins.get().proxy;
 		if (proxy != null) {
 			boolean noProxyHost = false;
 			for (Pattern pattern : proxy.getNoProxyHostPatterns()) {
@@ -141,66 +145,50 @@ public CIProxyConfiguration getProxyConfiguration(URL targetUrl) {
 	public CIJobsList getJobsList(boolean includeParameters) {
 		ACLContext securityContext = startImpersonation();
 		CIJobsList result = dtoFactory.newDTO(CIJobsList.class);
-		PipelineNode tmpConfig;
-		TopLevelItem tmpItem;
-		List<PipelineNode> list = new ArrayList<>();
+		Map<String, PipelineNode> jobsMap = new HashMap<>();
+
 		try {
-			boolean hasReadPermission = Jenkins.getInstance().hasPermission(Item.READ);
+			boolean hasReadPermission = Jenkins.get().hasPermission(Item.READ);
 			if (!hasReadPermission) {
-				stopImpersonation(securityContext);
 				throw new PermissionException(403);
 			}
-			List<String> itemNames = (List<String>) Jenkins.getInstance().getTopLevelItemNames();
-			for (String name : itemNames) {
-				tmpItem = Jenkins.getInstance().getItem(name);
-
-				if (tmpItem == null) {
-					continue;
-				}
 
-				String jobName = tmpItem.getName();
-				String jobClassName = tmpItem.getClass().getName();
+			Collection<String> jobNames = Jenkins.get().getJobNames();
+			for (String jobName : jobNames) {
+				String tempJobName = jobName;
 				try {
-					if (tmpItem instanceof AbstractProject) {
-						AbstractProject abstractProject = (AbstractProject) tmpItem;
-						if (abstractProject.isDisabled()) {
-							continue;
-						}
-						tmpConfig = createPipelineNode(name, abstractProject, includeParameters);
-						list.add(tmpConfig);
-					} else if (jobClassName.equals(JobProcessorFactory.WORKFLOW_JOB_NAME)) {
-						tmpConfig = createPipelineNode(name, (Job) tmpItem, includeParameters);
-						list.add(tmpConfig);
-					} else if (jobClassName.equals(JobProcessorFactory.FOLDER_JOB_NAME)) {
-						for (Job tmpJob : tmpItem.getAllJobs()) {
-							jobName = tmpJob.getFullName();
-							tmpConfig = createPipelineNode(jobName, tmpJob, includeParameters);
-							list.add(tmpConfig);
-						}
-					} else if (jobClassName.equals(JobProcessorFactory.WORKFLOW_MULTI_BRANCH_JOB_NAME)) {
-						tmpConfig = createPipelineNodeFromJobName(name);
-						list.add(tmpConfig);
-					} else if (jobClassName.equals(JobProcessorFactory.GITHUB_ORGANIZATION_FOLDER)) {
-						Collection<? extends Item> items = ((AbstractFolder) tmpItem).getItems();
-						for (Item item : items) {
-							jobName = item.getFullName();
-							tmpConfig = createPipelineNodeFromJobNameAndFolder(item.getDisplayName(), name);
-							list.add(tmpConfig);
-						}
+					Job tmpJob = (Job) Jenkins.get().getItemByFullName(tempJobName);
+
+					if (tmpJob == null) {
+						continue;
+					}
+					if (tmpJob instanceof AbstractProject && ((AbstractProject) tmpJob).isDisabled()) {
+						continue;
+					}
+					if (tmpJob instanceof MatrixConfiguration) {
+						continue;
+					}
+
+					PipelineNode tmpConfig;
+					if (JobProcessorFactory.WORKFLOW_MULTI_BRANCH_JOB_NAME.equals(tmpJob.getParent().getClass().getName())) {
+						tempJobName = tmpJob.getParent().getFullName();
+						tmpConfig = createPipelineNodeFromJobName(tempJobName);
 					} else {
-						logger.info(String.format("getJobsList : Item '%s' of type '%s' is not supported", jobName, jobClassName));
+						tmpConfig = createPipelineNode(tempJobName, tmpJob, includeParameters);
 					}
+					jobsMap.put(tempJobName, tmpConfig);
 				} catch (Throwable e) {
-					logger.error("getJobsList : Failed to add job '" + jobName + "' to JobList  : " + e.getClass().getCanonicalName() + " - " + e.getMessage(), e);
+					logger.error("failed to add job '" + tempJobName + "' to JobList", e);
 				}
-
 			}
-			result.setJobs(list.toArray(new PipelineNode[0]));
-		} catch (AccessDeniedException e) {
+
+			result.setJobs(jobsMap.values().toArray(new PipelineNode[0]));
+		} catch (AccessDeniedException ade) {
 			throw new PermissionException(403);
 		} finally {
 			stopImpersonation(securityContext);
 		}
+
 		return result;
 	}
 
@@ -209,7 +197,7 @@ public PipelineNode getPipeline(String rootJobCiId) {
 		ACLContext securityContext = startImpersonation();
 		try {
 			PipelineNode result;
-			boolean hasRead = Jenkins.getInstance().hasPermission(Item.READ);
+			boolean hasRead = Jenkins.get().hasPermission(Item.READ);
 			if (!hasRead) {
 				throw new PermissionException(403);
 			}
@@ -340,6 +328,7 @@ public InputStream getTestsResult(String jobId, String buildId) {
 				} catch (Exception fnfe) {
 					logger.error("'" + TestListener.TEST_RESULT_FILE + "' file no longer exists, test results of '" + jobId + " #" + buildId + "' won't be pushed to Octane", fnfe);
 				}
+				tryRemoveTempTestResultFile(run);
 			} else {
 				logger.error("build '" + jobId + " #" + buildId + "' not found");
 			}
@@ -349,6 +338,23 @@ public InputStream getTestsResult(String jobId, String buildId) {
 		}
 	}
 
+	private void tryRemoveTempTestResultFile(Run run) {
+		try {
+			File[] matches = run.getRootDir().listFiles((dir, name) -> name.startsWith(JUnitExtension.TEMP_TEST_RESULTS_FILE_NAME_PREFIX));
+			if (matches != null) {
+				for (File f : matches) {
+					try {
+						Files.deleteIfExists(f.toPath());
+					} catch (Exception e) {
+						logger.error("Failed to delete the temp test result file at '" + f.getPath() + "'", e);
+					}
+				}
+			}
+		} catch (Exception e) {
+			logger.error("Fail to tryRemoveTempTestResultFile : " + e.getMessage());
+		}
+	}
+
 	@Override
 	public InputStream getBuildLog(String jobId, String buildId) {
 		ACLContext originalContext = startImpersonation();
@@ -415,12 +421,13 @@ public SSCProjectConfiguration getSSCProjectConfiguration(String jobId, String b
 			stopImpersonation(originalContext);
 		}
 	}
+
 	@Override
 	public Long getFodRelease(String jobId, String buildId) {
 		ACLContext originalContext = startImpersonation();
 		try {
 			Run run = getRunByRefNames(jobId, buildId);
-			if (run != null && run instanceof AbstractBuild) {
+			if (run instanceof AbstractBuild) {
 				return FodConfigUtil.getFODReleaseFromBuild((AbstractBuild) run);
 			} else {
 				logger.error("build '" + jobId + " #" + buildId + "' (of specific type AbstractBuild) not found");
@@ -431,7 +438,7 @@ public Long getFodRelease(String jobId, String buildId) {
 		}
 	}
 
-    @Override
+	@Override
 	public FodServerConfiguration getFodServerConfiguration() {
 
 		ACLContext originalContext = startImpersonation();
@@ -450,6 +457,7 @@ public FodServerConfiguration getFodServerConfiguration() {
 			stopImpersonation(originalContext);
 		}
 	}
+
 	@Override
 	public void runTestDiscovery(DiscoveryInfo discoveryInfo) {
 		ACLContext securityContext = startImpersonation();
@@ -466,8 +474,7 @@ public PipelineNode createExecutor(DiscoveryInfo discoveryInfo) {
 			ACLContext securityContext = startImpersonation();
 			try {
 				Job project = TestExecutionJobCreatorService.createExecutor(discoveryInfo);
-				PipelineNode result = ModelFactory.createStructureItem(project);
-				return result;
+				return ModelFactory.createStructureItem(project);
 			} finally {
 				stopImpersonation(securityContext);
 			}
@@ -480,8 +487,7 @@ public PipelineNode createExecutor(DiscoveryInfo discoveryInfo) {
 	private Job createExecutorByJobName(String uftExecutorJobNameWithTestRunner) {
 		ACLContext securityContext = startImpersonation();
 		try {
-			Job project = TestExecutionJobCreatorService.createExecutorByJobName(uftExecutorJobNameWithTestRunner);
-			return project;
+			return TestExecutionJobCreatorService.createExecutorByJobName(uftExecutorJobNameWithTestRunner);
 		} catch (Exception e) {
 			logger.warn("Failed to create createExecutor by name : " + e.getMessage());
 			return null;
@@ -541,7 +547,7 @@ private void stopImpersonation(ACLContext impersonatedContext) {
 
 	private PipelineNode createPipelineNode(String name, Job job, boolean includeParameters) {
 		PipelineNode tmpConfig = dtoFactory.newDTO(PipelineNode.class)
-				.setJobCiId(JobProcessorFactory.getFlowProcessor(job).getTranslateJobName())
+				.setJobCiId(JobProcessorFactory.getFlowProcessor(job).getTranslatedJobName())
 				.setName(name);
 		if (includeParameters) {
 			tmpConfig.setParameters(ParameterProcessors.getConfigs(job));
@@ -555,20 +561,14 @@ private PipelineNode createPipelineNodeFromJobName(String name) {
 				.setName(name);
 	}
 
-	private PipelineNode createPipelineNodeFromJobNameAndFolder(String name, String folderName) {
-		return dtoFactory.newDTO(PipelineNode.class)
-				.setJobCiId(folderName + "/" + name)
-				.setName(folderName + "/" + name);
-	}
-
 	private InputStream getOctaneLogFile(Run run) {
 		InputStream result = null;
 		String octaneLogFilePath = run.getLogFile().getParent() + File.separator + "octane_log";
 		File logFile = new File(octaneLogFilePath);
 		if (!logFile.exists()) {
 			try (FileOutputStream fileOutputStream = new FileOutputStream(logFile);
-				 InputStream logStream = run.getLogInputStream();
-				 PlainTextConsoleOutputStream out = new PlainTextConsoleOutputStream(fileOutputStream)) {
+			     InputStream logStream = run.getLogInputStream();
+			     PlainTextConsoleOutputStream out = new PlainTextConsoleOutputStream(fileOutputStream)) {
 				IOUtils.copy(logStream, out);
 				out.flush();
 			} catch (IOException ioe) {
@@ -639,8 +639,6 @@ private List<ParameterValue> createParameters(Job project, CIParameters ciParame
 							}
 							break;
 						case NUMBER:
-							tmpValue = new StringParameterValue(ciParameter.getName(), ciParameter.getValue().toString());
-							break;
 						case STRING:
 							tmpValue = new StringParameterValue(ciParameter.getName(), ciParameter.getValue().toString());
 							break;
@@ -688,7 +686,7 @@ private Job getJobByRefId(String jobRefId) {
 		Job result = null;
 		if (jobRefId != null) {
 			try {
-				jobRefId = URLDecoder.decode(jobRefId, "UTF-8");
+				jobRefId = URLDecoder.decode(jobRefId, StandardCharsets.UTF_8.name());
 				TopLevelItem item = getTopLevelItem(jobRefId);
 				if (item instanceof Job) {
 					result = (Job) item;
@@ -713,34 +711,59 @@ private Job getJobByRefId(String jobRefId) {
 	}
 
 	private Item getItemByRefId(String itemRefId) {
-		Item result = null;
-		if (itemRefId != null) {
-			try {
-				String itemRefIdUncoded = URLDecoder.decode(itemRefId, "UTF-8");
-				if (itemRefIdUncoded.contains("/")) {
-					String newItemRefId = itemRefIdUncoded.substring(0, itemRefIdUncoded.indexOf("/"));
-					Item item = getTopLevelItem(newItemRefId);
-					if (item != null && item.getClass().getName().equals(JobProcessorFactory.GITHUB_ORGANIZATION_FOLDER)) {
-						Collection<? extends Item> allItems = ((AbstractFolder) item).getItems();
-						for (Item multibranchItem : allItems) {
-							if (itemRefIdUncoded.endsWith(multibranchItem.getName())) {
-								result = multibranchItem;
-								break;
-							}
+		if (itemRefId == null) {
+			return null;
+		}
+
+		try {
+			String itemRefIdDecoded = URLDecoder.decode(itemRefId, StandardCharsets.UTF_8.name());
+			if (!itemRefIdDecoded.contains("/")) {
+				return null;
+			}
+
+			String newItemRefId = itemRefIdDecoded.substring(0, itemRefIdDecoded.indexOf('/'));
+			Item item = getTopLevelItem(newItemRefId);
+			if (item == null) {
+				return null;
+			}
+
+			Item result = null;
+			if (item.getClass().getName().equals(JobProcessorFactory.GITHUB_ORGANIZATION_FOLDER)) {
+				Collection<? extends Item> allItems = ((AbstractFolder) item).getItems();
+				for (Item multiBranchItem : allItems) {
+					if (itemRefIdDecoded.endsWith(multiBranchItem.getName())) {
+						result = multiBranchItem;
+						break;
+					}
+				}
+			} else {
+				Collection<? extends Job> allJobs = item.getAllJobs();
+				for (Job job : allJobs) {
+					if (JobProcessorFactory.WORKFLOW_MULTI_BRANCH_JOB_NAME.equals(job.getParent().getClass().getName()) &&
+							itemRefId.endsWith(job.getParent().getFullName())
+					) {
+						result = (Item) job.getParent();
+					} else {
+						if (itemRefId.endsWith(job.getName())) {
+							result = job;
 						}
 					}
+					if (result != null) {
+						break;
+					}
 				}
-			} catch (UnsupportedEncodingException uee) {
-				logger.error("failed to decode job ref ID '" + itemRefId + "'", uee);
 			}
+			return result;
+		} catch (UnsupportedEncodingException uee) {
+			logger.error("failed to decode job ref ID '" + itemRefId + "'", uee);
+			return null;
 		}
-		return result;
 	}
 
 	private TopLevelItem getTopLevelItem(String jobRefId) {
 		TopLevelItem item;
 		try {
-			item = Jenkins.getInstance().getItem(jobRefId);
+			item = Jenkins.get().getItem(jobRefId);
 		} catch (AccessDeniedException e) {
 			String user = ConfigurationService.getSettings(getInstanceId()).getImpersonatedUser();
 			if (user != null && !user.isEmpty()) {
@@ -754,7 +777,7 @@ private TopLevelItem getTopLevelItem(String jobRefId) {
 
 	public static CIServerInfo getJenkinsServerInfo() {
 		CIServerInfo result = dtoFactory.newDTO(CIServerInfo.class);
-		String serverUrl = Jenkins.getInstance().getRootUrl();
+		String serverUrl = Jenkins.get().getRootUrl();
 		if (serverUrl != null && serverUrl.endsWith("/")) {
 			serverUrl = serverUrl.substring(0, serverUrl.length() - 1);
 		}

src/main/java/com/microfocus/application/automation/tools/octane/configuration/JobConfigurationProxy.java

@@ -159,7 +159,7 @@ public JSONObject updatePipelineOnSever(JSONObject pipelineObject) {
 				fields.put(jsonObject.getString("name"), assignedValues);
 			}
 
-			final String jobCiId = JobProcessorFactory.getFlowProcessor(job).getTranslateJobName();
+			final String jobCiId = JobProcessorFactory.getFlowProcessor(job).getTranslatedJobName();
 
 			PipelineContext pipelineContext = dtoFactory.newDTO(PipelineContext.class)
 					.setContextEntityId(pipelineId)
@@ -250,7 +250,7 @@ public JSONObject loadJobConfigurationFromServer(String instanceId) {
 			}
 			ret.put("isUftJob", isUftJob);
 
-			final String jobCiId = JobProcessorFactory.getFlowProcessor(job).getTranslateJobName();
+			final String jobCiId = JobProcessorFactory.getFlowProcessor(job).getTranslatedJobName();
 			PipelineContextList pipelineContextList = octaneClient.getPipelineContextService().getJobConfiguration(octaneClient.getInstanceId(), jobCiId);
 
 			if (!pipelineContextList.getData().isEmpty()) {