Skip to content

Use reported covered lines - W-16286380 #1660

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.

Sign up for GitHub

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

Merged
peternhale merged 1 commit into from
Oct 6, 2026
Merged

Use reported covered lines - W-16286380 #1660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,5 @@ node_modules

# ignore generated nut tests
test/nuts/generated/
/.fastcontext
/.sf
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"@salesforce/kit": "^4.0.0",
"@salesforce/plugin-info": "^4.0.10",
"@salesforce/sf-plugins-core": "^13.0.4",
"@salesforce/source-deploy-retrieve": "^13.4.3",
"@salesforce/source-deploy-retrieve": "^13.4.4",
"@salesforce/source-tracking": "^8.1.1",
"@salesforce/ts-types": "^3.2.0",
"ansis": "^3.17.0",
Expand Down
23 changes: 23 additions & 0 deletions schemas/project-delete-source.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,19 @@
"id": {
"type": "string"
},
"locationsCovered": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/LocationsCovered"
}
},
{
"$ref": "#/definitions/LocationsCovered"
}
]
},
"locationsNotCovered": {
"anyOf": [
{
Expand Down Expand Up @@ -370,6 +383,16 @@
"required": ["id", "name", "numLocations", "numLocationsNotCovered", "type"],
"additionalProperties": false
},
"LocationsCovered": {
"type": "object",
"properties": {
"line": {
"type": "string"
}
},
"required": ["line"],
"additionalProperties": false
},
"LocationsNotCovered": {
"type": "object",
"properties": {
Expand Down
23 changes: 23 additions & 0 deletions schemas/project-deploy-cancel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,19 @@
"id": {
"type": "string"
},
"locationsCovered": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/LocationsCovered"
}
},
{
"$ref": "#/definitions/LocationsCovered"
}
]
},
"locationsNotCovered": {
"anyOf": [
{
Expand Down Expand Up @@ -418,6 +431,16 @@
"required": ["id", "name", "numLocations", "numLocationsNotCovered", "type"],
"additionalProperties": false
},
"LocationsCovered": {
"type": "object",
"properties": {
"line": {
"type": "string"
}
},
"required": ["line"],
"additionalProperties": false
},
"LocationsNotCovered": {
"type": "object",
"properties": {
Expand Down
23 changes: 23 additions & 0 deletions schemas/project-deploy-quick.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,19 @@
"id": {
"type": "string"
},
"locationsCovered": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/LocationsCovered"
}
},
{
"$ref": "#/definitions/LocationsCovered"
}
]
},
"locationsNotCovered": {
"anyOf": [
{
Expand Down Expand Up @@ -418,6 +431,16 @@
"required": ["id", "name", "numLocations", "numLocationsNotCovered", "type"],
"additionalProperties": false
},
"LocationsCovered": {
"type": "object",
"properties": {
"line": {
"type": "string"
}
},
"required": ["line"],
"additionalProperties": false
},
"LocationsNotCovered": {
"type": "object",
"properties": {
Expand Down
23 changes: 23 additions & 0 deletions schemas/project-deploy-report.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,19 @@
"id": {
"type": "string"
},
"locationsCovered": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/LocationsCovered"
}
},
{
"$ref": "#/definitions/LocationsCovered"
}
]
},
"locationsNotCovered": {
"anyOf": [
{
Expand Down Expand Up @@ -418,6 +431,16 @@
"required": ["id", "name", "numLocations", "numLocationsNotCovered", "type"],
"additionalProperties": false
},
"LocationsCovered": {
"type": "object",
"properties": {
"line": {
"type": "string"
}
},
"required": ["line"],
"additionalProperties": false
},
"LocationsNotCovered": {
"type": "object",
"properties": {
Expand Down
23 changes: 23 additions & 0 deletions schemas/project-deploy-resume.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,19 @@
"id": {
"type": "string"
},
"locationsCovered": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/LocationsCovered"
}
},
{
"$ref": "#/definitions/LocationsCovered"
}
]
},
"locationsNotCovered": {
"anyOf": [
{
Expand Down Expand Up @@ -418,6 +431,16 @@
"required": ["id", "name", "numLocations", "numLocationsNotCovered", "type"],
"additionalProperties": false
},
"LocationsCovered": {
"type": "object",
"properties": {
"line": {
"type": "string"
}
},
"required": ["line"],
"additionalProperties": false
},
"LocationsNotCovered": {
"type": "object",
"properties": {
Expand Down
23 changes: 23 additions & 0 deletions schemas/project-deploy-start.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,19 @@
"id": {
"type": "string"
},
"locationsCovered": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/LocationsCovered"
}
},
{
"$ref": "#/definitions/LocationsCovered"
}
]
},
"locationsNotCovered": {
"anyOf": [
{
Expand Down Expand Up @@ -418,6 +431,16 @@
"required": ["id", "name", "numLocations", "numLocationsNotCovered", "type"],
"additionalProperties": false
},
"LocationsCovered": {
"type": "object",
"properties": {
"line": {
"type": "string"
}
},
"required": ["line"],
"additionalProperties": false
},
"LocationsNotCovered": {
"type": "object",
"properties": {
Expand Down
23 changes: 23 additions & 0 deletions schemas/project-deploy-validate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,19 @@
"id": {
"type": "string"
},
"locationsCovered": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/LocationsCovered"
}
},
{
"$ref": "#/definitions/LocationsCovered"
}
]
},
"locationsNotCovered": {
"anyOf": [
{
Expand Down Expand Up @@ -418,6 +431,16 @@
"required": ["id", "name", "numLocations", "numLocationsNotCovered", "type"],
"additionalProperties": false
},
"LocationsCovered": {
"type": "object",
"properties": {
"line": {
"type": "string"
}
},
"required": ["line"],
"additionalProperties": false
},
"LocationsNotCovered": {
"type": "object",
"properties": {
Expand Down
10 changes: 8 additions & 2 deletions src/formatters/deployResultFormatter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ export class DeployResultFormatter extends TestResultsFormatter implements Forma
...mapTestResults(ensureArray(runTestResult.failures)),
],
codecoverage: ensureArray(runTestResult?.codeCoverage).map((cov): CodeCoverageResult => {
const [uncoveredLines, coveredLines] = generateCoveredLines(cov);
const [uncoveredLines, coveredLines] = generateCoveredLines(cov, this.getApiVersion());
const [numLocationsNum, numLinesUncovered] = getCoverageNumbers(cov);

return {
Expand All @@ -271,14 +271,20 @@ export class DeployResultFormatter extends TestResultsFormatter implements Forma
private createCoverageReport(sourceDir: string): void {
if (this.resultsDir) {
const apexCoverage = transformCoverageToApexCoverage(
ensureArray(this.result.response?.details?.runTestResult?.codeCoverage)
ensureArray(this.result.response?.details?.runTestResult?.codeCoverage),
this.getApiVersion()
);
fs.mkdirSync(this.resultsDir, { recursive: true });
const coverageReport = new CoverageReporter(apexCoverage, this.resultsDir, sourceDir, this.coverageOptions);
coverageReport.generateReports();
}
}

private getApiVersion(): number | undefined {
const apiVersion = this.flags['target-org']?.getConnection().getApiVersion();
return apiVersion === undefined ? undefined : Number(apiVersion);
}

private displayReplacements(): void {
if (this.verbosity === 'verbose' && this.result.replacements?.size) {
const replacements = Array.from(this.result.replacements.entries()).flatMap(([filepath, stringsReplaced]) =>
Expand Down
16 changes: 12 additions & 4 deletions src/utils/coverage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,14 @@ export const mapTestResults = <T extends Failures | Successes>(testResults: T[])
testTimestamp: '',
}));

export const generateCoveredLines = (cov: CodeCoverage): [number[], number[]] => {
const [lineCount] = getCoverageNumbers(cov);
export const generateCoveredLines = (cov: CodeCoverage, apiVersion?: number): [number[], number[]] => {
const uncoveredLines = ensureArray(cov.locationsNotCovered).map((location) => parseInt(location.line, 10));

if (apiVersion !== undefined && apiVersion >= 68.0 && cov.locationsCovered !== undefined) {
return [uncoveredLines, ensureArray(cov.locationsCovered).map((location) => parseInt(location.line, 10))];
}

const [lineCount] = getCoverageNumbers(cov);
const minLineNumber = uncoveredLines.length ? Math.min(...uncoveredLines) : 1;
const lines = [...Array(lineCount).keys()].map((i) => i + minLineNumber);
const coveredLines = lines.filter((line) => !uncoveredLines.includes(line));
Expand Down Expand Up @@ -78,10 +83,13 @@ export const getCoverageFormattersOptions = (formatters: string[] = []): Coverag
};
};

export const transformCoverageToApexCoverage = (mdCoverage: CodeCoverage[]): ApexCodeCoverageAggregate => {
export const transformCoverageToApexCoverage = (
mdCoverage: CodeCoverage[],
apiVersion?: number
): ApexCodeCoverageAggregate => {
const apexCoverage = mdCoverage.map((cov): ApexCodeCoverageAggregateRecord => {
const [NumLinesCovered, NumLinesUncovered] = getCoverageNumbers(cov);
const [uncoveredLines, coveredLines] = generateCoveredLines(cov);
const [uncoveredLines, coveredLines] = generateCoveredLines(cov, apiVersion);

return {
ApexClassOrTrigger: {
Expand Down
35 changes: 34 additions & 1 deletion test/utils/coverage.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,13 @@
import { expect } from 'chai';
import { ApexTestResultOutcome } from '@salesforce/apex-node';
import { StandardColors } from '@salesforce/sf-plugins-core';
import { coverageOutput, generateCoveredLines, getCoveragePct, mapTestResults } from '../../src/utils/coverage.js';
import {
coverageOutput,
generateCoveredLines,
getCoveragePct,
mapTestResults,
transformCoverageToApexCoverage,
} from '../../src/utils/coverage.js';

// methods are mutating the object instead of returning new ones
function getSampleTestResult() {
Expand Down Expand Up @@ -385,6 +391,33 @@ describe('coverage utils', () => {
it('will generate covered lines correctly', () => {
expect(generateCoveredLines(getSampleTestResult().codeCoverage[0])).to.deep.equal([[12], [13, 14, 15]]);
});

it('uses locationsCovered at API version 68 or later', () => {
const coverage = {
...getSampleTestResult().codeCoverage[0],
locationsCovered: [{ line: '4' }, { line: '8' }, { line: '10' }],
};

expect(generateCoveredLines(coverage, 68)).to.deep.equal([[12], [4, 8, 10]]);
expect(transformCoverageToApexCoverage([coverage], 68).records[0].Coverage).to.deep.equal({
coveredLines: [4, 8, 10],
uncoveredLines: [12],
});
});

it('uses inferred covered lines before API version 68', () => {
const coverage = {
...getSampleTestResult().codeCoverage[0],
locationsCovered: [{ line: '4' }, { line: '8' }, { line: '10' }],
};

expect(generateCoveredLines(coverage, 67)).to.deep.equal([[12], [13, 14, 15]]);
});

it('uses inferred covered lines when a v68 response omits locationsCovered', () => {
expect(generateCoveredLines(getSampleTestResult().codeCoverage[0], 68)).to.deep.equal([[12], [13, 14, 15]]);
});

it('rounds 3 uncovered out of 44 to the nearest integer', () => {
expect(getCoveragePct(getSampleTestResult().codeCoverage[1])).equal(93);
});
Expand Down
Loading
Loading