Adding parent-child job support to the pipeline job. #92
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,25 +9,29 @@ | |
| import hudson.Extension; | ||
| import hudson.init.InitMilestone; | ||
| import hudson.init.Initializer; | ||
| import hudson.model.Job; | ||
| import hudson.model.Result; | ||
| import hudson.model.Run; | ||
| import java.sql.Timestamp; | ||
| import java.time.Instant; | ||
| import java.io.Serializable; | ||
| import jenkins.model.Jenkins; | ||
| import okhttp3.*; | ||
| import org.jenkinsci.plugins.workflow.job.WorkflowJob; | ||
| import java.time.temporal.ChronoUnit; | ||
| import java.io.IOException; | ||
| import java.net.HttpURLConnection; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.logging.Logger; | ||
|
|
||
| @Extension | ||
| public class QualityDashboardInit { | ||
|
|
||
| private static final Logger LOGGER = Logger.getLogger(QualityDashboardInit.class.getName()); | ||
| static QualityDashboardAPIUtil apiUtil = new QualityDashboardAPIUtil(); | ||
|
|
||
| @Initializer(after = InitMilestone.JOB_LOADED) | ||
| public static void postInstall() { | ||
| try { | ||
| initQDSetupIfRequired(); | ||
|
|
@@ -51,13 +55,15 @@ private static String exceptionToString(Throwable throwable) { | |
| private static void initQDSetupIfRequired() throws JsonProcessingException { | ||
| BrowserStackCredentials browserStackCredentials = QualityDashboardUtil.getBrowserStackCreds(); | ||
| try { | ||
| if(browserStackCredentials != null) { | ||
| apiUtil.logToQD(browserStackCredentials,"Starting plugin data export to QD"); | ||
| checkQDIntegrationAndDumpMetaData(browserStackCredentials); | ||
| } else { | ||
| LOGGER.warning("BrowserStack credentials not found. Skipping Quality Dashboard initialization."); | ||
| } | ||
| } catch (Exception e) { | ||
| try { | ||
| apiUtil.logToQD(browserStackCredentials, "Global exception in data export is:" + exceptionToString(e)); | ||
| } catch (Exception ex) { | ||
| String exceptionString = exceptionToString(ex); | ||
| apiUtil.logToQD(browserStackCredentials, "Global exception in exception data export is:" + exceptionString); | ||
|
|
@@ -69,7 +75,7 @@ private static void initQDSetupIfRequired() throws JsonProcessingException { | |
|
|
||
| private static void checkQDIntegrationAndDumpMetaData(BrowserStackCredentials browserStackCredentials) throws JsonProcessingException { | ||
| if(initialQDSetupRequired(browserStackCredentials)) { | ||
| List<PipelineInfo> allPipelines = getAllPipelines(browserStackCredentials); | ||
| if(!allPipelines.isEmpty()){ | ||
| boolean projectsSavedSuccessfully = sendPipelinesPaginated(browserStackCredentials, allPipelines); | ||
| if(projectsSavedSuccessfully) { | ||
|
|
@@ -105,41 +111,47 @@ private static boolean initialQDSetupRequired(BrowserStackCredentials browserSta | |
| return false; | ||
| } | ||
|
|
||
| private static List<PipelineInfo> getAllPipelines(BrowserStackCredentials browserStackCredentials) { | ||
| List<PipelineInfo> allPipelines = new ArrayList<>(); | ||
| Jenkins jenkins = Jenkins.getInstanceOrNull(); | ||
| Integer totalPipelines = 0; | ||
|
|
||
| if (jenkins != null) { | ||
| totalPipelines = jenkins.getAllItems().size(); | ||
| jenkins.getAllItems().forEach(job -> { | ||
| try { | ||
| String itemType = QualityDashboardUtil.getItemTypeModified(job); | ||
| boolean isWorkflowJob = job instanceof WorkflowJob; | ||
|
|
||
| // Logging job details | ||
| apiUtil.logToQD( | ||
| browserStackCredentials, | ||
| String.format( | ||
| "Job name: %s, instance type: %s, and is_workflow_job: %s", | ||
| job.getName(), | ||
| itemType, | ||
| isWorkflowJob ? "yes" : "no" | ||
| ) | ||
| ); | ||
| if (itemType != null && !itemType.equals("FOLDER")) { | ||
| String pipelineName = job.getFullName(); | ||
| allPipelines.add(new PipelineInfo(pipelineName, itemType)); | ||
| } | ||
| else{ | ||
| apiUtil.logToQD(browserStackCredentials, "Skipping job or Folder: " + job.getName() + " as it is not a Job or Folder instance"); | ||
| } | ||
|
|
||
| } catch (JsonProcessingException e) { | ||
| // Handling the exception and logging an error | ||
| LOGGER.warning("Error processing JSON for job: " + job.getName() + " - " + e.getMessage()); | ||
| e.printStackTrace(); | ||
| } | ||
| }); | ||
| } else { | ||
| try { | ||
| apiUtil.logToQD(browserStackCredentials, "Issue getting Jenkins Instance"); | ||
| } catch (JsonProcessingException e) { | ||
| LOGGER.warning("Error logging issue with Jenkins instance."); | ||
|
There was a problem hiding this comment. Shouldn't this be error?
Contributor
Author
There was a problem hiding this comment. @karanshah-browserstack, We are logging this as a warning instead of an error because the logs appear on the user's Jenkins system. We want to avoid showing error logs to the user. |
||
| e.printStackTrace(); | ||
| } | ||
| } | ||
|
|
@@ -149,20 +161,20 @@ private static List<String> getAllPipelines(BrowserStackCredentials browserStack | |
| apiUtil.logToQD(browserStackCredentials,"Total Pipelines detected : " + allPipelines.size()); | ||
| } catch (JsonProcessingException e) { | ||
| // Handling the exception and logging an error | ||
| LOGGER.warning("Error processing JSON for total pipelines: " + e.getMessage()); | ||
| e.printStackTrace(); | ||
| } | ||
| // Returning the list of filtered pipelines | ||
| return allPipelines; | ||
| } | ||
|
|
||
| private static boolean sendPipelinesPaginated(BrowserStackCredentials browserStackCredentials, List<PipelineInfo> allPipelines) { | ||
| boolean isSuccess = true; | ||
| int pageSize = getProjectPageSize(browserStackCredentials); | ||
| List<List<PipelineInfo>> pipelinesInSmallerBatches = Lists.partition(allPipelines, pageSize); | ||
| int totalPages = !pipelinesInSmallerBatches.isEmpty() ? pipelinesInSmallerBatches.size() : 0; | ||
| int page = 0; | ||
| for(List<PipelineInfo> singlePagePipelineList : pipelinesInSmallerBatches) { | ||
| try { | ||
| page++; | ||
| ObjectMapper objectMapper = new ObjectMapper(); | ||
|
|
@@ -188,10 +200,12 @@ private static List<PipelineDetails> getAllBuilds(BrowserStackCredentials browse | |
| Jenkins jenkins = Jenkins.getInstanceOrNull(); | ||
| Instant thresholdInstant = Instant.now().minus(getHistoryForDays(browserStackCredentials), ChronoUnit.DAYS); | ||
| if (jenkins != null) { | ||
| jenkins.getAllItems().forEach(item -> { | ||
| // Support both WorkflowJob and Matrix projects (and potentially other job types) | ||
| if (item instanceof Job) { | ||
| Job<?, ?> job = (Job<?, ?>) item; | ||
| String pipelineName = job.getFullName(); | ||
| List<? extends Run<?, ?>> allBuilds = job.getBuilds(); | ||
| if(!allBuilds.isEmpty()) { | ||
| allBuilds.stream().filter(build -> Instant.ofEpochMilli(build.getTimeInMillis()).isAfter(thresholdInstant)).forEach( | ||
| build -> { | ||
|
|
@@ -201,7 +215,19 @@ private static List<PipelineDetails> getAllBuilds(BrowserStackCredentials browse | |
| long endTimeInMillis = build.getTimeInMillis(); | ||
| Timestamp endTime = new Timestamp(endTimeInMillis); | ||
| String result = overallResult != null ? overallResult.toString() : null; | ||
|
|
||
| // Get root upstream project information for QEI with build number (returns in format "project#build") | ||
| String rootUpstreamProject = ""; | ||
| String immediateParentProject = ""; | ||
| try { | ||
| rootUpstreamProject = UpstreamPipelineResolver.resolveRootUpstreamProject(build, browserStackCredentials); | ||
| immediateParentProject = UpstreamPipelineResolver.resolveImmediateUpstreamProjectForQEI(build, browserStackCredentials); | ||
| } catch (Exception e) { | ||
| LOGGER.warning("Error resolving upstream project for " + pipelineName + " build number " + buildNumber + ": " + e.getMessage()); | ||
| e.printStackTrace(); | ||
| } | ||
| PipelineDetails pipelineDetail = new PipelineDetails(pipelineName, buildNumber, duration, result, | ||
| endTime, rootUpstreamProject, immediateParentProject); | ||
| allBuildResults.add(pipelineDetail); | ||
| } | ||
| ); | ||
|
|
@@ -249,9 +275,8 @@ private static int getHistoryForDays(BrowserStackCredentials browserStackCredent | |
| } | ||
| } catch(IOException e) { | ||
| e.printStackTrace(); | ||
| } | ||
| return no_of_days; | ||
| } | ||
|
|
||
| private static int getProjectPageSize(BrowserStackCredentials browserStackCredentials) { | ||
|
|
@@ -268,9 +293,8 @@ private static int getProjectPageSize(BrowserStackCredentials browserStackCreden | |
| } | ||
| } catch(IOException e) { | ||
| e.printStackTrace(); | ||
| } | ||
| return projectPageSize; | ||
| } | ||
|
|
||
| private static int getResultPageSize(BrowserStackCredentials browserStackCredentials) { | ||
|
|
@@ -287,9 +311,8 @@ private static int getResultPageSize(BrowserStackCredentials browserStackCredent | |
| } | ||
| } catch(IOException e) { | ||
| e.printStackTrace(); | ||
| } | ||
| return resultPageSize; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -307,13 +330,35 @@ class PipelineDetails { | |
|
|
||
| @JsonProperty("endTime") | ||
| private Timestamp endTime; | ||
|
|
||
| @JsonProperty("rootProject") | ||
| private String rootProject; | ||
|
|
||
| @JsonProperty("immediateParentProject") | ||
| private String immediateParentProject; | ||
|
|
||
| public PipelineDetails(String pipelineName, Integer buildNumber, Long buildDuration, String buildStatus, | ||
| Timestamp endTime, String rootProject, String immediateParentProject) { | ||
| this.pipelineName = pipelineName; | ||
| this.buildNumber = buildNumber; | ||
| this.buildDuration = buildDuration; | ||
| this.buildStatus = buildStatus; | ||
| this.endTime = endTime; | ||
| this.rootProject = rootProject; | ||
| this.immediateParentProject = immediateParentProject; | ||
| } | ||
| } | ||
|
|
||
| class PipelineInfo implements Serializable { | ||
| @JsonProperty("pipelineName") | ||
| private String pipelineName; | ||
|
|
||
| @JsonProperty("jobType") | ||
| private String jobType; | ||
|
|
||
| public PipelineInfo(String pipelineName, String jobType) { | ||
| this.pipelineName = pipelineName; | ||
| this.jobType = jobType; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -325,9 +370,9 @@ class PipelinesPaginated { | |
| private int totalPages; | ||
|
|
||
| @JsonProperty("pipelines") | ||
| private List<PipelineInfo> pipelines; | ||
|
|
||
| public PipelinesPaginated(int page, int totalPages, List<PipelineInfo> pipelines) { | ||
| this.page = page; | ||
| this.totalPages = totalPages; | ||
| this.pipelines = pipelines; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok for now but ideally it should be configurable either on client side or server side.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noted. As discussed, we will handle this in the future.