Refactor PhabricatorNotifier comment builder #48
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| // Copyright (c) 2015 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package com.uber.jenkins.phabricator; | ||
|
|
||
| import com.uber.jenkins.phabricator.utils.CommonUtils; | ||
| import com.uber.jenkins.phabricator.utils.Logger; | ||
| import hudson.model.Result; | ||
| import hudson.plugins.cobertura.Ratio; | ||
| import hudson.plugins.cobertura.targets.CoverageMetric; | ||
| import hudson.plugins.cobertura.targets.CoverageResult; | ||
|
|
||
| public class CommentBuilder { | ||
| private static final String UBERALLS_TAG = "uberalls"; | ||
| private final Logger logger; | ||
| private final CoverageResult currentCoverage; | ||
| private final StringBuilder comment; | ||
| private final String buildURL; | ||
| private final Result result; | ||
|
|
||
| public CommentBuilder(Logger logger, Result result, CoverageResult currentCoverage, String buildURL) { | ||
| this.logger = logger; | ||
| this.result = result; | ||
| this.currentCoverage = currentCoverage; | ||
| this.buildURL = buildURL; | ||
| this.comment = new StringBuilder(); | ||
| } | ||
|
|
||
| /** | ||
| * Get the final comment to post to Phabricator | ||
| * @return | ||
| */ | ||
| public String getComment() { | ||
| return comment.toString(); | ||
| } | ||
|
|
||
| /** | ||
| * Determine whether to attempt to process coverage | ||
| * @return | ||
| */ | ||
| public boolean hasCoverageAvailable() { | ||
| if (currentCoverage == null) { | ||
| return false; | ||
| } | ||
|
|
||
| Ratio lineCoverage = currentCoverage.getCoverage(CoverageMetric.LINE); | ||
| return lineCoverage != null; | ||
| } | ||
|
|
||
| /** | ||
| * Query uberalls for parent coverage and add appropriate comment | ||
| * @param parentCoverage the parent coverage returned from uberalls | ||
| * @param branchName the name of the current branch | ||
| */ | ||
| public void processParentCoverage(CodeCoverageMetrics parentCoverage, String branchName) { | ||
| if (parentCoverage == null) { | ||
| logger.info(UBERALLS_TAG, "unable to find coverage for parent commit"); | ||
| return; | ||
| } | ||
|
|
||
| Ratio lineCoverage = currentCoverage.getCoverage(CoverageMetric.LINE); | ||
| Float lineCoveragePercent = lineCoverage.getPercentageFloat(); | ||
|
|
||
| logger.info(UBERALLS_TAG, "line coverage: " + lineCoveragePercent); | ||
| logger.info(UBERALLS_TAG, "found parent coverage as " + parentCoverage.getLineCoveragePercent()); | ||
|
|
||
| float coverageDelta = lineCoveragePercent - parentCoverage.getLineCoveragePercent(); | ||
|
|
||
| String coverageDeltaDisplay = String.format("%.3f", coverageDelta); | ||
| String lineCoverageDisplay = String.format("%.3f", lineCoveragePercent); | ||
|
|
||
| if (coverageDelta > 0) { | ||
| comment.append("Coverage increased (+" + coverageDeltaDisplay + "%) to " + lineCoverageDisplay + "%"); | ||
| } else if (coverageDelta < 0) { | ||
| comment.append("Coverage decreased (" + coverageDeltaDisplay + "%) to " + lineCoverageDisplay + "%"); | ||
| } else { | ||
| comment.append("Coverage remained the same (" + lineCoverageDisplay + "%)"); | ||
| } | ||
|
|
||
| comment.append(" when pulling **" + branchName + "** into "); | ||
| comment.append(parentCoverage.getSha1().substring(0, 7)); | ||
| comment.append(". See " + buildURL + "cobertura for the coverage report"); | ||
| } | ||
|
|
||
| public void processBuildResult(boolean commentOnSuccess, boolean commentWithConsoleLinkOnFailure, boolean runHarbormaster) { | ||
| if (result == result.SUCCESS) { | ||
| if (comment.length() == 0 && (commentOnSuccess || !runHarbormaster)) { | ||
| comment.append("Build is green"); | ||
| } | ||
| } else if (result == Result.UNSTABLE) { | ||
| comment.append("Build is unstable"); | ||
| } else if (result == Result.FAILURE) { | ||
| if (!runHarbormaster || commentWithConsoleLinkOnFailure) { | ||
| comment.append("Build has FAILED"); | ||
| } | ||
| } else if (result == Result.ABORTED) { | ||
| comment.append("Build was aborted"); | ||
| } else { | ||
| logger.info(UBERALLS_TAG, "Unknown build status " + result.toString()); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Add user-defined content via a .phabricator-comment file | ||
| * @param customComment the contents of the file | ||
| */ | ||
| public void addUserComment(String customComment) { | ||
| if (CommonUtils.isBlank(customComment)) { | ||
| return; | ||
| } | ||
|
|
||
| // Ensure we separate previous parts of the comment with newlines | ||
| if (hasComment()) { | ||
| comment.append("\n\n"); | ||
| } | ||
| comment.append(String.format("```\n%s\n```\n\n", customComment)); | ||
| } | ||
|
|
||
| /** | ||
| * Determine if there exists a comment already | ||
| * @return | ||
| */ | ||
| public boolean hasComment() { | ||
| return comment.length() > 0; | ||
| } | ||
|
|
||
| /** | ||
| * Add a build link to the comment | ||
| */ | ||
| public void addBuildLink() { | ||
| comment.append(String.format(" %s for more details.", buildURL)); | ||
| } | ||
|
|
||
| /** | ||
| * Add a build failure message to the comment | ||
| */ | ||
| public void addBuildFailureMessage() { | ||
| comment.append(String.format("\n\nLink to build: %s", buildURL)); | ||
| comment.append(String.format("\nSee console output for more information: %sconsole", buildURL)); | ||
| } | ||
| } | ||
This file contains 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.
Can simplify this to:
return currentCoverage != null && currentCoverage.getCoverage(CoverageMetric.LINE) != null;
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.
Good call. Done.