sf-flow-coverage 0.4.2 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/README.md +92 -19
- package/lib/commands/flowcov/gate.d.ts +3 -0
- package/lib/commands/flowcov/gate.js +32 -4
- package/lib/commands/flowcov/gate.js.map +1 -1
- package/lib/commands/flowcov/readiness.d.ts +1 -0
- package/lib/commands/flowcov/readiness.js +16 -4
- package/lib/commands/flowcov/readiness.js.map +1 -1
- package/lib/commands/flowcov/scaffold.js +5 -1
- package/lib/commands/flowcov/scaffold.js.map +1 -1
- package/lib/core/apexTemplate.d.ts +6 -0
- package/lib/core/apexTemplate.js +107 -13
- package/lib/core/apexTemplate.js.map +1 -1
- package/lib/core/conditions.d.ts +25 -2
- package/lib/core/conditions.js +161 -13
- package/lib/core/conditions.js.map +1 -1
- package/lib/core/criteria.d.ts +8 -0
- package/lib/core/criteria.js +96 -24
- package/lib/core/criteria.js.map +1 -1
- package/lib/core/exclusions.d.ts +26 -0
- package/lib/core/exclusions.js +70 -0
- package/lib/core/exclusions.js.map +1 -0
- package/lib/core/flowFingerprint.d.ts +6 -0
- package/lib/core/flowFingerprint.js +94 -0
- package/lib/core/flowFingerprint.js.map +1 -1
- package/lib/core/flowSettings.d.ts +2 -1
- package/lib/core/flowSettings.js.map +1 -1
- package/lib/core/gate.d.ts +3 -0
- package/lib/core/gate.js +12 -0
- package/lib/core/gate.js.map +1 -1
- package/lib/core/lookupFilters.d.ts +33 -0
- package/lib/core/lookupFilters.js +139 -0
- package/lib/core/lookupFilters.js.map +1 -0
- package/lib/core/markdown.d.ts +14 -0
- package/lib/core/markdown.js +119 -0
- package/lib/core/markdown.js.map +1 -0
- package/lib/core/requiredFields.d.ts +6 -0
- package/lib/core/requiredFields.js +4 -0
- package/lib/core/requiredFields.js.map +1 -1
- package/lib/core/scaffold.d.ts +6 -0
- package/lib/core/scaffold.js +46 -2
- package/lib/core/scaffold.js.map +1 -1
- package/lib/core/toolingQuery.js.map +1 -1
- package/lib/core/validationRules.d.ts +14 -0
- package/lib/core/validationRules.js +30 -0
- package/lib/core/validationRules.js.map +1 -0
- package/lib/index.d.ts +4 -0
- package/lib/index.js +2 -0
- package/lib/index.js.map +1 -1
- package/messages/flowcov.gate.md +28 -1
- package/messages/flowcov.readiness.md +12 -0
- package/messages/flowcov.scaffold.md +1 -1
- package/oclif.manifest.json +40 -4
- package/package.json +1 -1
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { GateResult, ReadinessResult } from './types.js';
|
|
2
|
+
/** Output formats the `readiness` and `gate` commands print. */
|
|
3
|
+
export declare const OUTPUT_FORMATS: readonly ['human', 'markdown'];
|
|
4
|
+
export type OutputFormat = (typeof OUTPUT_FORMATS)[number];
|
|
5
|
+
/**
|
|
6
|
+
* The readiness report as Markdown, for a pull request comment or a GitHub job summary
|
|
7
|
+
* (`$GITHUB_STEP_SUMMARY`).
|
|
8
|
+
*/
|
|
9
|
+
export declare function readinessMarkdown(result: ReadinessResult): string;
|
|
10
|
+
/**
|
|
11
|
+
* The gate's results as Markdown, for a pull request comment or a GitHub job summary
|
|
12
|
+
* (`$GITHUB_STEP_SUMMARY`).
|
|
13
|
+
*/
|
|
14
|
+
export declare function gateMarkdown(result: GateResult): string;
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import { describeElements } from './elementCoverage.js';
|
|
2
|
+
import { deployAsActiveAdvice } from './flowSettings.js';
|
|
3
|
+
import { isProcessBuilder, PROCESS_BUILDER_ADVICE, processTypeLabel } from './flowTypes.js';
|
|
4
|
+
/** Output formats the `readiness` and `gate` commands print. */
|
|
5
|
+
export const OUTPUT_FORMATS = ['human', 'markdown'];
|
|
6
|
+
/** Text for a table cell: one line, with pipes escaped. */
|
|
7
|
+
function cell(value) {
|
|
8
|
+
return String(value ?? '')
|
|
9
|
+
.replace(/\r?\n/g, ' ')
|
|
10
|
+
.replace(/\|/g, '\\|');
|
|
11
|
+
}
|
|
12
|
+
/** An API name as inline code, so underscores and other characters show as typed. */
|
|
13
|
+
function code(name) {
|
|
14
|
+
return `\`${name.replace(/`/g, "'")}\``;
|
|
15
|
+
}
|
|
16
|
+
function table(headers, rows) {
|
|
17
|
+
return [
|
|
18
|
+
`| ${headers.join(' | ')} |`,
|
|
19
|
+
`| ${headers.map(() => '---').join(' | ')} |`,
|
|
20
|
+
...rows.map((row) => `| ${row.map(cell).join(' | ')} |`),
|
|
21
|
+
];
|
|
22
|
+
}
|
|
23
|
+
/** A GitHub alert block (`> [!WARNING]`), which other Markdown renderers show as a quote. */
|
|
24
|
+
function alert(kind, lines) {
|
|
25
|
+
if (lines.length === 0)
|
|
26
|
+
return [];
|
|
27
|
+
const body = lines.length === 1 ? lines : lines.map((line) => `- ${line}`);
|
|
28
|
+
return [`> [!${kind}]`, ...body.map((line) => `> ${line}`), ''];
|
|
29
|
+
}
|
|
30
|
+
function testNames(tests) {
|
|
31
|
+
return [...new Set(tests.map((t) => code(`${t.className}.${t.methodName}`)))].join(', ');
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* The readiness report as Markdown, for a pull request comment or a GitHub job summary
|
|
35
|
+
* (`$GITHUB_STEP_SUMMARY`).
|
|
36
|
+
*/
|
|
37
|
+
export function readinessMarkdown(result) {
|
|
38
|
+
const lines = ['## Flow coverage readiness', ''];
|
|
39
|
+
const status = result.ready
|
|
40
|
+
? '**Ready**: the org meets the coverage needed to deploy Flows as active.'
|
|
41
|
+
: `**Not ready**: add Apex tests for ${result.flowsNeeded} more Flow(s) to reach ${result.threshold}%.`;
|
|
42
|
+
lines.push(status, '', `Flow coverage: **${result.coveragePercent}%** (${result.coveredFlows} of ${result.totalFlows} active Flows and processes have a test). Threshold: ${result.threshold}%.`, '');
|
|
43
|
+
const warnings = [...result.warnings];
|
|
44
|
+
if (result.deployAsActive !== undefined) {
|
|
45
|
+
const sandbox = result.isSandbox === true;
|
|
46
|
+
const advice = deployAsActiveAdvice(result.deployAsActive, result.ready, result.threshold, sandbox);
|
|
47
|
+
// On in production but below the threshold, deployments fail: that's worth a warning.
|
|
48
|
+
if (result.deployAsActive && !result.ready && !sandbox)
|
|
49
|
+
warnings.push(advice);
|
|
50
|
+
else
|
|
51
|
+
lines.push(advice, '');
|
|
52
|
+
}
|
|
53
|
+
lines.push(...alert('WARNING', warnings));
|
|
54
|
+
if (result.processBuilderProcesses > 0) {
|
|
55
|
+
lines.push(...alert('NOTE', [
|
|
56
|
+
`${result.processBuilderProcesses} of the active Flows are Process Builder processes. ${PROCESS_BUILDER_ADVICE}`,
|
|
57
|
+
]));
|
|
58
|
+
}
|
|
59
|
+
const uncovered = result.flows.filter((f) => !f.covered);
|
|
60
|
+
if (uncovered.length > 0) {
|
|
61
|
+
const showChanges = result.flows.some((f) => f.changes !== undefined);
|
|
62
|
+
lines.push(`### Uncovered Flows (${uncovered.length})`, '', ...table(['Flow', 'Type', 'Version', ...(showChanges ? ['Changes'] : [])], uncovered.map((f) => [
|
|
63
|
+
code(f.flowName),
|
|
64
|
+
processTypeLabel(f.processType),
|
|
65
|
+
f.versionNumber,
|
|
66
|
+
...(showChanges ? [f.changes] : []),
|
|
67
|
+
])), '');
|
|
68
|
+
}
|
|
69
|
+
const covered = result.flows.filter((f) => f.covered);
|
|
70
|
+
if (covered.length > 0) {
|
|
71
|
+
const showType = covered.some((f) => isProcessBuilder(f.processType));
|
|
72
|
+
const showUncovered = covered.some((f) => (f.uncoveredElements?.length ?? 0) > 0);
|
|
73
|
+
lines.push(`### Covered Flows (${covered.length})`, '', ...table([
|
|
74
|
+
'Flow',
|
|
75
|
+
...(showType ? ['Type'] : []),
|
|
76
|
+
'Element Coverage',
|
|
77
|
+
...(showUncovered ? ['Uncovered Elements'] : []),
|
|
78
|
+
'Tests',
|
|
79
|
+
], covered.map((f) => [
|
|
80
|
+
code(f.flowName),
|
|
81
|
+
...(showType ? [processTypeLabel(f.processType)] : []),
|
|
82
|
+
`${f.elementCoveragePercent}%`,
|
|
83
|
+
...(showUncovered ? [describeElements(f.uncoveredElements ?? [])] : []),
|
|
84
|
+
testNames(f.tests),
|
|
85
|
+
])), '');
|
|
86
|
+
}
|
|
87
|
+
return `${lines.join('\n').trimEnd()}\n`;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* The gate's results as Markdown, for a pull request comment or a GitHub job summary
|
|
91
|
+
* (`$GITHUB_STEP_SUMMARY`).
|
|
92
|
+
*/
|
|
93
|
+
export function gateMarkdown(result) {
|
|
94
|
+
const lines = ['## Flow coverage gate', ''];
|
|
95
|
+
if (result.flows.length === 0) {
|
|
96
|
+
lines.push('No Flows changed. Nothing to check.');
|
|
97
|
+
return `${lines.join('\n')}\n`;
|
|
98
|
+
}
|
|
99
|
+
const failed = result.flows.filter((f) => f.status === 'fail').length;
|
|
100
|
+
lines.push(result.passed
|
|
101
|
+
? `**Passed** for ${result.flows.length} Flow(s).`
|
|
102
|
+
: `**Failed** for ${failed} of ${result.flows.length} Flow(s). See the Reason column.`, '');
|
|
103
|
+
if (result.minElementCoverage > 0) {
|
|
104
|
+
lines.push(`Each Flow needs ${result.minElementCoverage}% element coverage.`, '');
|
|
105
|
+
}
|
|
106
|
+
lines.push(...table(['Flow', 'Result', 'Element Coverage', 'Reason'], result.flows.map((f) => [
|
|
107
|
+
code(f.flowName),
|
|
108
|
+
f.status.toUpperCase(),
|
|
109
|
+
f.elementCoveragePercent === undefined ? '' : `${f.elementCoveragePercent}%`,
|
|
110
|
+
f.reason,
|
|
111
|
+
])), '');
|
|
112
|
+
const warnings = [
|
|
113
|
+
...result.flows.flatMap((f) => (f.warnings ?? []).map((warning) => `${code(f.flowName)}: ${warning}`)),
|
|
114
|
+
...result.warnings,
|
|
115
|
+
];
|
|
116
|
+
lines.push(...alert('WARNING', warnings));
|
|
117
|
+
return `${lines.join('\n').trimEnd()}\n`;
|
|
118
|
+
}
|
|
119
|
+
//# sourceMappingURL=markdown.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdown.js","sourceRoot":"","sources":["../../src/core/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAG5F,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,UAAU,CAAU,CAAC;AAG7D,2DAA2D;AAC3D,SAAS,IAAI,CAAC,KAAkC;IAC9C,OAAO,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;SACvB,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;SACtB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC3B,CAAC;AAED,qFAAqF;AACrF,SAAS,IAAI,CAAC,IAAY;IACxB,OAAO,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;AAC1C,CAAC;AAED,SAAS,KAAK,CAAC,OAAiB,EAAE,IAA+C;IAC/E,OAAO;QACL,KAAK,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI;QAC5B,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI;QAC7C,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;KACzD,CAAC;AACJ,CAAC;AAED,6FAA6F;AAC7F,SAAS,KAAK,CAAC,IAAwB,EAAE,KAAe;IACtD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAClC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC3E,OAAO,CAAC,OAAO,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,SAAS,CAAC,KAAoB;IACrC,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3F,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAuB;IACvD,MAAM,KAAK,GAAG,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK;QACzB,CAAC,CAAC,yEAAyE;QAC3E,CAAC,CAAC,qCAAqC,MAAM,CAAC,WAAW,0BAA0B,MAAM,CAAC,SAAS,IAAI,CAAC;IAC1G,KAAK,CAAC,IAAI,CACR,MAAM,EACN,EAAE,EACF,oBAAoB,MAAM,CAAC,eAAe,QAAQ,MAAM,CAAC,YAAY,OAAO,MAAM,CAAC,UAAU,wDAAwD,MAAM,CAAC,SAAS,IAAI,EACzK,EAAE,CACH,CAAC;IAEF,MAAM,QAAQ,GAAG,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC;QAC1C,MAAM,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACpG,sFAAsF;QACtF,IAAI,MAAM,CAAC,cAAc,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,OAAO;YAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;;YACzE,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC9B,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC1C,IAAI,MAAM,CAAC,uBAAuB,GAAG,CAAC,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CACR,GAAG,KAAK,CAAC,MAAM,EAAE;YACf,GAAG,MAAM,CAAC,uBAAuB,uDAAuD,sBAAsB,EAAE;SACjH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IACzD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;QACtE,KAAK,CAAC,IAAI,CACR,wBAAwB,SAAS,CAAC,MAAM,GAAG,EAC3C,EAAE,EACF,GAAG,KAAK,CACN,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAChE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YACnB,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YAChB,gBAAgB,CAAC,CAAC,CAAC,WAAW,CAAC;YAC/B,CAAC,CAAC,aAAa;YACf,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACpC,CAAC,CACH,EACD,EAAE,CACH,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IACtD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;QACtE,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,iBAAiB,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAClF,KAAK,CAAC,IAAI,CACR,sBAAsB,OAAO,CAAC,MAAM,GAAG,EACvC,EAAE,EACF,GAAG,KAAK,CACN;YACE,MAAM;YACN,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7B,kBAAkB;YAClB,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAChD,OAAO;SACR,EACD,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YAChB,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACtD,GAAG,CAAC,CAAC,sBAAsB,GAAG;YAC9B,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACvE,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;SACnB,CAAC,CACH,EACD,EAAE,CACH,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;AAC3C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAkB;IAC7C,MAAM,KAAK,GAAG,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;IAC5C,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;QAClD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACjC,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IACtE,KAAK,CAAC,IAAI,CACR,MAAM,CAAC,MAAM;QACX,CAAC,CAAC,kBAAkB,MAAM,CAAC,KAAK,CAAC,MAAM,WAAW;QAClD,CAAC,CAAC,kBAAkB,MAAM,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,kCAAkC,EACxF,EAAE,CACH,CAAC;IACF,IAAI,MAAM,CAAC,kBAAkB,GAAG,CAAC,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,mBAAmB,MAAM,CAAC,kBAAkB,qBAAqB,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IACD,KAAK,CAAC,IAAI,CACR,GAAG,KAAK,CACN,CAAC,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,QAAQ,CAAC,EAChD,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACtB,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;QAChB,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE;QACtB,CAAC,CAAC,sBAAsB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,sBAAsB,GAAG;QAC5E,CAAC,CAAC,MAAM;KACT,CAAC,CACH,EACD,EAAE,CACH,CAAC;IACF,MAAM,QAAQ,GAAG;QACf,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;QACtG,GAAG,MAAM,CAAC,QAAQ;KACnB,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC1C,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;AAC3C,CAAC"}
|
|
@@ -22,6 +22,10 @@ export type DescribeField = {
|
|
|
22
22
|
restrictedPicklist?: boolean;
|
|
23
23
|
/** The field's default value, such as a checkbox's `true` or `false`. */
|
|
24
24
|
defaultValue?: unknown;
|
|
25
|
+
/** Set for lookups with a lookup filter; `optionalFilter` is true when the filter only warns. */
|
|
26
|
+
filteredLookupInfo?: {
|
|
27
|
+
optionalFilter?: boolean;
|
|
28
|
+
} | null;
|
|
25
29
|
/** For lookups, the relationship name used in paths such as `Account__r.Type`. */
|
|
26
30
|
relationshipName?: string | null;
|
|
27
31
|
};
|
|
@@ -67,6 +71,8 @@ export type ObjectFields = {
|
|
|
67
71
|
createOnlyFields: Record<string, string[]>;
|
|
68
72
|
/** Active picklist values per picklist field, per object, and whether the picklist rejects others. */
|
|
69
73
|
picklists: Record<string, Record<string, PicklistInfo>>;
|
|
74
|
+
/** Lookup fields with a required lookup filter, per object. */
|
|
75
|
+
filteredLookups: Record<string, string[]>;
|
|
70
76
|
/** What a new record holds in each field a test doesn't set, per object (see `unsetFieldValues`). */
|
|
71
77
|
unsetValues: Record<string, Record<string, string | null>>;
|
|
72
78
|
};
|
|
@@ -166,6 +166,7 @@ export const emptyObjectFields = () => ({
|
|
|
166
166
|
readOnlyFields: {},
|
|
167
167
|
createOnlyFields: {},
|
|
168
168
|
picklists: {},
|
|
169
|
+
filteredLookups: {},
|
|
169
170
|
unsetValues: {},
|
|
170
171
|
});
|
|
171
172
|
/** Lookup targets a test points at an existing record instead of inserting one. */
|
|
@@ -275,6 +276,9 @@ export async function loadObjectFields(objects, describe, into = emptyObjectFiel
|
|
|
275
276
|
.filter((f) => !f.createable || f.calculated || f.autoNumber)
|
|
276
277
|
.map((f) => f.name);
|
|
277
278
|
into.picklists[object] = picklistInfo(fields);
|
|
279
|
+
into.filteredLookups[object] = fields
|
|
280
|
+
.filter((f) => f.type === 'reference' && f.filteredLookupInfo && !f.filteredLookupInfo.optionalFilter)
|
|
281
|
+
.map((f) => f.name);
|
|
278
282
|
into.createOnlyFields[object] = fields
|
|
279
283
|
.filter((f) => f.createable && !f.calculated && !f.autoNumber && f.updateable === false)
|
|
280
284
|
.map((f) => f.name);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"requiredFields.js","sourceRoot":"","sources":["../../src/core/requiredFields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"requiredFields.js","sourceRoot":"","sources":["../../src/core/requiredFields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAqChD,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAEtE,SAAS,SAAS,CAAC,KAAoB,EAAE,IAAY;IACnD,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1E,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC;AACrD,CAAC;AAED,qEAAqE;AACrE,SAAS,WAAW,CAAC,KAAoB,EAAE,MAAc;IACvD,MAAM,MAAM,GAAG,qCAAqC,CAAC;IACrD,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO;QACrD,OAAO,IAAI,MAAM,CAAC,WAAW,EAAE,OAAO,MAAM,4BAA4B,CAAC;IAC3E,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,iBAAiB,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACnF,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;QAClE,OAAO,KAAK,MAAM,OAAO,MAAM,UAAU,GAAG,GAAG,CAAC;IAClD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,iBAAiB,CAAC,KAAoB;IACpD,6EAA6E;IAC7E,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC;IAC1B,CAAC;IACD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,iBAAiB;YACpB,OAAO,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAClC,KAAK,OAAO;YACV,OAAO,oBAAoB,CAAC;QAC9B,KAAK,OAAO;YACV,OAAO,cAAc,CAAC;QACxB,KAAK,KAAK;YACR,OAAO,uBAAuB,CAAC;QACjC,KAAK,KAAK,CAAC;QACX,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,SAAS;YACZ,OAAO,GAAG,CAAC;QACb,KAAK,MAAM;YACT,OAAO,cAAc,CAAC;QACxB,KAAK,UAAU;YACb,OAAO,gBAAgB,CAAC;QAC1B,KAAK,MAAM;YACT,OAAO,+BAA+B,CAAC;QACzC,KAAK,SAAS;YACZ,OAAO,OAAO,CAAC;QACjB,KAAK,UAAU,CAAC;QAChB,KAAK,eAAe,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YACpE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;YAC/D,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;QACpE,CAAC;QACD,KAAK,WAAW;YACd,OAAO,uBAAuB,CAAC,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,QAAQ,CAAC;QAC3F;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED,8GAA8G;AAC9G,MAAM,UAAU,mBAAmB,CAAC,MAAuB;IACzD,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,iBAAiB;YAAE,SAAS;QAC7E,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,IAAI,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,SAAS;QAC5F,MAAM,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACtD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAuB;IACzD,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW;YAAE,SAAS;QACtG,MAAM,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACtD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAoB;IACvD,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC5C,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC;IAC1B,CAAC;IACD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,iBAAiB;YACpB,OAAO,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACrC,KAAK,OAAO;YACV,OAAO,uBAAuB,CAAC;QACjC,KAAK,OAAO;YACV,OAAO,cAAc,CAAC;QACxB,KAAK,KAAK;YACR,OAAO,uBAAuB,CAAC;QACjC,KAAK,KAAK,CAAC;QACX,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,SAAS;YACZ,OAAO,GAAG,CAAC;QACb,KAAK,MAAM;YACT,OAAO,yBAAyB,CAAC;QACnC,KAAK,UAAU;YACb,OAAO,2BAA2B,CAAC;QACrC,KAAK,MAAM;YACT,OAAO,+BAA+B,CAAC;QACzC,KAAK,SAAS;YACZ,OAAO,MAAM,CAAC;QAChB,KAAK,UAAU,CAAC;QAChB,KAAK,eAAe,EAAE,CAAC;YACrB,MAAM,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;YACvC,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC;YAC/G,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,CAAC;QACD;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,kBAAkB,CAAC,MAAuB;IACxD,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU;YAAE,SAAS;QACxE,MAAM,KAAK,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACtD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AA2BD,oDAAoD;AACpD,MAAM,UAAU,YAAY,CAAC,MAAuB;IAClD,MAAM,SAAS,GAAiC,EAAE,CAAC;IACnD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU;YAAE,SAAS;QACxC,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACxF,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,kBAAkB,KAAK,IAAI,EAAE,CAAC;IACpF,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAiB,EAAE,CAAC,CAAC;IACpD,cAAc,EAAE,EAAE;IAClB,WAAW,EAAE,EAAE;IACf,aAAa,EAAE,EAAE;IACjB,OAAO,EAAE,EAAE;IACX,aAAa,EAAE,EAAE;IACjB,WAAW,EAAE,EAAE;IACf,cAAc,EAAE,EAAE;IAClB,gBAAgB,EAAE,EAAE;IACpB,SAAS,EAAE,EAAE;IACb,eAAe,EAAE,EAAE;IACnB,WAAW,EAAE,EAAE;CAChB,CAAC,CAAC;AAEH,mFAAmF;AACnF,MAAM,CAAC,MAAM,mBAAmB,GAA2B;IACzD,IAAI,EAAE,sBAAsB;IAC5B,OAAO,EAAE,yBAAyB;IAClC,UAAU,EAAE,+BAA+B;CAC5C,CAAC;AAEF,wGAAwG;AACxG,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC;IAC7B,eAAe;IACf,OAAO;IACP,cAAc;IACd,eAAe;IACf,SAAS;IACT,YAAY;IACZ,UAAU;CACX,CAAC,CAAC;AAEH,kGAAkG;AAClG,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAElC,uFAAuF;AACvF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAc,EAAW,EAAE,CACzD,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,mBAAmB,CAAC,CAAC;AAElE;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAuB,EAAE,WAAoB;IAC5E,MAAM,MAAM,GAAkC,EAAE,CAAC;IACjD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU;YAAE,SAAS;QACxE,MAAM,WAAW,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QACrG,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,YAAY,KAAK,IAAI,IAAI,KAAK,CAAC,YAAY,KAAK,KAAK,CAAC,EAAE,CAAC;YAC9F,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAClD,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,YAAY,KAAK,MAAM,IAAI,KAAK,CAAC,YAAY,KAAK,OAAO,CAAC,EAAE,CAAC;YACzG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC;QAC1C,CAAC;aAAM,IAAI,WAAW,EAAE,CAAC;YACvB,wDAAwD;YACxD,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;gBAC/E,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,gBAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC;YAClE,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC;YACtD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,mBAAmB,CAAC,MAAuB;IACzD,MAAM,aAAa,GAA2B,EAAE,CAAC;IACjD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,KAAK,CAAC,gBAAgB;YAAE,aAAa,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC;IAC/G,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,MAAuB;IACnD,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU;YAAE,SAAS;QAClF,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QACxC,MAAM,MAAM,GACV,OAAO,CAAC,MAAM,KAAK,CAAC;YAClB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YACZ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,mBAAmB,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjG,IAAI,MAAM;YAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;IAC3C,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAiB,EACjB,QAAwB,EACxB,IAAI,GAAiB,iBAAiB,EAAE;IAExC,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAC3C,IAAI,MAAM,IAAI,IAAI,CAAC,cAAc;YAAE,SAAS;QAC5C,IAAI,MAAoD,CAAC;QACzD,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC;QAC/D,IAAI,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;YAC/D,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC;QAC3D,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;YAC1D,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;YACvD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;YACxD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAC7C,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YAC9E,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,MAAM;iBACjC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,UAAU,CAAC;iBAC5D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;YAC9C,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,MAAM;iBAClC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,cAAc,CAAC;iBACrG,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACtB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,MAAM;iBACnC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,UAAU,KAAK,KAAK,CAAC;iBACvF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
|
package/lib/core/scaffold.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
|
+
import type { ReadLookupFilters } from './lookupFilters.js';
|
|
1
2
|
import { type DescribeObject } from './requiredFields.js';
|
|
2
3
|
import type { ScaffoldResult } from './types.js';
|
|
4
|
+
import type { ReadValidationRules } from './validationRules.js';
|
|
3
5
|
export declare const DEFAULT_APEX_API_VERSION = "65.0";
|
|
4
6
|
export type ScaffoldOptions = {
|
|
5
7
|
flowNames: string[];
|
|
@@ -13,6 +15,10 @@ export type ScaffoldOptions = {
|
|
|
13
15
|
dryRun?: boolean;
|
|
14
16
|
/** Describes sObjects in the org so generated records set their required fields. */
|
|
15
17
|
describe?: DescribeObject;
|
|
18
|
+
/** Reads each object's active validation rules, so generated records meet them where they can. */
|
|
19
|
+
validationRules?: ReadValidationRules;
|
|
20
|
+
/** Reads required lookup filters, so the parent records a test inserts meet them where they can. */
|
|
21
|
+
lookupFilters?: ReadLookupFilters;
|
|
16
22
|
};
|
|
17
23
|
/** Generates starter Apex tests for the named Flows from their metadata files in the project. */
|
|
18
24
|
export declare function scaffoldTests(options: ScaffoldOptions): Promise<ScaffoldResult>;
|
package/lib/core/scaffold.js
CHANGED
|
@@ -80,6 +80,28 @@ function grandparentObjects(objects, fields) {
|
|
|
80
80
|
.filter(([field, target]) => field in (fields.requiredFields[object] ?? {}) && canInsertParent(target))
|
|
81
81
|
.map(([, target]) => target));
|
|
82
82
|
}
|
|
83
|
+
/**
|
|
84
|
+
* Objects along the entry criteria's relationship paths (`Contact__r.Account.Type` reaches
|
|
85
|
+
* Contact, then Account), as far as the described objects go.
|
|
86
|
+
*/
|
|
87
|
+
function criteriaPathObjects(flows, fields) {
|
|
88
|
+
const objects = [];
|
|
89
|
+
for (const flow of flows) {
|
|
90
|
+
if (!flow.object)
|
|
91
|
+
continue;
|
|
92
|
+
for (const path of fieldPaths(entryCondition(flow))) {
|
|
93
|
+
let object = flow.object;
|
|
94
|
+
for (const relationship of path.slice(0, Math.min(path.length - 1, MAX_PARENT_DEPTH))) {
|
|
95
|
+
const target = fields.lookups[object]?.[fields.relationships[object]?.[relationship] ?? ''];
|
|
96
|
+
if (!target || !canInsertParent(target))
|
|
97
|
+
break;
|
|
98
|
+
objects.push(target);
|
|
99
|
+
object = target;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
return objects;
|
|
104
|
+
}
|
|
83
105
|
async function exists(path) {
|
|
84
106
|
try {
|
|
85
107
|
await access(path);
|
|
@@ -128,11 +150,33 @@ export async function scaffoldTests(options) {
|
|
|
128
150
|
for (let depth = 1; depth <= MAX_PARENT_DEPTH && level.length > 0; depth++) {
|
|
129
151
|
const fresh = [...new Set(level)].filter((object) => !(object in objectFields.requiredFields));
|
|
130
152
|
await loadObjectFields(fresh, options.describe, objectFields);
|
|
131
|
-
level =
|
|
153
|
+
level = [
|
|
154
|
+
...grandparentObjects(fresh, objectFields),
|
|
155
|
+
...criteriaPathObjects(flows.map((f) => f.flow), objectFields),
|
|
156
|
+
].filter((object) => !(object in objectFields.requiredFields));
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
const validationRules = {};
|
|
160
|
+
if (options.validationRules) {
|
|
161
|
+
// Sequential on purpose: one Tooling API query per object, then one per rule.
|
|
162
|
+
for (const object of Object.keys(objectFields.requiredFields)) {
|
|
163
|
+
const rules = await options.validationRules(object);
|
|
164
|
+
if (rules.length > 0)
|
|
165
|
+
validationRules[object] = rules;
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
const lookupFilters = {};
|
|
169
|
+
if (options.lookupFilters) {
|
|
170
|
+
for (const [object, lookups] of Object.entries(objectFields.filteredLookups)) {
|
|
171
|
+
if (lookups.length === 0)
|
|
172
|
+
continue;
|
|
173
|
+
const filters = await options.lookupFilters(object, lookups);
|
|
174
|
+
if (filters.length > 0)
|
|
175
|
+
lookupFilters[object] = filters;
|
|
132
176
|
}
|
|
133
177
|
}
|
|
134
178
|
for (const { flowName, flow } of flows) {
|
|
135
|
-
const test = generateApexTest(flow, objectFields);
|
|
179
|
+
const test = generateApexTest(flow, { ...objectFields, validationRules, lookupFilters });
|
|
136
180
|
const classPath = join(outputDir, `${test.className}.cls`);
|
|
137
181
|
if (!options.force && (await exists(classPath))) {
|
|
138
182
|
result.skipped.push({ flowName, reason: `${classPath} already exists. Use --force to overwrite.` });
|
package/lib/core/scaffold.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../../src/core/scaffold.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../../src/core/scaffold.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EACL,eAAe,EAEf,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,GAEjB,MAAM,qBAAqB,CAAC;AAI7B,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAoB/C,oDAAoD;AACpD,SAAS,eAAe,CAAC,IAAkB;IACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS;SAC3B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,UAAU,CAAC;SACvF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAoB,CAAC,CAAC;IACtC,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,eAAe,CAAC,IAAI,IAAI,CAAC,MAAM;QAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9F,8FAA8F;IAC9F,KAAK,MAAM,MAAM,IAAI,cAAc,CAAC,IAAI,CAAC;QAAE,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI;YAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAClG,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,gFAAgF;AAChF,SAAS,cAAc,CAAC,IAAkB;IACxC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,cAAc;QAAE,OAAO,EAAE,CAAC;IACjD,MAAM,MAAM,GAAG,IAAI,GAAG,CACpB,IAAI,CAAC,SAAS;SACX,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;SACtF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACtB,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;AAC7E,CAAC;AAED,yGAAyG;AACzG,SAAS,oBAAoB,CAAC,IAAkB;IAC9C,OAAO,cAAc,CAAC,IAAI,CAAC;SACxB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC;SAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,IAAkB,EAAE,aAAqC;IAChF,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACpD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;aACvC,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CAAC,KAAqB,EAAE,MAAoB;IAChE,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,4EAA4E;QAC5E,KAAK,MAAM,MAAM,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,EAAE,CAAC;YAC1E,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9D,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,QAAQ,GAAG,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC;YAChH,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC3E,MAAM,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACnF,IAAI,IAAI,IAAI,eAAe,CAAC,MAAM,CAAC;oBAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,uFAAuF;AACvF,SAAS,kBAAkB,CAAC,OAAiB,EAAE,MAAoB;IACjE,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAChC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;SACzC,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;SACtG,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAC/B,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,KAAqB,EAAE,MAAoB;IACtE,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,SAAS;QAC3B,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACpD,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YACzB,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC;gBACtF,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC5F,IAAI,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;oBAAE,MAAM;gBAC/C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACrB,MAAM,GAAG,MAAM,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,IAAY;IAChC,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,iGAAiG;AACjG,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAwB;IAC1D,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,SAAS,GACb,OAAO,CAAC,SAAS;QACjB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,kBAAkB,IAAI,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACpG,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,IAAI,wBAAwB,CAAC;IACxE,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAmB,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAE5D,MAAM,KAAK,GAAoD,EAAE,CAAC;IAClE,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;QACvD,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,QAAQ,8BAA8B,OAAO,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;YAC7G,SAAS;QACX,CAAC;QACD,IAAI,IAAkB,CAAC;QACvB,IAAI,CAAC;YACH,IAAI,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;QAClE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAG,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YACpE,SAAS;QACX,CAAC;QACD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;gBAClB,QAAQ;gBACR,MAAM,EAAE,gBAAgB,IAAI,CAAC,WAAW,IAAI,SAAS,mDAAmD;aACzG,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,YAAY,GAAG,iBAAiB,EAAE,CAAC;IACzC,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,gBAAgB,CACpB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EACnF,OAAO,CAAC,QAAQ,EAChB,YAAY,CACb,CAAC;QACF,IAAI,KAAK,GAAG,aAAa,CACvB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EACxB,YAAY,CACb,CAAC;QACF,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,gBAAgB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;YAC3E,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC;YAC/F,MAAM,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;YAC9D,KAAK,GAAG;gBACN,GAAG,kBAAkB,CAAC,KAAK,EAAE,YAAY,CAAC;gBAC1C,GAAG,mBAAmB,CACpB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EACxB,YAAY,CACb;aACF,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,MAAM,eAAe,GAAqC,EAAE,CAAC;IAC7D,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC5B,8EAA8E;QAC9E,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;YAC9D,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YACpD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;gBAAE,eAAe,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QACxD,CAAC;IACH,CAAC;IACD,MAAM,aAAa,GAAmC,EAAE,CAAC;IACzD,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE,CAAC;YAC7E,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YACnC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC7D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;gBAAE,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,KAAK,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,KAAK,EAAE,CAAC;QACvC,MAAM,IAAI,GAAG,gBAAgB,CAAC,IAAI,EAAE,EAAE,GAAG,YAAY,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC,CAAC;QACzF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,SAAS,MAAM,CAAC,CAAC;QAC3D,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,4CAA4C,EAAE,CAAC,CAAC;YACpG,SAAS;QACX,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5C,MAAM,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9C,MAAM,SAAS,CAAC,GAAG,SAAS,WAAW,EAAE,gBAAgB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;QACjF,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"toolingQuery.js","sourceRoot":"","sources":["../../src/core/toolingQuery.ts"],"names":[],"mappings":"AAMA,MAAM,SAAS,GAAG,SAAS,CAAC;AAE5B,mGAAmG;AACnG,MAAM,UAAU,YAAY,CAAC,UAAuC;IAClE,OAAO,KAAK,EAAqC,IAAY,EAAgB,EAAE;QAC7E,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,KAAK,CAAI,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACjG,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC,CAAC;AACJ,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,SAAS,CAAC,UAAqC;IAC7D,OAAO,KAAK,EAAqC,IAAY,EAAgB,EAAE,CAC7E,CAAC,MAAM,UAAU,CAAC,KAAK,CAAI,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AACxF,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,YAAY,CAAC,UAAwC;IACnE,OAAO,KAAK,EAAE,IAAY,EAAE,
|
|
1
|
+
{"version":3,"file":"toolingQuery.js","sourceRoot":"","sources":["../../src/core/toolingQuery.ts"],"names":[],"mappings":"AAMA,MAAM,SAAS,GAAG,SAAS,CAAC;AAE5B,mGAAmG;AACnG,MAAM,UAAU,YAAY,CAAC,UAAuC;IAClE,OAAO,KAAK,EAAqC,IAAY,EAAgB,EAAE;QAC7E,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,KAAK,CAAI,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACjG,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC,CAAC;AACJ,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,SAAS,CAAC,UAAqC;IAC7D,OAAO,KAAK,EAAqC,IAAY,EAAgB,EAAE,CAC7E,CAAC,MAAM,UAAU,CAAC,KAAK,CAAI,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AACxF,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,YAAY,CAAC,UAAwC;IACnE,OAAO,KAAK,EAAE,IAAY,EAAE,QAA2B,EAAoB,EAAE,CAC3E,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAqD,EAAE,QAAkB,CAAC,CAAC;AACxG,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,cAAc,CAAC,UAAwC;IACrE,OAAO,KAAK,EAAE,UAAkB,EAA2B,EAAE;QAC3D,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QACrD,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAoC,EAAE,eAAe,EAAE,MAAM,CAAC,eAAe,EAAE,CAAC;IAC1G,CAAC,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { ToolingQuery } from './types.js';
|
|
2
|
+
/** An active validation rule: its name, error condition formula, and message. */
|
|
3
|
+
export type ValidationRule = {
|
|
4
|
+
name: string;
|
|
5
|
+
formula: string;
|
|
6
|
+
message?: string;
|
|
7
|
+
};
|
|
8
|
+
/** Reads the active validation rules of an object. Empty when they can't be read. */
|
|
9
|
+
export type ReadValidationRules = (object: string) => Promise<ValidationRule[]>;
|
|
10
|
+
/**
|
|
11
|
+
* Reads validation rules through the Tooling API. The error condition formula is only in a
|
|
12
|
+
* rule's `Metadata`, which the Tooling API returns one row at a time, so each rule takes a query.
|
|
13
|
+
*/
|
|
14
|
+
export declare function validationRuleReader(query: ToolingQuery): ReadValidationRules;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
const quote = (value) => `'${value.replace(/\\/g, '\\\\').replace(/'/g, "\\'")}'`;
|
|
2
|
+
/**
|
|
3
|
+
* Reads validation rules through the Tooling API. The error condition formula is only in a
|
|
4
|
+
* rule's `Metadata`, which the Tooling API returns one row at a time, so each rule takes a query.
|
|
5
|
+
*/
|
|
6
|
+
export function validationRuleReader(query) {
|
|
7
|
+
return async (object) => {
|
|
8
|
+
let rules;
|
|
9
|
+
try {
|
|
10
|
+
rules = await query(`SELECT Id, ValidationName, ErrorMessage FROM ValidationRule WHERE Active = true AND EntityDefinition.QualifiedApiName = ${quote(object)}`);
|
|
11
|
+
}
|
|
12
|
+
catch {
|
|
13
|
+
return [];
|
|
14
|
+
}
|
|
15
|
+
const result = [];
|
|
16
|
+
for (const rule of rules) {
|
|
17
|
+
try {
|
|
18
|
+
const [record] = await query(`SELECT Metadata FROM ValidationRule WHERE Id = ${quote(rule.Id)}`);
|
|
19
|
+
const formula = record?.Metadata?.errorConditionFormula;
|
|
20
|
+
if (formula)
|
|
21
|
+
result.push({ name: rule.ValidationName, formula, message: rule.ErrorMessage ?? undefined });
|
|
22
|
+
}
|
|
23
|
+
catch {
|
|
24
|
+
// A rule whose formula can't be read is left out.
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
return result;
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=validationRules.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validationRules.js","sourceRoot":"","sources":["../../src/core/validationRules.ts"],"names":[],"mappings":"AAQA,MAAM,KAAK,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC;AAIlG;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAmB;IACtD,OAAO,KAAK,EAAE,MAAM,EAAE,EAAE;QACtB,IAAI,KAAmB,CAAC;QACxB,IAAI,CAAC;YACH,KAAK,GAAG,MAAM,KAAK,CACjB,2HAA2H,KAAK,CAAC,MAAM,CAAC,EAAE,CAC3I,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,MAAM,GAAqB,EAAE,CAAC;QACpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC;gBACH,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,KAAK,CAC1B,kDAAkD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CACnE,CAAC;gBACF,MAAM,OAAO,GAAG,MAAM,EAAE,QAAQ,EAAE,qBAAqB,CAAC;gBACxD,IAAI,OAAO;oBAAE,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,IAAI,SAAS,EAAE,CAAC,CAAC;YAC5G,CAAC;YAAC,MAAM,CAAC;gBACP,kDAAkD;YACpD,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC"}
|
package/lib/index.d.ts
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
export { apexClassMetaXml, apexTestClassName, generateApexTest } from './core/apexTemplate.js';
|
|
2
2
|
export type { CoverageFormat } from './core/coverageFormats.js';
|
|
3
3
|
export { COVERAGE_FORMATS, formatCoverage } from './core/coverageFormats.js';
|
|
4
|
+
export type { Exclusion } from './core/exclusions.js';
|
|
5
|
+
export { findExclusion, IGNORE_FILE, parseIgnoreFile, readIgnoreFile } from './core/exclusions.js';
|
|
4
6
|
export type { DataQuery, MetadataRead } from './core/flowSettings.js';
|
|
5
7
|
export { COUNTED_PROCESS_TYPES, DEFAULT_THRESHOLD, isCountedProcessType } from './core/flowTypes.js';
|
|
6
8
|
export { parseFlowXml } from './core/flowXml.js';
|
|
7
9
|
export type { GateCandidate, GateOptions } from './core/gate.js';
|
|
8
10
|
export { collectChangedFlows, evaluateGate } from './core/gate.js';
|
|
11
|
+
export type { OutputFormat } from './core/markdown.js';
|
|
12
|
+
export { gateMarkdown, OUTPUT_FORMATS, readinessMarkdown } from './core/markdown.js';
|
|
9
13
|
export { OrgCoverageSource } from './core/orgCoverageSource.js';
|
|
10
14
|
export type { ReadinessOptions } from './core/readiness.js';
|
|
11
15
|
export { buildReadinessReport } from './core/readiness.js';
|
package/lib/index.js
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
export { apexClassMetaXml, apexTestClassName, generateApexTest } from './core/apexTemplate.js';
|
|
2
2
|
export { COVERAGE_FORMATS, formatCoverage } from './core/coverageFormats.js';
|
|
3
|
+
export { findExclusion, IGNORE_FILE, parseIgnoreFile, readIgnoreFile } from './core/exclusions.js';
|
|
3
4
|
export { COUNTED_PROCESS_TYPES, DEFAULT_THRESHOLD, isCountedProcessType } from './core/flowTypes.js';
|
|
4
5
|
export { parseFlowXml } from './core/flowXml.js';
|
|
5
6
|
export { collectChangedFlows, evaluateGate } from './core/gate.js';
|
|
7
|
+
export { gateMarkdown, OUTPUT_FORMATS, readinessMarkdown } from './core/markdown.js';
|
|
6
8
|
export { OrgCoverageSource } from './core/orgCoverageSource.js';
|
|
7
9
|
export { buildReadinessReport } from './core/readiness.js';
|
|
8
10
|
export { requiredFieldValues } from './core/requiredFields.js';
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/F,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE7E,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AACrG,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/F,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE7E,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEnG,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AACrG,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAE3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAO/F,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC"}
|
package/messages/flowcov.gate.md
CHANGED
|
@@ -10,7 +10,9 @@ Coverage is read from FlowTestCoverage in the target org. Deploy the branch to t
|
|
|
10
10
|
|
|
11
11
|
The gate also fails a Flow when the org has no active version of it, or when its active version is older than its latest version. Both usually mean the branch was deployed inactive, so the org's coverage doesn't belong to the version in the pull request.
|
|
12
12
|
|
|
13
|
-
With --from, the gate also compares each changed Flow at --to with the org's version: process type, start
|
|
13
|
+
With --from, the gate also compares each changed Flow at --to with the org's version: its process type, start element and entry criteria, Flow properties such as the API version and label, and each element and resource: which ones exist and what each one contains, such as a decision's conditions or an assignment's values. Canvas positions and Flow Builder's own settings are ignored. A difference usually means the branch wasn't deployed to the org. By default this is a warning; use --content-check to fail instead, or to skip the comparison.
|
|
14
|
+
|
|
15
|
+
To leave out Flows a team has chosen not to test yet, such as legacy Flows, list them in a `.flowcovignore` file in --project-dir or pass --exclude. Excluded Flows are skipped, with the pattern that matched them as the reason. Exclusions only affect the gate: Salesforce still counts every active Flow toward the org-wide total that `sf flowcov readiness` reports.
|
|
14
16
|
|
|
15
17
|
For a Flow that tests run only in part, the --json output lists the elements no test runs, and a Flow that fails --min-element-coverage names them in its reason.
|
|
16
18
|
|
|
@@ -30,6 +32,10 @@ Exits with code 1 when any Flow fails.
|
|
|
30
32
|
|
|
31
33
|
<%= config.bin %> <%= command.id %> --target-org ci-sandbox --from origin/main --content-check fail
|
|
32
34
|
|
|
35
|
+
- Skip legacy Flows, and add the results to a GitHub Actions job summary:
|
|
36
|
+
|
|
37
|
+
<%= config.bin %> <%= command.id %> --target-org ci-sandbox --from origin/main --exclude "Legacy_*" --output-format markdown >> "$GITHUB_STEP_SUMMARY"
|
|
38
|
+
|
|
33
39
|
- Check named Flows without git:
|
|
34
40
|
|
|
35
41
|
<%= config.bin %> <%= command.id %> --target-org ci-sandbox --flow Account_After_Save --flow Close_Cases
|
|
@@ -62,6 +68,27 @@ What to do when a changed Flow's content differs from the org's version.
|
|
|
62
68
|
|
|
63
69
|
"warn" prints a warning, "fail" fails a Flow that would otherwise pass, and "off" skips the comparison (and its one Tooling API query per Flow). Only applies with --from.
|
|
64
70
|
|
|
71
|
+
# flags.exclude.summary
|
|
72
|
+
|
|
73
|
+
Flow API name or file path pattern for a Flow the gate skips.
|
|
74
|
+
|
|
75
|
+
# flags.exclude.description
|
|
76
|
+
|
|
77
|
+
A pattern without "/" matches Flow API names, ignoring case; a pattern with "/" matches file paths from the repository root. "*" matches any characters except "/", "**" matches any characters, and "?" matches one character. A path ending in "/" matches everything under it. Patterns add to those in .flowcovignore, which lists one pattern per line with an optional "# reason" after it:
|
|
78
|
+
|
|
79
|
+
# Deferred until the Q3 rewrite
|
|
80
|
+
Legacy_*
|
|
81
|
+
Close_Old_Cases # replaced by Case_Closure next release
|
|
82
|
+
force-app/main/legacy/
|
|
83
|
+
|
|
65
84
|
# error.noInput
|
|
66
85
|
|
|
67
86
|
Provide --from to check changed Flows, or --flow to check named Flows.
|
|
87
|
+
|
|
88
|
+
# flags.output-format.summary
|
|
89
|
+
|
|
90
|
+
Format of the report printed to standard output.
|
|
91
|
+
|
|
92
|
+
# flags.output-format.description
|
|
93
|
+
|
|
94
|
+
"human" prints tables and warnings to the terminal. "markdown" prints the results as one Markdown document, warnings included, for a pull request comment or a GitHub Actions job summary. Redirect it to a file, for example `>> "$GITHUB_STEP_SUMMARY"`. --json takes precedence over both.
|
|
@@ -24,6 +24,10 @@ The report also says whether "Deploy processes and flows as active" is already o
|
|
|
24
24
|
|
|
25
25
|
<%= config.bin %> <%= command.id %> --target-org prod --fail-if-not-ready
|
|
26
26
|
|
|
27
|
+
- Add the report to a GitHub Actions job summary:
|
|
28
|
+
|
|
29
|
+
<%= config.bin %> <%= command.id %> --target-org prod --output-format markdown >> "$GITHUB_STEP_SUMMARY"
|
|
30
|
+
|
|
27
31
|
# flags.project-dir.summary
|
|
28
32
|
|
|
29
33
|
Git repository used to rank uncovered Flows by how often they change.
|
|
@@ -39,3 +43,11 @@ Coverage percentage the org must reach.
|
|
|
39
43
|
# flags.fail-if-not-ready.summary
|
|
40
44
|
|
|
41
45
|
Exit with code 1 when the org is below the threshold.
|
|
46
|
+
|
|
47
|
+
# flags.output-format.summary
|
|
48
|
+
|
|
49
|
+
Format of the report printed to standard output.
|
|
50
|
+
|
|
51
|
+
# flags.output-format.description
|
|
52
|
+
|
|
53
|
+
"human" prints tables and warnings to the terminal. "markdown" prints the report as one Markdown document, warnings included, for a pull request comment or a GitHub Actions job summary. Redirect it to a file, for example `>> "$GITHUB_STEP_SUMMARY"`. --json takes precedence over both.
|
|
@@ -4,7 +4,7 @@ Generate starter Apex tests for Flows.
|
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
Reads each Flow's metadata file from the project and writes an Apex test class named `<Flow>_FlowTest` that runs it: record-triggered Flows get a record built from the trigger object and entry criteria, autolaunched Flows are started with Flow.Interview and their input variables, and platform event Flows publish the event. When a target org is available (--target-org or a default org), the command describes each object the test creates and fills in its required fields, the fields the entry criteria need, and parent records (and their parents) for required lookups.
|
|
7
|
+
Reads each Flow's metadata file from the project and writes an Apex test class named `<Flow>_FlowTest` that runs it: record-triggered Flows get a record built from the trigger object and entry criteria, autolaunched Flows are started with Flow.Interview and their input variables, and platform event Flows publish the event. When a target org is available (--target-org or a default org), the command describes each object the test creates and fills in its required fields, the fields the entry criteria need, and parent records (and their parents) for required lookups. It also reads each object's active validation rules: a record the test saves (the triggering record on insert and on update, parents, and input records) gets the field values that keep a rule from blocking it, and a rule it can't avoid gets a TODO that names it. Required lookup filters (on standard and custom lookups) are met the same way: a parent record the test inserts gets the field values the filter needs.
|
|
8
8
|
|
|
9
9
|
Entry criteria are read as one condition, whether they are filters (with AND, OR, or custom logic) or a formula. The command meets one branch of an OR, and handles comparisons with literals, other fields, `$User.Id`, and `TODAY()`; `$Record__Prior` values in update tests; and fields on related records, which it sets on the parent record it inserts.
|
|
10
10
|
|