Skip to content

add basic logging for test failures #21023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from
22 changes: 10 additions & 12 deletions Tasks/GradleV3/Modules/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,27 @@ import { TaskResult } from 'azure-pipelines-task-lib';
/**
* Resolve task status based on code analysis run results
* @param {ICodeAnalysisResult} codeAnalysisResult - Code analysis run data
* @param {string[]} gradleOutput - Captured Gradle output
* @returns {ITaskResult} task status and message
*/
export function resolveTaskResult(codeAnalysisResult: ICodeAnalysisResult): ITaskResult {
export function resolveTaskResult(codeAnalysisResult: ICodeAnalysisResult, gradleOutput: string[]): ITaskResult {
let status: TaskResult;
let message: string = '';

let error: string = '';
if (codeAnalysisResult.gradleResult === 0) {
status = TaskResult.Succeeded;
message = 'Build succeeded.';
} else if (codeAnalysisResult.gradleResult === -1) {
}
else {
status = TaskResult.Failed;

if (codeAnalysisResult.statusFailed) {
message = `Code analysis failed. Gradle exit code: ${codeAnalysisResult.gradleResult}. Error: ${codeAnalysisResult.analysisError}`;
} else {
message = `Build failed. Gradle exit code: ${codeAnalysisResult.gradleResult}`;
}
message = `Build failed. Gradle exit code: ${codeAnalysisResult.gradleResult}`;
error = gradleOutput.join('');
}

const taskResult: ITaskResult = {
status: status,
message: message
message: message,
error: error
};

return taskResult;
}
}
21 changes: 18 additions & 3 deletions Tasks/GradleV3/gradletask.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { configureWrapperScript, isMultiModuleProject } from './Modules/project-
import { enableCodeCoverageAsync, publishTestResults, publishCodeCoverageResultsAsync, resolveCodeCoveragePreset } from './Modules/code-coverage';
import { ICodeAnalysisResult, ICodeCoveragePreset, ICodeCoverageSettings, IPublishCodeCoverageSettings, ITaskResult } from './interfaces';
import { resolveTaskResult } from './Modules/utils';
import * as stream from 'stream';

async function run() {
try {
Expand Down Expand Up @@ -139,9 +140,21 @@ async function run() {

// START: Run code analysis
const codeAnalysisResult: ICodeAnalysisResult = {};
const gradleOutput: string[] = [];
const stderrStream = new stream.Writable({
write: (chunk, encoding, callback) => {
const output = chunk.toString();
gradleOutput.push(output);
process.stderr.write(output);
callback();
}
});
const execOptions = getExecOptions();
execOptions.errStream = stderrStream;


try {
codeAnalysisResult.gradleResult = await gradleRunner.exec(getExecOptions());
codeAnalysisResult.gradleResult = await gradleRunner.exec(execOptions);
codeAnalysisResult.statusFailed = false;
codeAnalysisResult.analysisError = '';

Expand All @@ -150,7 +163,6 @@ async function run() {
codeAnalysisResult.gradleResult = -1;
codeAnalysisResult.statusFailed = true;
codeAnalysisResult.analysisError = err;

console.error(err);
tl.debug('taskRunner fail');
}
Expand All @@ -170,8 +182,11 @@ async function run() {
};
await publishCodeCoverageResultsAsync(publishCodeCoverageSettings);

const taskResult: ITaskResult = resolveTaskResult(codeAnalysisResult);
const taskResult: ITaskResult = resolveTaskResult(codeAnalysisResult, gradleOutput);
tl.setResult(taskResult.status, taskResult.message);
if(taskResult.error !== undefined && taskResult.error !== '') {
console.log(taskResult.error);
Copy link
Preview

Copilot AI Jun 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Use console.error instead of console.log when emitting error details, to ensure these messages are clearly marked as errors in the logs.

Suggested change
console.log(taskResult.error);
console.error(taskResult.error);

Copilot uses AI. Check for mistakes.

}
// END: Run code analysis
} catch (err) {
tl.setResult(tl.TaskResult.Failed, err);
Expand Down
1 change: 1 addition & 0 deletions Tasks/GradleV3/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ export interface ICodeAnalysisResult {
export interface ITaskResult {
status: TaskResult;
message: string;
error?: string;
}
2 changes: 1 addition & 1 deletion Tasks/GradleV3/task.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"author": "Microsoft Corporation",
"version": {
"Major": 3,
"Minor": 247,
"Minor": 259,
"Patch": 1
},
"releaseNotes": "Configuration of the SonarQube analysis was moved to the [SonarQube](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarqube) or [SonarCloud](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarcloud) extensions, in task `Prepare Analysis Configuration`",
Expand Down
2 changes: 1 addition & 1 deletion Tasks/GradleV3/task.loc.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"author": "Microsoft Corporation",
"version": {
"Major": 3,
"Minor": 247,
"Minor": 259,
"Patch": 1
},
"releaseNotes": "ms-resource:loc.releaseNotes",
Expand Down