From eba5cf61f19a168460d1a0f3a98ef9787907abe9 Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Thu, 19 May 2022 14:09:49 -0500 Subject: [PATCH 01/22] @W-10184957@: Implemented telemetry. --- src/lib/DefaultRuleManager.ts | 32 ++++++++++++++++++++--- src/lib/util/SfdxUtils.ts | 48 +++++++++++++++++++++++++++++++++++ src/types.d.ts | 6 +++++ test/lib/RuleManager.test.ts | 16 ++++++++++++ 4 files changed, 99 insertions(+), 3 deletions(-) create mode 100644 src/lib/util/SfdxUtils.ts diff --git a/src/lib/DefaultRuleManager.ts b/src/lib/DefaultRuleManager.ts index 726776f6a..35ce1c5ef 100644 --- a/src/lib/DefaultRuleManager.ts +++ b/src/lib/DefaultRuleManager.ts @@ -1,8 +1,8 @@ -import {Logger, Messages, SfdxError} from '@salesforce/core'; +import {Logger, Messages, SfdxError, Lifecycle} from '@salesforce/core'; import * as assert from 'assert'; import {Stats} from 'fs'; import {inject, injectable} from 'tsyringe'; -import {EngineExecutionDescriptor, RecombinedRuleResults, Rule, RuleGroup, RuleResult, RuleTarget} from '../types'; +import {EngineExecutionDescriptor, RecombinedRuleResults, Rule, RuleGroup, RuleResult, RuleTarget, TelemetryData} from '../types'; import {isEngineFilter, RuleFilter} from './RuleFilter'; import {OutputOptions, RuleManager} from './RuleManager'; import {RuleResultRecombinator} from './formatter/RuleResultRecombinator'; @@ -10,6 +10,7 @@ import {RuleCatalog} from './services/RuleCatalog'; import {RuleEngine} from './services/RuleEngine'; import {FileHandler} from './util/FileHandler'; import {PathMatcher} from './util/PathMatcher'; +import * as SfdxUtils from './util/SfdxUtils'; import {Controller} from '../Controller'; import globby = require('globby'); import path = require('path'); @@ -109,7 +110,7 @@ export class DefaultRuleManager implements RuleManager { } this.validateRunDescriptors(runDescriptorList); - + await this.emitRunTelemetry(runDescriptorList); // Warn the user if any positive targets were skipped const unmatchedTargets = targets.filter(t => !t.startsWith('!') && !matchedTargets.has(t)); @@ -143,6 +144,31 @@ export class DefaultRuleManager implements RuleManager { } } + protected async emitRunTelemetry(runDescriptorList: RunDescriptor[]): Promise { + const runTelemetryObject: TelemetryData = { + eventName: 'ENGINE_EXECUTION' + }; + + const executedEngineNames: Set = new Set(runDescriptorList.map(d => d.engine.getName().toLowerCase())); + + const allEngines: RuleEngine[] = await Controller.getAllEngines(); + for (const engine of allEngines) { + const engineName = engine.getName().toLowerCase(); + // Instead of concatenating the engines into a string, we assign each engine to a boolean value based on + // whether it's being executed. Theoretically, that will be more useful for gathering meaningful metrics. + runTelemetryObject[engineName] = executedEngineNames.has(engineName); + } + + // We also need to capture the SFDX version. + runTelemetryObject['sfdxVersion'] = await SfdxUtils.getSfdxVersion(); + // NOTE: In addition to the information that we added here, the following useful information is always captured + // by default: + // - node version + // - plugin version + // - executed command (e.g., `scanner:run`) + await Lifecycle.getInstance().emitTelemetry(runTelemetryObject); + } + protected async resolveEngineFilters(filters: RuleFilter[], engineOptions: Map = new Map()): Promise { let filteredEngineNames: readonly string[] = null; for (const filter of filters) { diff --git a/src/lib/util/SfdxUtils.ts b/src/lib/util/SfdxUtils.ts new file mode 100644 index 000000000..3dcf9ed15 --- /dev/null +++ b/src/lib/util/SfdxUtils.ts @@ -0,0 +1,48 @@ +import childProcess = require('child_process'); +/** + * A variable to store SFDX's version number, so we don't have to keep re-running `sfdx-v` + */ +let SFDX_VERSION: string; + + +/** + * Returns the current version of SFDX installed on the machine, or "unknown" if the version cannot be determined. + */ +export async function getSfdxVersion(): Promise { + // If we already have a cached value, we can just return that instead of doing anything else. + if (SFDX_VERSION !== undefined) { + return SFDX_VERSION; + } + + // Get the output of `sfdx -v`. + let rawVersionString: string; + try { + rawVersionString = await new Promise((res, rej) => { + childProcess.exec('sfdx -v', (err, stdout, stderr) => { + if (err) { + rej(stderr); + } else { + res(stdout); + } + }); + }); + } catch (e) { + // If the command fails, then we have no way of determining what the version is. So just set it to 'unknown' and + // be done with it. + SFDX_VERSION = 'unknown'; + return SFDX_VERSION; + } + + // The actual output for `sfdx -v` is a long-ish string that has stuff we don't want. So use this regex to just get + // the SFDX version part. + const regex = /(sfdx-cli\/\d+\.\d+\.\d+)/g; + const match = regex.exec(rawVersionString); + if (match.length > 0) { + SFDX_VERSION = match[0]; + } else { + // Even if our regex didn't pull out the value that we expected it to, we can still use the results of the command. + // It'll just be more verbose than is strictly necessary, which isn't the worst thing in the world. + SFDX_VERSION = rawVersionString; + } + return SFDX_VERSION; +} diff --git a/src/types.d.ts b/src/types.d.ts index d782ab528..dc2f7c57c 100644 --- a/src/types.d.ts +++ b/src/types.d.ts @@ -16,6 +16,12 @@ export type Rule = { url?: string; } +export type TelemetryData = { + eventName: string; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + [key: string]: any; +} + export type LooseObject = { /* eslint-disable-next-line @typescript-eslint/no-explicit-any */ [key: string]: any; diff --git a/test/lib/RuleManager.test.ts b/test/lib/RuleManager.test.ts index 2695dc659..1d65e8b38 100644 --- a/test/lib/RuleManager.test.ts +++ b/test/lib/RuleManager.test.ts @@ -2,6 +2,8 @@ import {expect} from 'chai'; import path = require('path'); import Sinon = require('sinon'); +import {Lifecycle} from '@salesforce/core'; + import {Controller} from '../../src/Controller'; import {Rule, RuleGroup, RuleTarget} from '../../src/types'; @@ -25,10 +27,12 @@ const EMPTY_ENGINE_OPTIONS = new Map(); describe('RuleManager', () => { let uxSpy; + let telemetrySpy; beforeEach(() => { Sinon.createSandbox(); uxSpy = Sinon.spy(uxEvents, 'emit'); + telemetrySpy = Sinon.spy(Lifecycle.getInstance(), 'emitTelemetry'); }); afterEach(() => { @@ -194,6 +198,7 @@ describe('RuleManager', () => { for (const res of parsedRes) { expect(res.violations[0], `Message is ${res.violations[0].message}`).to.have.property("ruleName").that.is.not.null; } + Sinon.assert.callCount(telemetrySpy, 1); }); it('TS project files', async () => { @@ -210,6 +215,7 @@ describe('RuleManager', () => { for (const res of parsedRes) { expect(res.violations[0], `Message is ${res.violations[0].message}`).to.have.property("ruleName").that.is.not.null; } + Sinon.assert.callCount(telemetrySpy, 1); }); it('App project files', async () => { @@ -226,6 +232,7 @@ describe('RuleManager', () => { for (const res of parsedRes) { expect(res.violations[0], `Message is ${res.violations[0]['message']}`).to.have.property("ruleName").that.is.not.null; } + Sinon.assert.callCount(telemetrySpy, 1); }); it('All targets match', async () => { @@ -243,6 +250,7 @@ describe('RuleManager', () => { } expect(parsedRes).to.be.an("array").that.has.length(1); Sinon.assert.callCount(uxSpy, 0); + Sinon.assert.callCount(telemetrySpy, 1); }); it('Single target file does not match', async () => { @@ -254,6 +262,7 @@ describe('RuleManager', () => { expect(results).to.equal(''); Sinon.assert.calledWith(uxSpy, EVENTS.WARNING_ALWAYS, `Target: '${invalidTarget.join(', ')}' was not processed by any engines.`); + Sinon.assert.callCount(telemetrySpy, 1); }); }); @@ -279,6 +288,7 @@ describe('RuleManager', () => { expect(violation.category).to.equal(category); } } + Sinon.assert.callCount(telemetrySpy, 1); }); it('Filtering by multiple categories runs any rule in either category', async () => { @@ -299,6 +309,7 @@ describe('RuleManager', () => { expect(res.violations[0], `Message is ${res.violations[0]['message']}`).to.have.property("ruleName").that.is.not.null; expect(res.violations[0].category).to.be.oneOf(categories); } + Sinon.assert.callCount(telemetrySpy, 1); }); }); @@ -310,6 +321,7 @@ describe('RuleManager', () => { const {results} = await ruleManager.runRulesMatchingCriteria(filters, ['app'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); expect(typeof results).to.equal('string', `Output ${results} should have been a string`); expect(results).to.equal('', `Output ${results} should have been an empty string`); + Sinon.assert.callCount(telemetrySpy, 1); }); it('Single target file does not match', async () => { @@ -323,6 +335,7 @@ describe('RuleManager', () => { expect(results).to.equal(''); Sinon.assert.callCount(uxSpy, 1); Sinon.assert.calledWith(uxSpy, EVENTS.WARNING_ALWAYS, `Target: '${invalidTarget.join(', ')}' was not processed by any engines.`); + Sinon.assert.callCount(telemetrySpy, 1); }); @@ -337,6 +350,7 @@ describe('RuleManager', () => { expect(results).to.equal(''); Sinon.assert.callCount(uxSpy, 1); Sinon.assert.calledWith(uxSpy, EVENTS.WARNING_ALWAYS, `Target: '${invalidTarget.join(', ')}' was not processed by any engines.`); + Sinon.assert.callCount(telemetrySpy, 1); }); it('Multiple targets do not match', async () => { @@ -350,6 +364,7 @@ describe('RuleManager', () => { expect(results).to.equal(''); Sinon.assert.callCount(uxSpy, 1); Sinon.assert.calledWith(uxSpy, EVENTS.WARNING_ALWAYS, `Targets: '${invalidTargets.join(', ')}' were not processed by any engines.`); + Sinon.assert.callCount(telemetrySpy, 1); }); it('Some targets do not match', async () => { @@ -369,6 +384,7 @@ describe('RuleManager', () => { expect(parsedRes).to.be.an("array").that.has.length(1); Sinon.assert.callCount(uxSpy, 1); Sinon.assert.calledWith(uxSpy, EVENTS.WARNING_ALWAYS, `Targets: '${invalidTargets.join(', ')}' were not processed by any engines.`); + Sinon.assert.callCount(telemetrySpy, 1); }); }); }); From 10e5ce3e5725807fdf7756792609b708abcc52f3 Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Fri, 20 May 2022 13:40:41 -0500 Subject: [PATCH 02/22] @W-10184957@: Integrated feedback from code review. --- src/lib/DefaultRuleManager.ts | 19 +++++++++++----- src/types.d.ts | 2 ++ test/lib/RuleManager.test.ts | 42 +++++++++++++++++++++++++++++++---- 3 files changed, 53 insertions(+), 10 deletions(-) diff --git a/src/lib/DefaultRuleManager.ts b/src/lib/DefaultRuleManager.ts index 35ce1c5ef..cbaaf1d63 100644 --- a/src/lib/DefaultRuleManager.ts +++ b/src/lib/DefaultRuleManager.ts @@ -145,21 +145,28 @@ export class DefaultRuleManager implements RuleManager { } protected async emitRunTelemetry(runDescriptorList: RunDescriptor[]): Promise { + // Get the name of every engine being executed. + const executedEngineNames: Set = new Set(runDescriptorList.map(d => d.engine.getName().toLowerCase())); + // Build the base telemetry data. const runTelemetryObject: TelemetryData = { - eventName: 'ENGINE_EXECUTION' + // This property is a requirement for the object. + eventName: 'ENGINE_EXECUTION', + // Knowing how many engines are run with each execution is valuable data. + executedEnginesCount: executedEngineNames.size, + // Creating a string of all the executed engines would yield data useful for metrics. + // Note: Calling `.sort()` without an argument causes a simple less-than to be used. + executedEnginesString: JSON.stringify([...executedEngineNames.values()].sort()) }; - const executedEngineNames: Set = new Set(runDescriptorList.map(d => d.engine.getName().toLowerCase())); - const allEngines: RuleEngine[] = await Controller.getAllEngines(); for (const engine of allEngines) { const engineName = engine.getName().toLowerCase(); - // Instead of concatenating the engines into a string, we assign each engine to a boolean value based on - // whether it's being executed. Theoretically, that will be more useful for gathering meaningful metrics. + // In addition to the string, assign each engine a boolean indicating whether it was executed. This will allow + // us to perform other kinds of analytics than the string. runTelemetryObject[engineName] = executedEngineNames.has(engineName); } - // We also need to capture the SFDX version. + // Finally, we also need to capture the SFDX version. runTelemetryObject['sfdxVersion'] = await SfdxUtils.getSfdxVersion(); // NOTE: In addition to the information that we added here, the following useful information is always captured // by default: diff --git a/src/types.d.ts b/src/types.d.ts index dc2f7c57c..efb4ed499 100644 --- a/src/types.d.ts +++ b/src/types.d.ts @@ -18,6 +18,8 @@ export type Rule = { export type TelemetryData = { eventName: string; + executedEnginesCount: number; + executedEnginesString: string; // eslint-disable-next-line @typescript-eslint/no-explicit-any [key: string]: any; } diff --git a/test/lib/RuleManager.test.ts b/test/lib/RuleManager.test.ts index 1d65e8b38..83d1f2d03 100644 --- a/test/lib/RuleManager.test.ts +++ b/test/lib/RuleManager.test.ts @@ -1,16 +1,15 @@ import {expect} from 'chai'; -import path = require('path'); -import Sinon = require('sinon'); import {Lifecycle} from '@salesforce/core'; import {Controller} from '../../src/Controller'; -import {Rule, RuleGroup, RuleTarget} from '../../src/types'; +import {Rule, RuleGroup, RuleTarget, TelemetryData} from '../../src/types'; +import {ENGINE} from '../../src/Constants'; import {CategoryFilter, EngineFilter, LanguageFilter, RuleFilter, RulesetFilter} from '../../src/lib/RuleFilter'; import {DefaultRuleManager} from '../../src/lib/DefaultRuleManager'; import {OUTPUT_FORMAT, RuleManager} from '../../src/lib/RuleManager'; -import {uxEvents, EVENTS} from '../../src/lib/ScannerEvents'; +import {EVENTS, uxEvents} from '../../src/lib/ScannerEvents'; import {RuleCatalog} from '../../src/lib/services/RuleCatalog'; import {RuleEngine} from '../../src/lib/services/RuleEngine'; @@ -19,6 +18,8 @@ import {RetireJsEngine} from '../../src/lib/retire-js/RetireJsEngine'; import * as TestOverrides from '../test-related-lib/TestOverrides'; import * as TestUtils from '../TestUtils'; +import path = require('path'); +import Sinon = require('sinon'); TestOverrides.initializeTestSetup(); @@ -313,6 +314,39 @@ describe('RuleManager', () => { }); }); + describe('Test Case: Run by engine', () => { + it('Filtering by engine works as expected', async () => { + const engines = [ENGINE.RETIRE_JS, ENGINE.ESLINT]; + const filters = [new EngineFilter(engines)]; + + const {results} = await ruleManager.runRulesMatchingCriteria(filters, ['app'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + let parsedRes = null; + if (typeof results !== 'string') { + expect(false, `Invalid output: ${results}`); + } else { + parsedRes = JSON.parse(results); + } + // This result indicates that not all executed engines found violations, which is what we expected. That's fine. + expect(parsedRes).to.be.an('array').that.has.length(1, 'Wrong number of engines returned violations'); + expect(parsedRes[0].engine).to.equal('eslint', 'Wrong engine returned results'); + expect(parsedRes[0].violations.length).to.equal(1, 'Wrong number of violations found'); + Sinon.assert.callCount(telemetrySpy, 1); + const telemetryArg: TelemetryData = telemetrySpy.args[0][0]; + expect(telemetryArg.eventName).to.equal('ENGINE_EXECUTION'); + expect(telemetryArg.executedEnginesCount).to.equal(2); + expect(telemetryArg.executedEnginesString).to.equal(JSON.stringify(['eslint', 'retire-js'])); + expect(telemetryArg['pmd']).to.equal(false); + expect(telemetryArg['pmd-custom']).to.equal(false); + expect(telemetryArg['eslint']).to.equal(true); + expect(telemetryArg['eslint-lwc']).to.equal(false); + expect(telemetryArg['eslint-typescript']).to.equal(false); + expect(telemetryArg['eslint-custom']).to.equal(false); + expect(telemetryArg['retire-js']).to.equal(true); + expect(telemetryArg['cpd']).to.equal(false); + expect(telemetryArg['sfge']).to.equal(false); + }); + }) + describe('Edge Cases', () => { it('When no rules match the given criteria, an empty string is returned', async () => { // Define our preposterous filter array. From 6afb360c631c2c4fb612fb3981c7ec3ca69d2444 Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Mon, 23 May 2022 13:07:47 -0500 Subject: [PATCH 03/22] @W-10184957@: Integrated feedback from code review. --- src/lib/DefaultRuleManager.ts | 23 ++++++------- src/lib/RuleManager.ts | 6 ++-- src/lib/ScannerRunCommand.ts | 12 ++++--- src/types.d.ts | 1 + test/lib/RuleManager.test.ts | 34 +++++++++++-------- .../eslint/TypescriptEslintStrategy.test.ts | 2 +- 6 files changed, 43 insertions(+), 35 deletions(-) diff --git a/src/lib/DefaultRuleManager.ts b/src/lib/DefaultRuleManager.ts index cbaaf1d63..24419c894 100644 --- a/src/lib/DefaultRuleManager.ts +++ b/src/lib/DefaultRuleManager.ts @@ -4,13 +4,12 @@ import {Stats} from 'fs'; import {inject, injectable} from 'tsyringe'; import {EngineExecutionDescriptor, RecombinedRuleResults, Rule, RuleGroup, RuleResult, RuleTarget, TelemetryData} from '../types'; import {isEngineFilter, RuleFilter} from './RuleFilter'; -import {OutputOptions, RuleManager} from './RuleManager'; +import {RunOptions, RuleManager} from './RuleManager'; import {RuleResultRecombinator} from './formatter/RuleResultRecombinator'; import {RuleCatalog} from './services/RuleCatalog'; import {RuleEngine} from './services/RuleEngine'; import {FileHandler} from './util/FileHandler'; import {PathMatcher} from './util/PathMatcher'; -import * as SfdxUtils from './util/SfdxUtils'; import {Controller} from '../Controller'; import globby = require('globby'); import path = require('path'); @@ -68,7 +67,7 @@ export class DefaultRuleManager implements RuleManager { return this.catalog.getRulesMatchingFilters(filters); } - async runRulesMatchingCriteria(filters: RuleFilter[], targets: string[], outputOptions: OutputOptions, engineOptions: Map, runDfa = false): Promise { + async runRulesMatchingCriteria(filters: RuleFilter[], targets: string[], runOptions: RunOptions, engineOptions: Map): Promise { // Declare a variable that we can later use to store the engine results, as well as something to help us track // which engines actually ran. let results: RuleResult[] = []; @@ -88,7 +87,7 @@ export class DefaultRuleManager implements RuleManager { const engineTargets = await this.unpackTargets(e, targets, matchedTargets); this.logger.trace(`For ${e.getName()}, found ${engineGroups.length} groups, ${engineRules.length} rules, ${engineTargets.length} targets`); - if ((e.isDfaEngine() === runDfa) && e.shouldEngineRun(engineGroups, engineRules, engineTargets, engineOptions)) { + if ((e.isDfaEngine() === runOptions.runDfa) && e.shouldEngineRun(engineGroups, engineRules, engineTargets, engineOptions)) { this.logger.trace(`${e.getName()} is eligible to execute.`); executedEngines.add(e.getName()); // Create a descriptor for this engine run, but do not actually run it just yet. This is because the run @@ -100,7 +99,7 @@ export class DefaultRuleManager implements RuleManager { rules: engineRules, target: engineTargets, engineOptions: engineOptions, - normalizeSeverity: outputOptions.normalizeSeverity + normalizeSeverity: runOptions.normalizeSeverity } }); } else { @@ -110,7 +109,7 @@ export class DefaultRuleManager implements RuleManager { } this.validateRunDescriptors(runDescriptorList); - await this.emitRunTelemetry(runDescriptorList); + await this.emitRunTelemetry(runDescriptorList, runOptions.sfdxVersion); // Warn the user if any positive targets were skipped const unmatchedTargets = targets.filter(t => !t.startsWith('!') && !matchedTargets.has(t)); @@ -127,8 +126,8 @@ export class DefaultRuleManager implements RuleManager { const psResults: RuleResult[][] = await Promise.all(ps); psResults.forEach(r => results = results.concat(r)); this.logger.trace(`Received rule violations: ${JSON.stringify(results)}`); - this.logger.trace(`Recombining results into requested format ${outputOptions.format}`); - return await RuleResultRecombinator.recombineAndReformatResults(results, outputOptions.format, executedEngines); + this.logger.trace(`Recombining results into requested format ${runOptions.format}`); + return await RuleResultRecombinator.recombineAndReformatResults(results, runOptions.format, executedEngines); } catch (e) { const message: string = e instanceof Error ? e.message : e as string; throw new SfdxError(message); @@ -144,7 +143,7 @@ export class DefaultRuleManager implements RuleManager { } } - protected async emitRunTelemetry(runDescriptorList: RunDescriptor[]): Promise { + protected async emitRunTelemetry(runDescriptorList: RunDescriptor[], sfdxVersion: string): Promise { // Get the name of every engine being executed. const executedEngineNames: Set = new Set(runDescriptorList.map(d => d.engine.getName().toLowerCase())); // Build the base telemetry data. @@ -155,7 +154,8 @@ export class DefaultRuleManager implements RuleManager { executedEnginesCount: executedEngineNames.size, // Creating a string of all the executed engines would yield data useful for metrics. // Note: Calling `.sort()` without an argument causes a simple less-than to be used. - executedEnginesString: JSON.stringify([...executedEngineNames.values()].sort()) + executedEnginesString: JSON.stringify([...executedEngineNames.values()].sort()), + sfdxVersion }; const allEngines: RuleEngine[] = await Controller.getAllEngines(); @@ -165,9 +165,6 @@ export class DefaultRuleManager implements RuleManager { // us to perform other kinds of analytics than the string. runTelemetryObject[engineName] = executedEngineNames.has(engineName); } - - // Finally, we also need to capture the SFDX version. - runTelemetryObject['sfdxVersion'] = await SfdxUtils.getSfdxVersion(); // NOTE: In addition to the information that we added here, the following useful information is always captured // by default: // - node version diff --git a/src/lib/RuleManager.ts b/src/lib/RuleManager.ts index 2bc904ac0..efc370a58 100644 --- a/src/lib/RuleManager.ts +++ b/src/lib/RuleManager.ts @@ -11,9 +11,11 @@ export enum OUTPUT_FORMAT { XML = 'xml' } -export type OutputOptions = { +export type RunOptions = { format: OUTPUT_FORMAT; normalizeSeverity: boolean; + runDfa: boolean; + sfdxVersion: string; } export interface RuleManager { @@ -34,5 +36,5 @@ export interface RuleManager { /** * @param engineOptions - see RuleEngine#run */ - runRulesMatchingCriteria(filters: RuleFilter[], target: string[], outputOptions: OutputOptions, engineOptions: Map, runDfa?: boolean): Promise; + runRulesMatchingCriteria(filters: RuleFilter[], target: string[], runOptions: RunOptions, engineOptions: Map): Promise; } diff --git a/src/lib/ScannerRunCommand.ts b/src/lib/ScannerRunCommand.ts index f6f8f8d4c..4e4fb69e3 100644 --- a/src/lib/ScannerRunCommand.ts +++ b/src/lib/ScannerRunCommand.ts @@ -4,7 +4,7 @@ import {ScannerCommand} from './ScannerCommand'; import {RecombinedRuleResults} from '../types'; import {RunOutputProcessor} from './util/RunOutputProcessor'; import {Controller} from '../Controller'; -import {OUTPUT_FORMAT, OutputOptions} from './RuleManager'; +import {OUTPUT_FORMAT, RunOptions} from './RuleManager'; import untildify = require('untildify'); import normalize = require('normalize-path'); @@ -32,9 +32,11 @@ export abstract class ScannerRunCommand extends ScannerCommand { // We need to derive the output format, either from information that was explicitly provided or from default values. // We can't use the defaultValue property for the flag, because there needs to be a behavioral differenec between // defaulting to a value and having the user explicitly select it. - const outputOptions: OutputOptions = { + const runOptions: RunOptions = { format: this.determineOutputFormat(), - normalizeSeverity: normalizeSeverity + normalizeSeverity: normalizeSeverity, + runDfa: this.pathBasedEngines(), + sfdxVersion: this.config.version }; const ruleManager = await Controller.createRuleManager(); @@ -48,7 +50,7 @@ export abstract class ScannerRunCommand extends ScannerCommand { let output: RecombinedRuleResults = null; try { - output = await ruleManager.runRulesMatchingCriteria(filters, targetPaths, outputOptions, engineOptions, this.pathBasedEngines()); + output = await ruleManager.runRulesMatchingCriteria(filters, targetPaths, runOptions, engineOptions); } catch (e) { // Rethrow any errors as SFDX errors. const message: string = e instanceof Error ? e.message : e as string; @@ -56,7 +58,7 @@ export abstract class ScannerRunCommand extends ScannerCommand { } return new RunOutputProcessor({ - format: outputOptions.format, + format: runOptions.format, severityForError: this.flags['severity-threshold'] as number, outfile: this.flags.outfile as string }, this.ux) diff --git a/src/types.d.ts b/src/types.d.ts index efb4ed499..1e325af13 100644 --- a/src/types.d.ts +++ b/src/types.d.ts @@ -20,6 +20,7 @@ export type TelemetryData = { eventName: string; executedEnginesCount: number; executedEnginesString: string; + sfdxVersion: string; // eslint-disable-next-line @typescript-eslint/no-explicit-any [key: string]: any; } diff --git a/test/lib/RuleManager.test.ts b/test/lib/RuleManager.test.ts index 83d1f2d03..471c044aa 100644 --- a/test/lib/RuleManager.test.ts +++ b/test/lib/RuleManager.test.ts @@ -8,7 +8,7 @@ import {ENGINE} from '../../src/Constants'; import {CategoryFilter, EngineFilter, LanguageFilter, RuleFilter, RulesetFilter} from '../../src/lib/RuleFilter'; import {DefaultRuleManager} from '../../src/lib/DefaultRuleManager'; -import {OUTPUT_FORMAT, RuleManager} from '../../src/lib/RuleManager'; +import {OUTPUT_FORMAT, RuleManager, RunOptions} from '../../src/lib/RuleManager'; import {EVENTS, uxEvents} from '../../src/lib/ScannerEvents'; import {RuleCatalog} from '../../src/lib/services/RuleCatalog'; @@ -184,10 +184,16 @@ describe('RuleManager', () => { after(() => { process.chdir("../../.."); }); + const runOptions: RunOptions = { + format: OUTPUT_FORMAT.JSON, + normalizeSeverity: false, + runDfa: false, + sfdxVersion: 'test' + }; describe('Test Case: Run without filters', () => { it('JS project files', async () => { // If we pass an empty list into the method, that's treated as the absence of filter criteria. - const {results} = await ruleManager.runRulesMatchingCriteria([], ['js'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria([], ['js'], runOptions, EMPTY_ENGINE_OPTIONS); let parsedRes = null; if (typeof results !== "string") { expect(false, `Invalid output: ${results}`); @@ -204,7 +210,7 @@ describe('RuleManager', () => { it('TS project files', async () => { // If we pass an empty list into the method, that's treated as the absence of filter criteria. - const {results} = await ruleManager.runRulesMatchingCriteria([], ['ts'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria([], ['ts'], runOptions, EMPTY_ENGINE_OPTIONS); let parsedRes = null; if (typeof results !== "string") { expect(false, `Invalid output: ${results}`); @@ -222,7 +228,7 @@ describe('RuleManager', () => { it('App project files', async () => { // If we pass an empty list into the method, that's treated as the absence of filter criteria. - const {results} = await ruleManager.runRulesMatchingCriteria([], ['app'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria([], ['app'], runOptions, EMPTY_ENGINE_OPTIONS); let parsedRes = null; if (typeof results !== "string") { expect(false, `Invalid output: ${results}`); @@ -242,7 +248,7 @@ describe('RuleManager', () => { const categories = ['Possible Errors']; const filters = [new CategoryFilter(categories)]; - const {results} = await ruleManager.runRulesMatchingCriteria(filters, validTargets, {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria(filters, validTargets, runOptions, EMPTY_ENGINE_OPTIONS); let parsedRes = null; if (typeof results !== "string") { expect(false, `Invalid output: ${results}`); @@ -259,7 +265,7 @@ describe('RuleManager', () => { // No filters const filters = []; - const {results} = await ruleManager.runRulesMatchingCriteria(filters, invalidTarget, {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria(filters, invalidTarget, runOptions, EMPTY_ENGINE_OPTIONS); expect(results).to.equal(''); Sinon.assert.calledWith(uxSpy, EVENTS.WARNING_ALWAYS, `Target: '${invalidTarget.join(', ')}' was not processed by any engines.`); @@ -274,7 +280,7 @@ describe('RuleManager', () => { const filters = [ new CategoryFilter([category])]; - const {results} = await ruleManager.runRulesMatchingCriteria(filters, ['app'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria(filters, ['app'], runOptions, EMPTY_ENGINE_OPTIONS); let parsedRes = null; if (typeof results !== "string") { expect(false, `Invalid output: ${results}`); @@ -297,7 +303,7 @@ describe('RuleManager', () => { const categories = ['Best Practices', 'Error Prone']; const filters = [new CategoryFilter(categories)]; - const {results} = await ruleManager.runRulesMatchingCriteria(filters, ['app'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria(filters, ['app'], runOptions, EMPTY_ENGINE_OPTIONS); let parsedRes = null; if (typeof results !== "string") { expect(false, `Invalid output: ${results}`); @@ -319,7 +325,7 @@ describe('RuleManager', () => { const engines = [ENGINE.RETIRE_JS, ENGINE.ESLINT]; const filters = [new EngineFilter(engines)]; - const {results} = await ruleManager.runRulesMatchingCriteria(filters, ['app'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria(filters, ['app'], runOptions, EMPTY_ENGINE_OPTIONS); let parsedRes = null; if (typeof results !== 'string') { expect(false, `Invalid output: ${results}`); @@ -352,7 +358,7 @@ describe('RuleManager', () => { // Define our preposterous filter array. const filters = [new CategoryFilter(['beebleborp'])]; - const {results} = await ruleManager.runRulesMatchingCriteria(filters, ['app'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria(filters, ['app'], runOptions, EMPTY_ENGINE_OPTIONS); expect(typeof results).to.equal('string', `Output ${results} should have been a string`); expect(results).to.equal('', `Output ${results} should have been an empty string`); Sinon.assert.callCount(telemetrySpy, 1); @@ -364,7 +370,7 @@ describe('RuleManager', () => { const categories = ['Best Practices', 'Error Prone']; const filters = [new CategoryFilter(categories)]; - const {results} = await ruleManager.runRulesMatchingCriteria(filters, invalidTarget, {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria(filters, invalidTarget, runOptions, EMPTY_ENGINE_OPTIONS); expect(results).to.equal(''); Sinon.assert.callCount(uxSpy, 1); @@ -379,7 +385,7 @@ describe('RuleManager', () => { const categories = ['Best Practices', 'Error Prone']; const filters = [new CategoryFilter(categories)]; - const {results} = await ruleManager.runRulesMatchingCriteria(filters, invalidTarget, {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria(filters, invalidTarget, runOptions, EMPTY_ENGINE_OPTIONS); expect(results).to.equal(''); Sinon.assert.callCount(uxSpy, 1); @@ -393,7 +399,7 @@ describe('RuleManager', () => { const categories = ['Best Practices', 'Error Prone']; const filters = [new CategoryFilter(categories)]; - const {results} = await ruleManager.runRulesMatchingCriteria(filters, invalidTargets, {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria(filters, invalidTargets, runOptions, EMPTY_ENGINE_OPTIONS); expect(results).to.equal(''); Sinon.assert.callCount(uxSpy, 1); @@ -408,7 +414,7 @@ describe('RuleManager', () => { const categories = ['Possible Errors']; const filters = [new CategoryFilter(categories)]; - const {results} = await ruleManager.runRulesMatchingCriteria(filters, [...invalidTargets, ...validTargets], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria(filters, [...invalidTargets, ...validTargets], runOptions, EMPTY_ENGINE_OPTIONS); let parsedRes = null; if (typeof results !== "string") { expect(false, `Invalid output: ${results}`); diff --git a/test/lib/eslint/TypescriptEslintStrategy.test.ts b/test/lib/eslint/TypescriptEslintStrategy.test.ts index 82f3fe92a..f161cf148 100644 --- a/test/lib/eslint/TypescriptEslintStrategy.test.ts +++ b/test/lib/eslint/TypescriptEslintStrategy.test.ts @@ -273,7 +273,7 @@ describe('TypescriptEslint Strategy', () => { }); it('The typescript engine should convert the eslint error to something more user friendly', async () => { - const {results} = await ruleManager.runRulesMatchingCriteria([], ['invalid-ts'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false}, EMPTY_ENGINE_OPTIONS); + const {results} = await ruleManager.runRulesMatchingCriteria([], ['invalid-ts'], {format: OUTPUT_FORMAT.JSON, normalizeSeverity: false, runDfa: false, sfdxVersion: 'test'}, EMPTY_ENGINE_OPTIONS); // Parse the json in order to make the string match easier. // There should be a single violation with a single message const ruleResults: RuleResult[] = JSON.parse(results.toString()); From 2d763934335fd50a6c7f8d6b4a276c3b236c51d8 Mon Sep 17 00:00:00 2001 From: Grace Date: Fri, 3 Jun 2022 10:14:44 -0700 Subject: [PATCH 04/22] @W-10127077@: adds --verbose-violations flag to provide more verbose output for retire-js --- messages/run.js | 5 +- src/Constants.ts | 3 +- src/commands/scanner/run.ts | 11 ++++ src/lib/retire-js/RetireJsEngine.ts | 41 +++++++++++++-- test/lib/retire-js/RetireJsEngine.test.ts | 63 +++++++++++++++++++++-- 5 files changed, 112 insertions(+), 11 deletions(-) diff --git a/messages/run.js b/messages/run.js index 9ad1aa43a..b80fdd72e 100644 --- a/messages/run.js +++ b/messages/run.js @@ -29,7 +29,10 @@ module.exports = { 'eslintConfigDescription': 'location of eslintrc config to customize eslint engine', 'eslintConfigDescriptionLong': 'Location of eslintrc to customize eslint engine', 'pmdConfigDescription': 'location of PMD rule reference XML file to customize rule selection', - 'pmdConfigDescriptionLong': 'Location of PMD rule reference XML file to customize rule selection' + 'pmdConfigDescriptionLong': 'Location of PMD rule reference XML file to customize rule selection', + "verboseViolationsDescription": "retire-js violation messages include more details", + "verboseViolationsDescriptionLong": "retire-js violation messages contain details about each vulnerability (e.g. summary, CVE, urls, etc.)" + }, "validations": { "outfileFormatMismatch": "Your chosen format %s does not appear to match your output file type of %s.", diff --git a/src/Constants.ts b/src/Constants.ts index e874040d8..e9f153217 100644 --- a/src/Constants.ts +++ b/src/Constants.ts @@ -94,7 +94,8 @@ export const Services = { export enum CUSTOM_CONFIG { EslintConfig = "EslintConfig", PmdConfig = "PmdConfig", - SfgeConfig = "SfgeConfig" + SfgeConfig = "SfgeConfig", + VerboseViolations = "VerboseViolations" } export const HARDCODED_RULES = { diff --git a/src/commands/scanner/run.ts b/src/commands/scanner/run.ts index 0ebe3e51f..28c56dc88 100644 --- a/src/commands/scanner/run.ts +++ b/src/commands/scanner/run.ts @@ -104,6 +104,10 @@ export default class Run extends ScannerRunCommand { description: messages.getMessage('flags.nsDescription'), longDescription: messages.getMessage('flags.nsDescriptionLong') }), + "verbose-violations": flags.boolean({ + description: messages.getMessage('flags.verboseViolationsDescription'), + longDescription: messages.getMessage('flags.verboseViolationsDescriptionLong') + }), }; protected validateCommandFlags(): Promise { @@ -149,6 +153,13 @@ export default class Run extends ScannerRunCommand { const pmdConfig = normalize(untildify(this.flags.pmdconfig as string)); options.set(CUSTOM_CONFIG.PmdConfig, pmdConfig); } + + // Capturing verbose-violations flag value (used for RetireJS output) + if (this.flags["verbose-violations"]) { + options.set(CUSTOM_CONFIG.VerboseViolations, "true"); + } + + return options; } diff --git a/src/lib/retire-js/RetireJsEngine.ts b/src/lib/retire-js/RetireJsEngine.ts index 88b9204de..87d0875eb 100644 --- a/src/lib/retire-js/RetireJsEngine.ts +++ b/src/lib/retire-js/RetireJsEngine.ts @@ -10,6 +10,8 @@ import * as engineUtils from '../util/CommonEngineUtils'; import cspawn = require('cross-spawn'); import path = require('path'); import StreamZip = require('node-stream-zip'); +import {CUSTOM_CONFIG} from '../../Constants'; + // Unlike the other engines we use, RetireJS doesn't really have "rules" per se. So we sorta have to synthesize a @@ -49,6 +51,8 @@ export type RetireJsInvocation = { */ type RetireJsVulnerability = { severity: string; + identifiers?: { [name: string]: string }; + info?: string[]; }; type RetireJsResult = { @@ -172,7 +176,7 @@ export class RetireJsEngine extends AbstractRuleEngine { const retireJsPromises: Promise[] = []; for (const invocation of invocationArray) { - retireJsPromises.push(this.executeRetireJs(invocation)); + retireJsPromises.push(this.executeRetireJs(invocation, engineOptions.has(CUSTOM_CONFIG.VerboseViolations))); } // We can combine the results into a single array using .reduce() instead of the more verbose for-loop. @@ -199,7 +203,7 @@ export class RetireJsEngine extends AbstractRuleEngine { return invocationArray; } - private async executeRetireJs(invocation: RetireJsInvocation): Promise { + private async executeRetireJs(invocation: RetireJsInvocation, verboseViolations: boolean): Promise { return new Promise((res, rej) => { const cp = cspawn(RetireJsEngine.NODE_EXEC_PATH, invocation.args); @@ -225,7 +229,8 @@ export class RetireJsEngine extends AbstractRuleEngine { } else if (code === 13) { // If RetireJS exits with code 13, then it ran successfully, but found at least one vulnerability. // Convert the output into RuleResult objects and resolve to that. - res(this.processOutput(stdout, invocation.rule)); + res(this.processOutput(stdout, invocation.rule, verboseViolations)); + } else { // If RetireJS exits with any other code, then it means something went wrong. The error could be // contained in either stdout or stderr, so we'll send them both to a method for processing, and @@ -261,7 +266,7 @@ export class RetireJsEngine extends AbstractRuleEngine { return stderr; } - private processOutput(cmdOutput: string, ruleName: string): RuleResult[] { + private processOutput(cmdOutput: string, ruleName: string, verboseViolations:boolean): RuleResult[] { // The output should be a valid result JSON. try { const outputJson: RetireJsOutput = RetireJsEngine.convertStringToResultObj(cmdOutput); @@ -282,6 +287,9 @@ export class RetireJsEngine extends AbstractRuleEngine { // Each `result` entry generates one RuleViolation. for (const result of data.results) { + + const message: string = verboseViolations ? this.generateVerboseMessage(result) : `${result.component} v${result.version} is insecure. Please upgrade to latest version.`; + ruleResult.violations.push({ line: 1, column: 1, @@ -290,7 +298,7 @@ export class RetireJsEngine extends AbstractRuleEngine { severity: result.vulnerabilities .map(vuln => this.retireSevToScannerSev(vuln.severity)) .reduce((min, sev) => min > sev ? sev: min, 9000), - message: `${result.component} v${result.version} is insecure. Please upgrade to latest version.`, + message: message, category: 'Insecure Dependencies' }); } @@ -307,6 +315,29 @@ export class RetireJsEngine extends AbstractRuleEngine { } } + private generateVerboseMessage(result: RetireJsResult): string { + const messageLines: string[] = [`${result.component} ${result.version} has known vulnerabilities:`]; + + // Each `vulnerability` generates a new line in the RuleViolation's message + for (const vuln of result.vulnerabilities) { + + // Array of all identifiers with starting with severity and summary (if applicable) + const vulnMessageItems: string[] = []; + + for (const identifier in vuln.identifiers) { + const text = `${identifier}: ${vuln.identifiers[identifier]}`; + identifier === "summary" ? vulnMessageItems.unshift(text) : vulnMessageItems.push(text); + } + + vulnMessageItems.unshift(`severity: ${vuln.severity}`); // unshift after other identifiers so severity is first + vulnMessageItems.push(vuln.info.join(" ")); // list info elements separated by space + messageLines.push(`${vulnMessageItems.join("; ")}`) + + } + + return messageLines.join("\n"); + } + private retireSevToScannerSev(sev: string): number { switch (sev.toLowerCase()) { case 'low': diff --git a/test/lib/retire-js/RetireJsEngine.test.ts b/test/lib/retire-js/RetireJsEngine.test.ts index b61a222b3..5067a0bba 100644 --- a/test/lib/retire-js/RetireJsEngine.test.ts +++ b/test/lib/retire-js/RetireJsEngine.test.ts @@ -301,7 +301,7 @@ describe('RetireJsEngine', () => { }; // THIS IS THE ACTUAL METHOD BEING TESTED: Now we feed that fake result into the engine and see what we get back. - const results: RuleResult[] = (testEngine as any).processOutput(JSON.stringify(fakeRetireOutput), 'insecure-bundled-dependencies'); + const results: RuleResult[] = (testEngine as any).processOutput(JSON.stringify(fakeRetireOutput), 'insecure-bundled-dependencies', false); // Now we run our assertions. expect(results.length).to.equal(2, 'Should be two result objects because of the two spoofed files.'); @@ -314,6 +314,61 @@ describe('RetireJsEngine', () => { expect(results[1].violations[1].severity).to.equal(3, 'Sev should be translated to 3'); }); + it('Properly generates message for --verbose-violations', async () => { + // First, we need to seed the test engine with some fake aliases. + const firstOriginal = path.join('first', 'unimportant', 'path', 'jquery-3.1.0.js'); + const firstAlias = path.join('first', 'unimportant', 'alias', 'jquery-3.1.0.js'); + const secondOriginal = path.join('first', 'unimportant', 'path', 'angular-scenario.js'); + const secondAlias = path.join('first', 'unimportant', 'alias', 'angular-scenario.js'); + + (testEngine as any).originalFilesByAlias.set(firstAlias, firstOriginal); + (testEngine as any).originalFilesByAlias.set(secondAlias, secondOriginal); + + // Next, we want to spoof some output that looks like it came from RetireJS. + const fakeRetireResult = { + "version": "3.1.0", + "component": "jquery", + "vulnerabilities": [{ + "below": "3.4.0", + "identifiers": { + "CVE": ["CVE-2019-11358"], + "summary": "summary one", + "random": "this could be anything" + }, + "info": [ + 'https://blog.jquery.com/2019/04/10/jquery-3-4-0-released/', + 'https://nvd.nist.gov/vuln/detail/CVE-2019-11358' + ], + "severity": "medium" + }, { + "below": "3.5.0", + "identifiers": { + "summary": "summary two" + }, + "info": [ + 'https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/' + ], + "severity": "medium" + }, { + "below": "3.6.0", + "identifiers": { + "CVE": ["CVE-2020-11111"], + }, + "info": [ + 'https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/' + ], + "severity": "low" + }] + } + + // THIS IS THE ACTUAL METHOD BEING TESTED: Now we feed that fake result into the engine and see what we get back. + const message: string = (testEngine as any).generateVerboseMessage(fakeRetireResult, 'insecure-bundled-dependencies', true); + + // Now we run our assertions. + expect(message).to.equal("jquery 3.1.0 has known vulnerabilities:\nseverity: medium; summary: summary one; CVE: CVE-2019-11358; random: this could be anything; https://blog.jquery.com/2019/04/10/jquery-3-4-0-released/ https://nvd.nist.gov/vuln/detail/CVE-2019-11358\nseverity: medium; summary: summary two; https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/\nseverity: low; CVE: CVE-2020-11111; https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/", 'Verbose message should contain correct information and format'); + + }); + // Changes to the codebase make it unclear how this corner case would occur, but it's worth having the automation // so we avoid introducing any weird bugs in the future. it('Corner Case: When file has multiple aliases, results are consolidated', async () => { @@ -377,7 +432,7 @@ describe('RetireJsEngine', () => { }; // THIS IS THE ACTUAL METHOD BEING TESTED: Now we feed that fake result into the engine and see what we get back. - const results: RuleResult[] = (testEngine as any).processOutput(JSON.stringify(fakeRetireOutput), 'insecure-bundled-dependencies'); + const results: RuleResult[] = (testEngine as any).processOutput(JSON.stringify(fakeRetireOutput), 'insecure-bundled-dependencies', false); // Now we run our assertions. expect(results.length).to.equal(1, 'Should be one result object, since both aliases correspond to the same original file'); @@ -393,7 +448,7 @@ describe('RetireJsEngine', () => { const invalidJson = '{"beep": ['; try { - const results: RuleResult[] = (testEngine as any).processOutput(invalidJson, 'insecure-bundled-dependencies'); + const results: RuleResult[] = (testEngine as any).processOutput(invalidJson, 'insecure-bundled-dependencies', false); expect(true).to.equal(false, 'Exception should be thrown'); expect(results).to.equal(null, 'This assertion should never fire. It is needed to make the TS compiler stop complaining'); } catch (e) { @@ -408,7 +463,7 @@ describe('RetireJsEngine', () => { }; try { - const results: RuleResult[] = (testEngine as any).processOutput(JSON.stringify(malformedJson), 'insecure-bundled-dependencies'); + const results: RuleResult[] = (testEngine as any).processOutput(JSON.stringify(malformedJson), 'insecure-bundled-dependencies', false); expect(true).to.equal(false, 'Exception should be thrown'); expect(results).to.equal(null, 'This assertion should never fire. It is needed to make the TS compiler stop complaining'); } catch (e) { From 5a0c0651adfdc9886a14c72a05ca6a1954308dd0 Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Wed, 1 Jun 2022 14:04:49 -0500 Subject: [PATCH 05/22] @W-10759090@: Implemented method-level targeting for SFGE, and message-passing system to allow for proper logging. --- cli-messaging/build.gradle.kts | 26 +++ .../gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 55190 bytes .../gradle/wrapper/gradle-wrapper.properties | 5 + cli-messaging/settings.gradle.kts | 1 + .../com/salesforce/messaging/CliMessager.java | 99 ++++++++ .../com/salesforce/messaging/EventKey.java | 59 +++++ .../com/salesforce/messaging/Message.java | 47 ++++ .../messaging/MessagePassableException.java | 47 ++++ .../salesforce/messaging/EventKeyTest.java | 126 +++++++++++ messages/EventKeyTemplates.js | 2 + messages/run-dfa.js | 2 + settings.gradle.kts | 1 + sfge/build.gradle.kts | 1 + sfge/src/main/java/com/salesforce/Main.java | 2 + .../com/salesforce/graph/ops/MethodUtil.java | 46 +++- .../salesforce/rules/AbstractRuleRunner.java | 9 +- .../salesforce/graph/ops/MethodUtilTest.java | 214 ++++++++++++++++++ src/commands/scanner/run/dfa.ts | 15 +- src/lib/DefaultRuleManager.ts | 36 ++- src/lib/cpd/CpdWrapper.ts | 6 +- src/lib/eslint/BaseEslintEngine.ts | 2 +- src/lib/eslint/TypescriptEslintStrategy.ts | 2 +- src/lib/pmd/PmdCatalogWrapper.ts | 46 ++-- src/lib/pmd/PmdSupport.ts | 11 +- src/lib/pmd/PmdWrapper.ts | 16 +- src/lib/services/CommandLineSupport.ts | 80 ++++--- src/lib/services/LocalCatalog.ts | 2 +- src/lib/{pmd => services}/OutputProcessor.ts | 0 src/lib/sfge/SfgeEngine.ts | 20 +- src/lib/sfge/SfgeWrapper.ts | 50 ++-- src/lib/util/EventCreator.ts | 14 +- src/lib/util/FileHandler.ts | 4 + src/types.d.ts | 1 + test/lib/RuleManager.test.ts | 30 +++ 34 files changed, 900 insertions(+), 122 deletions(-) create mode 100644 cli-messaging/build.gradle.kts create mode 100644 cli-messaging/gradle/wrapper/gradle-wrapper.jar create mode 100644 cli-messaging/gradle/wrapper/gradle-wrapper.properties create mode 100644 cli-messaging/settings.gradle.kts create mode 100644 cli-messaging/src/main/java/com/salesforce/messaging/CliMessager.java create mode 100644 cli-messaging/src/main/java/com/salesforce/messaging/EventKey.java create mode 100644 cli-messaging/src/main/java/com/salesforce/messaging/Message.java create mode 100644 cli-messaging/src/main/java/com/salesforce/messaging/MessagePassableException.java create mode 100644 cli-messaging/src/test/java/com/salesforce/messaging/EventKeyTest.java create mode 100644 sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java rename src/lib/{pmd => services}/OutputProcessor.ts (100%) diff --git a/cli-messaging/build.gradle.kts b/cli-messaging/build.gradle.kts new file mode 100644 index 000000000..54d198e8a --- /dev/null +++ b/cli-messaging/build.gradle.kts @@ -0,0 +1,26 @@ +plugins { + java +} + +version = "1.0" +java.sourceCompatibility = JavaVersion.VERSION_1_8 +group = "com.salesforce.messaging" + +repositories { + mavenCentral() +} + +dependencies { + implementation ("com.googlecode.json-simple:json-simple:1.1.1") { + exclude("junit") + } + implementation("com.google.code.gson:gson:2.3") + testImplementation("junit", "junit", "4.12") + implementation("com.google.guava:guava:28.0-jre") + testImplementation("org.junit.jupiter:junit-jupiter-api:5.6.0") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine") +} + +tasks.getByName("test") { + useJUnitPlatform() +} diff --git a/cli-messaging/gradle/wrapper/gradle-wrapper.jar b/cli-messaging/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000000000000000000000000000000000..87b738cbd051603d91cc39de6cb000dd98fe6b02 GIT binary patch literal 55190 zcmafaW0WS*vSoFbZQHhO+s0S6%`V%vZQJa!ZQHKus_B{g-pt%P_q|ywBQt-*Stldc z$+IJ3?^KWm27v+sf`9-50uuadKtMnL*BJ;1^6ynvR7H?hQcjE>7)art9Bu0Pcm@7C z@c%WG|JzYkP)<@zR9S^iR_sA`azaL$mTnGKnwDyMa;8yL_0^>Ba^)phg0L5rOPTbm7g*YIRLg-2^{qe^`rb!2KqS zk~5wEJtTdD?)3+}=eby3x6%i)sb+m??NHC^u=tcG8p$TzB<;FL(WrZGV&cDQb?O0GMe6PBV=V z?tTO*5_HTW$xea!nkc~Cnx#cL_rrUGWPRa6l+A{aiMY=<0@8y5OC#UcGeE#I>nWh}`#M#kIn-$A;q@u-p71b#hcSItS!IPw?>8 zvzb|?@Ahb22L(O4#2Sre&l9H(@TGT>#Py)D&eW-LNb!=S;I`ZQ{w;MaHW z#to!~TVLgho_Pm%zq@o{K3Xq?I|MVuVSl^QHnT~sHlrVxgsqD-+YD?Nz9@HA<;x2AQjxP)r6Femg+LJ-*)k%EZ}TTRw->5xOY z9#zKJqjZgC47@AFdk1$W+KhTQJKn7e>A&?@-YOy!v_(}GyV@9G#I?bsuto4JEp;5|N{orxi_?vTI4UF0HYcA( zKyGZ4<7Fk?&LZMQb6k10N%E*$gr#T&HsY4SPQ?yerqRz5c?5P$@6dlD6UQwZJ*Je9 z7n-@7!(OVdU-mg@5$D+R%gt82Lt%&n6Yr4=|q>XT%&^z_D*f*ug8N6w$`woqeS-+#RAOfSY&Rz z?1qYa5xi(7eTCrzCFJfCxc%j{J}6#)3^*VRKF;w+`|1n;Xaojr2DI{!<3CaP`#tXs z*`pBQ5k@JLKuCmovFDqh_`Q;+^@t_;SDm29 zCNSdWXbV?9;D4VcoV`FZ9Ggrr$i<&#Dx3W=8>bSQIU_%vf)#(M2Kd3=rN@^d=QAtC zI-iQ;;GMk|&A++W5#hK28W(YqN%?!yuW8(|Cf`@FOW5QbX|`97fxmV;uXvPCqxBD zJ9iI37iV)5TW1R+fV16y;6}2tt~|0J3U4E=wQh@sx{c_eu)t=4Yoz|%Vp<#)Qlh1V z0@C2ZtlT>5gdB6W)_bhXtcZS)`9A!uIOa`K04$5>3&8An+i9BD&GvZZ=7#^r=BN=k za+=Go;qr(M)B~KYAz|<^O3LJON}$Q6Yuqn8qu~+UkUKK~&iM%pB!BO49L+?AL7N7o z(OpM(C-EY753=G=WwJHE`h*lNLMNP^c^bBk@5MyP5{v7x>GNWH>QSgTe5 z!*GPkQ(lcbEs~)4ovCu!Zt&$${9$u(<4@9%@{U<-ksAqB?6F`bQ;o-mvjr)Jn7F&j$@`il1Mf+-HdBs<-`1FahTxmPMMI)@OtI&^mtijW6zGZ67O$UOv1Jj z;a3gmw~t|LjPkW3!EZ=)lLUhFzvO;Yvj9g`8hm%6u`;cuek_b-c$wS_0M4-N<@3l|88 z@V{Sd|M;4+H6guqMm4|v=C6B7mlpP(+It%0E;W`dxMOf9!jYwWj3*MRk`KpS_jx4c z=hrKBkFK;gq@;wUV2eqE3R$M+iUc+UD0iEl#-rECK+XmH9hLKrC={j@uF=f3UiceB zU5l$FF7#RKjx+6!JHMG5-!@zI-eG=a-!Bs^AFKqN_M26%cIIcSs61R$yuq@5a3c3& z4%zLs!g}+C5%`ja?F`?5-og0lv-;(^e<`r~p$x%&*89_Aye1N)9LNVk?9BwY$Y$$F^!JQAjBJvywXAesj7lTZ)rXuxv(FFNZVknJha99lN=^h`J2> zl5=~(tKwvHHvh|9-41@OV`c;Ws--PE%{7d2sLNbDp;A6_Ka6epzOSFdqb zBa0m3j~bT*q1lslHsHqaHIP%DF&-XMpCRL(v;MV#*>mB^&)a=HfLI7efblG z(@hzN`|n+oH9;qBklb=d^S0joHCsArnR1-h{*dIUThik>ot^!6YCNjg;J_i3h6Rl0ji)* zo(tQ~>xB!rUJ(nZjCA^%X;)H{@>uhR5|xBDA=d21p@iJ!cH?+%U|VSh2S4@gv`^)^ zNKD6YlVo$%b4W^}Rw>P1YJ|fTb$_(7C;hH+ z1XAMPb6*p^h8)e5nNPKfeAO}Ik+ZN_`NrADeeJOq4Ak;sD~ zTe77no{Ztdox56Xi4UE6S7wRVxJzWxKj;B%v7|FZ3cV9MdfFp7lWCi+W{}UqekdpH zdO#eoOuB3Fu!DU`ErfeoZWJbWtRXUeBzi zBTF-AI7yMC^ntG+8%mn(I6Dw}3xK8v#Ly{3w3_E?J4(Q5JBq~I>u3!CNp~Ekk&YH` z#383VO4O42NNtcGkr*K<+wYZ>@|sP?`AQcs5oqX@-EIqgK@Pmp5~p6O6qy4ml~N{D z{=jQ7k(9!CM3N3Vt|u@%ssTw~r~Z(}QvlROAkQQ?r8OQ3F0D$aGLh zny+uGnH5muJ<67Z=8uilKvGuANrg@s3Vu_lU2ajb?rIhuOd^E@l!Kl0hYIxOP1B~Q zggUmXbh$bKL~YQ#!4fos9UUVG#}HN$lIkM<1OkU@r>$7DYYe37cXYwfK@vrHwm;pg zbh(hEU|8{*d$q7LUm+x&`S@VbW*&p-sWrplWnRM|I{P;I;%U`WmYUCeJhYc|>5?&& zj}@n}w~Oo=l}iwvi7K6)osqa;M8>fRe}>^;bLBrgA;r^ZGgY@IC^ioRmnE&H4)UV5 zO{7egQ7sBAdoqGsso5q4R(4$4Tjm&&C|7Huz&5B0wXoJzZzNc5Bt)=SOI|H}+fbit z-PiF5(NHSy>4HPMrNc@SuEMDuKYMQ--G+qeUPqO_9mOsg%1EHpqoX^yNd~~kbo`cH zlV0iAkBFTn;rVb>EK^V6?T~t~3vm;csx+lUh_%ROFPy0(omy7+_wYjN!VRDtwDu^h4n|xpAMsLepm% zggvs;v8+isCW`>BckRz1MQ=l>K6k^DdT`~sDXTWQ<~+JtY;I~I>8XsAq3yXgxe>`O zZdF*{9@Z|YtS$QrVaB!8&`&^W->_O&-JXn1n&~}o3Z7FL1QE5R*W2W@=u|w~7%EeC1aRfGtJWxImfY-D3t!!nBkWM> zafu>^Lz-ONgT6ExjV4WhN!v~u{lt2-QBN&UxwnvdH|I%LS|J-D;o>@@sA62@&yew0 z)58~JSZP!(lX;da!3`d)D1+;K9!lyNlkF|n(UduR-%g>#{`pvrD^ClddhJyfL7C-(x+J+9&7EsC~^O`&}V%)Ut8^O_7YAXPDpzv8ir4 zl`d)(;imc6r16k_d^)PJZ+QPxxVJS5e^4wX9D=V2zH&wW0-p&OJe=}rX`*->XT=;_qI&)=WHkYnZx6bLoUh_)n-A}SF_ z9z7agNTM5W6}}ui=&Qs@pO5$zHsOWIbd_&%j^Ok5PJ3yUWQw*i4*iKO)_er2CDUME ztt+{Egod~W-fn^aLe)aBz)MOc_?i-stTj}~iFk7u^-gGSbU;Iem06SDP=AEw9SzuF zeZ|hKCG3MV(z_PJg0(JbqTRf4T{NUt%kz&}4S`)0I%}ZrG!jgW2GwP=WTtkWS?DOs znI9LY!dK+1_H0h+i-_~URb^M;4&AMrEO_UlDV8o?E>^3x%ZJyh$JuDMrtYL8|G3If zPf2_Qb_W+V?$#O; zydKFv*%O;Y@o_T_UAYuaqx1isMKZ^32JtgeceA$0Z@Ck0;lHbS%N5)zzAW9iz; z8tTKeK7&qw!8XVz-+pz>z-BeIzr*#r0nB^cntjQ9@Y-N0=e&ZK72vlzX>f3RT@i7@ z=z`m7jNk!9%^xD0ug%ptZnM>F;Qu$rlwo}vRGBIymPL)L|x}nan3uFUw(&N z24gdkcb7!Q56{0<+zu zEtc5WzG2xf%1<@vo$ZsuOK{v9gx^0`gw>@h>ZMLy*h+6ueoie{D#}}` zK2@6Xxq(uZaLFC%M!2}FX}ab%GQ8A0QJ?&!vaI8Gv=vMhd);6kGguDmtuOElru()) zuRk&Z{?Vp!G~F<1#s&6io1`poBqpRHyM^p;7!+L??_DzJ8s9mYFMQ0^%_3ft7g{PD zZd}8E4EV}D!>F?bzcX=2hHR_P`Xy6?FOK)mCj)Ym4s2hh z0OlOdQa@I;^-3bhB6mpw*X5=0kJv8?#XP~9){G-+0ST@1Roz1qi8PhIXp1D$XNqVG zMl>WxwT+K`SdO1RCt4FWTNy3!i?N>*-lbnn#OxFJrswgD7HjuKpWh*o@QvgF&j+CT z{55~ZsUeR1aB}lv#s_7~+9dCix!5(KR#c?K?e2B%P$fvrsZxy@GP#R#jwL{y#Ld$} z7sF>QT6m|}?V;msb?Nlohj7a5W_D$y+4O6eI;Zt$jVGymlzLKscqer9#+p2$0It&u zWY!dCeM6^B^Z;ddEmhi?8`scl=Lhi7W%2|pT6X6^%-=q90DS(hQ-%c+E*ywPvmoF(KqDoW4!*gmQIklm zk#!GLqv|cs(JRF3G?=AYY19{w@~`G3pa z@xR9S-Hquh*&5Yas*VI};(%9%PADn`kzm zeWMJVW=>>wap*9|R7n#!&&J>gq04>DTCMtj{P^d12|2wXTEKvSf?$AvnE!peqV7i4 zE>0G%CSn%WCW1yre?yi9*aFP{GvZ|R4JT}M%x_%Hztz2qw?&28l&qW<6?c6ym{f$d z5YCF+k#yEbjCN|AGi~-NcCG8MCF1!MXBFL{#7q z)HO+WW173?kuI}^Xat;Q^gb4Hi0RGyB}%|~j8>`6X4CPo+|okMbKy9PHkr58V4bX6<&ERU)QlF8%%huUz&f+dwTN|tk+C&&o@Q1RtG`}6&6;ncQuAcfHoxd5AgD7`s zXynq41Y`zRSiOY@*;&1%1z>oNcWTV|)sjLg1X8ijg1Y zbIGL0X*Sd}EXSQ2BXCKbJmlckY(@EWn~Ut2lYeuw1wg?hhj@K?XB@V_ZP`fyL~Yd3n3SyHU-RwMBr6t-QWE5TinN9VD4XVPU; zonIIR!&pGqrLQK)=#kj40Im%V@ij0&Dh0*s!lnTw+D`Dt-xmk-jmpJv$1-E-vfYL4 zqKr#}Gm}~GPE+&$PI@4ag@=M}NYi7Y&HW82Q`@Y=W&PE31D110@yy(1vddLt`P%N^ z>Yz195A%tnt~tvsSR2{m!~7HUc@x<&`lGX1nYeQUE(%sphTi>JsVqSw8xql*Ys@9B z>RIOH*rFi*C`ohwXjyeRBDt8p)-u{O+KWP;$4gg||%*u{$~yEj+Al zE(hAQRQ1k7MkCq9s4^N3ep*$h^L%2Vq?f?{+cicpS8lo)$Cb69b98au+m2J_e7nYwID0@`M9XIo1H~|eZFc8Hl!qly612ADCVpU zY8^*RTMX(CgehD{9v|^9vZ6Rab`VeZ2m*gOR)Mw~73QEBiktViBhR!_&3l$|be|d6 zupC`{g89Y|V3uxl2!6CM(RNpdtynaiJ~*DqSTq9Mh`ohZnb%^3G{k;6%n18$4nAqR zjPOrP#-^Y9;iw{J@XH9=g5J+yEVh|e=4UeY<^65`%gWtdQ=-aqSgtywM(1nKXh`R4 zzPP&7r)kv_uC7X9n=h=!Zrf<>X=B5f<9~Q>h#jYRD#CT7D~@6@RGNyO-#0iq0uHV1 zPJr2O4d_xLmg2^TmG7|dpfJ?GGa`0|YE+`2Rata9!?$j#e9KfGYuLL(*^z z!SxFA`$qm)q-YKh)WRJZ@S+-sD_1E$V?;(?^+F3tVcK6 z2fE=8hV*2mgiAbefU^uvcM?&+Y&E}vG=Iz!%jBF7iv){lyC`)*yyS~D8k+Mx|N3bm zI~L~Z$=W9&`x)JnO;8c>3LSDw!fzN#X3qi|0`sXY4?cz{*#xz!kvZ9bO=K3XbN z5KrgN=&(JbXH{Wsu9EdmQ-W`i!JWEmfI;yVTT^a-8Ch#D8xf2dtyi?7p z%#)W3n*a#ndFpd{qN|+9Jz++AJQO#-Y7Z6%*%oyEP5zs}d&kKIr`FVEY z;S}@d?UU=tCdw~EJ{b}=9x}S2iv!!8<$?d7VKDA8h{oeD#S-$DV)-vPdGY@x08n)@ zag?yLF_E#evvRTj4^CcrLvBL=fft&@HOhZ6Ng4`8ijt&h2y}fOTC~7GfJi4vpomA5 zOcOM)o_I9BKz}I`q)fu+Qnfy*W`|mY%LO>eF^a z;$)?T4F-(X#Q-m}!-k8L_rNPf`Mr<9IWu)f&dvt=EL+ESYmCvErd@8B9hd)afc(ZL94S z?rp#h&{7Ah5IJftK4VjATklo7@hm?8BX*~oBiz)jyc9FuRw!-V;Uo>p!CWpLaIQyt zAs5WN)1CCeux-qiGdmbIk8LR`gM+Qg=&Ve}w?zA6+sTL)abU=-cvU`3E?p5$Hpkxw znu0N659qR=IKnde*AEz_7z2pdi_Bh-sb3b=PdGO1Pdf_q2;+*Cx9YN7p_>rl``knY zRn%aVkcv1(W;`Mtp_DNOIECtgq%ufk-mu_<+Fu3Q17Tq4Rr(oeq)Yqk_CHA7LR@7@ zIZIDxxhS&=F2IQfusQ+Nsr%*zFK7S4g!U0y@3H^Yln|i;0a5+?RPG;ZSp6Tul>ezM z`40+516&719qT)mW|ArDSENle5hE2e8qY+zfeZoy12u&xoMgcP)4=&P-1Ib*-bAy` zlT?>w&B|ei-rCXO;sxo7*G;!)_p#%PAM-?m$JP(R%x1Hfas@KeaG%LO?R=lmkXc_MKZW}3f%KZ*rAN?HYvbu2L$ zRt_uv7~-IejlD1x;_AhwGXjB94Q=%+PbxuYzta*jw?S&%|qb=(JfJ?&6P=R7X zV%HP_!@-zO*zS}46g=J}#AMJ}rtWBr21e6hOn&tEmaM%hALH7nlm2@LP4rZ>2 zebe5aH@k!e?ij4Zwak#30|}>;`bquDQK*xmR=zc6vj0yuyC6+U=LusGnO3ZKFRpen z#pwzh!<+WBVp-!$MAc<0i~I%fW=8IO6K}bJ<-Scq>e+)951R~HKB?Mx2H}pxPHE@} zvqpq5j81_jtb_WneAvp<5kgdPKm|u2BdQx9%EzcCN&U{l+kbkhmV<1}yCTDv%&K^> zg;KCjwh*R1f_`6`si$h6`jyIKT7rTv5#k~x$mUyIw)_>Vr)D4fwIs@}{FSX|5GB1l z4vv;@oS@>Bu7~{KgUa_8eg#Lk6IDT2IY$41$*06{>>V;Bwa(-@N;ex4;D`(QK*b}{ z{#4$Hmt)FLqERgKz=3zXiV<{YX6V)lvYBr3V>N6ajeI~~hGR5Oe>W9r@sg)Na(a4- zxm%|1OKPN6^%JaD^^O~HbLSu=f`1px>RawOxLr+1b2^28U*2#h*W^=lSpSY4(@*^l z{!@9RSLG8Me&RJYLi|?$c!B0fP=4xAM4rerxX{xy{&i6=AqXueQAIBqO+pmuxy8Ib z4X^}r!NN3-upC6B#lt7&x0J;)nb9O~xjJMemm$_fHuP{DgtlU3xiW0UesTzS30L+U zQzDI3p&3dpONhd5I8-fGk^}@unluzu%nJ$9pzoO~Kk!>dLxw@M)M9?pNH1CQhvA`z zV;uacUtnBTdvT`M$1cm9`JrT3BMW!MNVBy%?@ZX%;(%(vqQAz<7I!hlDe|J3cn9=} zF7B;V4xE{Ss76s$W~%*$JviK?w8^vqCp#_G^jN0j>~Xq#Zru26e#l3H^{GCLEXI#n z?n~F-Lv#hU(bZS`EI9(xGV*jT=8R?CaK)t8oHc9XJ;UPY0Hz$XWt#QyLBaaz5+}xM zXk(!L_*PTt7gwWH*HLWC$h3Ho!SQ-(I||nn_iEC{WT3S{3V{8IN6tZ1C+DiFM{xlI zeMMk{o5;I6UvaC)@WKp9D+o?2Vd@4)Ue-nYci()hCCsKR`VD;hr9=vA!cgGL%3k^b(jADGyPi2TKr(JNh8mzlIR>n(F_hgiV(3@Ds(tjbNM7GoZ;T|3 zWzs8S`5PrA!9){jBJuX4y`f<4;>9*&NY=2Sq2Bp`M2(fox7ZhIDe!BaQUb@P(ub9D zlP8!p(AN&CwW!V&>H?yPFMJ)d5x#HKfwx;nS{Rr@oHqpktOg)%F+%1#tsPtq7zI$r zBo-Kflhq-=7_eW9B2OQv=@?|y0CKN77)N;z@tcg;heyW{wlpJ1t`Ap!O0`Xz{YHqO zI1${8Hag^r!kA<2_~bYtM=<1YzQ#GGP+q?3T7zYbIjN6Ee^V^b&9en$8FI*NIFg9G zPG$OXjT0Ku?%L7fat8Mqbl1`azf1ltmKTa(HH$Dqlav|rU{zP;Tbnk-XkGFQ6d+gi z-PXh?_kEJl+K98&OrmzgPIijB4!Pozbxd0H1;Usy!;V>Yn6&pu*zW8aYx`SC!$*ti zSn+G9p=~w6V(fZZHc>m|PPfjK6IN4(o=IFu?pC?+`UZAUTw!e`052{P=8vqT^(VeG z=psASIhCv28Y(;7;TuYAe>}BPk5Qg=8$?wZj9lj>h2kwEfF_CpK=+O6Rq9pLn4W)# zeXCKCpi~jsfqw7Taa0;!B5_C;B}e56W1s8@p*)SPzA;Fd$Slsn^=!_&!mRHV*Lmt| zBGIDPuR>CgS4%cQ4wKdEyO&Z>2aHmja;Pz+n|7(#l%^2ZLCix%>@_mbnyPEbyrHaz z>j^4SIv;ZXF-Ftzz>*t4wyq)ng8%0d;(Z_ExZ-cxwei=8{(br-`JYO(f23Wae_MqE z3@{Mlf^%M5G1SIN&en1*| zH~ANY1h3&WNsBy$G9{T=`kcxI#-X|>zLX2r*^-FUF+m0{k)n#GTG_mhG&fJfLj~K& zU~~6othMlvMm9<*SUD2?RD+R17|Z4mgR$L*R3;nBbo&Vm@39&3xIg;^aSxHS>}gwR zmzs?h8oPnNVgET&dx5^7APYx6Vv6eou07Zveyd+^V6_LzI$>ic+pxD_8s~ zC<}ucul>UH<@$KM zT4oI=62M%7qQO{}re-jTFqo9Z;rJKD5!X5$iwUsh*+kcHVhID08MB5cQD4TBWB(rI zuWc%CA}}v|iH=9gQ?D$1#Gu!y3o~p7416n54&Hif`U-cV?VrUMJyEqo_NC4#{puzU zzXEE@UppeeRlS9W*^N$zS`SBBi<@tT+<%3l@KhOy^%MWB9(A#*J~DQ;+MK*$rxo6f zcx3$3mcx{tly!q(p2DQrxcih|)0do_ZY77pyHGE#Q(0k*t!HUmmMcYFq%l$-o6%lS zDb49W-E?rQ#Hl``C3YTEdGZjFi3R<>t)+NAda(r~f1cT5jY}s7-2^&Kvo&2DLTPYP zhVVo-HLwo*vl83mtQ9)PR#VBg)FN}+*8c-p8j`LnNUU*Olm1O1Qqe62D#$CF#?HrM zy(zkX|1oF}Z=T#3XMLWDrm(|m+{1&BMxHY7X@hM_+cV$5-t!8HT(dJi6m9{ja53Yw z3f^`yb6Q;(e|#JQIz~B*=!-GbQ4nNL-NL z@^NWF_#w-Cox@h62;r^;Y`NX8cs?l^LU;5IWE~yvU8TqIHij!X8ydbLlT0gwmzS9} z@5BccG?vO;rvCs$mse1*ANi-cYE6Iauz$Fbn3#|ToAt5v7IlYnt6RMQEYLldva{~s zvr>1L##zmeoYgvIXJ#>bbuCVuEv2ZvZ8I~PQUN3wjP0UC)!U+wn|&`V*8?)` zMSCuvnuGec>QL+i1nCPGDAm@XSMIo?A9~C?g2&G8aNKjWd2pDX{qZ?04+2 zeyLw}iEd4vkCAWwa$ zbrHlEf3hfN7^1g~aW^XwldSmx1v~1z(s=1az4-wl} z`mM+G95*N*&1EP#u3}*KwNrPIgw8Kpp((rdEOO;bT1;6ea~>>sK+?!;{hpJ3rR<6UJb`O8P4@{XGgV%63_fs%cG8L zk9Fszbdo4tS$g0IWP1>t@0)E%-&9yj%Q!fiL2vcuL;90fPm}M==<>}Q)&sp@STFCY z^p!RzmN+uXGdtPJj1Y-khNyCb6Y$Vs>eZyW zPaOV=HY_T@FwAlleZCFYl@5X<<7%5DoO(7S%Lbl55?{2vIr_;SXBCbPZ(up;pC6Wx={AZL?shYOuFxLx1*>62;2rP}g`UT5+BHg(ju z&7n5QSvSyXbioB9CJTB#x;pexicV|9oaOpiJ9VK6EvKhl4^Vsa(p6cIi$*Zr0UxQ z;$MPOZnNae2Duuce~7|2MCfhNg*hZ9{+8H3?ts9C8#xGaM&sN;2lriYkn9W>&Gry! z3b(Xx1x*FhQkD-~V+s~KBfr4M_#0{`=Yrh90yj}Ph~)Nx;1Y^8<418tu!$1<3?T*~ z7Dl0P3Uok-7w0MPFQexNG1P5;y~E8zEvE49>$(f|XWtkW2Mj`udPn)pb%} zrA%wRFp*xvDgC767w!9`0vx1=q!)w!G+9(-w&p*a@WXg{?T&%;qaVcHo>7ca%KX$B z^7|KBPo<2;kM{2mRnF8vKm`9qGV%|I{y!pKm8B(q^2V;;x2r!1VJ^Zz8bWa)!-7a8 zSRf@dqEPlsj!7}oNvFFAA)75})vTJUwQ03hD$I*j6_5xbtd_JkE2`IJD_fQ;a$EkO z{fQ{~e%PKgPJsD&PyEvDmg+Qf&p*-qu!#;1k2r_(H72{^(Z)htgh@F?VIgK#_&eS- z$~(qInec>)XIkv@+{o6^DJLpAb>!d}l1DK^(l%#OdD9tKK6#|_R?-%0V!`<9Hj z3w3chDwG*SFte@>Iqwq`J4M&{aHXzyigT620+Vf$X?3RFfeTcvx_e+(&Q*z)t>c0e zpZH$1Z3X%{^_vylHVOWT6tno=l&$3 z9^eQ@TwU#%WMQaFvaYp_we%_2-9=o{+ck zF{cKJCOjpW&qKQquyp2BXCAP920dcrZ}T1@piukx_NY;%2W>@Wca%=Ch~x5Oj58Hv z;D-_ALOZBF(Mqbcqjd}P3iDbek#Dwzu`WRs`;hRIr*n0PV7vT+%Io(t}8KZ zpp?uc2eW!v28ipep0XNDPZt7H2HJ6oey|J3z!ng#1H~x_k%35P+Cp%mqXJ~cV0xdd z^4m5^K_dQ^Sg?$P`))ccV=O>C{Ds(C2WxX$LMC5vy=*44pP&)X5DOPYfqE${)hDg< z3hcG%U%HZ39=`#Ko4Uctg&@PQLf>?0^D|4J(_1*TFMOMB!Vv1_mnOq$BzXQdOGqgy zOp#LBZ!c>bPjY1NTXksZmbAl0A^Y&(%a3W-k>bE&>K?px5Cm%AT2E<&)Y?O*?d80d zgI5l~&Mve;iXm88Q+Fw7{+`PtN4G7~mJWR^z7XmYQ>uoiV!{tL)hp|= zS(M)813PM`d<501>{NqaPo6BZ^T{KBaqEVH(2^Vjeq zgeMeMpd*1tE@@);hGjuoVzF>Cj;5dNNwh40CnU+0DSKb~GEMb_# zT8Z&gz%SkHq6!;_6dQFYE`+b`v4NT7&@P>cA1Z1xmXy<2htaDhm@XXMp!g($ zw(7iFoH2}WR`UjqjaqOQ$ecNt@c|K1H1kyBArTTjLp%-M`4nzOhkfE#}dOpcd;b#suq8cPJ&bf5`6Tq>ND(l zib{VrPZ>{KuaIg}Y$W>A+nrvMg+l4)-@2jpAQ5h(Tii%Ni^-UPVg{<1KGU2EIUNGaXcEkOedJOusFT9X3%Pz$R+-+W+LlRaY-a$5r?4V zbPzgQl22IPG+N*iBRDH%l{Zh$fv9$RN1sU@Hp3m=M}{rX%y#;4(x1KR2yCO7Pzo>rw(67E{^{yUR`91nX^&MxY@FwmJJbyPAoWZ9Z zcBS$r)&ogYBn{DOtD~tIVJUiq|1foX^*F~O4hlLp-g;Y2wKLLM=?(r3GDqsPmUo*? zwKMEi*%f)C_@?(&&hk>;m07F$X7&i?DEK|jdRK=CaaNu-)pX>n3}@%byPKVkpLzBq z{+Py&!`MZ^4@-;iY`I4#6G@aWMv{^2VTH7|WF^u?3vsB|jU3LgdX$}=v7#EHRN(im zI(3q-eU$s~r=S#EWqa_2!G?b~ z<&brq1vvUTJH380=gcNntZw%7UT8tLAr-W49;9y^=>TDaTC|cKA<(gah#2M|l~j)w zY8goo28gj$n&zcNgqX1Qn6=<8?R0`FVO)g4&QtJAbW3G#D)uNeac-7cH5W#6i!%BH z=}9}-f+FrtEkkrQ?nkoMQ1o-9_b+&=&C2^h!&mWFga#MCrm85hW;)1pDt;-uvQG^D zntSB?XA*0%TIhtWDS!KcI}kp3LT>!(Nlc(lQN?k^bS8Q^GGMfo}^|%7s;#r+pybl@?KA++|FJ zr%se9(B|g*ERQU96az%@4gYrxRRxaM2*b}jNsG|0dQi;Rw{0WM0E>rko!{QYAJJKY z)|sX0N$!8d9E|kND~v|f>3YE|uiAnqbkMn)hu$if4kUkzKqoNoh8v|S>VY1EKmgO} zR$0UU2o)4i4yc1inx3}brso+sio{)gfbLaEgLahj8(_Z#4R-v) zglqwI%`dsY+589a8$Mu7#7_%kN*ekHupQ#48DIN^uhDxblDg3R1yXMr^NmkR z7J_NWCY~fhg}h!_aXJ#?wsZF$q`JH>JWQ9`jbZzOBpS`}-A$Vgkq7+|=lPx9H7QZG z8i8guMN+yc4*H*ANr$Q-3I{FQ-^;8ezWS2b8rERp9TMOLBxiG9J*g5=?h)mIm3#CGi4JSq1ohFrcrxx@`**K5%T}qbaCGldV!t zVeM)!U3vbf5FOy;(h08JnhSGxm)8Kqxr9PsMeWi=b8b|m_&^@#A3lL;bVKTBx+0v8 zLZeWAxJ~N27lsOT2b|qyp$(CqzqgW@tyy?CgwOe~^i;ZH zlL``i4r!>i#EGBNxV_P@KpYFQLz4Bdq{#zA&sc)*@7Mxsh9u%e6Ke`?5Yz1jkTdND zR8!u_yw_$weBOU}24(&^Bm|(dSJ(v(cBct}87a^X(v>nVLIr%%D8r|&)mi+iBc;B;x;rKq zd8*X`r?SZsTNCPQqoFOrUz8nZO?225Z#z(B!4mEp#ZJBzwd7jW1!`sg*?hPMJ$o`T zR?KrN6OZA1H{9pA;p0cSSu;@6->8aJm1rrO-yDJ7)lxuk#npUk7WNER1Wwnpy%u zF=t6iHzWU(L&=vVSSc^&D_eYP3TM?HN!Tgq$SYC;pSIPWW;zeNm7Pgub#yZ@7WPw#f#Kl)W4%B>)+8%gpfoH1qZ;kZ*RqfXYeGXJ_ zk>2otbp+1By`x^1V!>6k5v8NAK@T;89$`hE0{Pc@Q$KhG0jOoKk--Qx!vS~lAiypV zCIJ&6B@24`!TxhJ4_QS*S5;;Pk#!f(qIR7*(c3dN*POKtQe)QvR{O2@QsM%ujEAWEm) z+PM=G9hSR>gQ`Bv2(k}RAv2+$7qq(mU`fQ+&}*i%-RtSUAha>70?G!>?w%F(b4k!$ zvm;E!)2`I?etmSUFW7WflJ@8Nx`m_vE2HF#)_BiD#FaNT|IY@!uUbd4v$wTglIbIX zblRy5=wp)VQzsn0_;KdM%g<8@>#;E?vypTf=F?3f@SSdZ;XpX~J@l1;p#}_veWHp>@Iq_T z@^7|h;EivPYv1&u0~l9(a~>dV9Uw10QqB6Dzu1G~-l{*7IktljpK<_L8m0|7VV_!S zRiE{u97(%R-<8oYJ{molUd>vlGaE-C|^<`hppdDz<7OS13$#J zZ+)(*rZIDSt^Q$}CRk0?pqT5PN5TT`Ya{q(BUg#&nAsg6apPMhLTno!SRq1e60fl6GvpnwDD4N> z9B=RrufY8+g3_`@PRg+(+gs2(bd;5#{uTZk96CWz#{=&h9+!{_m60xJxC%r&gd_N! z>h5UzVX%_7@CUeAA1XFg_AF%(uS&^1WD*VPS^jcC!M2v@RHZML;e(H-=(4(3O&bX- zI6>usJOS+?W&^S&DL{l|>51ZvCXUKlH2XKJPXnHjs*oMkNM#ZDLx!oaM5(%^)5XaP zk6&+P16sA>vyFe9v`Cp5qnbE#r#ltR5E+O3!WnKn`56Grs2;sqr3r# zp@Zp<^q`5iq8OqOlJ`pIuyK@3zPz&iJ0Jcc`hDQ1bqos2;}O|$i#}e@ua*x5VCSx zJAp}+?Hz++tm9dh3Fvm_bO6mQo38al#>^O0g)Lh^&l82+&x)*<n7^Sw-AJo9tEzZDwyJ7L^i7|BGqHu+ea6(&7jKpBq>~V z8CJxurD)WZ{5D0?s|KMi=e7A^JVNM6sdwg@1Eg_+Bw=9j&=+KO1PG|y(mP1@5~x>d z=@c{EWU_jTSjiJl)d(>`qEJ;@iOBm}alq8;OK;p(1AdH$)I9qHNmxxUArdzBW0t+Qeyl)m3?D09770g z)hzXEOy>2_{?o%2B%k%z4d23!pZcoxyW1Ik{|m7Q1>fm4`wsRrl)~h z_=Z*zYL+EG@DV1{6@5@(Ndu!Q$l_6Qlfoz@79q)Kmsf~J7t1)tl#`MD<;1&CAA zH8;i+oBm89dTTDl{aH`cmTPTt@^K-%*sV+t4X9q0Z{A~vEEa!&rRRr=0Rbz4NFCJr zLg2u=0QK@w9XGE=6(-JgeP}G#WG|R&tfHRA3a9*zh5wNTBAD;@YYGx%#E4{C#Wlfo z%-JuW9=FA_T6mR2-Vugk1uGZvJbFvVVWT@QOWz$;?u6+CbyQsbK$>O1APk|xgnh_8 zc)s@Mw7#0^wP6qTtyNq2G#s?5j~REyoU6^lT7dpX{T-rhZWHD%dik*=EA7bIJgOVf_Ga!yC8V^tkTOEHe+JK@Fh|$kfNxO^= z#lpV^(ZQ-3!^_BhV>aXY~GC9{8%1lOJ}6vzXDvPhC>JrtXwFBC+!3a*Z-%#9}i z#<5&0LLIa{q!rEIFSFc9)>{-_2^qbOg5;_A9 ztQ))C6#hxSA{f9R3Eh^`_f${pBJNe~pIQ`tZVR^wyp}=gLK}e5_vG@w+-mp#Fu>e| z*?qBp5CQ5zu+Fi}xAs)YY1;bKG!htqR~)DB$ILN6GaChoiy%Bq@i+1ZnANC0U&D z_4k$=YP47ng+0NhuEt}6C;9-JDd8i5S>`Ml==9wHDQFOsAlmtrVwurYDw_)Ihfk35 zJDBbe!*LUpg%4n>BExWz>KIQ9vexUu^d!7rc_kg#Bf= z7TLz|l*y*3d2vi@c|pX*@ybf!+Xk|2*z$@F4K#MT8Dt4zM_EcFmNp31#7qT6(@GG? zdd;sSY9HHuDb=w&|K%sm`bYX#%UHKY%R`3aLMO?{T#EI@FNNFNO>p@?W*i0z(g2dt z{=9Ofh80Oxv&)i35AQN>TPMjR^UID-T7H5A?GI{MD_VeXZ%;uo41dVm=uT&ne2h0i zv*xI%9vPtdEK@~1&V%p1sFc2AA`9?H)gPnRdlO~URx!fiSV)j?Tf5=5F>hnO=$d$x zzaIfr*wiIc!U1K*$JO@)gP4%xp!<*DvJSv7p}(uTLUb=MSb@7_yO+IsCj^`PsxEl& zIxsi}s3L?t+p+3FXYqujGhGwTx^WXgJ1}a@Yq5mwP0PvGEr*qu7@R$9j>@-q1rz5T zriz;B^(ex?=3Th6h;7U`8u2sDlfS{0YyydK=*>-(NOm9>S_{U|eg(J~C7O zIe{|LK=Y`hXiF_%jOM8Haw3UtaE{hWdzo3BbD6ud7br4cODBtN(~Hl+odP0SSWPw;I&^m)yLw+nd#}3#z}?UIcX3=SssI}`QwY=% zAEXTODk|MqTx}2DVG<|~(CxgLyi*A{m>M@1h^wiC)4Hy>1K7@|Z&_VPJsaQoS8=ex zDL&+AZdQa>ylxhT_Q$q=60D5&%pi6+qlY3$3c(~rsITX?>b;({FhU!7HOOhSP7>bmTkC8KM%!LRGI^~y3Ug+gh!QM=+NZXznM)?L3G=4=IMvFgX3BAlyJ z`~jjA;2z+65D$j5xbv9=IWQ^&-K3Yh`vC(1Qz2h2`o$>Cej@XRGff!it$n{@WEJ^N z41qk%Wm=}mA*iwCqU_6}Id!SQd13aFER3unXaJJXIsSnxvG2(hSCP{i&QH$tL&TPx zDYJsuk+%laN&OvKb-FHK$R4dy%M7hSB*yj#-nJy?S9tVoxAuDei{s}@+pNT!vLOIC z8g`-QQW8FKp3cPsX%{)0B+x+OhZ1=L7F-jizt|{+f1Ga7%+!BXqjCjH&x|3%?UbN# zh?$I1^YokvG$qFz5ySK+Ja5=mkR&p{F}ev**rWdKMko+Gj^?Or=UH?SCg#0F(&a_y zXOh}dPv0D9l0RVedq1~jCNV=8?vZfU-Xi|nkeE->;ohG3U7z+^0+HV17~-_Mv#mV` zzvwUJJ15v5wwKPv-)i@dsEo@#WEO9zie7mdRAbgL2kjbW4&lk$vxkbq=w5mGKZK6@ zjXWctDkCRx58NJD_Q7e}HX`SiV)TZMJ}~zY6P1(LWo`;yDynY_5_L?N-P`>ALfmyl z8C$a~FDkcwtzK9m$tof>(`Vu3#6r#+v8RGy#1D2)F;vnsiL&P-c^PO)^B-4VeJteLlT@25sPa z%W~q5>YMjj!mhN})p$47VA^v$Jo6_s{!y?}`+h+VM_SN`!11`|;C;B};B&Z<@%FOG z_YQVN+zFF|q5zKab&e4GH|B;sBbKimHt;K@tCH+S{7Ry~88`si7}S)1E{21nldiu5 z_4>;XTJa~Yd$m4A9{Qbd)KUAm7XNbZ4xHbg3a8-+1uf*$1PegabbmCzgC~1WB2F(W zYj5XhVos!X!QHuZXCatkRsdEsSCc+D2?*S7a+(v%toqyxhjz|`zdrUvsxQS{J>?c& zvx*rHw^8b|v^7wq8KWVofj&VUitbm*a&RU_ln#ZFA^3AKEf<#T%8I!Lg3XEsdH(A5 zlgh&M_XEoal)i#0tcq8c%Gs6`xu;vvP2u)D9p!&XNt z!TdF_H~;`g@fNXkO-*t<9~;iEv?)Nee%hVe!aW`N%$cFJ(Dy9+Xk*odyFj72T!(b%Vo5zvCGZ%3tkt$@Wcx8BWEkefI1-~C_3y*LjlQ5%WEz9WD8i^ z2MV$BHD$gdPJV4IaV)G9CIFwiV=ca0cfXdTdK7oRf@lgyPx;_7*RRFk=?@EOb9Gcz zg~VZrzo*Snp&EE{$CWr)JZW)Gr;{B2ka6B!&?aknM-FENcl%45#y?oq9QY z3^1Y5yn&^D67Da4lI}ljDcphaEZw2;tlYuzq?uB4b9Mt6!KTW&ptxd^vF;NbX=00T z@nE1lIBGgjqs?ES#P{ZfRb6f!At51vk%<0X%d_~NL5b8UyfQMPDtfU@>ijA0NP3UU zh{lCf`Wu7cX!go`kUG`1K=7NN@SRGjUKuo<^;@GS!%iDXbJs`o6e`v3O8-+7vRkFm z)nEa$sD#-v)*Jb>&Me+YIW3PsR1)h=-Su)))>-`aRcFJG-8icomO4J@60 zw10l}BYxi{eL+Uu0xJYk-Vc~BcR49Qyyq!7)PR27D`cqGrik=?k1Of>gY7q@&d&Ds zt7&WixP`9~jjHO`Cog~RA4Q%uMg+$z^Gt&vn+d3&>Ux{_c zm|bc;k|GKbhZLr-%p_f%dq$eiZ;n^NxoS-Nu*^Nx5vm46)*)=-Bf<;X#?`YC4tLK; z?;u?shFbXeks+dJ?^o$l#tg*1NA?(1iFff@I&j^<74S!o;SWR^Xi);DM%8XiWpLi0 zQE2dL9^a36|L5qC5+&Pf0%>l&qQ&)OU4vjd)%I6{|H+pw<0(a``9w(gKD&+o$8hOC zNAiShtc}e~ob2`gyVZx59y<6Fpl*$J41VJ-H*e-yECWaDMmPQi-N8XI3 z%iI@ljc+d}_okL1CGWffeaejlxWFVDWu%e=>H)XeZ|4{HlbgC-Uvof4ISYQzZ0Um> z#Ov{k1c*VoN^f(gfiueuag)`TbjL$XVq$)aCUBL_M`5>0>6Ska^*Knk__pw{0I>jA zzh}Kzg{@PNi)fcAk7jMAdi-_RO%x#LQszDMS@_>iFoB+zJ0Q#CQJzFGa8;pHFdi`^ zxnTC`G$7Rctm3G8t8!SY`GwFi4gF|+dAk7rh^rA{NXzc%39+xSYM~($L(pJ(8Zjs* zYdN_R^%~LiGHm9|ElV4kVZGA*T$o@YY4qpJOxGHlUi*S*A(MrgQ{&xoZQo+#PuYRs zv3a$*qoe9gBqbN|y|eaH=w^LE{>kpL!;$wRahY(hhzRY;d33W)m*dfem@)>pR54Qy z ze;^F?mwdU?K+=fBabokSls^6_6At#1Sh7W*y?r6Ss*dmZP{n;VB^LDxM1QWh;@H0J z!4S*_5j_;+@-NpO1KfQd&;C7T`9ak;X8DTRz$hDNcjG}xAfg%gwZSb^zhE~O);NMO zn2$fl7Evn%=Lk!*xsM#(y$mjukN?A&mzEw3W5>_o+6oh62kq=4-`e3B^$rG=XG}Kd zK$blh(%!9;@d@3& zGFO60j1Vf54S}+XD?%*uk7wW$f`4U3F*p7@I4Jg7f`Il}2H<{j5h?$DDe%wG7jZQL zI{mj?t?Hu>$|2UrPr5&QyK2l3mas?zzOk0DV30HgOQ|~xLXDQ8M3o#;CNKO8RK+M; zsOi%)js-MU>9H4%Q)#K_me}8OQC1u;f4!LO%|5toa1|u5Q@#mYy8nE9IXmR}b#sZK z3sD395q}*TDJJA9Er7N`y=w*S&tA;mv-)Sx4(k$fJBxXva0_;$G6!9bGBw13c_Uws zXks4u(8JA@0O9g5f?#V~qR5*u5aIe2HQO^)RW9TTcJk28l`Syl>Q#ZveEE4Em+{?%iz6=V3b>rCm9F zPQQm@-(hfNdo2%n?B)u_&Qh7^^@U>0qMBngH8}H|v+Ejg*Dd(Y#|jgJ-A zQ_bQscil%eY}8oN7ZL+2r|qv+iJY?*l)&3W_55T3GU;?@Om*(M`u0DXAsQ7HSl56> z4P!*(%&wRCb?a4HH&n;lAmr4rS=kMZb74Akha2U~Ktni>>cD$6jpugjULq)D?ea%b zk;UW0pAI~TH59P+o}*c5Ei5L-9OE;OIBt>^(;xw`>cN2`({Rzg71qrNaE=cAH^$wP zNrK9Glp^3a%m+ilQj0SnGq`okjzmE7<3I{JLD6Jn^+oas=h*4>Wvy=KXqVBa;K&ri z4(SVmMXPG}0-UTwa2-MJ=MTfM3K)b~DzSVq8+v-a0&Dsv>4B65{dBhD;(d44CaHSM zb!0ne(*<^Q%|nuaL`Gb3D4AvyO8wyygm=1;9#u5x*k0$UOwx?QxR*6Od8>+ujfyo0 zJ}>2FgW_iv(dBK2OWC-Y=Tw!UwIeOAOUUC;h95&S1hn$G#if+d;*dWL#j#YWswrz_ zMlV=z+zjZJ%SlDhxf)vv@`%~$Afd)T+MS1>ZE7V$Rj#;J*<9Ld=PrK0?qrazRJWx) z(BTLF@Wk279nh|G%ZY7_lK7=&j;x`bMND=zgh_>>-o@6%8_#Bz!FnF*onB@_k|YCF z?vu!s6#h9bL3@tPn$1;#k5=7#s*L;FLK#=M89K^|$3LICYWIbd^qguQp02w5>8p-H z+@J&+pP_^iF4Xu>`D>DcCnl8BUwwOlq6`XkjHNpi@B?OOd`4{dL?kH%lt78(-L}eah8?36zw9d-dI6D{$s{f=M7)1 zRH1M*-82}DoFF^Mi$r}bTB5r6y9>8hjL54%KfyHxn$LkW=AZ(WkHWR;tIWWr@+;^^ zVomjAWT)$+rn%g`LHB6ZSO@M3KBA? z+W7ThSBgpk`jZHZUrp`F;*%6M5kLWy6AW#T{jFHTiKXP9ITrMlEdti7@&AT_a-BA!jc(Kt zWk>IdY-2Zbz?U1)tk#n_Lsl?W;0q`;z|t9*g-xE!(}#$fScX2VkjSiboKWE~afu5d z2B@9mvT=o2fB_>Mnie=TDJB+l`GMKCy%2+NcFsbpv<9jS@$X37K_-Y!cvF5NEY`#p z3sWEc<7$E*X*fp+MqsOyMXO=<2>o8)E(T?#4KVQgt=qa%5FfUG_LE`n)PihCz2=iNUt7im)s@;mOc9SR&{`4s9Q6)U31mn?}Y?$k3kU z#h??JEgH-HGt`~%)1ZBhT9~uRi8br&;a5Y3K_Bl1G)-y(ytx?ok9S*Tz#5Vb=P~xH z^5*t_R2It95=!XDE6X{MjLYn4Eszj9Y91T2SFz@eYlx9Z9*hWaS$^5r7=W5|>sY8}mS(>e9Ez2qI1~wtlA$yv2e-Hjn&K*P z2zWSrC~_8Wrxxf#%QAL&f8iH2%R)E~IrQLgWFg8>`Vnyo?E=uiALoRP&qT{V2{$79 z%9R?*kW-7b#|}*~P#cA@q=V|+RC9=I;aK7Pju$K-n`EoGV^-8Mk=-?@$?O37evGKn z3NEgpo_4{s>=FB}sqx21d3*=gKq-Zk)U+bM%Q_}0`XGkYh*+jRaP+aDnRv#Zz*n$pGp zEU9omuYVXH{AEx>=kk}h2iKt!yqX=EHN)LF}z1j zJx((`CesN1HxTFZ7yrvA2jTPmKYVij>45{ZH2YtsHuGzIRotIFj?(8T@ZWUv{_%AI zgMZlB03C&FtgJqv9%(acqt9N)`4jy4PtYgnhqev!r$GTIOvLF5aZ{tW5MN@9BDGu* zBJzwW3sEJ~Oy8is`l6Ly3an7RPtRr^1Iu(D!B!0O241Xua>Jee;Rc7tWvj!%#yX#m z&pU*?=rTVD7pF6va1D@u@b#V@bShFr3 zMyMbNCZwT)E-%L-{%$3?n}>EN>ai7b$zR_>=l59mW;tfKj^oG)>_TGCJ#HbLBsNy$ zqAqPagZ3uQ(Gsv_-VrZmG&hHaOD#RB#6J8&sL=^iMFB=gH5AIJ+w@sTf7xa&Cnl}@ zxrtzoNq>t?=(+8bS)s2p3>jW}tye0z2aY_Dh@(18-vdfvn;D?sv<>UgL{Ti08$1Q+ zZI3q}yMA^LK=d?YVg({|v?d1|R?5 zL0S3fw)BZazRNNX|7P4rh7!+3tCG~O8l+m?H} z(CB>8(9LtKYIu3ohJ-9ecgk+L&!FX~Wuim&;v$>M4 zUfvn<=Eok(63Ubc>mZrd8d7(>8bG>J?PtOHih_xRYFu1Hg{t;%+hXu2#x%a%qzcab zv$X!ccoj)exoOnaco_jbGw7KryOtuf(SaR-VJ0nAe(1*AA}#QV1lMhGtzD>RoUZ;WA?~!K{8%chYn?ttlz17UpDLlhTkGcVfHY6R<2r4E{mU zq-}D?+*2gAkQYAKrk*rB%4WFC-B!eZZLg4(tR#@kUQHIzEqV48$9=Q(~J_0 zy1%LSCbkoOhRO!J+Oh#;bGuXe;~(bIE*!J@i<%_IcB7wjhB5iF#jBn5+u~fEECN2* z!QFh!m<(>%49H12Y33+?$JxKV3xW{xSs=gxkxW-@Xds^|O1`AmorDKrE8N2-@ospk z=Au%h=f!`_X|G^A;XWL}-_L@D6A~*4Yf!5RTTm$!t8y&fp5_oqvBjW{FufS`!)5m% z2g(=9Ap6Y2y(9OYOWuUVGp-K=6kqQ)kM0P^TQT{X{V$*sN$wbFb-DaUuJF*!?EJPl zJev!UsOB^UHZ2KppYTELh+kqDw+5dPFv&&;;C~=u$Mt+Ywga!8YkL2~@g67}3wAQP zrx^RaXb1(c7vwU8a2se75X(cX^$M{FH4AHS7d2}heqqg4F0!1|Na>UtAdT%3JnS!B)&zelTEj$^b0>Oyfw=P-y-Wd^#dEFRUN*C{!`aJIHi<_YA2?piC%^ zj!p}+ZnBrM?ErAM+D97B*7L8U$K zo(IR-&LF(85p+fuct9~VTSdRjs`d-m|6G;&PoWvC&s8z`TotPSoksp;RsL4VL@CHf z_3|Tn%`ObgRhLmr60<;ya-5wbh&t z#ycN_)3P_KZN5CRyG%LRO4`Ot)3vY#dNX9!f!`_>1%4Q`81E*2BRg~A-VcN7pcX#j zrbl@7`V%n z6J53(m?KRzKb)v?iCuYWbH*l6M77dY4keS!%>}*8n!@ROE4!|7mQ+YS4dff1JJC(t z6Fnuf^=dajqHpH1=|pb(po9Fr8it^;2dEk|Ro=$fxqK$^Yix{G($0m-{RCFQJ~LqUnO7jJcjr zl*N*!6WU;wtF=dLCWzD6kW;y)LEo=4wSXQDIcq5WttgE#%@*m><@H;~Q&GniA-$in z`sjWFLgychS1kIJmPtd-w6%iKkj&dGhtB%0)pyy0M<4HZ@ZY0PWLAd7FCrj&i|NRh?>hZj*&FYnyu%Ur`JdiTu&+n z78d3n)Rl6q&NwVj_jcr#s5G^d?VtV8bkkYco5lV0LiT+t8}98LW>d)|v|V3++zLbHC(NC@X#Hx?21J0M*gP2V`Yd^DYvVIr{C zSc4V)hZKf|OMSm%FVqSRC!phWSyuUAu%0fredf#TDR$|hMZihJ__F!)Nkh6z)d=NC z3q4V*K3JTetxCPgB2_)rhOSWhuXzu+%&>}*ARxUaDeRy{$xK(AC0I=9%X7dmc6?lZNqe-iM(`?Xn3x2Ov>sej6YVQJ9Q42>?4lil?X zew-S>tm{=@QC-zLtg*nh5mQojYnvVzf3!4TpXPuobW_*xYJs;9AokrXcs!Ay z;HK>#;G$*TPN2M!WxdH>oDY6k4A6S>BM0Nimf#LfboKxJXVBC=RBuO&g-=+@O-#0m zh*aPG16zY^tzQLNAF7L(IpGPa+mDsCeAK3k=IL6^LcE8l0o&)k@?dz!79yxUquQIe($zm5DG z5RdXTv)AjHaOPv6z%99mPsa#8OD@9=URvHoJ1hYnV2bG*2XYBgB!-GEoP&8fLmWGg z9NG^xl5D&3L^io&3iYweV*qhc=m+r7C#Jppo$Ygg;jO2yaFU8+F*RmPL` zYxfGKla_--I}YUT353k}nF1zt2NO?+kofR8Efl$Bb^&llgq+HV_UYJUH7M5IoN0sT z4;wDA0gs55ZI|FmJ0}^Pc}{Ji-|#jdR$`!s)Di4^g3b_Qr<*Qu2rz}R6!B^;`Lj3sKWzjMYjexX)-;f5Y+HfkctE{PstO-BZan0zdXPQ=V8 zS8cBhnQyy4oN?J~oK0zl!#S|v6h-nx5to7WkdEk0HKBm;?kcNO*A+u=%f~l&aY*+J z>%^Dz`EQ6!+SEX$>?d(~|MNWU-}JTrk}&`IR|Ske(G^iMdk04)Cxd@}{1=P0U*%L5 zMFH_$R+HUGGv|ju2Z>5x(-aIbVJLcH1S+(E#MNe9g;VZX{5f%_|Kv7|UY-CM(>vf= z!4m?QS+AL+rUyfGJ;~uJGp4{WhOOc%2ybVP68@QTwI(8kDuYf?#^xv zBmOHCZU8O(x)=GVFn%tg@TVW1)qJJ_bU}4e7i>&V?r zh-03>d3DFj&@}6t1y3*yOzllYQ++BO-q!)zsk`D(z||)y&}o%sZ-tUF>0KsiYKFg6 zTONq)P+uL5Vm0w{D5Gms^>H1qa&Z##*X31=58*r%Z@Ko=IMXX{;aiMUp-!$As3{sq z0EEk02MOsgGm7$}E%H1ys2$yftNbB%1rdo@?6~0!a8Ym*1f;jIgfcYEF(I_^+;Xdr z2a>&oc^dF3pm(UNpazXgVzuF<2|zdPGjrNUKpdb$HOgNp*V56XqH`~$c~oSiqx;8_ zEz3fHoU*aJUbFJ&?W)sZB3qOSS;OIZ=n-*#q{?PCXi?Mq4aY@=XvlNQdA;yVC0Vy+ z{Zk6OO!lMYWd`T#bS8FV(`%flEA9El;~WjZKU1YmZpG#49`ku`oV{Bdtvzyz3{k&7 zlG>ik>eL1P93F zd&!aXluU_qV1~sBQf$F%sM4kTfGx5MxO0zJy<#5Z&qzNfull=k1_CZivd-WAuIQf> zBT3&WR|VD|=nKelnp3Q@A~^d_jN3@$x2$f@E~e<$dk$L@06Paw$);l*ewndzL~LuU zq`>vfKb*+=uw`}NsM}~oY}gW%XFwy&A>bi{7s>@(cu4NM;!%ieP$8r6&6jfoq756W z$Y<`J*d7nK4`6t`sZ;l%Oen|+pk|Ry2`p9lri5VD!Gq`U#Ms}pgX3ylAFr8(?1#&dxrtJgB>VqrlWZf61(r`&zMXsV~l{UGjI7R@*NiMJLUoK*kY&gY9kC@^}Fj* zd^l6_t}%Ku<0PY71%zQL`@}L}48M!@=r)Q^Ie5AWhv%#l+Rhu6fRpvv$28TH;N7Cl z%I^4ffBqx@Pxpq|rTJV)$CnxUPOIn`u278s9#ukn>PL25VMv2mff)-RXV&r`Dwid7}TEZxXX1q(h{R6v6X z&x{S_tW%f)BHc!jHNbnrDRjGB@cam{i#zZK*_*xlW@-R3VDmp)<$}S%t*@VmYX;1h zFWmpXt@1xJlc15Yjs2&e%)d`fimRfi?+fS^BoTcrsew%e@T^}wyVv6NGDyMGHSKIQ zC>qFr4GY?#S#pq!%IM_AOf`#}tPoMn7JP8dHXm(v3UTq!aOfEXNRtEJ^4ED@jx%le zvUoUs-d|2(zBsrN0wE(Pj^g5wx{1YPg9FL1)V1JupsVaXNzq4fX+R!oVX+q3tG?L= z>=s38J_!$eSzy0m?om6Wv|ZCbYVHDH*J1_Ndajoh&?L7h&(CVii&rmLu+FcI;1qd_ zHDb3Vk=(`WV?Uq;<0NccEh0s`mBXcEtmwt6oN99RQt7MNER3`{snV$qBTp={Hn!zz z1gkYi#^;P8s!tQl(Y>|lvz{5$uiXsitTD^1YgCp+1%IMIRLiSP`sJru0oY-p!FPbI)!6{XM%)(_Dolh1;$HlghB-&e><;zU&pc=ujpa-(+S&Jj zX1n4T#DJDuG7NP;F5TkoG#qjjZ8NdXxF0l58RK?XO7?faM5*Z17stidTP|a%_N z^e$D?@~q#Pf+708cLSWCK|toT1YSHfXVIs9Dnh5R(}(I;7KhKB7RD>f%;H2X?Z9eR z{lUMuO~ffT!^ew= z7u13>STI4tZpCQ?yb9;tSM-(EGb?iW$a1eBy4-PVejgMXFIV_Ha^XB|F}zK_gzdhM z!)($XfrFHPf&uyFQf$EpcAfk83}91Y`JFJOiQ;v5ca?)a!IxOi36tGkPk4S6EW~eq z>WiK`Vu3D1DaZ}515nl6>;3#xo{GQp1(=uTXl1~ z4gdWxr-8a$L*_G^UVd&bqW_nzMM&SlNW$8|$lAfo@zb+P>2q?=+T^qNwblP*RsN?N zdZE%^Zs;yAwero1qaoqMp~|KL=&npffh981>2om!fseU(CtJ=bW7c6l{U5(07*e0~ zJRbid6?&psp)ilmYYR3ZIg;t;6?*>hoZ3uq7dvyyq-yq$zH$yyImjfhpQb@WKENSP zl;KPCE+KXzU5!)mu12~;2trrLfs&nlEVOndh9&!SAOdeYd}ugwpE-9OF|yQs(w@C9 zoXVX`LP~V>%$<(%~tE*bsq(EFm zU5z{H@Fs^>nm%m%wZs*hRl=KD%4W3|(@j!nJr{Mmkl`e_uR9fZ-E{JY7#s6i()WXB0g-b`R{2r@K{2h3T+a>82>722+$RM*?W5;Bmo6$X3+Ieg9&^TU(*F$Q3 zT572!;vJeBr-)x?cP;^w1zoAM`nWYVz^<6N>SkgG3s4MrNtzQO|A?odKurb6DGZffo>DP_)S0$#gGQ_vw@a9JDXs2}hV&c>$ zUT0;1@cY5kozKOcbN6)n5v)l#>nLFL_x?2NQgurQH(KH@gGe>F|$&@ zq@2A!EXcIsDdzf@cWqElI5~t z4cL9gg7{%~4@`ANXnVAi=JvSsj95-7V& zME3o-%9~2?cvlH#twW~99=-$C=+b5^Yv}Zh4;Mg-!LS zw>gqc=}CzS9>v5C?#re>JsRY!w|Mtv#%O3%Ydn=S9cQarqkZwaM4z(gL~1&oJZ;t; zA5+g3O6itCsu93!G1J_J%Icku>b3O6qBW$1Ej_oUWc@MI)| zQ~eyS-EAAnVZp}CQnvG0N>Kc$h^1DRJkE7xZqJ0>p<>9*apXgBMI-v87E0+PeJ-K& z#(8>P_W^h_kBkI;&e_{~!M+TXt@z8Po*!L^8XBn{of)knd-xp{heZh~@EunB2W)gd zAVTw6ZZasTi>((qpBFh(r4)k zz&@Mc@ZcI-4d639AfcOgHOU+YtpZ)rC%Bc5gw5o~+E-i+bMm(A6!uE>=>1M;V!Wl4 z<#~muol$FsY_qQC{JDc8b=$l6Y_@_!$av^08`czSm!Xan{l$@GO-zPq1s>WF)G=wv zDD8j~Ht1pFj)*-b7h>W)@O&m&VyYci&}K|0_Z*w`L>1jnGfCf@6p}Ef*?wdficVe_ zmPRUZ(C+YJU+hIj@_#IiM7+$4kH#VS5tM!Ksz01siPc-WUe9Y3|pb4u2qnn zRavJiRpa zq?tr&YV?yKt<@-kAFl3s&Kq#jag$hN+Y%%kX_ytvpCsElgFoN3SsZLC>0f|m#&Jhu zp7c1dV$55$+k78FI2q!FT}r|}cIV;zp~#6X2&}22$t6cHx_95FL~T~1XW21VFuatb zpM@6w>c^SJ>Pq6{L&f9()uy)TAWf;6LyHH3BUiJ8A4}od)9sriz~e7}l7Vr0e%(=>KG1Jay zW0azuWC`(|B?<6;R)2}aU`r@mt_#W2VrO{LcX$Hg9f4H#XpOsAOX02x^w9+xnLVAt z^~hv2guE-DElBG+`+`>PwXn5kuP_ZiOO3QuwoEr)ky;o$n7hFoh}Aq0@Ar<8`H!n} zspCC^EB=6>$q*gf&M2wj@zzfBl(w_@0;h^*fC#PW9!-kT-dt*e7^)OIU{Uw%U4d#g zL&o>6`hKQUps|G4F_5AuFU4wI)(%9(av7-u40(IaI|%ir@~w9-rLs&efOR@oQy)}{ z&T#Qf`!|52W0d+>G!h~5A}7VJky`C3^fkJzt3|M&xW~x-8rSi-uz=qBsgODqbl(W#f{Ew#ui(K)(Hr&xqZs` zfrK^2)tF#|U=K|_U@|r=M_Hb;qj1GJG=O=d`~#AFAccecIaq3U`(Ds1*f*TIs=IGL zp_vlaRUtFNK8(k;JEu&|i_m39c(HblQkF8g#l|?hPaUzH2kAAF1>>Yykva0;U@&oRV8w?5yEK??A0SBgh?@Pd zJg{O~4xURt7!a;$rz9%IMHQeEZHR8KgFQixarg+MfmM_OeX#~#&?mx44qe!wt`~dd zqyt^~ML>V>2Do$huU<7}EF2wy9^kJJSm6HoAD*sRz%a|aJWz_n6?bz99h)jNMp}3k ztPVbos1$lC1nX_OK0~h>=F&v^IfgBF{#BIi&HTL}O7H-t4+wwa)kf3AE2-Dx@#mTA z!0f`>vz+d3AF$NH_-JqkuK1C+5>yns0G;r5ApsU|a-w9^j4c+FS{#+7- zH%skr+TJ~W_8CK_j$T1b;$ql_+;q6W|D^BNK*A+W5XQBbJy|)(IDA=L9d>t1`KX2b zOX(Ffv*m?e>! zS3lc>XC@IqPf1g-%^4XyGl*1v0NWnwZTW?z4Y6sncXkaA{?NYna3(n@(+n+#sYm}A zGQS;*Li$4R(Ff{obl3#6pUsA0fKuWurQo$mWXMNPV5K66V!XYOyc})^>889Hg3I<{V^Lj9($B4Zu$xRr=89-lDz9x`+I8q(vEAimx1K{sTbs|5x7S zZ+7o$;9&9>@3K;5-DVzGw=kp7ez%1*kxhGytdLS>Q)=xUWv3k_x(IsS8we39Tijvr z`GKk>gkZTHSht;5q%fh9z?vk%sWO}KR04G9^jleJ^@ovWrob7{1xy7V=;S~dDVt%S za$Q#Th%6g1(hiP>hDe}7lcuI94K-2~Q0R3A1nsb7Y*Z!DtQ(Ic<0;TDKvc6%1kBdJ z$hF!{uALB0pa?B^TC}#N5gZ|CKjy|BnT$7eaKj;f>Alqdb_FA3yjZ4CCvm)D&ibL) zZRi91HC!TIAUl<|`rK_6avGh`!)TKk=j|8*W|!vb9>HLv^E%t$`@r@piI(6V8pqDG zBON7~=cf1ZWF6jc{qkKm;oYBtUpIdau6s+<-o^5qNi-p%L%xAtn9OktFd{@EjVAT% z#?-MJ5}Q9QiK_jYYWs+;I4&!N^(mb!%4zx7qO6oCEDn=8oL6#*9XIJ&iJ30O`0vsFy|fEVkw}*jd&B6!IYi+~Y)qv6QlM&V9g0 zh)@^BVDB|P&#X{31>G*nAT}Mz-j~zd>L{v{9AxrxKFw8j;ccQ$NE0PZCc(7fEt1xd z`(oR2!gX6}R+Z77VkDz^{I)@%&HQT5q+1xlf*3R^U8q%;IT8-B53&}dNA7GW`Ki&= z$lrdH zDCu;j$GxW<&v_4Te7=AE2J0u1NM_7Hl9$u{z(8#%8vvrx2P#R7AwnY|?#LbWmROa; zOJzU_*^+n(+k;Jd{e~So9>OF>fPx$Hb$?~K1ul2xr>>o@**n^6IMu8+o3rDp(X$cC z`wQt9qIS>yjA$K~bg{M%kJ00A)U4L+#*@$8UlS#lN3YA{R{7{-zu#n1>0@(#^eb_% zY|q}2)jOEM8t~9p$X5fpT7BZQ1bND#^Uyaa{mNcFWL|MoYb@>y`d{VwmsF&haoJuS2W7azZU0{tu#Jj_-^QRc35tjW~ae&zhKk!wD}#xR1WHu z_7Fys#bp&R?VXy$WYa$~!dMxt2@*(>@xS}5f-@6eoT%rwH zv_6}M?+piNE;BqaKzm1kK@?fTy$4k5cqYdN8x-<(o6KelwvkTqC3VW5HEnr+WGQlF zs`lcYEm=HPpmM4;Ich7A3a5Mb3YyQs7(Tuz-k4O0*-YGvl+2&V(B&L1F8qfR0@vQM-rF<2h-l9T12eL}3LnNAVyY_z51xVr$%@VQ-lS~wf3mnHc zoM({3Z<3+PpTFCRn_Y6cbxu9v>_>eTN0>hHPl_NQQuaK^Mhrv zX{q#80ot;ptt3#js3>kD&uNs{G0mQp>jyc0GG?=9wb33hm z`y2jL=J)T1JD7eX3xa4h$bG}2ev=?7f>-JmCj6){Upo&$k{2WA=%f;KB;X5e;JF3IjQBa4e-Gp~xv- z|In&Rad7LjJVz*q*+splCj|{7=kvQLw0F@$vPuw4m^z=B^7=A4asK_`%lEf_oIJ-O z{L)zi4bd#&g0w{p1$#I&@bz3QXu%Y)j46HAJKWVfRRB*oXo4lIy7BcVl4hRs<%&iQ zr|)Z^LUJ>qn>{6y`JdabfNNFPX7#3`x|uw+z@h<`x{J4&NlDjnknMf(VW_nKWT!Jh zo1iWBqT6^BR-{T=4Ybe+?6zxP_;A5Uo{}Xel%*=|zRGm1)pR43K39SZ=%{MDCS2d$~}PE-xPw4ZK6)H;Zc&0D5p!vjCn0wCe&rVIhchR9ql!p2`g0b@JsC^J#n_r*4lZ~u0UHKwo(HaHUJDHf^gdJhTdTW z3i7Zp_`xyKC&AI^#~JMVZj^9WsW}UR#nc#o+ifY<4`M+?Y9NTBT~p`ONtAFf8(ltr*ER-Ig!yRs2xke#NN zkyFcaQKYv>L8mQdrL+#rjgVY>Z2_$bIUz(kaqL}cYENh-2S6BQK-a(VNDa_UewSW` zMgHi<3`f!eHsyL6*^e^W7#l?V|42CfAjsgyiJsA`yNfAMB*lAsJj^K3EcCzm1KT zDU2+A5~X%ax-JJ@&7>m`T;;}(-e%gcYQtj}?ic<*gkv)X2-QJI5I0tA2`*zZRX(;6 zJ0dYfMbQ+{9Rn3T@Iu4+imx3Y%bcf2{uT4j-msZ~eO)5Z_T7NC|Nr3)|NWjomhv=E zXaVin)MY)`1QtDyO7mUCjG{5+o1jD_anyKn73uflH*ASA8rm+S=gIfgJ);>Zx*hNG z!)8DDCNOrbR#9M7Ud_1kf6BP)x^p(|_VWCJ+(WGDbYmnMLWc?O4zz#eiP3{NfP1UV z(n3vc-axE&vko^f+4nkF=XK-mnHHQ7>w05$Q}iv(kJc4O3TEvuIDM<=U9@`~WdKN* zp4e4R1ncR_kghW}>aE$@OOc~*aH5OOwB5U*Z)%{LRlhtHuigxH8KuDwvq5{3Zg{Vr zrd@)KPwVKFP2{rXho(>MTZZfkr$*alm_lltPob4N4MmhEkv`J(9NZFzA>q0Ch;!Ut zi@jS_=0%HAlN+$-IZGPi_6$)ap>Z{XQGt&@ZaJ(es!Po5*3}>R4x66WZNsjE4BVgn z>}xm=V?F#tx#e+pimNPH?Md5hV7>0pAg$K!?mpt@pXg6UW9c?gvzlNe0 z3QtIWmw$0raJkjQcbv-7Ri&eX6Ks@@EZ&53N|g7HU<;V1pkc&$3D#8k!coJ=^{=vf z-pCP;vr2#A+i#6VA?!hs6A4P@mN62XYY$#W9;MwNia~89i`=1GoFESI+%Mbrmwg*0 zbBq4^bA^XT#1MAOum)L&ARDXJ6S#G>&*72f50M1r5JAnM1p7GFIv$Kf9eVR(u$KLt z9&hQ{t^i16zL1c(tRa~?qr?lbSN;1k;%;p*#gw_BwHJRjcYPTj6>y-rw*dFTnEs95 z`%-AoPL!P16{=#RI0 zUb6#`KR|v^?6uNnY`zglZ#Wd|{*rZ(x&Hk8N6ob6mpX~e^qu5kxvh$2TLJA$M=rx zc!#ot+sS+-!O<0KR6+Lx&~zgEhCsbFY{i_DQCihspM?e z-V}HemMAvFzXR#fV~a=Xf-;tJ1edd}Mry@^=9BxON;dYr8vDEK<<{ zW~rg(ZspxuC&aJo$GTM!9_sXu(EaQJNkV9AC(ob#uA=b4*!Uf}B*@TK=*dBvKKPAF z%14J$S)s-ws9~qKsf>DseEW(ssVQ9__YNg}r9GGx3AJiZR@w_QBlGP>yYh0lQCBtf zx+G;mP+cMAg&b^7J!`SiBwC81M_r0X9kAr2y$0(Lf1gZK#>i!cbww(hn$;fLIxRf? z!AtkSZc-h76KGSGz%48Oe`8ZBHkSXeVb!TJt_VC>$m<#}(Z}!(3h631ltKb3CDMw^fTRy%Ia!b&at`^g7Ew-%WLT9(#V0OP9CE?uj62s>`GI3NA z!`$U+i<`;IQyNBkou4|-7^9^ylac-Xu!M+V5p5l0Ve?J0wTSV+$gYtoc=+Ve*OJUJ z$+uIGALW?}+M!J9+M&#bT=Hz@{R2o>NtNGu1yS({pyteyb>*sg4N`KAD?`u3F#C1y z2K4FKOAPASGZTep54PqyCG(h3?kqQQAxDSW@>T2d!n;9C8NGS;3A8YMRcL>b=<<%M zMiWf$jY;`Ojq5S{kA!?28o)v$;)5bTL<4eM-_^h4)F#eeC2Dj*S`$jl^yn#NjJOYT zx%yC5Ww@eX*zsM)P(5#wRd=0+3~&3pdIH7CxF_2iZSw@>kCyd z%M}$1p((Bidw4XNtk&`BTkU{-PG)SXIZ)yQ!Iol6u8l*SQ1^%zC72FP zLvG>_Z0SReMvB%)1@+et0S{<3hV@^SY3V~5IY(KUtTR{*^xJ^2NN{sIMD9Mr9$~(C$GLNlSpzS=fsbw-DtHb_T|{s z9OR|sx!{?F``H!gVUltY7l~dx^a(2;OUV^)7 z%@hg`8+r&xIxmzZ;Q&v0X%9P)U0SE@r@(lKP%TO(>6I_iF{?PX(bez6v8Gp!W_nd5 z<8)`1jcT)ImNZp-9rr4_1MQ|!?#8sJQx{`~7)QZ75I=DPAFD9Mt{zqFrcrXCU9MG8 zEuGcy;nZ?J#M3!3DWW?Zqv~dnN6ijlIjPfJx(#S0cs;Z=jDjKY|$w2s4*Xa1Iz953sN2Lt!Vmk|%ZwOOqj`sA--5Hiaq8!C%LV zvWZ=bxeRV(&%BffMJ_F~~*FdcjhRVNUXu)MS(S#67rDe%Ler=GS+WysC1I2=Bmbh3s6wdS}o$0 zz%H08#SPFY9JPdL6blGD$D-AaYi;X!#zqib`(XX*i<*eh+2UEPzU4}V4RlC3{<>-~ zadGA8lSm>b7Z!q;D_f9DT4i)Q_}ByElGl*Cy~zX%IzHp)@g-itZB6xM70psn z;AY8II99e6P2drgtTG5>`^|7qg`9MTp%T~|1N3tBqV}2zgow3TFAH{XPor0%=HrkXnKyxyozHlJ6 zd3}OWkl?H$l#yZqOzZbMI+lDLoH48;s10!m1!K87g;t}^+A3f3e&w{EYhVPR0Km*- zh5-ku$Z|Ss{2?4pGm(Rz!0OQb^_*N`)rW{z)^Cw_`a(_L9j=&HEJl(!4rQy1IS)>- zeTIr>hOii`gc(fgYF(cs$R8l@q{mJzpoB5`5r>|sG zBpsY}RkY(g5`bj~D>(;F8v*DyjX(#nVLSs>)XneWI&%Wo>a0u#4A?N<1SK4D}&V1oN)76 z%S>a2n3n>G`YY1>0Hvn&AMtMuI_?`5?4y3w2Hnq4Qa2YH5 zxKdfM;k467djL31Y$0kd9FCPbU=pHBp@zaIi`Xkd80;%&66zvSqsq6%aY)jZacfvw ztkWE{ZV6V2WL9e}Dvz|!d96KqVkJU@5ryp#rReeWu>mSrOJxY^tWC9wd0)$+lZc%{ zY=c4#%OSyQJvQUuy^u}s8DN8|8T%TajOuaY^)R-&8s@r9D`(Ic4NmEu)fg1f!u`xUb;9t#rM z>}cY=648@d5(9A;J)d{a^*ORdVtJrZ77!g~^lZ9@)|-ojvW#>)Jhe8$7W3mhmQh@S zU=CSO+1gSsQ+Tv=x-BD}*py_Ox@;%#hPb&tqXqyUW9jV+fonnuCyVw=?HR>dAB~Fg z^vl*~y*4|)WUW*9RC%~O1gHW~*tJb^a-j;ae2LRNo|0S2`RX>MYqGKB^_ng7YRc@! zFxg1X!VsvXkNuv^3mI`F2=x6$(pZdw=jfYt1ja3FY7a41T07FPdCqFhU6%o|Yb6Z4 zpBGa=(ao3vvhUv#*S{li|EyujXQPUV;0sa5!0Ut)>tPWyC9e0_9(=v*z`TV5OUCcx zT=w=^8#5u~7<}8Mepqln4lDv*-~g^VoV{(+*4w(q{At6d^E-Usa2`JXty++Oh~on^ z;;WHkJsk2jvh#N|?(2PLl+g!M0#z_A;(#Uy=TzL&{Ei5G9#V{JbhKV$Qmkm%5tn!CMA? z@hM=b@2DZWTQ6>&F6WCq6;~~WALiS#@{|I+ucCmD6|tBf&e;$_)%JL8$oIQ%!|Xih1v4A$=7xNO zZVz$G8;G5)rxyD+M0$20L$4yukA_D+)xmK3DMTH3Q+$N&L%qB)XwYx&s1gkh=%qGCCPwnwhbT4p%*3R)I}S#w7HK3W^E%4w z2+7ctHPx3Q97MFYB48HfD!xKKb(U^K_4)Bz(5dvwyl*R?)k;uHEYVi|{^rvh)w7}t z`tnH{v9nlVHj2ign|1an_wz0vO)*`3RaJc#;(W-Q6!P&>+@#fptCgtUSn4!@b7tW0&pE2Qj@7}f#ugu4*C)8_}AMRuz^WG zc)XDcOPQjRaGptRD^57B83B-2NKRo!j6TBAJntJPHNQG;^Oz}zt5F^kId~miK3J@l ztc-IKp6qL!?u~q?qfGP0I~$5gvq#-0;R(oLU@sYayr*QH95fnrYA*E|n%&FP@Cz`a zSdJ~(c@O^>qaO`m9IQ8sd8!L<+)GPJDrL7{4{ko2gWOZel^3!($Gjt|B&$4dtfTmBmC>V`R&&6$wpgvdmns zxcmfS%9_ZoN>F~azvLFtA(9Q5HYT#A(byGkESnt{$Tu<73$W~reB4&KF^JBsoqJ6b zS?$D7DoUgzLO-?P`V?5_ub$nf1p0mF?I)StvPomT{uYjy!w&z$t~j&en=F~hw|O(1 zlV9$arQmKTc$L)Kupwz_zA~deT+-0WX6NzFPh&d+ly*3$%#?Ca9Z9lOJsGVoQ&1HNg+)tJ_sw)%oo*DK)iU~n zvL``LqTe=r=7SwZ@LB)9|3QB5`0(B9r(iR}0nUwJss-v=dXnwMRQFYSRK1blS#^g(3@z{`=8_CGDm!LESTWig zzm1{?AG&7`uYJ;PoFO$o8RWuYsV26V{>D-iYTnvq7igWx9@w$EC*FV^vpvDl@i9yp zPIqiX@hEZF4VqzI3Y)CHhR`xKN8poL&~ak|wgbE4zR%Dm(a@?bw%(7(!^>CM!^4@J z6Z)KhoQP;WBq_Z_&<@i2t2&xq>N>b;Np2rX?yK|-!14iE2T}E|jC+=wYe~`y38g3J z8QGZquvqBaG!vw&VtdXWX5*i5*% zJP~7h{?&E|<#l{klGPaun`IgAJ4;RlbRqgJz5rmHF>MtJHbfqyyZi53?Lhj=(Ku#& z__ubmZIxzSq3F90Xur!1)Vqe6b@!ueHA!93H~jdHmaS5Q^CULso}^poy)0Op6!{^9 zWyCyyIrdBP4fkliZ%*g+J-A!6VFSRF6Liu6G^^=W>cn81>4&7(c7(6vCGSAJ zQZ|S3mb|^Wf=yJ(h~rq`iiW~|n#$+KcblIR<@|lDtm!&NBzSG-1;7#YaU+-@=xIm4 zE}edTYd~e&_%+`dIqqgFntL-FxL3!m4yTNt<(^Vt9c6F(`?9`u>$oNxoKB29<}9FE zgf)VK!*F}nW?}l95%RRk8N4^Rf8)Xf;drT4<|lUDLPj^NPMrBPL;MX&0oGCsS za3}vWcF(IPx&W6{s%zwX{UxHX2&xLGfT{d9bWP!g;Lg#etpuno$}tHoG<4Kd*=kpU z;4%y(<^yj(UlG%l-7E9z_Kh2KoQ19qT3CR@Ghr>BAgr3Vniz3LmpC4g=g|A3968yD2KD$P7v$ zx9Q8`2&qH3&y-iv0#0+jur@}k`6C%7fKbCr|tHX2&O%r?rBpg`YNy~2m+ z*L7dP$RANzVUsG_Lb>=__``6vA*xpUecuGsL+AW?BeSwyoQfDlXe8R1*R1M{0#M?M zF+m19`3<`gM{+GpgW^=UmuK*yMh3}x)7P738wL8r@(Na6%ULPgbPVTa6gh5Q(SR0f znr6kdRpe^(LVM;6Rt(Z@Lsz3EX*ry6(WZ?w>#ZRelx)N%sE+MN>5G|Z8{%@b&D+Ov zPU{shc9}%;G7l;qbonIb_1m^Qc8ez}gTC-k02G8Rl?7={9zBz8uRX2{XJQ{vZhs67avlRn| zgRtWl0Lhjet&!YC47GIm%1gdq%T24_^@!W3pCywc89X4I5pnBCZDn(%!$lOGvS*`0!AoMtqxNPFgaMR zwoW$p;8l6v%a)vaNsesED3f}$%(>zICnoE|5JwP&+0XI}JxPccd+D^gx`g`=GsUc0 z9Uad|C+_@_0%JmcObGnS@3+J^0P!tg+fUZ_w#4rk#TlJYPXJiO>SBxzs9(J;XV9d{ zmTQE1(K8EYaz9p^XLbdWudyIPJlGPo0U*)fAh-jnbfm@SYD_2+?|DJ-^P+ojG{2{6 z>HJtedEjO@j_tqZ4;Zq1t5*5cWm~W?HGP!@_f6m#btM@46cEMhhK{(yI&jG)fwL1W z^n_?o@G8a-jYt!}$H*;{0#z8lANlo!9b@!c5K8<(#lPlpE!z86Yq#>WT&2} z;;G1$pD%iNoj#Z=&kij5&V1KHIhN-h<;{HC5wD)PvkF>CzlQOEx_0;-TJ*!#&{Wzt zKcvq^SZIdop}y~iouNqtU7K7+?eIz-v_rfNM>t#i+dD$s_`M;sjGubTdP)WI*uL@xPOLHt#~T<@Yz>xt50ZoTw;a(a}lNiDN-J${gOdE zx?8LOA|tv{Mb}=TTR=LcqMqbCJkKj+@;4Mu)Cu0{`~ohix6E$g&tff)aHeUAQQ%M? zIN4uSUTzC1iMEWL*W-in1y)C`E+R8j?4_?X4&2Zv5?QdkNMz(k} zw##^Ikx`#_s>i&CO_mu@vJJ*|3ePRDl5pq$9V^>D;g0R%l>lw;ttyM6Sy`NBF{)Lr zSk)V>mZr96+aHY%vTLLt%vO-+juw6^SO_ zYGJaGeWX6W(TOQx=5oTGXOFqMMU*uZyt>MR-Y`vxW#^&)H zk0!F8f*@v6NO@Z*@Qo)+hlX40EWcj~j9dGrLaq%1;DE_%#lffXCcJ;!ZyyyZTz74Q zb2WSly6sX{`gQeToQsi1-()5EJ1nJ*kXGD`xpXr~?F#V^sxE3qSOwRSaC9x9oa~jJ zTG9`E|q zC5Qs1xh}jzb5UPYF`3N9YuMnI7xsZ41P;?@c|%w zl=OxLr6sMGR+`LStLvh)g?fA5p|xbUD;yFAMQg&!PEDYxVYDfA>oTY;CFt`cg?Li1 z0b})!9Rvw&j#*&+D2))kXLL z0+j=?7?#~_}N-qdEIP>DQaZh#F(#e0WNLzwUAj@r694VJ8?Dr5_io2X49XYsG^ zREt0$HiNI~6VV!ycvao+0v7uT$_ilKCvsC+VDNg7yG1X+eNe^3D^S==F3ByiW0T^F zH6EsH^}Uj^VPIE&m)xlmOScYR(w750>hclqH~~dM2+;%GDXT`u4zG!p((*`Hwx41M z4KB+`hfT(YA%W)Ve(n+Gu9kuXWKzxg{1ff^xNQw>w%L-)RySTk9kAS92(X0Shg^Q? zx1YXg_TLC^?h6!4mBqZ9pKhXByu|u~gF%`%`vdoaGBN3^j4l!4x?Bw4Jd)Z4^di}! zXlG1;hFvc>H?bmmu1E7Vx=%vahd!P1#ZGJOJYNbaek^$DHt`EOE|Hlij+hX>ocQFSLVu|wz`|KVl@Oa;m2k6b*mNK2Vo{~l9>Qa3@B7G7#k?)aLx;w6U ze8bBq%vF?5v>#TspEoaII!N}sRT~>bh-VWJ7Q*1qsz%|G)CFmnttbq$Ogb{~YK_=! z{{0vhlW@g!$>|}$&4E3@k`KPElW6x#tSX&dfle>o!irek$NAbDzdd2pVeNzk4&qgJ zXvNF0$R96~g0x+R1igR=Xu&X_Hc5;!Ze&C)eUTB$9wW&?$&o8Yxhm5s(S`;?{> z*F?9Gr0|!OiKA>Rq-ae=_okB6&yMR?!JDer{@iQgIn=cGxs-u^!8Q$+N&pfg2WM&Z zulHu=Uh~U>fS{=Nm0x>ACvG*4R`Dx^kJ65&Vvfj`rSCV$5>c04N26Rt2S?*kh3JKq z9(3}5T?*x*AP(X2Ukftym0XOvg~r6Ms$2x&R&#}Sz23aMGU&7sU-cFvE3Eq`NBJe84VoftWF#v7PDAp`@V zRFCS24_k~;@~R*L)eCx@Q9EYmM)Sn}HLbVMyxx%{XnMBDc-YZ<(DXDBYUt8$u5Zh} zBK~=M9cG$?_m_M61YG+#|9Vef7LfbH>(C21&aC)x$^Lg}fa#SF){RX|?-xZjSOrn# z2ZAwUF)$VB<&S;R3FhNSQOV~8w%A`V9dWyLiy zgt7G=Z4t|zU3!dh5|s(@XyS|waBr$>@=^Dspmem8)@L`Ns{xl%rGdX!R(BiC5C7Vo zXetb$oC_iXS}2x_Hy}T(hUUNbO47Q@+^4Q`h>(R-;OxCyW#eoOeC51jzxnM1yxBrp zz6}z`(=cngs6X05e79o_B7@3K|Qpe3n38Py_~ zpi?^rj!`pq!7PHGliC$`-8A^Ib?2qgJJCW+(&TfOnFGJ+@-<<~`7BR0f4oSINBq&R z2CM`0%WLg_Duw^1SPwj-{?BUl2Y=M4e+7yL1{C&&f&zjF06#xf>VdLozgNye(BNgSD`=fFbBy0HIosLl@JwCQl^s;eTnc( z3!r8G=K>zb`|bLLI0N|eFJk%s)B>oJ^M@AQzqR;HUjLsOqW<0v>1ksT_#24*U@R3HJu*A^#1o#P3%3_jq>icD@<`tqU6ICEgZrME(xX#?i^Z z%Id$_uyQGlFD-CcaiRtRdGn|K`Lq5L-rx7`vYYGH7I=eLfHRozPiUtSe~Tt;IN2^gCXmf2#D~g2@9bhzK}3nphhG%d?V7+Zq{I2?Gt*!NSn_r~dd$ zqkUOg{U=MI?Ehx@`(X%rQB?LP=CjJ*V!rec{#0W2WshH$X#9zep!K)tzZoge*LYd5 z@g?-j5_mtMp>_WW`p*UNUZTFN{_+#m*bJzt{hvAdkF{W40{#L3w6gzPztnsA_4?&0 z(+>pv!zB16rR-(nm(^c>Z(its{ny677vT8sF564^mlZvJ!h65}OW%Hn|2OXbOQM%b z{6C54Z2v;^hyMQ;UH+HwFD2!F!VlQ}6Z{L0_9g5~CH0@Mqz?ZC`^QkhOU#$Lx<4`B zyZsa9uPF!rZDo8ZVfzzR#raQ>5|)k~_Ef*wDqG^76o)j!C4 zykvT*o$!-MBko@?{b~*Zf2*YMlImrK`cEp|#D7f%Twm<|C|dWD MESSAGES = new ArrayList<>(); + + public static CliMessager getInstance() { + return LazyHolder.INSTANCE; + } + + /** + * Add exception to pass onto Typescript layer. + * Will be treated as an Error based on the properties set + * in EventKey. Please make sure that EventKey is correct and is + * in sync with messages/EventKeyTemplates.json + * + * @param exception to send to Typescript layer + */ + public void addMessage(MessagePassableException exception) { + final EventKey eventKey = exception.getEventKey(); + addMessage( + exception.getFullStacktrace(), + eventKey, + exception.getArgs()); + } + + /** + * Add message to pass onto Typescript layer. + * Make sure EventKey is updated with messages/EventKeyTemplates.json + * and has correct properties in the enum. + * + * @param internalLog Information for internal use. Will be logged but not displayed to user + * @param eventKey EventKey to display to user + * @param args String args passed to the EventKey to make the displayed message meaningful + */ + public void addMessage(String internalLog, EventKey eventKey, String... args) { + // Developer error if eventKey was not added to exception and we'll get a bunch of NPEs + assert (eventKey != null); + // Confirm that the correct number of arguments for the message has been provided + // If this fails, this would be a developer error + assert (eventKey.getArgCount() == args.length); + + final Message message = new Message( + eventKey.getMessageKey(), + Arrays.asList(args), + internalLog, + eventKey.getMessageType(), + eventKey.getMessageHandler(), + eventKey.isVerbose()); + MESSAGES.add(message); + } + + /** + * Convert all messages stored by the instance into a JSON-formatted string, enclosed in the start and end strings. + * Java code can use this method to log the messages to console, and TypeScript code can seek the start and stop + * strings to get an array of messages that can be deserialized. + * @return + */ + public String getAllMessagesWithFormatting() { + final String messagesAsJson = getMessagesAsJson(); + return START + messagesAsJson + END; + } + + private String getMessagesAsJson() { + return new Gson().toJson(MESSAGES); + } + + /** + * TO BE USED ONLY BY TESTS! + * + * @return all messages as JSON without formatting + */ + public String getAllMessages() { + return getMessagesAsJson(); + } + + /** + * TO BE USED ONLY BY TESTS! + * STAY AWAY!! + */ + public void resetMessages() { + MESSAGES.clear(); + } + + private static final class LazyHolder { + // Postpone initialization until first use + private static final CliMessager INSTANCE = new CliMessager(); + } +} diff --git a/cli-messaging/src/main/java/com/salesforce/messaging/EventKey.java b/cli-messaging/src/main/java/com/salesforce/messaging/EventKey.java new file mode 100644 index 000000000..d7e812002 --- /dev/null +++ b/cli-messaging/src/main/java/com/salesforce/messaging/EventKey.java @@ -0,0 +1,59 @@ +package com.salesforce.messaging; +import static com.salesforce.messaging.Message.*; + +public enum EventKey { + // MAKE SURE `messageKey` OF EVERY VALUE ADDED HERE HAS AN ENTRY IN 'messages/EventKeyTemplates.js'! + INFO_GENERAL_INTERNAL_LOG("info.generalInternalLog", 1, MessageType.INFO, MessageHandler.INTERNAL, true), + WARNING_INVALID_CAT_SKIPPED("warning.invalidCategorySkipped", 1, MessageType.WARNING, MessageHandler.UX, true), + WARNING_INVALID_RULESET_SKIPPED("warning.invalidRulesetSkipped", 1, MessageType.WARNING, MessageHandler.UX, true), + WARNING_XML_DROPPED("warning.xmlDropped", 1, MessageType.WARNING, MessageHandler.UX, true), + INFO_JAR_AND_XML_PROCESSED("info.jarAndXmlProcessed", 2, MessageType.INFO, MessageHandler.UX, true), + ERROR_INTERNAL_UNEXPECTED("error.internal.unexpectedError", 1, MessageType.ERROR, MessageHandler.INTERNAL, false), + ERROR_INTERNAL_MAIN_INVALID_ARGUMENT("error.internal.mainInvalidArgument", 1, MessageType.ERROR, MessageHandler.INTERNAL, false), + ERROR_INTERNAL_JSON_WRITE_FAILED("error.internal.jsonWriteFailed", 1, MessageType.ERROR, MessageHandler.INTERNAL, false), + ERROR_INTERNAL_CLASSPATH_DOES_NOT_EXIST("error.internal.classpathDoesNotExist", 1, MessageType.ERROR, MessageHandler.INTERNAL, false), + ERROR_INTERNAL_XML_MISSING_IN_CLASSPATH("error.internal.xmlMissingInClasspath", 1, MessageType.ERROR, MessageHandler.INTERNAL, false), + ERROR_EXTERNAL_JAR_NOT_READABLE("error.external.jarNotReadable", 1, MessageType.ERROR, MessageHandler.UX, false), + ERROR_EXTERNAL_DIR_NOT_READABLE("error.external.dirNotReadable", 1, MessageType.ERROR, MessageHandler.UX, false), + ERROR_EXTERNAL_DUPLICATE_XML_PATH("error.external.duplicateXmlPath", 3, MessageType.ERROR, MessageHandler.UX, false), + ERROR_EXTERNAL_MULTIPLE_RULE_DESC("error.external.multipleRuleDesc", 2, MessageType.ERROR, MessageHandler.UX, false), + ERROR_EXTERNAL_RECURSION_LIMIT("error.external.recursionLimitReached", 2, MessageType.ERROR, MessageHandler.UX, false), + ERROR_EXTERNAL_XML_NOT_READABLE("error.external.xmlNotReadable", 2, MessageType.ERROR, MessageHandler.UX, false), + ERROR_EXTERNAL_XML_NOT_PARSABLE("error.external.xmlNotParsable", 2, MessageType.ERROR, MessageHandler.UX, false), + WARNING_MULTIPLE_METHOD_TARGET_MATCHES("warning.multipleMethodTargetMatches", 3, MessageType.WARNING, MessageHandler.UX, true), + WARNING_NO_METHOD_TARGET_MATCHES("warning.noMethodTargetMatches", 2, MessageType.WARNING, MessageHandler.UX, false); + + final String messageKey; + final int argCount; + final MessageType messageType; + final MessageHandler messageHandler; + final boolean verbose;//true: only when verbose is true, false: ignores verbose flag and always prints + + EventKey(String messageKey, int argCount, MessageType messageType, MessageHandler messageHandler, boolean verbose) { + this.messageKey = messageKey; + this.argCount = argCount; + this.messageType = messageType; + this.messageHandler = messageHandler; + this.verbose = verbose; + } + + public String getMessageKey() { + return this.messageKey; + } + + public int getArgCount() { + return this.argCount; + } + + public MessageType getMessageType() { + return this.messageType; + } + + public MessageHandler getMessageHandler() { + return this.messageHandler; + } + + public boolean isVerbose() { + return this.verbose; + } +} diff --git a/cli-messaging/src/main/java/com/salesforce/messaging/Message.java b/cli-messaging/src/main/java/com/salesforce/messaging/Message.java new file mode 100644 index 000000000..20ba93ae0 --- /dev/null +++ b/cli-messaging/src/main/java/com/salesforce/messaging/Message.java @@ -0,0 +1,47 @@ +package com.salesforce.messaging; + +import java.time.Instant; +import java.util.List; + +public class Message { + final private String messageKey; + final private List args; + final private String internalLog; + final private MessageType type; + final private MessageHandler handler; + final private boolean verbose; + final private long time; + + Message(String messageKey, List args, String internalLog, MessageType type, MessageHandler handler, boolean verbose) { + this.messageKey = messageKey; + this.args = args; + this.internalLog = internalLog; + this.type = type; + this.handler = handler; + this.verbose = verbose; + this.time = Instant.now().toEpochMilli(); + } + + public String getMessageKey() { + return messageKey; + } + + public List getArgs() { + return args; + } + + public String getInternalLog() { + return internalLog; + } + + enum MessageHandler { + UX, + INTERNAL + } + + enum MessageType { + INFO, + WARNING, + ERROR + } +} diff --git a/cli-messaging/src/main/java/com/salesforce/messaging/MessagePassableException.java b/cli-messaging/src/main/java/com/salesforce/messaging/MessagePassableException.java new file mode 100644 index 000000000..bba99811e --- /dev/null +++ b/cli-messaging/src/main/java/com/salesforce/messaging/MessagePassableException.java @@ -0,0 +1,47 @@ +package com.salesforce.messaging; + +import com.google.common.base.Throwables; + +import java.util.Arrays; + +/** + * Internal exception representation. + * Extends RuntimeException to avoid declaring everywhere + * Handles capability to plug into CliMessager + */ +public class MessagePassableException extends RuntimeException { + + private final EventKey eventKey; + private final String[] args; + + public MessagePassableException(EventKey eventKey, String... args) { + this(eventKey, null, args); + } + + public MessagePassableException(EventKey eventKey, Throwable throwable, String... args) { + super(throwable); + + this.eventKey = eventKey; + this.args = args; + } + + public EventKey getEventKey() { + return eventKey; + } + + public String[] getArgs() { + return args; + } + + public String getFullStacktrace() { + return Throwables.getStackTraceAsString(this).replace("\\n", " | "); + } + + @Override + public String toString() { + return "MessagePassableException{" + + "eventKey=" + eventKey + + ", args=" + Arrays.toString(args) + + '}'; + } +} diff --git a/cli-messaging/src/test/java/com/salesforce/messaging/EventKeyTest.java b/cli-messaging/src/test/java/com/salesforce/messaging/EventKeyTest.java new file mode 100644 index 000000000..85acf00fa --- /dev/null +++ b/cli-messaging/src/test/java/com/salesforce/messaging/EventKeyTest.java @@ -0,0 +1,126 @@ +package com.salesforce.messaging; + +import org.json.simple.JSONObject; +import org.json.simple.parser.JSONParser; +import org.json.simple.parser.ParseException; + +import static org.junit.Assert.*; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; + +import static com.salesforce.messaging.Message.*; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.Collection; + +/** + * Parses messages/EventKeyTemplates.json and confirms that enums defined in EventKey + * are valid + */ +@RunWith(Parameterized.class) +public class EventKeyTest { + private static final String INFO = "info"; + private static final String WARNING = "warning"; + private static final String ERROR_EXTERNAL = "error.external"; + private static final String ERROR_INTERNAL = "error.internal"; + + // Current path is sfdx-scanner/pmd-cataloger + private static final String MESSAGES_FILE = "../messages/EventKeyTemplates.js"; + + JSONObject jsonObject = null; + + @Before + public void extractMessagesJson() throws IOException, ParseException { + final Path path = Paths.get(MESSAGES_FILE); + assertTrue("Invalid test setup. File does not exist: " + MESSAGES_FILE, Files.exists(path)); + final String fileContent = new String(Files.readAllBytes(path)); + final String[] fileSplit = fileContent.split("="); + final int fileParts = fileSplit.length; + assertEquals("Invalid test setup. File has more than one '=', which caused confusion in picking JSON content. Please revisit messages in " + MESSAGES_FILE, 2, fileParts); + final String jsonContent = fileSplit[1]; + jsonObject = (JSONObject) new JSONParser().parse(jsonContent); + assertNotNull("Invalid test setup. Messages json has not been parsed correctly. Please check validity of " + MESSAGES_FILE, jsonObject); + } + + @Test + public void verifyKeyInJson() { + // Split messageKey into levels + final String messageKey = eventKey.getMessageKey(); + final String[] levels = messageKey.split("\\."); + + // Loop through JSON to verify presence of each level + int idx = 0; + JSONObject currentJsonContent = this.jsonObject; + while (idx < levels.length - 1) { + currentJsonContent = (JSONObject) currentJsonContent.get(levels[idx]); + assertNotNull("Level " + levels[idx] + " not found. Recheck value of messageKey " + messageKey + " in EventKey." + eventKey, currentJsonContent); + idx++; + } + final Object lastLevel = currentJsonContent.get(levels[levels.length - 1]); + assertNotNull("messageKey " + messageKey + " does not exist. Recheck EventKey." + eventKey, lastLevel); + assertTrue("Message value should be a String for messageKey " + messageKey + " in EventKey." + eventKey, lastLevel instanceof String); + } + + @Test + public void verifyInfo() { + if (!eventKey.getMessageKey().startsWith(INFO)) { + return; + } + assertEquals("Unexpected messageType on EventKey." + eventKey, MessageType.INFO, eventKey.getMessageType()); + assertTrue("Verbose value on INFO messages are expected to be True. Please recheck EventKey." + eventKey, eventKey.isVerbose()); + } + + @Test + public void verifyWarning() { + if (!eventKey.getMessageKey().startsWith(WARNING)) { + return; + } + assertEquals("Unexpected messageType on EventKey." + eventKey, MessageType.WARNING, eventKey.getMessageType()); + // No verbose check since we don't have a rule yet + } + + @Test + public void verifyErrorExternal() { + if (!eventKey.getMessageKey().startsWith(ERROR_EXTERNAL)) { + return; + } + assertEquals("Unexpected messageType on EventKey." + eventKey, MessageType.ERROR, eventKey.getMessageType()); + assertFalse("Verbose value on external error messages should be True. Please recheck EventKey." + eventKey, eventKey.isVerbose()); + assertEquals("MessageHandler on external error messages should be UX. Please recheck EventKey." + eventKey, MessageHandler.UX, eventKey.getMessageHandler()); + } + + @Test + public void verifyErrorInternal() { + if (!eventKey.getMessageKey().startsWith(ERROR_INTERNAL)) { + return; + } + assertEquals("Unexpected messageType on EventKey." + eventKey, MessageType.ERROR, eventKey.getMessageType()); + assertFalse("Verbose value on internal error messages should be True. Please recheck EventKey." + eventKey, eventKey.isVerbose()); + assertEquals("MessageHandler on internal error messages should be INTERNAL. Please recheck EventKey." + eventKey, MessageHandler.INTERNAL, eventKey.getMessageHandler()); + } + + // Needed to make this test run dynamically for each EntryKey value + + private EventKey eventKey; + + public EventKeyTest(EventKey eventKey) { + this.eventKey = eventKey; + } + + @Parameters + public static Collection fetchEventKeys() { + Collection data = new ArrayList<>(); + for (EventKey eventKey : EventKey.values()) { + data.add(new Object[]{eventKey}); + } + return data; + } +} diff --git a/messages/EventKeyTemplates.js b/messages/EventKeyTemplates.js index 8448344f8..a5d0f3a48 100644 --- a/messages/EventKeyTemplates.js +++ b/messages/EventKeyTemplates.js @@ -18,6 +18,8 @@ module.exports = { "pmdSkippedFile": "PMD failed to evaluate against file '%s'. Message: %s", "pmdSuppressedViolation": "PMD suppressed violation against file '%s'. Message: %s. Suppression Type: %s. User Message: %s", "unexpectedPmdNodeType": "Encountered unexpected PMD node of type '%s'", + "multipleMethodTargetMatches": "Total of %s methods in file %s matched name #%s", + "noMethodTargetMatches": "No methods in file %s matched name #%s()", "pmdConfigError": "PMD failed to evaluate rule '%s'. Message: %s" }, "error": { diff --git a/messages/run-dfa.js b/messages/run-dfa.js index ef4482433..ccd4caff5 100644 --- a/messages/run-dfa.js +++ b/messages/run-dfa.js @@ -24,6 +24,8 @@ module.exports = { "targetDescriptionLong": "Source code location. May use glob patterns. Multiple values can be specified as a comma-separated list" }, "validations": { + "methodLevelTargetCannotBeGlob": "Method-level targets supplied to --target cannot be globs", + "methodLevelTargetMustBeRealFile": "Method-level target %s must be a real file", "projectdirCannotBeGlob": "--projectdir cannot specify globs", "projectdirMustBeDir": "--projectdir must specify directories", "projectdirMustExist": "--projectdir must specify existing paths" diff --git a/settings.gradle.kts b/settings.gradle.kts index e4b0f53a7..e9eead571 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -7,5 +7,6 @@ rootProject.name = "sfdx-scanner" +include("cli-messaging") include("pmd-cataloger") include("sfge") diff --git a/sfge/build.gradle.kts b/sfge/build.gradle.kts index 9954e0421..fadc52fbc 100644 --- a/sfge/build.gradle.kts +++ b/sfge/build.gradle.kts @@ -10,6 +10,7 @@ repositories { } dependencies { + implementation(project(":cli-messaging")) implementation("commons-cli:commons-cli:1.4") implementation("org.apache.commons:commons-collections4:4.4") implementation("org.apache.tinkerpop:tinkergraph-gremlin:3.5.1") diff --git a/sfge/src/main/java/com/salesforce/Main.java b/sfge/src/main/java/com/salesforce/Main.java index 28064664e..175bc62e1 100644 --- a/sfge/src/main/java/com/salesforce/Main.java +++ b/sfge/src/main/java/com/salesforce/Main.java @@ -5,6 +5,7 @@ import com.salesforce.exception.SfgeException; import com.salesforce.exception.SfgeRuntimeException; import com.salesforce.graph.ops.GraphUtil; +import com.salesforce.messaging.CliMessager; import com.salesforce.metainfo.MetaInfoCollector; import com.salesforce.metainfo.MetaInfoCollectorProvider; import com.salesforce.rules.AbstractRule; @@ -147,6 +148,7 @@ private int execute(String... args) { allViolations.size())); } OutputFormatter formatter = new OutputFormatter(); + System.out.println(CliMessager.getInstance().getAllMessagesWithFormatting()); System.out.println(formatter.formatViolationJsons(allViolations)); return allViolations.isEmpty() ? EXIT_NO_VIOLATIONS : EXIT_WITH_VIOLATIONS; } diff --git a/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java b/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java index e1101f7b6..74e3ae847 100644 --- a/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java +++ b/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java @@ -8,6 +8,7 @@ import com.salesforce.apex.jorje.ASTConstants; import com.salesforce.apex.jorje.ASTConstants.NodeType; import com.salesforce.collections.CollectionUtil; +import com.salesforce.collections.NonNullHashMap; import com.salesforce.exception.UnexpectedException; import com.salesforce.graph.ApexPath; import com.salesforce.graph.Schema; @@ -53,6 +54,8 @@ import com.salesforce.graph.vertex.VariableExpressionVertex; import com.salesforce.graph.visitor.ApexPathWalker; import com.salesforce.graph.visitor.DefaultNoOpPathVertexVisitor; +import com.salesforce.messaging.CliMessager; +import com.salesforce.messaging.EventKey; import com.salesforce.metainfo.MetaInfoCollectorProvider; import com.salesforce.rules.AbstractRuleRunner.RuleRunnerTarget; import java.util.ArrayList; @@ -99,7 +102,7 @@ public static List getTargetedMethods( // things, the performance // hit is negligible. for (RuleRunnerTarget target : targets) { - methodVertices.addAll( + List targetMethodVertices = SFVertexFactory.loadVertices( g, g.V().where( @@ -112,11 +115,50 @@ public static List getTargetedMethods( .until(__.has(Schema.FILE_NAME)) .has(Schema.FILE_NAME, target.getTargetFile()) .count() - .is(P.eq(1))))); + .is(P.eq(1)))); + addMessagesForTarget(target, targetMethodVertices); + methodVertices.addAll(targetMethodVertices); } return methodVertices; } + /** + * If any of the method names specified by the provided target returned multiple results or zero results, adds a + * message to a {@link CliMessager} instance indicating such. + * @param target - A target that specifies a file and methods within that file + * @param vertices - The method vertices returned by the query created using the target + */ + private static void addMessagesForTarget(RuleRunnerTarget target, List vertices) { + NonNullHashMap methodCountByName = CollectionUtil.newNonNullHashMap(); + // Map each vertex's method name to the number of vertices sharing that name. + for (MethodVertex methodVertex : vertices) { + String methodName = methodVertex.getName(); + int priorCount = methodCountByName.getOrDefault(methodName, 0); + methodCountByName.put(methodName, priorCount + 1); + } + // For each of the methods we were instructed to target, see how many methods with that name + // were found. + for (String targetMethod : target.getTargetMethods()) { + Integer methodCount = methodCountByName.getOrDefault(targetMethod, 0); + if (methodCount == 0) { + CliMessager.getInstance() + .addMessage( + "Loading " + targetMethod + " vertices", + EventKey.WARNING_NO_METHOD_TARGET_MATCHES, + target.getTargetFile(), + targetMethod); + } else if (methodCount > 1) { + CliMessager.getInstance() + .addMessage( + "Loading " + targetMethod + " vertices", + EventKey.WARNING_MULTIPLE_METHOD_TARGET_MATCHES, + methodCount.toString(), + target.getTargetFile(), + targetMethod); + } + } + } + /** * Returns non-test methods in the target files with an @AuraEnabled annotation. An empty list * implicitly includes all files. diff --git a/sfge/src/main/java/com/salesforce/rules/AbstractRuleRunner.java b/sfge/src/main/java/com/salesforce/rules/AbstractRuleRunner.java index 9eaa3abbb..b97595a82 100644 --- a/sfge/src/main/java/com/salesforce/rules/AbstractRuleRunner.java +++ b/sfge/src/main/java/com/salesforce/rules/AbstractRuleRunner.java @@ -160,8 +160,13 @@ public String toString() { } public static final class RuleRunnerTarget { - private String targetFile; - private List targetMethods; + private final String targetFile; + private final List targetMethods; + + public RuleRunnerTarget(String targetFile, List targetMethods) { + this.targetFile = targetFile; + this.targetMethods = targetMethods; + } /** Get the name of the file that this target represents. */ public String getTargetFile() { diff --git a/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java b/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java new file mode 100644 index 000000000..9cae5ccf5 --- /dev/null +++ b/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java @@ -0,0 +1,214 @@ +package com.salesforce.graph.ops; + +import static org.hamcrest.Matchers.containsString; +import static org.hamcrest.Matchers.equalTo; +import static org.hamcrest.Matchers.hasSize; +import static org.junit.jupiter.api.Assertions.assertEquals; + +import com.salesforce.TestUtil; +import com.salesforce.graph.vertex.MethodVertex; +import com.salesforce.messaging.CliMessager; +import com.salesforce.messaging.EventKey; +import com.salesforce.rules.AbstractRuleRunner.RuleRunnerTarget; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; +import org.hamcrest.MatcherAssert; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +public class MethodUtilTest { + private GraphTraversalSource g; + + private static final String METHOD_THAT_DOES_NOT_EXIST = "methodThatDoesNotExist"; + private static final String METHOD_WITHOUT_OVERLOADS_1 = "methodWithoutOverloads1"; + private static final String METHOD_WITHOUT_OVERLOADS_2 = "methodWithoutOverloads2"; + private static final String METHOD_WITH_INTERNAL_OVERLOADS = "methodWithInternalOverloads"; + private static final String METHOD_WITH_EXTERNAL_NAME_DUPLICATION = + "methodWithExternalNameDuplication"; + + private static final String SOURCE_FILE_1 = + "public class Foo1 {\n" + + " public boolean " + + METHOD_WITHOUT_OVERLOADS_1 + + "() {\n" + + " return true;\n" + + " }\n" + + "\n" + + " public boolean " + + METHOD_WITHOUT_OVERLOADS_2 + + "() {\n" + + " return true;\n" + + " }\n" + + "\n" + + " public boolean " + + METHOD_WITH_INTERNAL_OVERLOADS + + "() {\n" + + " return true;\n" + + " }\n" + + "\n" + + " public boolean " + + METHOD_WITH_INTERNAL_OVERLOADS + + "(boolean b) {\n" + + " return b;\n" + + " }\n" + + "\n" + + " public boolean " + + METHOD_WITH_EXTERNAL_NAME_DUPLICATION + + "() {\n" + + " return true;\n" + + " }\n" + + "\n" + + " public boolean " + + METHOD_WITH_EXTERNAL_NAME_DUPLICATION + + "(boolean b) {\n" + + " return b;\n" + + " }\n" + + "}\n"; + + private static final String SOURCE_FILE_2 = + "public class Foo2 {\n" + + " public boolean " + + METHOD_WITH_EXTERNAL_NAME_DUPLICATION + + "() {\n" + + " return true;\n" + + " }\n" + + "\n" + + " public boolean " + + METHOD_WITH_EXTERNAL_NAME_DUPLICATION + + "(boolean b) {\n" + + " return b;\n" + + " }\n" + + "}\n"; + + @BeforeEach + public void setup() { + this.g = TestUtil.getGraph(); + CliMessager.getInstance().resetMessages(); + } + + @Test + public void getTargetMethods_targetSingleMethod() { + TestUtil.Config config = + TestUtil.Config.Builder.get(g, new String[] {SOURCE_FILE_1, SOURCE_FILE_2}).build(); + TestUtil.buildGraph(config); + // Create a rule target encompassing only the first non-overloaded method in the first file. + List targets = new ArrayList<>(); + targets.add( + new RuleRunnerTarget( + "TestCode0", Collections.singletonList(METHOD_WITHOUT_OVERLOADS_1))); + + List methodVertices = MethodUtil.getTargetedMethods(g, targets); + + MatcherAssert.assertThat(methodVertices, hasSize(equalTo(1))); + MethodVertex firstVertex = methodVertices.get(0); + assertEquals(METHOD_WITHOUT_OVERLOADS_1, firstVertex.getName()); + + String messages = CliMessager.getInstance().getAllMessages(); + assertEquals("[]", messages); + } + + @Test + public void getTargetMethods_targetMultipleMethods() { + TestUtil.Config config = + TestUtil.Config.Builder.get(g, new String[] {SOURCE_FILE_1, SOURCE_FILE_2}).build(); + TestUtil.buildGraph(config); + // Create a rule target encompassing both non-overloaded methods in the first file. + List targets = new ArrayList<>(); + targets.add( + new RuleRunnerTarget( + "TestCode0", + Arrays.asList(METHOD_WITHOUT_OVERLOADS_1, METHOD_WITHOUT_OVERLOADS_2))); + + List methodVertices = MethodUtil.getTargetedMethods(g, targets); + + MatcherAssert.assertThat(methodVertices, hasSize(equalTo(2))); + MethodVertex firstVertex = methodVertices.get(0); + assertEquals(METHOD_WITHOUT_OVERLOADS_1, firstVertex.getName()); + + MethodVertex secondVertex = methodVertices.get(1); + assertEquals(METHOD_WITHOUT_OVERLOADS_2, secondVertex.getName()); + + String messages = CliMessager.getInstance().getAllMessages(); + assertEquals("[]", messages); + } + + @Test + public void getTargetMethods_targetOverloadedMethods() { + TestUtil.Config config = + TestUtil.Config.Builder.get(g, new String[] {SOURCE_FILE_1, SOURCE_FILE_2}).build(); + TestUtil.buildGraph(config); + // Create a rule target encompassing only the overloaded method in the first file. + List targets = new ArrayList<>(); + targets.add( + new RuleRunnerTarget( + "TestCode0", Collections.singletonList(METHOD_WITH_INTERNAL_OVERLOADS))); + + List methodVertices = MethodUtil.getTargetedMethods(g, targets); + + MatcherAssert.assertThat(methodVertices, hasSize(equalTo(2))); + MethodVertex firstVertex = methodVertices.get(0); + assertEquals(METHOD_WITH_INTERNAL_OVERLOADS, firstVertex.getName()); + + MethodVertex secondVertex = methodVertices.get(1); + assertEquals(METHOD_WITH_INTERNAL_OVERLOADS, secondVertex.getName()); + + String messages = CliMessager.getInstance().getAllMessages(); + MatcherAssert.assertThat( + messages, + containsString(EventKey.WARNING_MULTIPLE_METHOD_TARGET_MATCHES.getMessageKey())); + } + + @Test + public void getTargetMethods_targetNameDupedMethods() { + TestUtil.Config config = + TestUtil.Config.Builder.get(g, new String[] {SOURCE_FILE_1, SOURCE_FILE_2}).build(); + TestUtil.buildGraph(config); + // Create a rule target encompassing only the method in the first file whose name is used + // elsewhere. + List targets = new ArrayList<>(); + targets.add( + new RuleRunnerTarget( + "TestCode0", + Collections.singletonList(METHOD_WITH_EXTERNAL_NAME_DUPLICATION))); + + List methodVertices = MethodUtil.getTargetedMethods(g, targets); + + MatcherAssert.assertThat(methodVertices, hasSize(equalTo(2))); + MethodVertex firstVertex = methodVertices.get(0); + assertEquals(METHOD_WITH_EXTERNAL_NAME_DUPLICATION, firstVertex.getName()); + assertEquals(18, firstVertex.getBeginLine()); + + MethodVertex secondVertex = methodVertices.get(1); + assertEquals(METHOD_WITH_EXTERNAL_NAME_DUPLICATION, secondVertex.getName()); + assertEquals(22, secondVertex.getBeginLine()); + + String messages = CliMessager.getInstance().getAllMessages(); + MatcherAssert.assertThat( + messages, + containsString(EventKey.WARNING_MULTIPLE_METHOD_TARGET_MATCHES.getMessageKey())); + } + + @Test + public void getTargetMethods_targetMethodDoesNotExist() { + TestUtil.Config config = + TestUtil.Config.Builder.get(g, new String[] {SOURCE_FILE_1, SOURCE_FILE_2}).build(); + TestUtil.buildGraph(config); + // Create a rule target encompassing a method that doesn't actually exist with that name. + List targets = new ArrayList<>(); + targets.add( + new RuleRunnerTarget( + "TestCode0", Collections.singletonList(METHOD_THAT_DOES_NOT_EXIST))); + + List methodVertices = MethodUtil.getTargetedMethods(g, targets); + + MatcherAssert.assertThat(methodVertices, hasSize(equalTo(0))); + + String messages = CliMessager.getInstance().getAllMessages(); + MatcherAssert.assertThat( + messages, + containsString(EventKey.WARNING_NO_METHOD_TARGET_MATCHES.getMessageKey())); + } +} diff --git a/src/commands/scanner/run/dfa.ts b/src/commands/scanner/run/dfa.ts index 7497140ed..efb931d64 100644 --- a/src/commands/scanner/run/dfa.ts +++ b/src/commands/scanner/run/dfa.ts @@ -99,8 +99,8 @@ export default class Dfa extends ScannerRunCommand { }; protected async validateCommandFlags(): Promise { - // Entries in the projectdir array must be non-glob paths to existing directories. const fh = new FileHandler(); + // Entries in the projectdir array must be non-glob paths to existing directories. for (const dir of (this.flags.projectdir as string[])) { if (globby.hasMagic(dir)) { throw SfdxError.create('@salesforce/sfdx-scanner', 'run-dfa', 'validations.projectdirCannotBeGlob', []); @@ -110,6 +110,19 @@ export default class Dfa extends ScannerRunCommand { throw SfdxError.create('@salesforce/sfdx-scanner', 'run-dfa', 'validations.projectdirMustBeDir', []); } } + // Entries in the target array may specify methods, but only if the entry is neither a directory nor a glob. + for (const target of (this.flags.target as string[])) { + // The target specifies a method if it includes the `#` syntax. + if (target.indexOf('#') > -1) { + if( globby.hasMagic(target)) { + throw SfdxError.create('@salesforce/sfdx-scanner', 'run-dfa', 'validations.methodLevelTargetCannotBeGlob', []); + } + const potentialFilePath = target.split('#')[0]; + if (!(await fh.isFile(potentialFilePath))) { + throw SfdxError.create('@salesforce/sfdx-scanner', 'run-dfa', 'validations.methodLevelTargetMustBeRealFile', [potentialFilePath]); + } + } + } } /** diff --git a/src/lib/DefaultRuleManager.ts b/src/lib/DefaultRuleManager.ts index 24419c894..ce4ad7d51 100644 --- a/src/lib/DefaultRuleManager.ts +++ b/src/lib/DefaultRuleManager.ts @@ -236,46 +236,58 @@ export class DefaultRuleManager implements RuleManager { const pm = new PathMatcher([...engineTargets, ...negativePatterns]); for (const target of positivePatterns) { // Used to detect if the target resulted in a match - const startLength: number = ruleTargets.length; + const ruleTargetsInitialLength: number = ruleTargets.length; + // Positive patterns might use method-level targeting. We only want to do path evaluation against the part + // that's actually a path. + const targetPortions = target.split('#'); + // The array will always have at least one entry, since if there's no '#' then it will return a singleton array. + const targetPath = targetPortions[0]; if (globby.hasMagic(target)) { // The target is a magic glob. Retrieve paths in the working directory that match it, and then filter against // our pattern matcher. - const matchingTargets = await globby(target); + const matchingTargets = await globby(targetPath); // Map relative files to absolute paths. This solves ambiguity of current working directory const absoluteMatchingTargets = matchingTargets.map(t => path.resolve(t)); // Filter the targets based on our target patterns. const filteredTargets = await pm.filterPathsByPatterns(absoluteMatchingTargets); const ruleTarget = { - target, - paths: filteredTargets + target: targetPath, + paths: filteredTargets, + methods: [] }; if (ruleTarget.paths.length > 0) { ruleTargets.push(ruleTarget); } - } else if (await this.fileHandler.exists(target)) { - const stats: Stats = await this.fileHandler.stats(target); + } else if (await this.fileHandler.exists(targetPath)) { + const stats: Stats = await this.fileHandler.stats(targetPath); if (stats.isDirectory()) { // If the target is a directory, we should get everything in it, convert relative paths to absolute // paths, and then filter based our matcher. - const relativePaths = await globby(target); + const relativePaths = await globby(targetPath); const ruleTarget = { - target, + target: targetPath, isDirectory: true, - paths: await pm.filterPathsByPatterns(relativePaths.map(t => path.resolve(t))) + paths: await pm.filterPathsByPatterns(relativePaths.map(t => path.resolve(t))), + methods: [] }; if (ruleTarget.paths.length > 0) { ruleTargets.push(ruleTarget); } } else { // The target is just a file. Validate it against our matcher, and add it if eligible. - const absolutePath = path.resolve(target); + const absolutePath = path.resolve(targetPath); if (await pm.pathMatchesPatterns(absolutePath)) { - ruleTargets.push({target, paths: [absolutePath]}); + ruleTargets.push({ + target: targetPath, + paths: [absolutePath], + // If the pattern has method-level targets, then they're delimited with a semi-colon. + methods: targetPortions.length === 1 ? [] : targetPortions[1].split(';') + }); } } } - if (startLength !== ruleTargets.length) { + if (ruleTargetsInitialLength !== ruleTargets.length) { matchedTargets.add(target); } } diff --git a/src/lib/cpd/CpdWrapper.ts b/src/lib/cpd/CpdWrapper.ts index b42c18231..ed70c9d50 100644 --- a/src/lib/cpd/CpdWrapper.ts +++ b/src/lib/cpd/CpdWrapper.ts @@ -3,7 +3,7 @@ import {FileHandler} from '../util/FileHandler'; import * as JreSetupManager from './../JreSetupManager'; import path = require('path'); import { PMD_LIB } from '../../Constants'; -import { CommandLineSupport } from '../services/CommandLineSupport'; +import { CommandLineSupport, ResultHandlerArgs } from '../services/CommandLineSupport'; const MAIN_CLASS = 'net.sourceforge.pmd.cpd.CPD'; const HEAP_SIZE = '-Xmx1024m'; @@ -72,6 +72,10 @@ export default class CpdWrapper extends CommandLineSupport { return super.runCommand(); } + protected handleResults(args: ResultHandlerArgs): void { + super.defaultResultHandler(args); + } + constructor(options: CpdWrapperOptions) { super(options); this.path = options.path; diff --git a/src/lib/eslint/BaseEslintEngine.ts b/src/lib/eslint/BaseEslintEngine.ts index f20b7ce06..a10e2702e 100644 --- a/src/lib/eslint/BaseEslintEngine.ts +++ b/src/lib/eslint/BaseEslintEngine.ts @@ -1,7 +1,7 @@ import {Logger, SfdxError} from '@salesforce/core'; import { Catalog, ESRuleConfig, ESRuleConfigValue, LooseObject, Rule, RuleGroup, RuleResult, RuleTarget, ESRule, TargetPattern, ESRuleMetadata } from '../../types'; import {ENGINE, Severity} from '../../Constants'; -import {OutputProcessor} from '../pmd/OutputProcessor'; +import {OutputProcessor} from '../services/OutputProcessor'; import {AbstractRuleEngine} from '../services/RuleEngine'; import {Config} from '../util/Config'; import {Controller} from '../../Controller'; diff --git a/src/lib/eslint/TypescriptEslintStrategy.ts b/src/lib/eslint/TypescriptEslintStrategy.ts index 4436382de..64c40ea0b 100644 --- a/src/lib/eslint/TypescriptEslintStrategy.ts +++ b/src/lib/eslint/TypescriptEslintStrategy.ts @@ -4,7 +4,7 @@ import {FileHandler} from '../util/FileHandler'; import {ENGINE, LANGUAGE, HARDCODED_RULES} from '../../Constants'; import {ESRule, ESRuleConfigValue, ESRuleConfig, RuleViolation} from '../../types'; import { Logger, Messages, SfdxError } from '@salesforce/core'; -import { OutputProcessor } from '../pmd/OutputProcessor'; +import { OutputProcessor } from '../services/OutputProcessor'; import {deepCopy} from '../util/Utils'; import { rules } from '@typescript-eslint/eslint-plugin'; import {EslintStrategyHelper, ProcessRuleViolationType, RuleDefaultStatus} from './EslintCommons'; diff --git a/src/lib/pmd/PmdCatalogWrapper.ts b/src/lib/pmd/PmdCatalogWrapper.ts index 37031f5a9..6d77306eb 100644 --- a/src/lib/pmd/PmdCatalogWrapper.ts +++ b/src/lib/pmd/PmdCatalogWrapper.ts @@ -1,10 +1,9 @@ import {Logger, Messages} from '@salesforce/core'; -import {ChildProcessWithoutNullStreams} from "child_process"; import {Catalog} from '../../types'; import {FileHandler} from '../util/FileHandler'; import * as PrettyPrinter from '../util/PrettyPrinter'; import * as JreSetupManager from './../JreSetupManager'; -import {OutputProcessor} from './OutputProcessor'; +import {ResultHandlerArgs} from '../services/CommandLineSupport'; import * as PmdLanguageManager from './PmdLanguageManager'; import {PmdSupport} from './PmdSupport'; import { PMD_LIB } from '../../Constants'; @@ -21,7 +20,6 @@ const PMD_CATALOGER_LIB = path.join(__dirname, '..', '..', '..', 'dist', 'pmd-ca const MAIN_CLASS = 'sfdc.sfdx.scanner.pmd.Main'; export class PmdCatalogWrapper extends PmdSupport { - private outputProcessor: OutputProcessor; private logger: Logger; // TODO: add relevant trace logs private initialized: boolean; private sfdxScannerPath: string; @@ -30,8 +28,8 @@ export class PmdCatalogWrapper extends PmdSupport { if (this.initialized) { return; } + await super.init(); this.logger = await Logger.child('PmdCatalogWrapper'); - this.outputProcessor = await OutputProcessor.create({}); this.sfdxScannerPath = Controller.getSfdxScannerPath(); this.initialized = true; @@ -68,7 +66,7 @@ export class PmdCatalogWrapper extends PmdSupport { protected async buildClasspath(): Promise { const catalogerLibs = `${PMD_CATALOGER_LIB}/*`; - const classpathEntries = await super.buildClasspath(); + const classpathEntries = await super.buildSharedClasspath(); classpathEntries.push(catalogerLibs); return classpathEntries; } @@ -151,32 +149,20 @@ export class PmdCatalogWrapper extends PmdSupport { return path.join(PMD_LIB, "pmd-" + language + "-" + PMD_VERSION + ".jar"); } - /** - * Accepts a child process created by child_process.spawn(), and a Promise's resolve and reject function. - * Resolves/rejects the Promise once the child process finishes. - * @param cp - * @param res - * @param rej - */ - protected monitorChildProcess(cp: ChildProcessWithoutNullStreams, res: (string) => void, rej: (string) => void): void { - let stdout = ''; - - // When data is passed back up to us, pop it onto the appropriate string. - cp.stdout.on('data', data => { - stdout += data; - }); - - // When the child process exits, if it exited with a zero code we can resolve, otherwise we'll reject. - cp.on('exit', code => { - this.outputProcessor.processOutput(stdout); - this.logger.trace(`monitorChildProcess has received exit code ${code}`); - if (code === 0) { - res(stdout); - } else { - rej(messages.getMessage('error.external.errorMessageAbove')); - } - }); + protected isSuccessfulExitCode(code: number): boolean { + // By internal convention, 0 indicates success and any non-0 code indicates failure. + return code === 0; } + protected handleResults(args: ResultHandlerArgs): void { + if (this.isSuccessfulExitCode(args.code)) { + args.res(args.stdout); + } else { + // If the process errored out, then one of the Messages logged by the parent class already indicates that. + // So rather than returning stderr (which will be confusing and likely unhelpful, just return a hardcoded + // string indicating that the cause was logged elsewhere. + args.rej(messages.getMessage('error.external.errorMessageAbove')); + } + } } diff --git a/src/lib/pmd/PmdSupport.ts b/src/lib/pmd/PmdSupport.ts index ce663b8a1..93b8f4a20 100644 --- a/src/lib/pmd/PmdSupport.ts +++ b/src/lib/pmd/PmdSupport.ts @@ -14,7 +14,7 @@ export enum Format { export abstract class PmdSupport extends CommandLineSupport { - protected async buildClasspath(): Promise { + protected async buildSharedClasspath(): Promise { // Include PMD libs into classpath const pmdLibs = `${PMD_LIB}/*`; const classpathEntries = [pmdLibs]; @@ -28,15 +28,6 @@ export abstract class PmdSupport extends CommandLineSupport { return classpathEntries; } - protected isSuccessfulExitCode(code: number): boolean { - // PMD's convention is that an exit code of 0 indicates a successful run with no violations, and an exit code of - // 4 indicates a successful run with at least one violation. - return code === 0 || code === 4; - } - - - protected abstract buildCommandArray(): Promise<[string, string[]]>; - protected async getCustomRulePathEntries(): Promise>> { const customRulePathManager = await Controller.createRulePathManager(); return customRulePathManager.getRulePathEntries(PmdEngine.ENGINE_NAME); diff --git a/src/lib/pmd/PmdWrapper.ts b/src/lib/pmd/PmdWrapper.ts index 56098c9c4..0c6bc442a 100644 --- a/src/lib/pmd/PmdWrapper.ts +++ b/src/lib/pmd/PmdWrapper.ts @@ -2,6 +2,7 @@ import {Logger} from '@salesforce/core'; import {Format, PmdSupport} from './PmdSupport'; import * as JreSetupManager from './../JreSetupManager'; import path = require('path'); +import { ResultHandlerArgs } from '../services/CommandLineSupport'; import {FileHandler} from '../util/FileHandler'; const MAIN_CLASS = 'net.sourceforge.pmd.PMD'; @@ -33,6 +34,10 @@ export default class PmdWrapper extends PmdSupport { this.initialized = true; } + protected async buildClasspath(): Promise { + return super.buildSharedClasspath(); + } + public static async execute(path: string, rules: string, reportFormat?: Format, reportFile?: string): Promise { const myPmd = await PmdWrapper.create({ path: path, @@ -62,7 +67,7 @@ export default class PmdWrapper extends PmdSupport { // Start with the arguments we know we'll always need. // NOTE: If we were going to run this command from the CLI directly, then we'd wrap the classpath in quotes, but this // is intended for child_process.spawn(), which freaks out if you do that. - const classpath = await super.buildClasspath(); + const classpath = await this.buildClasspath(); // Operating systems impose limits on the maximum length of a command line invocation. This can be problematic // when scannning a large number of files. Store the list of files to scan in a temp file. Pass the location // of the temp file to PMD. The temp file is cleaned up when the process exits. @@ -84,4 +89,13 @@ export default class PmdWrapper extends PmdSupport { return [command, args]; } + protected isSuccessfulExitCode(code: number): boolean { + // PMD's convention is that an exit code of 0 indicates a successful run with no violations, and an exit code of + // 4 indicates a successful run with at least one violation. + return code === 0 || code === 4; + } + + protected handleResults(args: ResultHandlerArgs): void { + super.defaultResultHandler(args); + } } diff --git a/src/lib/services/CommandLineSupport.ts b/src/lib/services/CommandLineSupport.ts index 62aa9de37..8dcbcc71e 100644 --- a/src/lib/services/CommandLineSupport.ts +++ b/src/lib/services/CommandLineSupport.ts @@ -1,13 +1,23 @@ import { Logger } from '@salesforce/core'; import {AsyncCreatable} from '@salesforce/kit'; -import {ChildProcessWithoutNullStreams} from 'child_process'; import cspawn = require('cross-spawn'); +import {OutputProcessor} from './OutputProcessor'; import {SpinnerManager, NoOpSpinnerManager} from './SpinnerManager'; + +export type ResultHandlerArgs = { + code: number; + stdout: string; + stderr: string; + res: (string) => void; + rej: (string) => void; +}; + export abstract class CommandLineSupport extends AsyncCreatable { private parentLogger: Logger; private parentInitialized: boolean; + private outputProcessor: OutputProcessor; protected async init(): Promise { @@ -16,6 +26,7 @@ export abstract class CommandLineSupport extends AsyncCreatable { } this.parentLogger = await Logger.child('CommandLineSupport'); + this.outputProcessor = await OutputProcessor.create({}); this.parentInitialized = true; } @@ -32,37 +43,19 @@ export abstract class CommandLineSupport extends AsyncCreatable { } /** - * Accepts a child process created by child_process.spawn(), and a Promise's resolve and reject functions. - * Resolves/rejects the Promise once the child process finishes. - * @param cp - * @param res - * @param rej + * Perform any job-specific processing on the results of a child process execution, and either resolve or reject as + * needed. + * @param args + * @protected */ - protected monitorChildProcess(cp: ChildProcessWithoutNullStreams, res: (string) => void, rej: (string) => void): void { - let stdout = ''; - let stderr = ''; - this.getSpinnerManager().startSpinner(); - - // When data is passed back up to us, pop it onto the appropriate string. - cp.stdout.on('data', data => { - stdout += data; - }); - cp.stderr.on('data', data => { - stderr += data; - }); + protected abstract handleResults(args: ResultHandlerArgs): void; - cp.on('exit', code => { - this.parentLogger.trace(`monitorChildProcess has received exit code ${code}`); - if (this.isSuccessfulExitCode(code)) { - this.getSpinnerManager().stopSpinner(true); - res(stdout); - } else { - // If we got any other error, it means something actually went wrong. We'll just reject with stderr for - // the ease of upstream error handling. - this.getSpinnerManager().stopSpinner(false); - rej(stderr); - } - }); + protected defaultResultHandler(args: ResultHandlerArgs): void { + if (this.isSuccessfulExitCode(args.code)) { + args.res(args.stdout); + } else { + args.rej(args.stderr); + } } protected abstract isSuccessfulExitCode(code: number): boolean; @@ -74,7 +67,32 @@ export abstract class CommandLineSupport extends AsyncCreatable { return new Promise((res, rej) => { const cp = cspawn.spawn(command, args); - this.monitorChildProcess(cp, res, rej); + + let stdout = ''; + let stderr = ''; + this.getSpinnerManager().startSpinner(); + + // When data is passed back up to us, pop it onto the appropriate string. + cp.stdout.on('data', data => { + stdout += data; + }); + cp.stderr.on('data', data => { + stderr += data; + }); + + cp.on('exit', code => { + this.parentLogger.trace(`runCommand has received exit code ${code}`); + this.getSpinnerManager().stopSpinner(this.isSuccessfulExitCode(code)); + // The output processor's input is always stdout. + this.outputProcessor.processOutput(stdout); + this.handleResults({ + code, + stdout, + stderr, + res, + rej + }); + }); }); } } diff --git a/src/lib/services/LocalCatalog.ts b/src/lib/services/LocalCatalog.ts index d8e9fcbef..7193bffe6 100644 --- a/src/lib/services/LocalCatalog.ts +++ b/src/lib/services/LocalCatalog.ts @@ -3,7 +3,7 @@ import * as path from 'path'; import {injectable} from 'tsyringe'; import {CATALOG_FILE} from '../../Constants'; import {Catalog, Rule, RuleEvent, RuleGroup} from '../../types'; -import {OutputProcessor} from '../pmd/OutputProcessor'; +import {OutputProcessor} from './OutputProcessor'; import {isRuleGroupFilter, RuleFilter} from '../RuleFilter'; import {FileHandler} from '../util/FileHandler'; import * as PrettyPrinter from '../util/PrettyPrinter'; diff --git a/src/lib/pmd/OutputProcessor.ts b/src/lib/services/OutputProcessor.ts similarity index 100% rename from src/lib/pmd/OutputProcessor.ts rename to src/lib/services/OutputProcessor.ts diff --git a/src/lib/sfge/SfgeEngine.ts b/src/lib/sfge/SfgeEngine.ts index a18c30fcc..09de49885 100644 --- a/src/lib/sfge/SfgeEngine.ts +++ b/src/lib/sfge/SfgeEngine.ts @@ -135,18 +135,26 @@ export class SfgeEngine extends AbstractRuleEngine { * @param engineOptions - A mapping of keys to values for engineOptions. Not all key/value pairs will apply to all engines. */ public async run(ruleGroups: RuleGroup[], rules: Rule[], targets: RuleTarget[], engineOptions: Map): Promise { - // Pull all targeted paths out of our target descriptors. - const targetPaths: string[] = targets.reduce((accumulator: string[], target: RuleTarget) => {return [...accumulator, ...target.paths]}, []); + // Make sure we have actual targets to run against. + let targetCount = 0; + targets.forEach((t) => { + if (t.methods.length > 0) { + // If we're targeting individual methods, then each method is counted as a separate target for this purpose. + targetCount += t.methods.length; + } else { + targetCount += t.paths.length; + } + }); - if (targetPaths.length === 0) { - this.logger.trace(`No targets for ${SfgeEngine.ENGINE_NAME} found. Nothing to execute. Returning early.`); + if (targetCount === 0) { + this.logger.trace(`No targets from ${SfgeEngine.ENGINE_NAME} found. Nothing to execute. Returning early.`); return []; } - this.logger.trace(`About to run ${SfgeEngine.ENGINE_NAME} rules. Targets: ${targetPaths.length}, Selected rules: ${JSON.stringify(rules)}`); + this.logger.trace(`About to run ${SfgeEngine.ENGINE_NAME} rules. Targets: ${targetCount} files and/or methods, Selected rules: ${JSON.stringify(rules)}`); try { - const output = await SfgeWrapper.runSfge(targetPaths, rules, JSON.parse(engineOptions.get(CUSTOM_CONFIG.SfgeConfig)) as SfgeConfig); + const output = await SfgeWrapper.runSfge(targets, rules, JSON.parse(engineOptions.get(CUSTOM_CONFIG.SfgeConfig)) as SfgeConfig); // TODO: There should be some kind of method-call here to pull logs and warnings from the output. const results = this.processStdout(output); diff --git a/src/lib/sfge/SfgeWrapper.ts b/src/lib/sfge/SfgeWrapper.ts index 076a4289b..805f606d6 100644 --- a/src/lib/sfge/SfgeWrapper.ts +++ b/src/lib/sfge/SfgeWrapper.ts @@ -4,8 +4,8 @@ import {AsyncCreatable} from '@salesforce/kit'; import {Controller} from '../../Controller'; import * as JreSetupManager from '../JreSetupManager'; import {uxEvents, EVENTS} from '../ScannerEvents'; -import {Rule, SfgeConfig} from '../../types'; -import {CommandLineSupport} from '../services/CommandLineSupport'; +import {Rule, SfgeConfig, RuleTarget} from '../../types'; +import {CommandLineSupport, ResultHandlerArgs} from '../services/CommandLineSupport'; import {SpinnerManager, NoOpSpinnerManager} from '../services/SpinnerManager'; import {FileHandler} from '../util/FileHandler'; @@ -27,7 +27,7 @@ const EXIT_NO_VIOLATIONS = 0; const EXIT_WITH_VIOLATIONS = 4; interface SfgeWrapperOptions { - targetFiles: string[]; + targets: RuleTarget[]; projectDirs: string[]; command: string; rules: Rule[]; @@ -76,7 +76,7 @@ export class SfgeWrapper extends CommandLineSupport { private logger: Logger; private initialized: boolean; private fh: FileHandler; - private targetFiles: string[]; + private targets: RuleTarget[]; private projectDirs: string[]; private command: string; private rules: Rule[]; @@ -88,7 +88,7 @@ export class SfgeWrapper extends CommandLineSupport { constructor(options: SfgeWrapperOptions) { super(options); - this.targetFiles = options.targetFiles; + this.targets = options.targets; this.projectDirs = options.projectDirs; this.command = options.command; this.rules = options.rules; @@ -123,6 +123,10 @@ export class SfgeWrapper extends CommandLineSupport { return code === EXIT_NO_VIOLATIONS || code === EXIT_WITH_VIOLATIONS; } + protected handleResults(args: ResultHandlerArgs) { + super.defaultResultHandler(args); + } + /** * Returns a spinner that will be used while waiting for the child process to complete. For the CATALOG flow, this will * be a {@link NoOpSpinnerManager}, and for the EXECUTE flow, this will be a {@link SfgeSpinnerManager}. @@ -142,7 +146,7 @@ export class SfgeWrapper extends CommandLineSupport { const sourceListFile = await this.createInputFile(this.projectDirs); const rulesToRun = this.rules.map(rule => rule.name).join(','); - this.logger.trace(`Stored the names of ${this.targetFiles.length} targeted files in ${targetListFile}`); + this.logger.trace(`Stored the names of ${this.targets.length} targeted files in ${targetListFile}`); this.logger.trace(`Stored the names of ${this.projectDirs.length} source directories in ${sourceListFile}`); this.logger.trace(`Rules to be executed: ${rulesToRun}`); @@ -168,7 +172,7 @@ export class SfgeWrapper extends CommandLineSupport { public static async getCatalog() { const wrapper = await SfgeWrapper.create({ - targetFiles: [], + targets: [], projectDirs: [], command: CATALOG_COMMAND, rules: [], @@ -179,20 +183,34 @@ export class SfgeWrapper extends CommandLineSupport { } private createTargetJsons(): string { - // TODO: For now, the target files can only be file-level instead of method-level. When that changes, this code - // will change too. - const targetJsons: SfgeTarget[] = this.targetFiles.map(t => { - return { - targetFile: t, - targetMethods: [] - }; + const targetJsons: SfgeTarget[] = []; + this.targets.forEach(t => { + // If the target specifies individual methods in a file, then create one object encompassing the file and + // those methods. + // NOTE: This code assumes that method-level targets cannot have multiple paths in the `paths` property. If + // this assumption is ever invalidated, then this code must change. + if (t.methods.length > 0) { + targetJsons.push({ + targetFile: t.paths[0], + targetMethods: t.methods + }); + } else { + // Otherwise, the target is a collection of paths encompassing whole files, and each path should be its + // own subject. + t.paths.forEach(p => { + targetJsons.push({ + targetFile: p, + targetMethods: [] + }); + }); + } }); return JSON.stringify(targetJsons); } - public static async runSfge(targetPaths: string[], rules: Rule[], sfgeConfig: SfgeConfig): Promise { + public static async runSfge(targets: RuleTarget[], rules: Rule[], sfgeConfig: SfgeConfig): Promise { const wrapper = await SfgeWrapper.create({ - targetFiles: targetPaths, + targets, projectDirs: sfgeConfig.projectDirs, command: EXEC_COMMAND, rules: rules, diff --git a/src/lib/util/EventCreator.ts b/src/lib/util/EventCreator.ts index 214179edd..8eee00211 100644 --- a/src/lib/util/EventCreator.ts +++ b/src/lib/util/EventCreator.ts @@ -1,4 +1,4 @@ -import {OutputProcessor} from '../pmd/OutputProcessor'; +import {OutputProcessor} from '../services/OutputProcessor'; import {AsyncCreatable} from '@salesforce/kit'; export class EventCreator extends AsyncCreatable { @@ -17,13 +17,13 @@ export class EventCreator extends AsyncCreatable { public createUxInfoAlwaysMessage(eventTemplateKey: string, args: string[]): void { const event = { - messageKey: eventTemplateKey, - args: args, - type: 'INFO', - handler: 'UX', - verbose: false, + messageKey: eventTemplateKey, + args: args, + type: 'INFO', + handler: 'UX', + verbose: false, time: Date.now() }; this.outputProcessor.emitEvents([event]); } -} \ No newline at end of file +} diff --git a/src/lib/util/FileHandler.ts b/src/lib/util/FileHandler.ts index d5cbc0c5a..e0adaa8b7 100644 --- a/src/lib/util/FileHandler.ts +++ b/src/lib/util/FileHandler.ts @@ -25,6 +25,10 @@ export class FileHandler { return await this.exists(filename) && (await this.stats(filename)).isDirectory(); } + async isFile(filename: string): Promise { + return await this.exists(filename) && (await this.stats(filename)).isFile(); + } + readDir(filename: string): Promise { return fs.readdir(filename); } diff --git a/src/types.d.ts b/src/types.d.ts index 1e325af13..e7f733fcf 100644 --- a/src/types.d.ts +++ b/src/types.d.ts @@ -53,6 +53,7 @@ export type RuleTarget = { target: string; isDirectory?: boolean; paths: string[]; + methods?: string[]; } export type RuleResult = { engine: string; diff --git a/test/lib/RuleManager.test.ts b/test/lib/RuleManager.test.ts index 471c044aa..c805cd6a9 100644 --- a/test/lib/RuleManager.test.ts +++ b/test/lib/RuleManager.test.ts @@ -15,6 +15,7 @@ import {RuleCatalog} from '../../src/lib/services/RuleCatalog'; import {RuleEngine} from '../../src/lib/services/RuleEngine'; import {RetireJsEngine} from '../../src/lib/retire-js/RetireJsEngine'; +import {SfgeEngine} from '../../src/lib/sfge/SfgeEngine'; import * as TestOverrides from '../test-related-lib/TestOverrides'; import * as TestUtils from '../TestUtils'; @@ -516,6 +517,35 @@ describe('RuleManager', () => { expect(results[0].paths.length).to.equal(2, 'Wrong number of paths matched'); }); + it('Positive method-level targets are properly matched', async () => { + // All tests will use the SFGE engine, since method-level targeting is intended for that engine anyway. + const engine = new SfgeEngine(); + await engine.init(); + + // Targets are all going to be normalized Unix paths, some of which also specify individual methods. + const targetFile1 = 'test/code-fixtures/projects/sfge-working-app/force-app/main/default/classes/AuraEnabledFls.cls'; + const targetMethods1 = ['flsNoEnforcementAttempted', 'flsDoneCorrectly']; + const targetFile2 = 'test/code-fixtures/projects/sfge-working-app/force-app/main/default/classes/VfControllerFls.cls'; + const targetMethods2 = ['flsWrongPermissionChecked']; + const targets = [ + `${targetFile1}#${targetMethods1.join(';')}`, + `${targetFile2}#${targetMethods2.join(';')}` + ]; + + const testRuleManager: UnpackTargetsDRM = new UnpackTargetsDRM(); + await testRuleManager.init(); + + // THIS IS THE INVOCATION OF THE TARGET METHOD! + const results: RuleTarget[] = await testRuleManager.unpackTargets(engine, targets, new Set()); + + // Validate the results. + expect(results.length).to.equal(2, 'Wrong number of targets matched'); + expect(results[0].target).to.equal(targetFile1, 'Expected different first file'); + expect(results[0].methods).to.deep.equal(targetMethods1, 'Expected different first methods'); + expect(results[1].target).to.equal(targetFile2, 'Expected different second file'); + expect(results[1].methods).to.deep.equal(targetMethods2, 'Expected different second methods'); + }); + it('Positive glob-type targets are properly matched', async () => { // All of the tests will use the RetireJS engine, since it's got the most straightforward inclusion/exclusion rules. const engine = new RetireJsEngine(); From f526cb5cee71c36db2bca7e094944ea186d70fca Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Wed, 1 Jun 2022 16:30:04 -0500 Subject: [PATCH 06/22] @W-10759090@: Added unit test coverage for inner classes. --- .../salesforce/graph/ops/MethodUtilTest.java | 68 +++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java b/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java index 9cae5ccf5..4d826e83b 100644 --- a/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java +++ b/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java @@ -4,6 +4,8 @@ import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.hasSize; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.fail; import com.salesforce.TestUtil; import com.salesforce.graph.vertex.MethodVertex; @@ -25,9 +27,12 @@ public class MethodUtilTest { private static final String METHOD_THAT_DOES_NOT_EXIST = "methodThatDoesNotExist"; private static final String METHOD_WITHOUT_OVERLOADS_1 = "methodWithoutOverloads1"; private static final String METHOD_WITHOUT_OVERLOADS_2 = "methodWithoutOverloads2"; + private static final String METHOD_WITHOUT_OVERLOADS_3 = "methodWithoutOverloads3"; private static final String METHOD_WITH_INTERNAL_OVERLOADS = "methodWithInternalOverloads"; private static final String METHOD_WITH_EXTERNAL_NAME_DUPLICATION = "methodWithExternalNameDuplication"; + private static final String METHOD_WITH_INNER_CLASS_DUPLICATION = + "methodWithInnerClassDuplication"; private static final String SOURCE_FILE_1 = "public class Foo1 {\n" @@ -83,6 +88,23 @@ public class MethodUtilTest { + " }\n" + "}\n"; + private static final String SOURCE_FILE_3 = + "public class Foo3 {\n" + + " public boolean " + METHOD_WITH_INNER_CLASS_DUPLICATION + "() {\n" + + " return true;\n" + + " }\n" + + " \n" + + " public class InnerFoo {\n" + + " public boolean " + METHOD_WITHOUT_OVERLOADS_3 + "() {\n" + + " return true;\n" + + " }\n" + + " \n" + + " public boolean " + METHOD_WITH_INNER_CLASS_DUPLICATION + "() {\n" + + " return true;\n" + + " }\n" + + " }\n" + + "}\n"; + @BeforeEach public void setup() { this.g = TestUtil.getGraph(); @@ -211,4 +233,50 @@ public void getTargetMethods_targetMethodDoesNotExist() { messages, containsString(EventKey.WARNING_NO_METHOD_TARGET_MATCHES.getMessageKey())); } + + @Test + public void getTargetMethods_targetMethodInInnerClass() { + TestUtil.Config config = + TestUtil.Config.Builder.get(g, new String[]{SOURCE_FILE_3}).build(); + TestUtil.buildGraph(config); + // Create a rule target encompassing the method that exists only in the inner class. + List targets = new ArrayList<>(); + targets.add(new RuleRunnerTarget("TestCode0", Collections.singletonList(METHOD_WITHOUT_OVERLOADS_3))); + + List methodVertices = MethodUtil.getTargetedMethods(g, targets); + + MatcherAssert.assertThat(methodVertices, hasSize(equalTo(1))); + } + + @Test + public void getTargetMethods_targetMethodInInnerAndOuterClass() { + TestUtil.Config config = + TestUtil.Config.Builder.get(g, new String[]{SOURCE_FILE_3}).build(); + TestUtil.buildGraph(config); + // Create a rule target encompassing the method that exists only in the inner class. + List targets = new ArrayList<>(); + targets.add(new RuleRunnerTarget("TestCode0", Collections.singletonList(METHOD_WITH_INNER_CLASS_DUPLICATION))); + + List methodVertices = MethodUtil.getTargetedMethods(g, targets); + + MatcherAssert.assertThat(methodVertices, hasSize(equalTo(2))); + boolean line2Found = false; + boolean line11Found = false; + for (MethodVertex methodVertex : methodVertices) { + assertEquals(METHOD_WITH_INNER_CLASS_DUPLICATION, methodVertex.getName()); + if (methodVertex.getBeginLine() == 2) { + line2Found = true; + } else if (methodVertex.getBeginLine() == 11) { + line11Found = true; + } else { + fail("Unexpected line number " + methodVertex.getBeginLine()); + } + } + assertTrue(line2Found); + assertTrue(line11Found); + String messages = CliMessager.getInstance().getAllMessages(); + MatcherAssert.assertThat( + messages, + containsString(EventKey.WARNING_MULTIPLE_METHOD_TARGET_MATCHES.getMessageKey())); + } } From 6980d4b24879150fe86a8046ef6a7ad625c25f51 Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Fri, 3 Jun 2022 15:49:24 -0500 Subject: [PATCH 07/22] @W-10759090@: Added help text documenting new feature. --- messages/run-dfa.js | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/messages/run-dfa.js b/messages/run-dfa.js index ccd4caff5..fc6b70c64 100644 --- a/messages/run-dfa.js +++ b/messages/run-dfa.js @@ -21,7 +21,7 @@ module.exports = { "sevthresholdDescription": "throws an error when violations of specific severity (or more severe) are detected, invokes --normalize-severity", "sevthresholdDescriptionLong": "Throws an error if violations are found with equal or greater severity than provided value. Values are 1 (high), 2 (moderate), and 3 (low). Exit code is the most severe violation. Using this flag also invokes the --normalize-severity flag", "targetDescription": "location of source code", - "targetDescriptionLong": "Source code location. May use glob patterns. Multiple values can be specified as a comma-separated list" + "targetDescriptionLong": "Source code location. May use glob patterns, or specify individual methods with #-syntax. Multiple values can be specified as a comma-separated list" }, "validations": { "methodLevelTargetCannotBeGlob": "Method-level targets supplied to --target cannot be globs", @@ -39,6 +39,9 @@ module.exports = { Unix example: $ sfdx scanner:run:dfa --target './**/*.cls,!./**/IgnoreMe.cls' ... Windows example: > sfdx scanner:run:dfa --target ".\\**\\*.cls,!.\\**\\IgnoreMe.cls" ... Evaluate rules against all .cls files below the current directory, except for IgnoreMe.cls. + Individual methods within a file may be targeted by suffixing the file's path with a hash (#), and a semi-colon-delimited list of method names. This syntax is incompatible with globs and directories. + E.g., $ sfdx scanner:run:dfa --target "./File1.cls#Method1;Method2,./File2.cls#Method3" ... + Evaluates rules against ALL methods named Method1 or Method2 in File1.cls, and ALL methods named Method3 in File2.cls. Use --normalize-severity to output a normalized (across all engines) severity (1 [high], 2 [moderate], and 3 [low]) in addition to the engine specific severity (when shown). E.g., $ sfdx scanner:run:dfa --target "/some-project/" --projectdir "/some-project/" --format csv --normalize-severity Use --severity-threshold to throw a non-zero exit code when rule violations of a specific normalized severity (or greater) are found. For this example, if there are any rule violations with a severity of 2 or more (which includes 1-high and 2-moderate), the exit code will be equal to the severity of the most severe violation. From 9735b1d254ed8a0f20d5a38ebfe5a519cc2a4c69 Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Fri, 3 Jun 2022 12:26:40 -0500 Subject: [PATCH 08/22] @W-10759090@: Supplemental PR to integrate cli-messaging into pmd-cataloger and increase test coverage as necessary. --- pmd-cataloger/build.gradle.kts | 1 + .../sfdc/sfdx/scanner/messaging/EventKey.java | 57 -------- .../sfdc/sfdx/scanner/messaging/Message.java | 43 ------ .../sfdx/scanner/messaging/SfdxMessager.java | 107 --------------- .../messaging/SfdxScannerException.java | 48 ------- .../scanner/pmd/LanguageXmlFileMapping.java | 10 +- .../main/java/sfdc/sfdx/scanner/pmd/Main.java | 24 ++-- .../sfdx/scanner/pmd/PmdRuleCataloger.java | 30 +++-- .../sfdc/sfdx/scanner/pmd/XmlFileFinder.java | 16 +-- .../scanner/pmd/catalog/PmdCatalogRule.java | 6 +- .../pmd/catalog/PmdCatalogRuleset.java | 6 +- .../java/sfdc/sfdx/scanner/xml/XmlReader.java | 12 +- .../sfdx/scanner/messaging/EventKeyTest.java | 126 ------------------ .../pmd/LanguageXmlFileMappingTest.java | 4 +- .../scanner/pmd/MainArgsHandlingTest.java | 6 +- .../sfdx/scanner/pmd/MainMessagesTest.java | 14 +- ...a => MessagePassableExceptionMatcher.java} | 22 +-- .../scanner/pmd/PmdRuleCatalogerTest.java | 114 +++++++++++----- .../sfdx/scanner/pmd/XmlFileFinderTest.java | 4 +- .../pmd/catalog/PmdCatalogRuleTest.java | 48 +++++-- 20 files changed, 198 insertions(+), 500 deletions(-) delete mode 100644 pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/EventKey.java delete mode 100644 pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/Message.java delete mode 100644 pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/SfdxMessager.java delete mode 100644 pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/SfdxScannerException.java delete mode 100644 pmd-cataloger/src/test/java/sfdc/sfdx/scanner/messaging/EventKeyTest.java rename pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/{SfdxScannerExceptionMatcher.java => MessagePassableExceptionMatcher.java} (66%) diff --git a/pmd-cataloger/build.gradle.kts b/pmd-cataloger/build.gradle.kts index 7027ace1a..1c6a061cc 100644 --- a/pmd-cataloger/build.gradle.kts +++ b/pmd-cataloger/build.gradle.kts @@ -54,6 +54,7 @@ tasks.register("installPmd") { } dependencies { + implementation(project(":cli-messaging")) implementation ("com.googlecode.json-simple:json-simple:1.1.1") { exclude("junit") } diff --git a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/EventKey.java b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/EventKey.java deleted file mode 100644 index c29da9408..000000000 --- a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/EventKey.java +++ /dev/null @@ -1,57 +0,0 @@ -package sfdc.sfdx.scanner.messaging; -import static sfdc.sfdx.scanner.messaging.SfdxMessager.*; - -public enum EventKey { - // MAKE SURE messageKey OF EVERY VALUE ADDED HERE HAS AN ENTRY IN 'messages/EventKeyTemplates.js'! - INFO_GENERAL_INTERNAL_LOG("info.generalInternalLog", 1, MessageType.INFO, MessageHandler.INTERNAL, true), - WARNING_INVALID_CAT_SKIPPED("warning.invalidCategorySkipped", 1, MessageType.WARNING, MessageHandler.UX, true), - WARNING_INVALID_RULESET_SKIPPED("warning.invalidRulesetSkipped", 1, MessageType.WARNING, MessageHandler.UX, true), - WARNING_XML_DROPPED("warning.xmlDropped", 1, MessageType.WARNING, MessageHandler.UX, true), - INFO_JAR_AND_XML_PROCESSED("info.jarAndXmlProcessed", 2, MessageType.INFO, MessageHandler.UX, true), - ERROR_INTERNAL_UNEXPECTED("error.internal.unexpectedError", 1, MessageType.ERROR, MessageHandler.INTERNAL, false), - ERROR_INTERNAL_MAIN_INVALID_ARGUMENT("error.internal.mainInvalidArgument", 1, MessageType.ERROR, MessageHandler.INTERNAL, false), - ERROR_INTERNAL_JSON_WRITE_FAILED("error.internal.jsonWriteFailed", 1, MessageType.ERROR, MessageHandler.INTERNAL, false), - ERROR_INTERNAL_CLASSPATH_DOES_NOT_EXIST("error.internal.classpathDoesNotExist", 1, MessageType.ERROR, MessageHandler.INTERNAL, false), - ERROR_INTERNAL_XML_MISSING_IN_CLASSPATH("error.internal.xmlMissingInClasspath", 1, MessageType.ERROR, MessageHandler.INTERNAL, false), - ERROR_EXTERNAL_JAR_NOT_READABLE("error.external.jarNotReadable", 1, MessageType.ERROR, MessageHandler.UX, false), - ERROR_EXTERNAL_DIR_NOT_READABLE("error.external.dirNotReadable", 1, MessageType.ERROR, MessageHandler.UX, false), - ERROR_EXTERNAL_DUPLICATE_XML_PATH("error.external.duplicateXmlPath", 3, MessageType.ERROR, MessageHandler.UX, false), - ERROR_EXTERNAL_MULTIPLE_RULE_DESC("error.external.multipleRuleDesc", 2, MessageType.ERROR, MessageHandler.UX, false), - ERROR_EXTERNAL_RECURSION_LIMIT("error.external.recursionLimitReached", 2, MessageType.ERROR, MessageHandler.UX, false), - ERROR_EXTERNAL_XML_NOT_READABLE("error.external.xmlNotReadable", 2, MessageType.ERROR, MessageHandler.UX, false), - ERROR_EXTERNAL_XML_NOT_PARSABLE("error.external.xmlNotParsable", 2, MessageType.ERROR, MessageHandler.UX, false); - - String messageKey; - int argCount; - MessageType messageType; - MessageHandler messageHandler; - boolean verbose;//true: only when verbose is true, false: ignores verbose flag and always prints - - EventKey(String messageKey, int argCount, MessageType messageType, MessageHandler messageHandler, boolean verbose) { - this.messageKey = messageKey; - this.argCount = argCount; - this.messageType = messageType; - this.messageHandler = messageHandler; - this.verbose = verbose; - } - - public String getMessageKey() { - return this.messageKey; - } - - public int getArgCount() { - return this.argCount; - } - - public MessageType getMessageType() { - return this.messageType; - } - - public MessageHandler getMessageHandler() { - return this.messageHandler; - } - - public boolean isVerbose() { - return this.verbose; - } -} diff --git a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/Message.java b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/Message.java deleted file mode 100644 index 3694429e9..000000000 --- a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/Message.java +++ /dev/null @@ -1,43 +0,0 @@ -package sfdc.sfdx.scanner.messaging; - -import com.google.gson.Gson; -import static sfdc.sfdx.scanner.messaging.SfdxMessager.*; -import java.time.Instant; -import java.util.List; - -public class Message { - private String messageKey; - private List args; - private String internalLog; - private MessageType type; - private MessageHandler handler; - private boolean verbose; - private long time; - - Message(String messageKey, List args, String internalLog, MessageType type, MessageHandler handler, boolean verbose) { - this.messageKey = messageKey; - this.args = args; - this.internalLog = internalLog; - this.type = type; - this.handler = handler; - this.time = Instant.now().toEpochMilli(); - this.verbose = verbose; - } - - String toJson() { - return new Gson().toJson(this); - } - - public String getMessageKey() { - return messageKey; - } - - public List getArgs() { - return args; - } - - public String getInternalLog() { - return internalLog; - } - -} diff --git a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/SfdxMessager.java b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/SfdxMessager.java deleted file mode 100644 index a080ff73d..000000000 --- a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/SfdxMessager.java +++ /dev/null @@ -1,107 +0,0 @@ -package sfdc.sfdx.scanner.messaging; - -import com.google.gson.Gson; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; - -public class SfdxMessager { - // The START string gives us something to scan for when we're processing output. - private static final String START = "SFDX-START"; - // The END string lets us know when a message stops, which should prevent bugs involving multi-line output. - private static final String END = "SFDX-END"; - - private static final List MESSAGES = new ArrayList<>(); - - private static SfdxMessager INSTANCE = null; - - public static SfdxMessager getInstance() { - if (INSTANCE == null) { - INSTANCE = new SfdxMessager(); - } - return INSTANCE; - } - - /** - * Add exception to pass onto Typescript layer. - * Will be treated as an Error based on the properties set - * in EventKey. Please make sure that EventKey is correct and is - * in sync with messages/EventKeyTemplates.json - * - * @param exception to send to Typescript layer - */ - public void addMessage(SfdxScannerException exception) { - final EventKey eventKey = exception.getEventKey(); - addMessage( - exception.getFullStacktrace(), - eventKey, - exception.getArgs()); - } - - /** - * Add message to pass onto Typescript layer. - * Make sure EventKey is updated with messages/EventKeyTemplates.json - * and has correct properties in the enum. - * - * @param internalLog Information for internal use. Will be logged but not displayed to user - * @param eventKey EventKey to display to user - * @param args String args passed to the EventKey to make the displayed message meaningful - */ - public void addMessage(String internalLog, EventKey eventKey, String... args) { - // Developer error if eventKey was not added to exception and we'll get a bunch of NPEs - assert (eventKey != null); - // Confirm that the correct number of arguments for the message has been provided - // If this fails, this would be a developer error - assert (eventKey.getArgCount() == args.length); - - final Message message = new Message( - eventKey.getMessageKey(), - Arrays.asList(args), - internalLog, - eventKey.getMessageType(), - eventKey.getMessageHandler(), - eventKey.isVerbose()); - MESSAGES.add(message); - } - - - public String getAllMessagesWithFormatting() { - final String messagesAsJson = getMessagesAsJson(); - return START + messagesAsJson + END; - } - - private String getMessagesAsJson() { - return new Gson().toJson(MESSAGES); - } - - - /** - * TO BE USED ONLY BY TESTS! - * - * @return all messages as JSON without formatting - */ - public String getAllMessages() { - return getMessagesAsJson(); - } - - /** - * TO BE USED ONLY BY TESTS! - * STAY AWAY!! - */ - public void resetMessages() { - MESSAGES.clear(); - } - - enum MessageHandler { - UX, - INTERNAL - } - - enum MessageType { - INFO, - WARNING, - ERROR - } -} - diff --git a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/SfdxScannerException.java b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/SfdxScannerException.java deleted file mode 100644 index 688561a0b..000000000 --- a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/messaging/SfdxScannerException.java +++ /dev/null @@ -1,48 +0,0 @@ -package sfdc.sfdx.scanner.messaging; - -import com.google.common.base.Throwables; -import sfdc.sfdx.scanner.messaging.EventKey; - -import java.util.Arrays; - -/** - * Internal exception representation. - * Extends RuntimeException to avoid declaring everywhere - * Handles capability to plug into SfdxMessager - */ -public class SfdxScannerException extends RuntimeException { - - private final EventKey eventKey; - private final String[] args; - - public SfdxScannerException(EventKey eventKey, String... args) { - this(eventKey, null, args); - } - - public SfdxScannerException(EventKey eventKey, Throwable throwable, String... args) { - super(throwable); - - this.eventKey = eventKey; - this.args = args; - } - - public EventKey getEventKey() { - return eventKey; - } - - public String[] getArgs() { - return args; - } - - public String getFullStacktrace() { - return Throwables.getStackTraceAsString(this).replace("\\n", " | "); - } - - @Override - public String toString() { - return "SfdxScannerException{" + - "eventKey=" + eventKey + - ", args=" + Arrays.toString(args) + - '}'; - } -} diff --git a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/LanguageXmlFileMapping.java b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/LanguageXmlFileMapping.java index 7fd975984..a7fa620af 100644 --- a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/LanguageXmlFileMapping.java +++ b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/LanguageXmlFileMapping.java @@ -1,8 +1,8 @@ package sfdc.sfdx.scanner.pmd; -import sfdc.sfdx.scanner.messaging.EventKey; -import sfdc.sfdx.scanner.messaging.SfdxMessager; -import sfdc.sfdx.scanner.messaging.SfdxScannerException; +import com.salesforce.messaging.EventKey; +import com.salesforce.messaging.CliMessager; +import com.salesforce.messaging.MessagePassableException; import java.util.*; @@ -57,7 +57,7 @@ private void addPathForLanguage(String path, String language, String sourceJar) addCategoryPathForLanguage(path, language, sourceJar); categoryToSourceJar.put(path, sourceJar); } else { - SfdxMessager.getInstance().addMessage("Adding path " + path + " for language " + language, EventKey.WARNING_XML_DROPPED, path); + CliMessager.getInstance().addMessage("Adding path " + path + " for language " + language, EventKey.WARNING_XML_DROPPED, path); } } } @@ -81,7 +81,7 @@ private void addPath(String path, String language, String sourceJar, Map> rulePathEntries = parseArguments(args); catalogRules(rulePathEntries); - } catch (SfdxScannerException se) { + } catch (MessagePassableException se) { // Add all SfdxScannerExceptions as messages - SfdxMessager.getInstance().addMessage(se); + CliMessager.getInstance().addMessage(se); exitGracefully = false; } catch (Throwable throwable) { // Catch and handle any exceptions that may have slipped through - final SfdxScannerException exception = new SfdxScannerException(EventKey.ERROR_INTERNAL_UNEXPECTED, throwable, throwable.getMessage()); - SfdxMessager.getInstance().addMessage(exception); + final MessagePassableException exception = new MessagePassableException(EventKey.ERROR_INTERNAL_UNEXPECTED, throwable, throwable.getMessage()); + CliMessager.getInstance().addMessage(exception); exitGracefully = false; } finally { // Print all the messages we have collected in a parsable format - System.out.println(SfdxMessager.getInstance().getAllMessagesWithFormatting()); + System.out.println(CliMessager.getInstance().getAllMessagesWithFormatting()); } return exitGracefully; @@ -71,7 +71,7 @@ private void catalogRules(Map> rulePathEntries) { Map> parseArguments(String[] args) { if (args == null || args.length < 1) { - throw new SfdxScannerException(EventKey.ERROR_INTERNAL_MAIN_INVALID_ARGUMENT, NO_ARGUMENTS_FOUND); + throw new MessagePassableException(EventKey.ERROR_INTERNAL_MAIN_INVALID_ARGUMENT, NO_ARGUMENTS_FOUND); } final Map> rulePathEntries = new HashMap<>(); @@ -87,19 +87,19 @@ private void parseArg(Map> languagePathEntries, String arg) // DIVIDER should split arg in language and path list. No less, no more if (splitArg.length != 2) { - throw new SfdxScannerException(EventKey.ERROR_INTERNAL_MAIN_INVALID_ARGUMENT, String.format(EXPECTED_DIVIDER, arg)); + throw new MessagePassableException(EventKey.ERROR_INTERNAL_MAIN_INVALID_ARGUMENT, String.format(EXPECTED_DIVIDER, arg)); } final String language = splitArg[0].trim(); final String paths = splitArg[1]; if ("".equals(language.trim()) || "".equals((paths.trim()))) { - throw new SfdxScannerException(EventKey.ERROR_INTERNAL_MAIN_INVALID_ARGUMENT, String.format(MISSING_PARTS, arg)); + throw new MessagePassableException(EventKey.ERROR_INTERNAL_MAIN_INVALID_ARGUMENT, String.format(MISSING_PARTS, arg)); } final String[] pathArray = paths.split(COMMA); if (pathArray.length < 1) { - throw new SfdxScannerException(EventKey.ERROR_INTERNAL_MAIN_INVALID_ARGUMENT, String.format(NO_PATH_PROVIDED, language, arg)); + throw new MessagePassableException(EventKey.ERROR_INTERNAL_MAIN_INVALID_ARGUMENT, String.format(NO_PATH_PROVIDED, language, arg)); } // Stream path array to filter out empty path diff --git a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/PmdRuleCataloger.java b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/PmdRuleCataloger.java index 40bcb6c8f..2b01456b1 100644 --- a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/PmdRuleCataloger.java +++ b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/PmdRuleCataloger.java @@ -8,16 +8,15 @@ import com.google.gson.Gson; import com.google.gson.GsonBuilder; import org.w3c.dom.*; -import sfdc.sfdx.scanner.messaging.Message; -import sfdc.sfdx.scanner.messaging.SfdxScannerException; -import sfdc.sfdx.scanner.messaging.SfdxMessager; +import com.salesforce.messaging.EventKey; +import com.salesforce.messaging.MessagePassableException; +import com.salesforce.messaging.CliMessager; import sfdc.sfdx.scanner.pmd.catalog.PmdCatalogCategory; import sfdc.sfdx.scanner.pmd.catalog.PmdCatalogJson; import sfdc.sfdx.scanner.pmd.catalog.PmdCatalogRule; import sfdc.sfdx.scanner.pmd.catalog.PmdCatalogRuleset; import sfdc.sfdx.scanner.xml.XmlReader; import sfdc.sfdx.scanner.paths.PathManipulator; -import sfdc.sfdx.scanner.messaging.EventKey; class PmdRuleCataloger { private Map> rulePathEntries; @@ -110,7 +109,7 @@ private void processCategoryFile(String language, String path) { // If the root node isn't of type 'ruleset', this isn't a valid category file, so we should just log something and skip it. if (!root.getTagName().equalsIgnoreCase("ruleset") || !root.getAttribute("xmlns").startsWith("http://pmd.sourceforge.net")) { String fullPath = PathManipulator.getInstance().convertResourcePathToAbsolutePath(path); - SfdxMessager.getInstance().addMessage("Processing category file for language " + language + " at path " + path, EventKey.WARNING_INVALID_CAT_SKIPPED, fullPath); + CliMessager.getInstance().addMessage("Processing category file for language " + language + " at path " + path, EventKey.WARNING_INVALID_CAT_SKIPPED, fullPath); return; } @@ -143,7 +142,7 @@ private void generateRulesetRepresentation(String language, String path) { // If the root node isn't of type 'ruleset', this isn't a valid ruleset file, so we should just log something and skip it. if (!root.getTagName().equalsIgnoreCase("ruleset") || !root.getAttribute("xmlns").startsWith("http://pmd.sourceforge.net")) { String fullPath = PathManipulator.getInstance().convertResourcePathToAbsolutePath(path); - SfdxMessager.getInstance().addMessage("Generating Ruleset representation for language " + language + " at path " + path, EventKey.WARNING_INVALID_RULESET_SKIPPED, fullPath); + CliMessager.getInstance().addMessage("Generating Ruleset representation for language " + language + " at path " + path, EventKey.WARNING_INVALID_RULESET_SKIPPED, fullPath); return; } @@ -181,17 +180,22 @@ private void linkRulesToRulesets(List rules, List findXmlFilesInPath(String pathString) { final Path path = Paths.get(pathString); - List xmlContainers = new ArrayList<>(); + List xmlContainers = new ArrayList<>(); // Make sure that the path exists to begin with if (!Files.exists(path)) { - throw new SfdxScannerException(EventKey.ERROR_INTERNAL_CLASSPATH_DOES_NOT_EXIST, path.getFileName().toString()); + throw new MessagePassableException(EventKey.ERROR_INTERNAL_CLASSPATH_DOES_NOT_EXIST, path.getFileName().toString()); } if (Files.isDirectory(path)) { @@ -124,10 +124,10 @@ public List findXmlFilesInJar(String jarPath) { } } - SfdxMessager.getInstance().addMessage("", EventKey.INFO_JAR_AND_XML_PROCESSED, jarPath, xmlFiles.toString()); + CliMessager.getInstance().addMessage("", EventKey.INFO_JAR_AND_XML_PROCESSED, jarPath, xmlFiles.toString()); } catch (Exception e) { //TODO: add logging and print stacktrace for debugging - throw new SfdxScannerException(EventKey.ERROR_EXTERNAL_JAR_NOT_READABLE, e, jarPath); + throw new MessagePassableException(EventKey.ERROR_EXTERNAL_JAR_NOT_READABLE, e, jarPath); } return xmlFiles; @@ -146,7 +146,7 @@ private List scoutForFiles(FileType fileType, Path path) { filesFound.addAll(walk.map(x -> x.toString()) .filter(f -> f.endsWith(fileType.suffix)).collect(Collectors.toList())); } catch (IOException e) { - throw new SfdxScannerException(EventKey.ERROR_EXTERNAL_DIR_NOT_READABLE, e, path.toString()); + throw new MessagePassableException(EventKey.ERROR_EXTERNAL_DIR_NOT_READABLE, e, path.toString()); } return filesFound; diff --git a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRule.java b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRule.java index a24ffc4d3..08f83f5f4 100644 --- a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRule.java +++ b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRule.java @@ -4,8 +4,8 @@ import org.w3c.dom.*; import org.json.simple.*; -import sfdc.sfdx.scanner.messaging.SfdxScannerException; -import sfdc.sfdx.scanner.messaging.EventKey; +import com.salesforce.messaging.MessagePassableException; +import com.salesforce.messaging.EventKey; import static sfdc.sfdx.scanner.pmd.catalog.PmdCatalogJson.*; @@ -80,7 +80,7 @@ private String getDescription(Element element) { default: // If there was more than one description node, then something's gone crazy wrong and we should exit as gracefully // as possible. - throw new SfdxScannerException(EventKey.ERROR_EXTERNAL_MULTIPLE_RULE_DESC, getFullName(), String.valueOf(nl.getLength())); + throw new MessagePassableException(EventKey.ERROR_EXTERNAL_MULTIPLE_RULE_DESC, getFullName(), String.valueOf(nl.getLength())); } return res; } diff --git a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRuleset.java b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRuleset.java index 34c7015d9..fb35ffbfc 100644 --- a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRuleset.java +++ b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRuleset.java @@ -2,8 +2,8 @@ import org.w3c.dom.Element; import org.w3c.dom.NodeList; -import sfdc.sfdx.scanner.messaging.SfdxScannerException; -import sfdc.sfdx.scanner.messaging.EventKey; +import com.salesforce.messaging.MessagePassableException; +import com.salesforce.messaging.EventKey; import java.util.*; @@ -98,7 +98,7 @@ private void recursivelyProcessRule(PmdCatalogRule rule, PmdCatalogRuleset calle // for circular references, we're just going to forcibly exit if we go deeper than 10 layers of recursion, which is // way more than anyone could possibly want or need. if (recursionDepth > 10) { - throw new SfdxScannerException(EventKey.ERROR_EXTERNAL_RECURSION_LIMIT, caller.getPath(), rule.getFullName()); + throw new MessagePassableException(EventKey.ERROR_EXTERNAL_RECURSION_LIMIT, caller.getPath(), rule.getFullName()); } // Depending on whether this method was invoked by another ruleset, we'll either look for references to the rule's // category or references to the ruleset that invoked this method. diff --git a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/xml/XmlReader.java b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/xml/XmlReader.java index 72594ec55..f9df581ce 100644 --- a/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/xml/XmlReader.java +++ b/pmd-cataloger/src/main/java/sfdc/sfdx/scanner/xml/XmlReader.java @@ -2,8 +2,8 @@ import org.w3c.dom.Document; import org.xml.sax.SAXException; -import sfdc.sfdx.scanner.messaging.SfdxScannerException; -import sfdc.sfdx.scanner.messaging.EventKey; +import com.salesforce.messaging.MessagePassableException; +import com.salesforce.messaging.EventKey; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; @@ -68,13 +68,13 @@ public Document getDocumentFromPath(String path) { DocumentBuilder db = dbf.newDocumentBuilder(); doc = db.parse(in); } catch (FileNotFoundException fnf) { - throw new SfdxScannerException(EventKey.ERROR_INTERNAL_CLASSPATH_DOES_NOT_EXIST, path); + throw new MessagePassableException(EventKey.ERROR_INTERNAL_CLASSPATH_DOES_NOT_EXIST, path); } catch (IOException ioe) { - throw new SfdxScannerException(EventKey.ERROR_EXTERNAL_XML_NOT_READABLE, ioe, path, ioe.getMessage()); + throw new MessagePassableException(EventKey.ERROR_EXTERNAL_XML_NOT_READABLE, ioe, path, ioe.getMessage()); } catch (ParserConfigurationException | SAXException e) { - throw new SfdxScannerException(EventKey.ERROR_EXTERNAL_XML_NOT_PARSABLE, e, path, e.getMessage()); + throw new MessagePassableException(EventKey.ERROR_EXTERNAL_XML_NOT_PARSABLE, e, path, e.getMessage()); } catch (IllegalArgumentException iae) { - throw new SfdxScannerException(EventKey.ERROR_INTERNAL_XML_MISSING_IN_CLASSPATH, iae, path); + throw new MessagePassableException(EventKey.ERROR_INTERNAL_XML_MISSING_IN_CLASSPATH, iae, path); } return doc; } diff --git a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/messaging/EventKeyTest.java b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/messaging/EventKeyTest.java deleted file mode 100644 index b9222fe65..000000000 --- a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/messaging/EventKeyTest.java +++ /dev/null @@ -1,126 +0,0 @@ -package sfdc.sfdx.scanner.messaging; - -import org.json.simple.JSONObject; -import org.json.simple.parser.JSONParser; -import org.json.simple.parser.ParseException; - -import static org.junit.Assert.*; - -import org.junit.Before; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.junit.runners.Parameterized; -import org.junit.runners.Parameterized.Parameters; - -import static sfdc.sfdx.scanner.messaging.SfdxMessager.*; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.util.ArrayList; -import java.util.Collection; - -/** - * Parses messages/EventKeyTemplates.json and confirms that enums defined in EventKey - * are valid - */ -@RunWith(Parameterized.class) -public class EventKeyTest { - private static final String INFO = "info"; - private static final String WARNING = "warning"; - private static final String ERROR_EXTERNAL = "error.external"; - private static final String ERROR_INTERNAL = "error.internal"; - - // Current path is sfdx-scanner/pmd-cataloger - private static final String MESSAGES_FILE = "../messages/EventKeyTemplates.js"; - - JSONObject jsonObject = null; - - @Before - public void extractMessagesJson() throws IOException, ParseException { - final Path path = Paths.get(MESSAGES_FILE); - assertTrue("Invalid test setup. File does not exist: " + MESSAGES_FILE, Files.exists(path)); - final String fileContent = new String(Files.readAllBytes(path)); - final String[] fileSplit = fileContent.split("="); - final int fileParts = fileSplit.length; - assertEquals("Invalid test setup. File has more than one '=', which caused confusion in picking JSON content. Please revisit messages in " + MESSAGES_FILE, 2, fileParts); - final String jsonContent = fileSplit[1]; - jsonObject = (JSONObject) new JSONParser().parse(jsonContent); - assertNotNull("Invalid test setup. Messages json has not been parsed correctly. Please check validity of " + MESSAGES_FILE, jsonObject); - } - - @Test - public void verifyKeyInJson() { - // Split messageKey into levels - final String messageKey = eventKey.getMessageKey(); - final String[] levels = messageKey.split("\\."); - - // Loop through JSON to verify presence of each level - int idx = 0; - JSONObject currentJsonContent = this.jsonObject; - while (idx < levels.length - 1) { - currentJsonContent = (JSONObject) currentJsonContent.get(levels[idx]); - assertNotNull("Level " + levels[idx] + " not found. Recheck value of messageKey " + messageKey + " in EventKey." + eventKey, currentJsonContent); - idx++; - } - final Object lastLevel = currentJsonContent.get(levels[levels.length - 1]); - assertNotNull("messageKey " + messageKey + " does not exist. Recheck EventKey." + eventKey, lastLevel); - assertTrue("Message value should be a String for messageKey " + messageKey + " in EventKey." + eventKey, lastLevel instanceof String); - } - - @Test - public void verifyInfo() { - if (!eventKey.getMessageKey().startsWith(INFO)) { - return; - } - assertEquals("Unexpected messageType on EventKey." + eventKey, MessageType.INFO, eventKey.getMessageType()); - assertTrue("Verbose value on INFO messages are expected to be True. Please recheck EventKey." + eventKey, eventKey.isVerbose()); - } - - @Test - public void verifyWarning() { - if (!eventKey.getMessageKey().startsWith(WARNING)) { - return; - } - assertEquals("Unexpected messageType on EventKey." + eventKey, MessageType.WARNING, eventKey.getMessageType()); - // No verbose check since we don't have a rule yet - } - - @Test - public void verifyErrorExternal() { - if (!eventKey.getMessageKey().startsWith(ERROR_EXTERNAL)) { - return; - } - assertEquals("Unexpected messageType on EventKey." + eventKey, MessageType.ERROR, eventKey.getMessageType()); - assertFalse("Verbose value on external error messages should be True. Please recheck EventKey." + eventKey, eventKey.isVerbose()); - assertEquals("MessageHandler on external error messages should be UX. Please recheck EventKey." + eventKey, MessageHandler.UX, eventKey.getMessageHandler()); - } - - @Test - public void verifyErrorInternal() { - if (!eventKey.getMessageKey().startsWith(ERROR_INTERNAL)) { - return; - } - assertEquals("Unexpected messageType on EventKey." + eventKey, MessageType.ERROR, eventKey.getMessageType()); - assertFalse("Verbose value on internal error messages should be True. Please recheck EventKey." + eventKey, eventKey.isVerbose()); - assertEquals("MessageHandler on internal error messages should be INTERNAL. Please recheck EventKey." + eventKey, MessageHandler.INTERNAL, eventKey.getMessageHandler()); - } - - // Needed to make this test run dynamically for each EntryKey value - - private EventKey eventKey; - - public EventKeyTest(EventKey eventKey) { - this.eventKey = eventKey; - } - - @Parameters - public static Collection fetchEventKeys() { - Collection data = new ArrayList<>(); - for (EventKey eventKey : EventKey.values()) { - data.add(new Object[]{eventKey}); - } - return data; - } -} diff --git a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/LanguageXmlFileMappingTest.java b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/LanguageXmlFileMappingTest.java index 889fabcc7..b7874f389 100644 --- a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/LanguageXmlFileMappingTest.java +++ b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/LanguageXmlFileMappingTest.java @@ -15,7 +15,7 @@ import org.junit.Test; import org.junit.rules.ExpectedException; -import sfdc.sfdx.scanner.messaging.EventKey; +import com.salesforce.messaging.EventKey; /** * Unit test for {@link LanguageXmlFileMapping} @@ -122,7 +122,7 @@ private void testCollision(String collidingPath) { languageXmlFileMapping.addPathsForLanguage(Arrays.asList(xmlContainer1), APEX); - thrown.expect(new SfdxScannerExceptionMatcher(EventKey.ERROR_EXTERNAL_DUPLICATE_XML_PATH, + thrown.expect(new MessagePassableExceptionMatcher(EventKey.ERROR_EXTERNAL_DUPLICATE_XML_PATH, new String[] { collidingPath, jar2, jar1 })); languageXmlFileMapping.addPathsForLanguage(Arrays.asList(xmlContainer2), APEX); diff --git a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MainArgsHandlingTest.java b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MainArgsHandlingTest.java index c1ea39af7..5f9dc54b8 100644 --- a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MainArgsHandlingTest.java +++ b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MainArgsHandlingTest.java @@ -3,8 +3,8 @@ import static org.junit.Assert.*; import org.junit.Test; -import sfdc.sfdx.scanner.messaging.SfdxScannerException; -import sfdc.sfdx.scanner.messaging.EventKey; +import com.salesforce.messaging.MessagePassableException; +import com.salesforce.messaging.EventKey; import java.util.List; import java.util.Map; @@ -72,7 +72,7 @@ private void testParseArgForErrorHandling(String[] args, String expectedArgForMe try { main.parseArguments(args); fail(failureMessage); - } catch (SfdxScannerException e) { + } catch (MessagePassableException e) { assertEquals("Unexpected eventKey on exception", EventKey.ERROR_INTERNAL_MAIN_INVALID_ARGUMENT, e.getEventKey()); assertEquals("Unexpected arg list on exception", expectedArgForMessage, e.getArgs()[0]); } diff --git a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MainMessagesTest.java b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MainMessagesTest.java index 2aa4c3196..f6f67fa6f 100644 --- a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MainMessagesTest.java +++ b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MainMessagesTest.java @@ -7,10 +7,10 @@ import org.junit.After; import org.junit.Before; import org.junit.Test; -import sfdc.sfdx.scanner.messaging.EventKey; -import sfdc.sfdx.scanner.messaging.SfdxScannerException; -import sfdc.sfdx.scanner.messaging.Message; -import sfdc.sfdx.scanner.messaging.SfdxMessager; +import com.salesforce.messaging.EventKey; +import com.salesforce.messaging.MessagePassableException; +import com.salesforce.messaging.Message; +import com.salesforce.messaging.CliMessager; import java.util.List; @@ -21,14 +21,14 @@ public class MainMessagesTest { @Before @After public void clearMessages() { - SfdxMessager.getInstance().resetMessages(); + CliMessager.getInstance().resetMessages(); } @Test public void verifySfdxScannerExceptionsToMessages() { final EventKey expectedEventKey = EventKey.ERROR_INTERNAL_UNEXPECTED; final String[] expectedArgs = {"dummy arg"}; - final SfdxScannerException exception = new SfdxScannerException(expectedEventKey, expectedArgs); + final MessagePassableException exception = new MessagePassableException(expectedEventKey, expectedArgs); // Setup mock final Main.Dependencies dependencies = setupMockToThrowException(exception); @@ -74,7 +74,7 @@ private Main.Dependencies setupMockToThrowException(Exception exception) { } private List getMessages() { - final String messagesInJson = SfdxMessager.getInstance().getAllMessages(); + final String messagesInJson = CliMessager.getInstance().getAllMessages(); assertNotNull(messagesInJson); // Deserialize JSON to verify further diff --git a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/SfdxScannerExceptionMatcher.java b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MessagePassableExceptionMatcher.java similarity index 66% rename from pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/SfdxScannerExceptionMatcher.java rename to pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MessagePassableExceptionMatcher.java index e0d9e9686..d5d606484 100644 --- a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/SfdxScannerExceptionMatcher.java +++ b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/MessagePassableExceptionMatcher.java @@ -6,41 +6,41 @@ import org.hamcrest.Description; import org.hamcrest.TypeSafeMatcher; -import sfdc.sfdx.scanner.messaging.EventKey; -import sfdc.sfdx.scanner.messaging.SfdxScannerException; +import com.salesforce.messaging.EventKey; +import com.salesforce.messaging.MessagePassableException; /** * Custom matcher that can be used with * {@link org.junit.rules.ExpectedException#expect(org.hamcrest.Matcher)} - * + * * 
  * // Example Usage
- * thrown.expect(new SfdxScannerExceptionMatcher(EventKey.WARNING_INVALID_CAT_SKIPPED,
+ * thrown.expect(new MessagePassableExceptionMatcher(EventKey.WARNING_INVALID_CAT_SKIPPED,
  * 		new String[] { "InventoryName" }));
  *
*/ -public class SfdxScannerExceptionMatcher extends TypeSafeMatcher { +public class MessagePassableExceptionMatcher extends TypeSafeMatcher { private final EventKey expectedEventKey; private final String[] expectedArgs; - public SfdxScannerExceptionMatcher(EventKey expectedEventKey, String[] expectedArgs) { + public MessagePassableExceptionMatcher(EventKey expectedEventKey, String[] expectedArgs) { this.expectedEventKey = expectedEventKey; this.expectedArgs = nullToEmpty(expectedArgs); } - + @Override - protected boolean matchesSafely(SfdxScannerException item) { + protected boolean matchesSafely(MessagePassableException item) { String[] actualArgs = nullToEmpty(item.getArgs()); return expectedEventKey.equals(item.getEventKey()) && - Arrays.equals(expectedArgs, actualArgs); + Arrays.equals(expectedArgs, actualArgs); } @Override public void describeTo(Description description) { description.appendText("EventKey=").appendValue(expectedEventKey.name()).appendText(", Args=") - .appendValue(expectedArgs); + .appendValue(expectedArgs); } - + /** * Convert a null array to empty array. The are equivalent for our purposes. */ diff --git a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/PmdRuleCatalogerTest.java b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/PmdRuleCatalogerTest.java index 77bfacefb..69ee077f3 100644 --- a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/PmdRuleCatalogerTest.java +++ b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/PmdRuleCatalogerTest.java @@ -5,50 +5,94 @@ import static org.hamcrest.Matchers.hasSize; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.fail; import static sfdc.sfdx.scanner.TestConstants.*; +import java.nio.file.Path; +import java.nio.file.Paths; import java.util.Arrays; import java.util.Collections; import java.util.Hashtable; import java.util.List; import java.util.Map; +import com.salesforce.messaging.CliMessager; import org.json.simple.JSONObject; +import org.json.simple.parser.JSONParser; +import org.json.simple.parser.ParseException; +import org.junit.After; +import org.junit.Before; import org.junit.Rule; import org.junit.Test; import org.junit.rules.ExpectedException; import org.mockito.ArgumentCaptor; import org.mockito.Mockito; -import sfdc.sfdx.scanner.messaging.EventKey; +import com.salesforce.messaging.EventKey; import sfdc.sfdx.scanner.pmd.catalog.PmdCatalogJson; /** * Unit test for {@link PmdRuleCataloger} */ public class PmdRuleCatalogerTest { + private static final String TEST_CATALOG_DIR = "./test/path/to/a/directory"; + private static final String TEST_CATALOG_FILE = "PmdCatalog.json"; @Rule - public ExpectedException thrown = ExpectedException.none();; + public ExpectedException thrown = ExpectedException.none(); + + public ArgumentCaptor jsonContentsCaptor; + public ArgumentCaptor directoryPathCaptor; + public ArgumentCaptor fileNameCaptor; + + @Before + public void setup() { + System.setProperty("catalogHome", TEST_CATALOG_DIR); + System.setProperty("catalogName", TEST_CATALOG_FILE); + CliMessager.getInstance().resetMessages(); + } + + @After + public void teardown() { + System.clearProperty("catalogHome"); + System.clearProperty("catalogName"); + } + + public PmdRuleCataloger createPmdRuleCatalogerSpy(Map> rulePathEntries) { + PmdRuleCataloger pmdRuleCataloger = new PmdRuleCataloger(rulePathEntries); + PmdRuleCataloger pmdRuleCatalogerSpy = Mockito.spy(pmdRuleCataloger); + + jsonContentsCaptor = ArgumentCaptor.forClass(String.class); + directoryPathCaptor = ArgumentCaptor.forClass(Path.class); + fileNameCaptor = ArgumentCaptor.forClass(String.class); + + Mockito.doNothing().when(pmdRuleCatalogerSpy).persistJsonToFile(jsonContentsCaptor.capture(), directoryPathCaptor.capture(), fileNameCaptor.capture()); + + return pmdRuleCatalogerSpy; + } + @SuppressWarnings("unchecked") @Test public void testAddJar() { Map> rulePathEntries = new Hashtable<>(); - + rulePathEntries.put(APEX, Collections.singletonList(JAR_FILE_CATEGORIES_AND_RULESETS.toAbsolutePath().toString())); - PmdRuleCataloger pmdRuleCataloger = new PmdRuleCataloger(rulePathEntries); - PmdRuleCataloger pmdRuleCatalogerSpy = Mockito.spy(pmdRuleCataloger); - - ArgumentCaptor pmdCatalogJsonCaptor = ArgumentCaptor.forClass(PmdCatalogJson.class); - Mockito.doNothing().when(pmdRuleCatalogerSpy).writeJsonToFile(pmdCatalogJsonCaptor.capture()); + + PmdRuleCataloger pmdRuleCatalogerSpy = createPmdRuleCatalogerSpy(rulePathEntries); pmdRuleCatalogerSpy.catalogRules(); - - PmdCatalogJson pmdCatalogJson = pmdCatalogJsonCaptor.getValue(); - assertNotNull(pmdCatalogJson); - - JSONObject json = pmdCatalogJson.constructJson(); - assertNotNull(json); - + + String catalogJson = jsonContentsCaptor.getValue(); + Path directoryPath = directoryPathCaptor.getValue(); + String fileName = fileNameCaptor.getValue(); + + JSONObject json = null; + try { + json = (JSONObject) (new JSONParser().parse(catalogJson)); + } catch (ParseException pe) { + fail("Parse failure " + pe.getMessage()); + } + List rulesets = (List)json.get(PmdCatalogJson.JSON_RULESETS); assertNotNull(rulesets); assertThat(rulesets, hasSize(equalTo(1))); @@ -62,27 +106,32 @@ public void testAddJar() { Map category = (Map)categories.get(0); assertNotNull(category); assertThat((List)category.get(PmdCatalogJson.JSON_PATHS), contains("category/apex/cat1.xml")); + + assertEquals(directoryPath, Paths.get(TEST_CATALOG_DIR)); + assertEquals(fileName, TEST_CATALOG_FILE); } - + @SuppressWarnings("unchecked") @Test public void testAddXml() { String path = XML_FILE.toAbsolutePath().toString(); Map> rulePathEntries = new Hashtable<>(); - + rulePathEntries.put(APEX, Collections.singletonList(path)); - PmdRuleCataloger pmdRuleCataloger = new PmdRuleCataloger(rulePathEntries); - PmdRuleCataloger pmdRuleCatalogerSpy = Mockito.spy(pmdRuleCataloger); - - ArgumentCaptor pmdCatalogJsonCaptor = ArgumentCaptor.forClass(PmdCatalogJson.class); - Mockito.doNothing().when(pmdRuleCatalogerSpy).writeJsonToFile(pmdCatalogJsonCaptor.capture()); + + PmdRuleCataloger pmdRuleCatalogerSpy = createPmdRuleCatalogerSpy(rulePathEntries); pmdRuleCatalogerSpy.catalogRules(); - - PmdCatalogJson pmdCatalogJson = pmdCatalogJsonCaptor.getValue(); - assertNotNull(pmdCatalogJson); - JSONObject json = pmdCatalogJson.constructJson(); - assertNotNull(json); + String catalogJson = jsonContentsCaptor.getValue(); + Path directoryPath = directoryPathCaptor.getValue(); + String fileName = fileNameCaptor.getValue(); + + JSONObject json = null; + try { + json = (JSONObject) (new JSONParser().parse(catalogJson)); + } catch (ParseException pe) { + fail("Parse failure " + pe.getMessage()); + } List categories = (List)json.get(PmdCatalogJson.JSON_CATEGORIES); assertNotNull(categories); @@ -90,17 +139,20 @@ public void testAddXml() { Map category = (Map)categories.get(0); assertNotNull(category); assertThat((List)category.get(PmdCatalogJson.JSON_PATHS), contains(path)); + + assertEquals(directoryPath, Paths.get(TEST_CATALOG_DIR)); + assertEquals(fileName, TEST_CATALOG_FILE); } - + @Test public void testExceptionIsThrownWhenCollisionOccurs() { Map> rulePathEntries = new Hashtable<>(); - + rulePathEntries.put(APEX, Arrays.asList(COLLISION_JAR_1.toAbsolutePath().toString(), COLLISION_JAR_2.toAbsolutePath().toString())); PmdRuleCataloger pmdRuleCataloger = new PmdRuleCataloger(rulePathEntries); - - thrown.expect(new SfdxScannerExceptionMatcher(EventKey.ERROR_EXTERNAL_DUPLICATE_XML_PATH, + + thrown.expect(new MessagePassableExceptionMatcher(EventKey.ERROR_EXTERNAL_DUPLICATE_XML_PATH, new String[] { "category/joshapex/somecat.xml", COLLISION_JAR_2.toAbsolutePath().toString(), COLLISION_JAR_1.toAbsolutePath().toString() })); diff --git a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/XmlFileFinderTest.java b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/XmlFileFinderTest.java index 8a10a68e2..e8e3dd8cf 100644 --- a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/XmlFileFinderTest.java +++ b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/XmlFileFinderTest.java @@ -16,7 +16,7 @@ import org.junit.Rule; import org.junit.Test; import org.junit.rules.ExpectedException; -import sfdc.sfdx.scanner.messaging.EventKey; +import com.salesforce.messaging.EventKey; /** * Unit tests for {@link XmlFileFinder} @@ -106,7 +106,7 @@ private String getSingleFile(List xmlContainers, Str @Test public void testFindingNonExistentFile_ExpectError() { XmlFileFinder xmlFileFinder = new XmlFileFinder(); - thrown.expect(new SfdxScannerExceptionMatcher(EventKey.ERROR_INTERNAL_CLASSPATH_DOES_NOT_EXIST, new String[]{"nonexistentfile.xml"})); + thrown.expect(new MessagePassableExceptionMatcher(EventKey.ERROR_INTERNAL_CLASSPATH_DOES_NOT_EXIST, new String[]{"nonexistentfile.xml"})); List xmlContainers = xmlFileFinder.findXmlFilesInPath("nonexistentfile.xml"); } diff --git a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRuleTest.java b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRuleTest.java index 034ff90fa..45abd4071 100644 --- a/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRuleTest.java +++ b/pmd-cataloger/src/test/java/sfdc/sfdx/scanner/pmd/catalog/PmdCatalogRuleTest.java @@ -1,22 +1,31 @@ package sfdc.sfdx.scanner.pmd.catalog; +import com.salesforce.messaging.EventKey; import org.json.simple.JSONObject; import static org.junit.Assert.*; +import org.junit.Rule; import org.junit.Test; import static org.mockito.Mockito.*; +import org.junit.rules.ExpectedException; import org.w3c.dom.Element; import org.w3c.dom.NodeList; +import sfdc.sfdx.scanner.pmd.MessagePassableExceptionMatcher; import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; import java.util.List; public class PmdCatalogRuleTest { + @Rule + public ExpectedException thrown = ExpectedException.none(); + private static final String NAME = "Name"; private static final String MESSAGE = "Some message"; private static final String LANGUAGE = "apex"; @@ -29,7 +38,7 @@ public class PmdCatalogRuleTest { @Test public void testCatalogRuleJsonConversion() { // Setup mock - final Element elementMock = getElementMock(1, "description"); + final Element elementMock = getElementMock(Collections.singletonList("description")); final PmdCatalogRule catalogRule = new PmdCatalogRule(elementMock, CATEGORY, LANGUAGE); @@ -55,11 +64,10 @@ public void testCatalogRuleJsonConversion() { @Test public void testCatalogRuleNoDescription() { - final int descriptionNlCount = 0; final String emptyDescription = ""; // Setup mock - final Element elementMock = getElementMock(descriptionNlCount, emptyDescription); + final Element elementMock = getElementMock(Collections.singletonList("")); final PmdCatalogRule catalogRule = new PmdCatalogRule(elementMock, CATEGORY, LANGUAGE); // Execute @@ -71,11 +79,10 @@ public void testCatalogRuleNoDescription() { @Test public void testCatalogRuleJsonWithDescription() { - final int descriptionNlCount = 1; final String description = "Some description"; // Setup mock - final Element elementMock = getElementMock(descriptionNlCount, description); + final Element elementMock = getElementMock(Collections.singletonList(description)); final PmdCatalogRule catalogRule = new PmdCatalogRule(elementMock, CATEGORY, LANGUAGE); // Execute @@ -85,18 +92,33 @@ public void testCatalogRuleJsonWithDescription() { assertEquals("Unexpected description", description, jsonObject.get(PmdCatalogJson.JSON_DESCRIPTION)); } - private Element getElementMock(int descriptionNlCount, String emptyDescription) { + @Test + public void testCatalogRuleJsonWithMultipleDescriptions_expectException() { + final String description1 = "Some Description"; + final String description2 = "Some Other Description"; + + // Setup mock + final Element elementMock = getElementMock(Arrays.asList(description1, description2)); + thrown.expect(new MessagePassableExceptionMatcher(EventKey.ERROR_EXTERNAL_MULTIPLE_RULE_DESC, + new String[]{CATEGORY.getPath() + "/" + NAME, "2"} + )); + // Even initializing the object should be enough to trigger the expected exception. + final PmdCatalogRule catalogRule = new PmdCatalogRule(elementMock, CATEGORY, LANGUAGE); + } + + private Element getElementMock(List descriptions) { final Element elementMock = mock(Element.class); doReturn(NAME).when(elementMock).getAttribute(PmdCatalogRule.ATTR_NAME); doReturn(MESSAGE).when(elementMock).getAttribute(PmdCatalogRule.ATTR_MESSAGE); - final Element descElementMock = mock(Element.class); - doReturn(emptyDescription).when(descElementMock).getTextContent(); - - final NodeList nodeList = mock(NodeList.class); - doReturn(descriptionNlCount).when(nodeList).getLength(); - doReturn(descElementMock).when(nodeList).item(0); - doReturn(nodeList).when(elementMock).getElementsByTagName(PmdCatalogRule.ATTR_DESCRIPTION); + final NodeList nodeListMock = mock(NodeList.class); + doReturn(descriptions.size()).when(nodeListMock).getLength(); + for (int i = 0; i < descriptions.size(); i++) { + final Element descElementMock = mock(Element.class); + doReturn(descriptions.get(i)).when(descElementMock).getTextContent(); + doReturn(descElementMock).when(nodeListMock).item(i); + } + doReturn(nodeListMock).when(elementMock).getElementsByTagName(PmdCatalogRule.ATTR_DESCRIPTION); return elementMock; } From 539e2651dd19130ad6449b80c137494765a572d7 Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Tue, 7 Jun 2022 11:15:24 -0500 Subject: [PATCH 09/22] @W-10759090@: Refactored CLI result handler into separate class for better readability. --- src/lib/cpd/CpdWrapper.ts | 4 ++-- src/lib/pmd/PmdWrapper.ts | 4 ++-- src/lib/services/CommandLineSupport.ts | 23 ++++++++++++++--------- src/lib/sfge/SfgeWrapper.ts | 4 ++-- 4 files changed, 20 insertions(+), 15 deletions(-) diff --git a/src/lib/cpd/CpdWrapper.ts b/src/lib/cpd/CpdWrapper.ts index ed70c9d50..bb1199604 100644 --- a/src/lib/cpd/CpdWrapper.ts +++ b/src/lib/cpd/CpdWrapper.ts @@ -3,7 +3,7 @@ import {FileHandler} from '../util/FileHandler'; import * as JreSetupManager from './../JreSetupManager'; import path = require('path'); import { PMD_LIB } from '../../Constants'; -import { CommandLineSupport, ResultHandlerArgs } from '../services/CommandLineSupport'; +import { CommandLineSupport, CommandLineResultHandler, ResultHandlerArgs } from '../services/CommandLineSupport'; const MAIN_CLASS = 'net.sourceforge.pmd.cpd.CPD'; const HEAP_SIZE = '-Xmx1024m'; @@ -73,7 +73,7 @@ export default class CpdWrapper extends CommandLineSupport { } protected handleResults(args: ResultHandlerArgs): void { - super.defaultResultHandler(args); + new CommandLineResultHandler().handleResults(args); } constructor(options: CpdWrapperOptions) { diff --git a/src/lib/pmd/PmdWrapper.ts b/src/lib/pmd/PmdWrapper.ts index 0c6bc442a..0878302fa 100644 --- a/src/lib/pmd/PmdWrapper.ts +++ b/src/lib/pmd/PmdWrapper.ts @@ -2,7 +2,7 @@ import {Logger} from '@salesforce/core'; import {Format, PmdSupport} from './PmdSupport'; import * as JreSetupManager from './../JreSetupManager'; import path = require('path'); -import { ResultHandlerArgs } from '../services/CommandLineSupport'; +import { CommandLineResultHandler, ResultHandlerArgs } from '../services/CommandLineSupport'; import {FileHandler} from '../util/FileHandler'; const MAIN_CLASS = 'net.sourceforge.pmd.PMD'; @@ -96,6 +96,6 @@ export default class PmdWrapper extends PmdSupport { } protected handleResults(args: ResultHandlerArgs): void { - super.defaultResultHandler(args); + new CommandLineResultHandler().handleResults(args); } } diff --git a/src/lib/services/CommandLineSupport.ts b/src/lib/services/CommandLineSupport.ts index 8dcbcc71e..4ad203958 100644 --- a/src/lib/services/CommandLineSupport.ts +++ b/src/lib/services/CommandLineSupport.ts @@ -7,12 +7,23 @@ import {SpinnerManager, NoOpSpinnerManager} from './SpinnerManager'; export type ResultHandlerArgs = { code: number; + isSuccess: boolean; stdout: string; stderr: string; res: (string) => void; rej: (string) => void; }; +export class CommandLineResultHandler { + public handleResults(args: ResultHandlerArgs): void { + if (args.isSuccess) { + args.res(args.stdout); + } else { + args.rej(args.stderr); + } + } +} + export abstract class CommandLineSupport extends AsyncCreatable { private parentLogger: Logger; @@ -50,14 +61,6 @@ export abstract class CommandLineSupport extends AsyncCreatable { */ protected abstract handleResults(args: ResultHandlerArgs): void; - protected defaultResultHandler(args: ResultHandlerArgs): void { - if (this.isSuccessfulExitCode(args.code)) { - args.res(args.stdout); - } else { - args.rej(args.stderr); - } - } - protected abstract isSuccessfulExitCode(code: number): boolean; protected abstract buildCommandArray(): Promise<[string, string[]]>; @@ -82,11 +85,13 @@ export abstract class CommandLineSupport extends AsyncCreatable { cp.on('exit', code => { this.parentLogger.trace(`runCommand has received exit code ${code}`); - this.getSpinnerManager().stopSpinner(this.isSuccessfulExitCode(code)); + const isSuccess = this.isSuccessfulExitCode(code); + this.getSpinnerManager().stopSpinner(isSuccess); // The output processor's input is always stdout. this.outputProcessor.processOutput(stdout); this.handleResults({ code, + isSuccess, stdout, stderr, res, diff --git a/src/lib/sfge/SfgeWrapper.ts b/src/lib/sfge/SfgeWrapper.ts index 805f606d6..da16d480d 100644 --- a/src/lib/sfge/SfgeWrapper.ts +++ b/src/lib/sfge/SfgeWrapper.ts @@ -5,7 +5,7 @@ import {Controller} from '../../Controller'; import * as JreSetupManager from '../JreSetupManager'; import {uxEvents, EVENTS} from '../ScannerEvents'; import {Rule, SfgeConfig, RuleTarget} from '../../types'; -import {CommandLineSupport, ResultHandlerArgs} from '../services/CommandLineSupport'; +import {CommandLineSupport, CommandLineResultHandler, ResultHandlerArgs} from '../services/CommandLineSupport'; import {SpinnerManager, NoOpSpinnerManager} from '../services/SpinnerManager'; import {FileHandler} from '../util/FileHandler'; @@ -124,7 +124,7 @@ export class SfgeWrapper extends CommandLineSupport { } protected handleResults(args: ResultHandlerArgs) { - super.defaultResultHandler(args); + new CommandLineResultHandler().handleResults(args); } /** From 8882d410fce5f2ba86b871a7ee8b12e8bb0ca255 Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Tue, 7 Jun 2022 12:50:54 -0500 Subject: [PATCH 10/22] @W-10759090@: Consolidated SFGE input into single file. --- sfge/src/main/java/com/salesforce/Main.java | 10 +- .../java/com/salesforce/cli/CliArgParser.java | 31 +++- .../com/salesforce/graph/ops/MethodUtil.java | 13 +- .../salesforce/graph/ops/MethodUtilTest.java | 137 ++++++++++-------- src/lib/sfge/SfgeWrapper.ts | 36 +++-- 5 files changed, 133 insertions(+), 94 deletions(-) diff --git a/sfge/src/main/java/com/salesforce/Main.java b/sfge/src/main/java/com/salesforce/Main.java index 175bc62e1..d7f4e0c31 100644 --- a/sfge/src/main/java/com/salesforce/Main.java +++ b/sfge/src/main/java/com/salesforce/Main.java @@ -23,12 +23,14 @@ * The main class, invoked by sfdx-scanner. `catalog` flow lists all of the available rules in a * standardized format. * - *

The `execute` flow accepts three parameters. + *

The `execute` flow accepts as a parameter the name of a file whose contents are a JSON with + * the following structure: * *

    - *
  1. The name of a file whose * contents are directories from which the graph should be built. - *
  2. The name of a file whose contents are individual files against which rules should be run. - *
  3. A comma-separated list of rule names. + *
  4. rulesToRun: An array of rule names. + *
  5. projectDirs: An array of directories from which the graph should be built. + *
  6. targets: An array of objects with a `targetFile` property indicating the file to be + * analyzed and a `targetMethods` property indicating individual methods. *
* *

Exit codes: diff --git a/sfge/src/main/java/com/salesforce/cli/CliArgParser.java b/sfge/src/main/java/com/salesforce/cli/CliArgParser.java index 74ab4cc85..e8e7eabd3 100644 --- a/sfge/src/main/java/com/salesforce/cli/CliArgParser.java +++ b/sfge/src/main/java/com/salesforce/cli/CliArgParser.java @@ -40,7 +40,7 @@ public CLI_ACTION getCliAction(String... args) { } public static class ExecuteArgParser { - private static int ARG_COUNT = 4; + private static int ARG_COUNT = 2; private final List projectDirs; private final List targets; @@ -63,9 +63,10 @@ public void parseArgs(String... args) { "Wrong number of arguments. Expected %d; received %d", ARG_COUNT, args.length)); } - identifyTargetFiles(args[1]); - identifyProjectDirs(args[2]); - identifyRules(args[3]); + ExecuteInput input = readInputFile(args[1]); + targets.addAll(input.targets); + projectDirs.addAll(input.projectDirs); + identifyRules(input.rulesToRun); } public List getProjectDirs() { @@ -102,6 +103,17 @@ private void identifyTargetFiles(String inputFile) { } } + private ExecuteInput readInputFile(String fileName) { + try { + String inputJson = String.join("\n", readFile(fileName)); + Gson gson = new Gson(); + return gson.fromJson(inputJson, ExecuteInput.class); + } catch (IOException ex) { + throw new InvocationException( + "Could not read input file " + fileName + ": " + ex.getMessage(), ex); + } + } + private List readFile(String fileName) throws IOException { final List allLines = Files.readAllLines(Paths.get(fileName)); final List lines = @@ -112,10 +124,9 @@ private List readFile(String fileName) throws IOException { return lines; } - private void identifyRules(String ruleString) { - String[] ruleNames = ruleString.split(","); + private void identifyRules(List rulesToRun) { try { - for (String ruleName : ruleNames) { + for (String ruleName : rulesToRun) { AbstractRule rule = RuleUtil.getRule(ruleName); selectedRules.add(rule); } @@ -134,4 +145,10 @@ public static class InvocationException extends SfgeRuntimeException { super(msg, cause); } } + + public static class ExecuteInput { + private List rulesToRun; + private List projectDirs; + private List targets; + } } diff --git a/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java b/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java index 74e3ae847..ef13eb3cd 100644 --- a/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java +++ b/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java @@ -122,12 +122,13 @@ public static List getTargetedMethods( return methodVertices; } - /** - * If any of the method names specified by the provided target returned multiple results or zero results, adds a - * message to a {@link CliMessager} instance indicating such. - * @param target - A target that specifies a file and methods within that file - * @param vertices - The method vertices returned by the query created using the target - */ + /** + * If any of the method names specified by the provided target returned multiple results or zero + * results, adds a message to a {@link CliMessager} instance indicating such. + * + * @param target - A target that specifies a file and methods within that file + * @param vertices - The method vertices returned by the query created using the target + */ private static void addMessagesForTarget(RuleRunnerTarget target, List vertices) { NonNullHashMap methodCountByName = CollectionUtil.newNonNullHashMap(); // Map each vertex's method name to the number of vertices sharing that name. diff --git a/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java b/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java index 4d826e83b..871a51f4b 100644 --- a/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java +++ b/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java @@ -31,8 +31,8 @@ public class MethodUtilTest { private static final String METHOD_WITH_INTERNAL_OVERLOADS = "methodWithInternalOverloads"; private static final String METHOD_WITH_EXTERNAL_NAME_DUPLICATION = "methodWithExternalNameDuplication"; - private static final String METHOD_WITH_INNER_CLASS_DUPLICATION = - "methodWithInnerClassDuplication"; + private static final String METHOD_WITH_INNER_CLASS_DUPLICATION = + "methodWithInnerClassDuplication"; private static final String SOURCE_FILE_1 = "public class Foo1 {\n" @@ -88,22 +88,28 @@ public class MethodUtilTest { + " }\n" + "}\n"; - private static final String SOURCE_FILE_3 = - "public class Foo3 {\n" - + " public boolean " + METHOD_WITH_INNER_CLASS_DUPLICATION + "() {\n" - + " return true;\n" - + " }\n" - + " \n" - + " public class InnerFoo {\n" - + " public boolean " + METHOD_WITHOUT_OVERLOADS_3 + "() {\n" - + " return true;\n" - + " }\n" - + " \n" - + " public boolean " + METHOD_WITH_INNER_CLASS_DUPLICATION + "() {\n" - + " return true;\n" - + " }\n" - + " }\n" - + "}\n"; + private static final String SOURCE_FILE_3 = + "public class Foo3 {\n" + + " public boolean " + + METHOD_WITH_INNER_CLASS_DUPLICATION + + "() {\n" + + " return true;\n" + + " }\n" + + " \n" + + " public class InnerFoo {\n" + + " public boolean " + + METHOD_WITHOUT_OVERLOADS_3 + + "() {\n" + + " return true;\n" + + " }\n" + + " \n" + + " public boolean " + + METHOD_WITH_INNER_CLASS_DUPLICATION + + "() {\n" + + " return true;\n" + + " }\n" + + " }\n" + + "}\n"; @BeforeEach public void setup() { @@ -234,49 +240,54 @@ public void getTargetMethods_targetMethodDoesNotExist() { containsString(EventKey.WARNING_NO_METHOD_TARGET_MATCHES.getMessageKey())); } - @Test - public void getTargetMethods_targetMethodInInnerClass() { - TestUtil.Config config = - TestUtil.Config.Builder.get(g, new String[]{SOURCE_FILE_3}).build(); - TestUtil.buildGraph(config); - // Create a rule target encompassing the method that exists only in the inner class. - List targets = new ArrayList<>(); - targets.add(new RuleRunnerTarget("TestCode0", Collections.singletonList(METHOD_WITHOUT_OVERLOADS_3))); - - List methodVertices = MethodUtil.getTargetedMethods(g, targets); - - MatcherAssert.assertThat(methodVertices, hasSize(equalTo(1))); - } - - @Test - public void getTargetMethods_targetMethodInInnerAndOuterClass() { - TestUtil.Config config = - TestUtil.Config.Builder.get(g, new String[]{SOURCE_FILE_3}).build(); - TestUtil.buildGraph(config); - // Create a rule target encompassing the method that exists only in the inner class. - List targets = new ArrayList<>(); - targets.add(new RuleRunnerTarget("TestCode0", Collections.singletonList(METHOD_WITH_INNER_CLASS_DUPLICATION))); - - List methodVertices = MethodUtil.getTargetedMethods(g, targets); - - MatcherAssert.assertThat(methodVertices, hasSize(equalTo(2))); - boolean line2Found = false; - boolean line11Found = false; - for (MethodVertex methodVertex : methodVertices) { - assertEquals(METHOD_WITH_INNER_CLASS_DUPLICATION, methodVertex.getName()); - if (methodVertex.getBeginLine() == 2) { - line2Found = true; - } else if (methodVertex.getBeginLine() == 11) { - line11Found = true; - } else { - fail("Unexpected line number " + methodVertex.getBeginLine()); - } - } - assertTrue(line2Found); - assertTrue(line11Found); - String messages = CliMessager.getInstance().getAllMessages(); - MatcherAssert.assertThat( - messages, - containsString(EventKey.WARNING_MULTIPLE_METHOD_TARGET_MATCHES.getMessageKey())); - } + @Test + public void getTargetMethods_targetMethodInInnerClass() { + TestUtil.Config config = + TestUtil.Config.Builder.get(g, new String[] {SOURCE_FILE_3}).build(); + TestUtil.buildGraph(config); + // Create a rule target encompassing the method that exists only in the inner class. + List targets = new ArrayList<>(); + targets.add( + new RuleRunnerTarget( + "TestCode0", Collections.singletonList(METHOD_WITHOUT_OVERLOADS_3))); + + List methodVertices = MethodUtil.getTargetedMethods(g, targets); + + MatcherAssert.assertThat(methodVertices, hasSize(equalTo(1))); + } + + @Test + public void getTargetMethods_targetMethodInInnerAndOuterClass() { + TestUtil.Config config = + TestUtil.Config.Builder.get(g, new String[] {SOURCE_FILE_3}).build(); + TestUtil.buildGraph(config); + // Create a rule target encompassing the method that exists only in the inner class. + List targets = new ArrayList<>(); + targets.add( + new RuleRunnerTarget( + "TestCode0", + Collections.singletonList(METHOD_WITH_INNER_CLASS_DUPLICATION))); + + List methodVertices = MethodUtil.getTargetedMethods(g, targets); + + MatcherAssert.assertThat(methodVertices, hasSize(equalTo(2))); + boolean line2Found = false; + boolean line11Found = false; + for (MethodVertex methodVertex : methodVertices) { + assertEquals(METHOD_WITH_INNER_CLASS_DUPLICATION, methodVertex.getName()); + if (methodVertex.getBeginLine() == 2) { + line2Found = true; + } else if (methodVertex.getBeginLine() == 11) { + line11Found = true; + } else { + fail("Unexpected line number " + methodVertex.getBeginLine()); + } + } + assertTrue(line2Found); + assertTrue(line11Found); + String messages = CliMessager.getInstance().getAllMessages(); + MatcherAssert.assertThat( + messages, + containsString(EventKey.WARNING_MULTIPLE_METHOD_TARGET_MATCHES.getMessageKey())); + } } diff --git a/src/lib/sfge/SfgeWrapper.ts b/src/lib/sfge/SfgeWrapper.ts index da16d480d..723516852 100644 --- a/src/lib/sfge/SfgeWrapper.ts +++ b/src/lib/sfge/SfgeWrapper.ts @@ -42,6 +42,12 @@ type SfgeTarget = { targetMethods: string[]; }; +type SfgeInput = { + targets: SfgeTarget[]; + projectDirs: string[]; + rulesToRun: string[]; +}; + class SfgeSpinnerManager extends AsyncCreatable implements SpinnerManager { private initialized: boolean; private intervalId: NodeJS.Timeout; @@ -113,9 +119,9 @@ export class SfgeWrapper extends CommandLineSupport { return Promise.resolve([`${SFGE_LIB}/*`]); } - private async createInputFile(targetFiles: string[]): Promise { + private async createInputFile(input: SfgeInput): Promise { const inputFile = await this.fh.tmpFileWithCleanup(); - await this.fh.writeFile(inputFile, targetFiles.join('\n')); + await this.fh.writeFile(inputFile, JSON.stringify(input)); return inputFile; } @@ -142,13 +148,11 @@ export class SfgeWrapper extends CommandLineSupport { const command = path.join(javaHome, 'bin', 'java'); const classpath = await this.buildClasspath(); - const targetListFile = await this.createInputFile([this.createTargetJsons()]); - const sourceListFile = await this.createInputFile(this.projectDirs); - const rulesToRun = this.rules.map(rule => rule.name).join(','); + const inputObject: SfgeInput = this.createInputJson(); + const inputFile = await this.createInputFile(inputObject); - this.logger.trace(`Stored the names of ${this.targets.length} targeted files in ${targetListFile}`); - this.logger.trace(`Stored the names of ${this.projectDirs.length} source directories in ${sourceListFile}`); - this.logger.trace(`Rules to be executed: ${rulesToRun}`); + this.logger.trace(`Stored the names of ${this.targets.length} targeted files and ${this.projectDirs.length} source directories in ${inputFile}`); + this.logger.trace(`Rules to be executed: ${JSON.stringify(inputObject.rulesToRun)}`); const args = [`-Dsfge_log_name=${this.logFilePath}`, '-cp', classpath.join(path.delimiter)]; if (this.ruleThreadCount != null) { @@ -160,7 +164,7 @@ export class SfgeWrapper extends CommandLineSupport { if (this.ignoreParseErrors != null) { args.push(`-DSFGE_IGNORE_PARSE_ERRORS=${this.ignoreParseErrors.toString()}`); } - args.push(MAIN_CLASS, this.command, targetListFile, sourceListFile, rulesToRun); + args.push(MAIN_CLASS, this.command, inputFile); this.logger.trace(`Preparing to execute sfge with command: "${command}", args: "${JSON.stringify(args)}"`); return [command, args]; @@ -182,15 +186,19 @@ export class SfgeWrapper extends CommandLineSupport { return wrapper.execute(); } - private createTargetJsons(): string { - const targetJsons: SfgeTarget[] = []; + private createInputJson(): SfgeInput { + const inputJson: SfgeInput = { + targets: [], + projectDirs: this.projectDirs, + rulesToRun: this.rules.map(rule => rule.name) + }; this.targets.forEach(t => { // If the target specifies individual methods in a file, then create one object encompassing the file and // those methods. // NOTE: This code assumes that method-level targets cannot have multiple paths in the `paths` property. If // this assumption is ever invalidated, then this code must change. if (t.methods.length > 0) { - targetJsons.push({ + inputJson.targets.push({ targetFile: t.paths[0], targetMethods: t.methods }); @@ -198,14 +206,14 @@ export class SfgeWrapper extends CommandLineSupport { // Otherwise, the target is a collection of paths encompassing whole files, and each path should be its // own subject. t.paths.forEach(p => { - targetJsons.push({ + inputJson.targets.push({ targetFile: p, targetMethods: [] }); }); } }); - return JSON.stringify(targetJsons); + return inputJson; } public static async runSfge(targets: RuleTarget[], rules: Rule[], sfgeConfig: SfgeConfig): Promise { From ea1d9705ceda1f3d9c4f3afc4778bef6a104628e Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Mon, 6 Jun 2022 15:54:41 -0500 Subject: [PATCH 11/22] @W-11120894@: Added proper cloning for EngineDirective nodes. --- .../com/salesforce/graph/ops/CloneUtil.java | 3 + .../ops/directive/EngineDirectiveTest.java | 59 +++++++++++++++++++ 2 files changed, 62 insertions(+) diff --git a/sfge/src/main/java/com/salesforce/graph/ops/CloneUtil.java b/sfge/src/main/java/com/salesforce/graph/ops/CloneUtil.java index 4329acfbc..1ddd7b0b3 100644 --- a/sfge/src/main/java/com/salesforce/graph/ops/CloneUtil.java +++ b/sfge/src/main/java/com/salesforce/graph/ops/CloneUtil.java @@ -9,6 +9,7 @@ import com.salesforce.exception.UnexpectedException; import com.salesforce.graph.DeepCloneable; import com.salesforce.graph.Immutable; +import com.salesforce.graph.ops.directive.EngineDirective; import com.salesforce.graph.symbols.AbstractClassInstanceScope; import com.salesforce.graph.symbols.ClassInstanceScope; import com.salesforce.graph.symbols.DeserializedClassInstanceScope; @@ -230,6 +231,8 @@ private static T cloneIfPossible(@Nullable T item) { return (T) cloneTreeMap((TreeMap) item); } else if (item instanceof BaseSFVertex) { return item; + } else if (item instanceof EngineDirective) { + return item; } else if (item instanceof LinkedList) { return (T) cloneLinkedList((LinkedList) item); } else if (item instanceof Enum) { diff --git a/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java b/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java index ffb6953ee..3ded4812f 100644 --- a/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java +++ b/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java @@ -3,6 +3,7 @@ import static org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.__.has; import static org.hamcrest.Matchers.contains; import static org.hamcrest.Matchers.empty; +import static org.hamcrest.Matchers.hasItem; import com.salesforce.ArgumentsUtil; import com.salesforce.TestUtil; @@ -512,6 +513,64 @@ public boolean test(BaseSFVertex vertex) { MatcherAssert.assertThat(engineDirectives, contains(DISABLE_STACK_1)); } + /** + * This is a test for W-11120894, wherein the sfge-disable-stack annotation wasn't working for methods with exceptions + * inside nested forked method calls. The attempt to clone the annotation was causing an exception, which overrode the + * functionality of the annotation itself. + */ + @MethodSource(value = "testDisableStackDirective") + @ParameterizedTest(name = "{displayName}: directive=({0})") + public void testDisableStackAnnotationWithForkedExceptionPaths(String directive) { + String[] sourceCode = { + "public class MyClass {\n" + + directive + + "\n" + + " public static void doSomething(boolean enterBranch, boolean throwException) {\n" + + " ExceptionThrower helper = new ExceptionThrower();\n" + + " if (enterBranch) {\n" + + " ExceptionThrower.throwExceptionIfAsked(throwException);\n" + + " }\n" + + " System.debug('hello');\n" + + " }\n" + + "}", + "public class ExceptionThrower {\n" + + " public void throwExceptionIfAsked(boolean isAsked) {\n" + + " if (isAsked) {\n" + + " throw new MyException();\n" + + " }\n" + + " }\n" + + "}" + }; + List engineDirectives = new ArrayList<>(); + VertexPredicate predicate = + new AbstractVisitingVertexPredicate() { + @Override + public boolean test(BaseSFVertex vertex) { + if (vertex instanceof MethodCallExpressionVertex) { + MethodCallExpressionVertex methodCallExpression = + (MethodCallExpressionVertex) vertex; + if (methodCallExpression.getFullMethodName().equals("System.debug")) { + engineDirectives.addAll( + ContextProviders.ENGINE_DIRECTIVE_CONTEXT + .get() + .getEngineDirectiveContext() + .getEngineDirectives()); + } + } + return true; + } + }; + + TestUtil.Config config = TestUtil.Config.Builder.get(g, sourceCode).build(); + ApexPathExpanderConfig expanderConfig = + ApexPathExpanderConfig.Builder.get() + .expandMethodCalls(true) + .withVertexPredicate(predicate) + .build(); + TestUtil.getApexPaths(config, expanderConfig, "doSomething"); + MatcherAssert.assertThat(engineDirectives, hasItem(DISABLE_STACK_1)); + } + @MethodSource(value = "testDisableStackDirective") @ParameterizedTest(name = "{displayName}: directive=({0})") public void testDisableStackAnnotationIntermediateMethod(String directive) { From be568324a2dfa120c633d7a6856714b9d9f137aa Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Thu, 9 Jun 2022 12:42:57 -0500 Subject: [PATCH 12/22] @W-11120894@: Integrated feedback from code review. --- .../graph/ops/directive/EngineDirectiveTest.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java b/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java index 3ded4812f..79d04f52d 100644 --- a/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java +++ b/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java @@ -514,9 +514,11 @@ public boolean test(BaseSFVertex vertex) { } /** - * This is a test for W-11120894, wherein the sfge-disable-stack annotation wasn't working for methods with exceptions - * inside nested forked method calls. The attempt to clone the annotation was causing an exception, which overrode the - * functionality of the annotation itself. + * This is a test for W-11120894, wherein the sfge-disable-stack engine directive wasn't working for methods with + * exceptions inside nested forked method calls. The attempt to clone the annotation during path generation + * was causing an exception, which was overriding the functionality of the annotation itself. + * This test recreates such a scenario, then makes sure the associated with it were correctly generated and contain + * the expected annotation. */ @MethodSource(value = "testDisableStackDirective") @ParameterizedTest(name = "{displayName}: directive=({0})") From c049364110e86e76fa38eda0683f11b6861893a9 Mon Sep 17 00:00:00 2001 From: Joshua Feingold Date: Mon, 13 Jun 2022 13:40:48 -0500 Subject: [PATCH 13/22] @W-10759090@: Resolved issues identified in QA. --- .../com/salesforce/messaging/EventKey.java | 2 +- messages/run.js | 3 +- .../com/salesforce/graph/ops/CloneUtil.java | 4 +- .../com/salesforce/graph/ops/MethodUtil.java | 3 +- .../salesforce/graph/ops/MethodUtilTest.java | 22 ++++++++++ .../ops/directive/EngineDirectiveTest.java | 42 +++++++++---------- src/commands/scanner/run.ts | 10 ++++- 7 files changed, 57 insertions(+), 29 deletions(-) diff --git a/cli-messaging/src/main/java/com/salesforce/messaging/EventKey.java b/cli-messaging/src/main/java/com/salesforce/messaging/EventKey.java index d7e812002..a09f07269 100644 --- a/cli-messaging/src/main/java/com/salesforce/messaging/EventKey.java +++ b/cli-messaging/src/main/java/com/salesforce/messaging/EventKey.java @@ -20,7 +20,7 @@ public enum EventKey { ERROR_EXTERNAL_RECURSION_LIMIT("error.external.recursionLimitReached", 2, MessageType.ERROR, MessageHandler.UX, false), ERROR_EXTERNAL_XML_NOT_READABLE("error.external.xmlNotReadable", 2, MessageType.ERROR, MessageHandler.UX, false), ERROR_EXTERNAL_XML_NOT_PARSABLE("error.external.xmlNotParsable", 2, MessageType.ERROR, MessageHandler.UX, false), - WARNING_MULTIPLE_METHOD_TARGET_MATCHES("warning.multipleMethodTargetMatches", 3, MessageType.WARNING, MessageHandler.UX, true), + WARNING_MULTIPLE_METHOD_TARGET_MATCHES("warning.multipleMethodTargetMatches", 3, MessageType.WARNING, MessageHandler.UX, false), WARNING_NO_METHOD_TARGET_MATCHES("warning.noMethodTargetMatches", 2, MessageType.WARNING, MessageHandler.UX, false); final String messageKey; diff --git a/messages/run.js b/messages/run.js index b80fdd72e..5e24efce5 100644 --- a/messages/run.js +++ b/messages/run.js @@ -32,9 +32,10 @@ module.exports = { 'pmdConfigDescriptionLong': 'Location of PMD rule reference XML file to customize rule selection', "verboseViolationsDescription": "retire-js violation messages include more details", "verboseViolationsDescriptionLong": "retire-js violation messages contain details about each vulnerability (e.g. summary, CVE, urls, etc.)" - + }, "validations": { + "methodLevelTargetingDisallowed": "Target '%s' is invalid, as this command does not support method-level targeting", "outfileFormatMismatch": "Your chosen format %s does not appear to match your output file type of %s.", "outfileMustBeValid": "--outfile must be a well-formed filepath.", "outfileMustBeSupportedType": "--outfile must be of a supported type. Current options are: .csv; .xml; .json; .html; .sarif.", diff --git a/sfge/src/main/java/com/salesforce/graph/ops/CloneUtil.java b/sfge/src/main/java/com/salesforce/graph/ops/CloneUtil.java index 1ddd7b0b3..5877a9807 100644 --- a/sfge/src/main/java/com/salesforce/graph/ops/CloneUtil.java +++ b/sfge/src/main/java/com/salesforce/graph/ops/CloneUtil.java @@ -231,8 +231,8 @@ private static T cloneIfPossible(@Nullable T item) { return (T) cloneTreeMap((TreeMap) item); } else if (item instanceof BaseSFVertex) { return item; - } else if (item instanceof EngineDirective) { - return item; + } else if (item instanceof EngineDirective) { + return item; } else if (item instanceof LinkedList) { return (T) cloneLinkedList((LinkedList) item); } else if (item instanceof Enum) { diff --git a/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java b/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java index ef13eb3cd..5e6720e96 100644 --- a/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java +++ b/sfge/src/main/java/com/salesforce/graph/ops/MethodUtil.java @@ -8,7 +8,6 @@ import com.salesforce.apex.jorje.ASTConstants; import com.salesforce.apex.jorje.ASTConstants.NodeType; import com.salesforce.collections.CollectionUtil; -import com.salesforce.collections.NonNullHashMap; import com.salesforce.exception.UnexpectedException; import com.salesforce.graph.ApexPath; import com.salesforce.graph.Schema; @@ -130,7 +129,7 @@ public static List getTargetedMethods( * @param vertices - The method vertices returned by the query created using the target */ private static void addMessagesForTarget(RuleRunnerTarget target, List vertices) { - NonNullHashMap methodCountByName = CollectionUtil.newNonNullHashMap(); + TreeMap methodCountByName = CollectionUtil.newTreeMap(); // Map each vertex's method name to the number of vertices sharing that name. for (MethodVertex methodVertex : vertices) { String methodName = methodVertex.getName(); diff --git a/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java b/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java index 871a51f4b..a139421a8 100644 --- a/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java +++ b/sfge/src/test/java/com/salesforce/graph/ops/MethodUtilTest.java @@ -138,6 +138,28 @@ public void getTargetMethods_targetSingleMethod() { assertEquals("[]", messages); } + @Test + public void getTargetMethods_targetSingleMethodCaseInsensitive() { + TestUtil.Config config = + TestUtil.Config.Builder.get(g, new String[] {SOURCE_FILE_1, SOURCE_FILE_2}).build(); + TestUtil.buildGraph(config); + // Create a rule target encompassing only the first non-overloaded method in the first file. + List targets = new ArrayList<>(); + targets.add( + new RuleRunnerTarget( + "TestCode0", + Collections.singletonList(METHOD_WITHOUT_OVERLOADS_1.toLowerCase()))); + + List methodVertices = MethodUtil.getTargetedMethods(g, targets); + + MatcherAssert.assertThat(methodVertices, hasSize(equalTo(1))); + MethodVertex firstVertex = methodVertices.get(0); + assertEquals(METHOD_WITHOUT_OVERLOADS_1, firstVertex.getName()); + + String messages = CliMessager.getInstance().getAllMessages(); + assertEquals("[]", messages); + } + @Test public void getTargetMethods_targetMultipleMethods() { TestUtil.Config config = diff --git a/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java b/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java index 79d04f52d..7b88c8a56 100644 --- a/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java +++ b/sfge/src/test/java/com/salesforce/graph/ops/directive/EngineDirectiveTest.java @@ -513,13 +513,13 @@ public boolean test(BaseSFVertex vertex) { MatcherAssert.assertThat(engineDirectives, contains(DISABLE_STACK_1)); } - /** - * This is a test for W-11120894, wherein the sfge-disable-stack engine directive wasn't working for methods with - * exceptions inside nested forked method calls. The attempt to clone the annotation during path generation - * was causing an exception, which was overriding the functionality of the annotation itself. - * This test recreates such a scenario, then makes sure the associated with it were correctly generated and contain - * the expected annotation. - */ + /** + * This is a test for W-11120894, wherein the sfge-disable-stack engine directive wasn't working + * for methods with exceptions inside nested forked method calls. The attempt to clone the + * annotation during path generation was causing an exception, which was overriding the + * functionality of the annotation itself. This test recreates such a scenario, then makes sure + * the associated with it were correctly generated and contain the expected annotation. + */ @MethodSource(value = "testDisableStackDirective") @ParameterizedTest(name = "{displayName}: directive=({0})") public void testDisableStackAnnotationWithForkedExceptionPaths(String directive) { @@ -528,20 +528,20 @@ public void testDisableStackAnnotationWithForkedExceptionPaths(String directive) + directive + "\n" + " public static void doSomething(boolean enterBranch, boolean throwException) {\n" - + " ExceptionThrower helper = new ExceptionThrower();\n" - + " if (enterBranch) {\n" - + " ExceptionThrower.throwExceptionIfAsked(throwException);\n" - + " }\n" - + " System.debug('hello');\n" - + " }\n" - + "}", - "public class ExceptionThrower {\n" - + " public void throwExceptionIfAsked(boolean isAsked) {\n" - + " if (isAsked) {\n" - + " throw new MyException();\n" - + " }\n" - + " }\n" - + "}" + + " ExceptionThrower helper = new ExceptionThrower();\n" + + " if (enterBranch) {\n" + + " ExceptionThrower.throwExceptionIfAsked(throwException);\n" + + " }\n" + + " System.debug('hello');\n" + + " }\n" + + "}", + "public class ExceptionThrower {\n" + + " public void throwExceptionIfAsked(boolean isAsked) {\n" + + " if (isAsked) {\n" + + " throw new MyException();\n" + + " }\n" + + " }\n" + + "}" }; List engineDirectives = new ArrayList<>(); VertexPredicate predicate = diff --git a/src/commands/scanner/run.ts b/src/commands/scanner/run.ts index 28c56dc88..153684981 100644 --- a/src/commands/scanner/run.ts +++ b/src/commands/scanner/run.ts @@ -118,6 +118,12 @@ export default class Run extends ScannerRunCommand { if ((this.flags.pmdconfig || this.flags.eslintconfig) && (this.flags.category || this.flags.ruleset)) { this.ux.log(messages.getMessage('output.filtersIgnoredCustom', [])); } + // None of the pathless engines support method-level targeting, so attempting to use it should result in an error. + for (const target of (this.flags.target as string[])) { + if (target.indexOf('#') > -1) { + throw SfdxError.create('@salesforce/sfdx-scanner', 'run', 'validations.methodLevelTargetingDisallowed', [target]); + } + } return Promise.resolve(); } @@ -153,12 +159,12 @@ export default class Run extends ScannerRunCommand { const pmdConfig = normalize(untildify(this.flags.pmdconfig as string)); options.set(CUSTOM_CONFIG.PmdConfig, pmdConfig); } - + // Capturing verbose-violations flag value (used for RetireJS output) if (this.flags["verbose-violations"]) { options.set(CUSTOM_CONFIG.VerboseViolations, "true"); } - + return options; } From ca93a43a6f064ccbc5153a78f65828a3207176e9 Mon Sep 17 00:00:00 2001 From: Roopa Mohan Date: Fri, 10 Jun 2022 16:36:14 -0700 Subject: [PATCH 14/22] Adding cli-messaging to sfge and pmd-cataloger so that they can be built and developed independently --- pmd-cataloger/settings.gradle.kts | 3 +++ settings.gradle.kts | 4 +--- sfge/settings.gradle.kts | 3 +++ 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/pmd-cataloger/settings.gradle.kts b/pmd-cataloger/settings.gradle.kts index 99ffef2c9..9ea44c98e 100644 --- a/pmd-cataloger/settings.gradle.kts +++ b/pmd-cataloger/settings.gradle.kts @@ -1,2 +1,5 @@ rootProject.name = "pmd-cataloger" +include(":cli-messaging") +project(":cli-messaging").projectDir = file("../cli-messaging") + diff --git a/settings.gradle.kts b/settings.gradle.kts index e9eead571..89468d0d5 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -7,6 +7,4 @@ rootProject.name = "sfdx-scanner" -include("cli-messaging") -include("pmd-cataloger") -include("sfge") +include(":cli-messaging", ":pmd-cataloger", ":sfge") diff --git a/sfge/settings.gradle.kts b/sfge/settings.gradle.kts index 2a5845a37..4239bd015 100644 --- a/sfge/settings.gradle.kts +++ b/sfge/settings.gradle.kts @@ -1 +1,4 @@ rootProject.name = "sfge" + +include(":cli-messaging") +project(":cli-messaging").projectDir = file("../cli-messaging") From 7f5a7c5fe12cd88b6ed682901cfcbb0bcaf2c6f7 Mon Sep 17 00:00:00 2001 From: Roopa Mohan Date: Mon, 13 Jun 2022 11:56:38 -0700 Subject: [PATCH 15/22] Removing settings.gradle on subprojects to keep up with gradle standards of having a single root in a nested system --- pmd-cataloger/settings.gradle.kts | 5 ----- sfge/settings.gradle.kts | 4 ---- 2 files changed, 9 deletions(-) delete mode 100644 pmd-cataloger/settings.gradle.kts delete mode 100644 sfge/settings.gradle.kts diff --git a/pmd-cataloger/settings.gradle.kts b/pmd-cataloger/settings.gradle.kts deleted file mode 100644 index 9ea44c98e..000000000 --- a/pmd-cataloger/settings.gradle.kts +++ /dev/null @@ -1,5 +0,0 @@ -rootProject.name = "pmd-cataloger" - -include(":cli-messaging") -project(":cli-messaging").projectDir = file("../cli-messaging") - diff --git a/sfge/settings.gradle.kts b/sfge/settings.gradle.kts deleted file mode 100644 index 4239bd015..000000000 --- a/sfge/settings.gradle.kts +++ /dev/null @@ -1,4 +0,0 @@ -rootProject.name = "sfge" - -include(":cli-messaging") -project(":cli-messaging").projectDir = file("../cli-messaging") From b135d4dc6d4783396466cbc2814b3a6f337eec2f Mon Sep 17 00:00:00 2001 From: Grace Date: Wed, 15 Jun 2022 10:31:52 -0700 Subject: [PATCH 16/22] @d/W-11267130@: violation messages use
instead of \n in html --- src/lib/formatter/RuleResultRecombinator.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/lib/formatter/RuleResultRecombinator.ts b/src/lib/formatter/RuleResultRecombinator.ts index 1c87daa8c..7565d7e91 100644 --- a/src/lib/formatter/RuleResultRecombinator.ts +++ b/src/lib/formatter/RuleResultRecombinator.ts @@ -373,7 +373,7 @@ URL: ${url}`; ruleName: v.ruleName, category: v.category, url: v.url, - message: v.message, + message: v.message.replace(/\n/g, '
'), //
used for line breaks in html line: v.line, column: v.column, endLine: v.endLine || null, @@ -387,7 +387,7 @@ URL: ${url}`; ruleName: v.ruleName, category: v.category, url: v.url, - message: v.message, + message: v.message.replace(/\n/g, '
'), //
used for line breaks in html line: v.sourceLine, column: v.sourceColumn, sinkFileName: v.sinkFileName, From a4c5e19e8c04921a0919d783b046c55652022751 Mon Sep 17 00:00:00 2001 From: Grace Date: Wed, 15 Jun 2022 12:48:33 -0700 Subject: [PATCH 17/22] newline change only applies when flag used --- src/lib/DefaultRuleManager.ts | 3 ++- src/lib/formatter/RuleResultRecombinator.ts | 10 +++++----- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/src/lib/DefaultRuleManager.ts b/src/lib/DefaultRuleManager.ts index ce4ad7d51..b9ee1c31e 100644 --- a/src/lib/DefaultRuleManager.ts +++ b/src/lib/DefaultRuleManager.ts @@ -14,6 +14,7 @@ import {Controller} from '../Controller'; import globby = require('globby'); import path = require('path'); import {uxEvents, EVENTS} from './ScannerEvents'; +import {CUSTOM_CONFIG} from '../Constants'; Messages.importMessagesDirectory(__dirname); const messages = Messages.loadMessages('@salesforce/sfdx-scanner', 'DefaultRuleManager'); @@ -127,7 +128,7 @@ export class DefaultRuleManager implements RuleManager { psResults.forEach(r => results = results.concat(r)); this.logger.trace(`Received rule violations: ${JSON.stringify(results)}`); this.logger.trace(`Recombining results into requested format ${runOptions.format}`); - return await RuleResultRecombinator.recombineAndReformatResults(results, runOptions.format, executedEngines); + return await RuleResultRecombinator.recombineAndReformatResults(results, runOptions.format, executedEngines, engineOptions.has(CUSTOM_CONFIG.VerboseViolations)); } catch (e) { const message: string = e instanceof Error ? e.message : e as string; throw new SfdxError(message); diff --git a/src/lib/formatter/RuleResultRecombinator.ts b/src/lib/formatter/RuleResultRecombinator.ts index 7565d7e91..4111619cb 100644 --- a/src/lib/formatter/RuleResultRecombinator.ts +++ b/src/lib/formatter/RuleResultRecombinator.ts @@ -37,7 +37,7 @@ type DfaTableRow = BaseTableRow & { export class RuleResultRecombinator { - public static async recombineAndReformatResults(results: RuleResult[], format: OUTPUT_FORMAT, executedEngines: Set): Promise { + public static async recombineAndReformatResults(results: RuleResult[], format: OUTPUT_FORMAT, executedEngines: Set, verboseViolations = false): Promise { // We need to change the results we were given into the desired final format. let formattedResults: string | {columns; rows} = null; switch (format) { @@ -45,7 +45,7 @@ export class RuleResultRecombinator { formattedResults = await this.constructCsv(results, executedEngines); break; case OUTPUT_FORMAT.HTML: - formattedResults = await this.constructHtml(results, executedEngines); + formattedResults = await this.constructHtml(results, executedEngines, verboseViolations); break; case OUTPUT_FORMAT.JSON: formattedResults = this.constructJson(results); @@ -351,7 +351,7 @@ URL: ${url}`; return JSON.stringify(results.filter(r => r.violations.length > 0)); } - private static async constructHtml(results: RuleResult[], executedEngines: Set): Promise { + private static async constructHtml(results: RuleResult[], executedEngines: Set, verboseViolations = false): Promise { // If the results were just an empty string, we can return it. if (results.length === 0) { return ''; @@ -373,7 +373,7 @@ URL: ${url}`; ruleName: v.ruleName, category: v.category, url: v.url, - message: v.message.replace(/\n/g, '
'), //
used for line breaks in html + message: verboseViolations ? v.message.replace(/\n/g, '
') : v.message, //
used for line breaks in html line: v.line, column: v.column, endLine: v.endLine || null, @@ -387,7 +387,7 @@ URL: ${url}`; ruleName: v.ruleName, category: v.category, url: v.url, - message: v.message.replace(/\n/g, '
'), //
used for line breaks in html + message: verboseViolations ? v.message.replace(/\n/g, '
') : v.message, //
used for line breaks in html line: v.sourceLine, column: v.sourceColumn, sinkFileName: v.sinkFileName, From 9b3a269af1b3dc4d62d2f3e12a69fed80d4079d6 Mon Sep 17 00:00:00 2001 From: Grace Date: Thu, 16 Jun 2022 08:54:38 -0700 Subject: [PATCH 18/22] added test for html verbose-violations message format --- src/lib/formatter/RuleResultRecombinator.ts | 4 +-- .../formatter/RuleResultRecombinator.test.ts | 25 +++++++++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/src/lib/formatter/RuleResultRecombinator.ts b/src/lib/formatter/RuleResultRecombinator.ts index 4111619cb..191fe1cf1 100644 --- a/src/lib/formatter/RuleResultRecombinator.ts +++ b/src/lib/formatter/RuleResultRecombinator.ts @@ -373,7 +373,7 @@ URL: ${url}`; ruleName: v.ruleName, category: v.category, url: v.url, - message: verboseViolations ? v.message.replace(/\n/g, '
') : v.message, //
used for line breaks in html + message: verboseViolations && result.engine === 'retire-js' ? v.message.replace(/\n/g, '
') : v.message, //
used for line breaks in html line: v.line, column: v.column, endLine: v.endLine || null, @@ -387,7 +387,7 @@ URL: ${url}`; ruleName: v.ruleName, category: v.category, url: v.url, - message: verboseViolations ? v.message.replace(/\n/g, '
') : v.message, //
used for line breaks in html + message: verboseViolations && result.engine === 'retire-js' ? v.message.replace(/\n/g, '
') : v.message, //
used for line breaks in html line: v.sourceLine, column: v.sourceColumn, sinkFileName: v.sinkFileName, diff --git a/test/lib/formatter/RuleResultRecombinator.test.ts b/test/lib/formatter/RuleResultRecombinator.test.ts index 414808b5c..88122f072 100644 --- a/test/lib/formatter/RuleResultRecombinator.test.ts +++ b/test/lib/formatter/RuleResultRecombinator.test.ts @@ -288,6 +288,22 @@ const allFakeDfaRuleResultsNormalized: RuleResult[] = [ } ]; +const retireJsVerboseViolations: RuleResult[] = [ + { + engine: 'retire-js', + fileName: sampleFile1, + violations: [{ + "line": 1, + "column": 1, + "severity": 2, + "message": "jquery 3.1.0 has known vulnerabilities:\nseverity: medium; summary: jQuery before 3.4.0, as used in Drupal, Backdrop CMS, and other products, mishandles jQuery.extend(true, {}, ...) because of Object.prototype pollution; CVE: CVE-2019-11358; https://blog.jquery.com/2019/04/10/jquery-3-4-0-released/ https://nvd.nist.gov/vuln/detail/CVE-2019-11358 https://github.com/jquery/jquery/commit/753d591aea698e57d6db58c9f722cd0808619b1b\nseverity: medium; summary: Regex in its jQuery.htmlPrefilter sometimes may introduce XSS; CVE: CVE-2020-11022; https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/\nseverity: medium; summary: Regex in its jQuery.htmlPrefilter sometimes may introduce XSS; CVE: CVE-2020-11023; https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/", + "ruleName": "insecure-bundled-dependencies", + "category": "Insecure Dependencies", + }] + } +]; + + function isString(x: string | {columns; rows}): x is string { return typeof x === 'string'; } @@ -1268,5 +1284,14 @@ describe('RuleResultRecombinator', () => { expect(problemNumber).to.equal(6, 'Problem Number Index'); }); }); + + describe('Output Format: HTML', () => { + it ('Using --verbose-violations', async () => { + const results = (await RuleResultRecombinator.recombineAndReformatResults(retireJsVerboseViolations, OUTPUT_FORMAT.HTML, new Set(['retire-js']), true)).results as string; + const violationString = results.split("const violations = [")[1].split("];\n")[0]; + const violation: RuleViolation = JSON.parse(violationString as string); + expect(violation.message).to.equal("jquery 3.1.0 has known vulnerabilities:
severity: medium; summary: jQuery before 3.4.0, as used in Drupal, Backdrop CMS, and other products, mishandles jQuery.extend(true, {}, ...) because of Object.prototype pollution; CVE: CVE-2019-11358; https://blog.jquery.com/2019/04/10/jquery-3-4-0-released/ https://nvd.nist.gov/vuln/detail/CVE-2019-11358 https://github.com/jquery/jquery/commit/753d591aea698e57d6db58c9f722cd0808619b1b
severity: medium; summary: Regex in its jQuery.htmlPrefilter sometimes may introduce XSS; CVE: CVE-2020-11022; https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/
severity: medium; summary: Regex in its jQuery.htmlPrefilter sometimes may introduce XSS; CVE: CVE-2020-11023; https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/"); + }); + }); }); }); From 182afac1a555458bb2aee439595294442b5f8950 Mon Sep 17 00:00:00 2001 From: Grace Date: Thu, 16 Jun 2022 10:16:36 -0700 Subject: [PATCH 19/22] feedback from PR --- src/lib/formatter/RuleResultRecombinator.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/lib/formatter/RuleResultRecombinator.ts b/src/lib/formatter/RuleResultRecombinator.ts index 191fe1cf1..fc1450884 100644 --- a/src/lib/formatter/RuleResultRecombinator.ts +++ b/src/lib/formatter/RuleResultRecombinator.ts @@ -1,7 +1,7 @@ import {SfdxError} from '@salesforce/core'; import * as path from 'path'; import {EngineExecutionSummary, RecombinedData, RecombinedRuleResults, RuleResult, RuleViolation} from '../../types'; -import {DfaEngineFilters} from '../../Constants'; +import {DfaEngineFilters, ENGINE} from '../../Constants'; import {OUTPUT_FORMAT} from '../RuleManager'; import * as wrap from 'word-wrap'; import {FileHandler} from '../util/FileHandler'; @@ -373,7 +373,7 @@ URL: ${url}`; ruleName: v.ruleName, category: v.category, url: v.url, - message: verboseViolations && result.engine === 'retire-js' ? v.message.replace(/\n/g, '
') : v.message, //
used for line breaks in html + message: verboseViolations && result.engine === ENGINE.RETIRE_JS ? v.message.replace(/\n/g, '
') : v.message, //
used for line breaks in html line: v.line, column: v.column, endLine: v.endLine || null, @@ -387,7 +387,7 @@ URL: ${url}`; ruleName: v.ruleName, category: v.category, url: v.url, - message: verboseViolations && result.engine === 'retire-js' ? v.message.replace(/\n/g, '
') : v.message, //
used for line breaks in html + message: v.message, line: v.sourceLine, column: v.sourceColumn, sinkFileName: v.sinkFileName, From 5d716cf5890f299377fa8797b9f2f1dcd12c2ff5 Mon Sep 17 00:00:00 2001 From: Grace Date: Wed, 15 Jun 2022 10:59:54 -0700 Subject: [PATCH 20/22] @W-11267235@: violation messages use a semicolon instead of a line break in json format --- src/lib/formatter/RuleResultRecombinator.ts | 20 +++++++++++++++++-- .../formatter/RuleResultRecombinator.test.ts | 7 ++++++- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/src/lib/formatter/RuleResultRecombinator.ts b/src/lib/formatter/RuleResultRecombinator.ts index fc1450884..1abf62073 100644 --- a/src/lib/formatter/RuleResultRecombinator.ts +++ b/src/lib/formatter/RuleResultRecombinator.ts @@ -48,7 +48,7 @@ export class RuleResultRecombinator { formattedResults = await this.constructHtml(results, executedEngines, verboseViolations); break; case OUTPUT_FORMAT.JSON: - formattedResults = this.constructJson(results); + formattedResults = this.constructJson(results, verboseViolations); break; case OUTPUT_FORMAT.JUNIT: formattedResults = this.constructJunit(results); @@ -344,10 +344,26 @@ URL: ${url}`; return {columns, rows}; } - private static constructJson(results: RuleResult[]): string { + private static constructJson(results: RuleResult[], verboseViolations = false): string { if (results.length === 0) { return ''; } + + if (verboseViolations) { + const resultsVerbose = JSON.parse(JSON.stringify(results)) as RuleResult[]; + for (const result of resultsVerbose) { + if (result.engine === ENGINE.RETIRE_JS) { + for (const violation of result.violations) { + // in the json format we need to replace new lines in the message + // for the first line (ending with a colon) we will replace it with a space + // for following lines, we will replace it with a semicolon and a space + violation.message = violation.message.replace(/:\n/g, ': ').replace(/\n/g, '; '); + } + } + } + return JSON.stringify(resultsVerbose.filter(r => r.violations.length > 0)); + } + return JSON.stringify(results.filter(r => r.violations.length > 0)); } diff --git a/test/lib/formatter/RuleResultRecombinator.test.ts b/test/lib/formatter/RuleResultRecombinator.test.ts index 88122f072..66f118484 100644 --- a/test/lib/formatter/RuleResultRecombinator.test.ts +++ b/test/lib/formatter/RuleResultRecombinator.test.ts @@ -303,7 +303,6 @@ const retireJsVerboseViolations: RuleResult[] = [ } ]; - function isString(x: string | {columns; rows}): x is string { return typeof x === 'string'; } @@ -857,6 +856,12 @@ describe('RuleResultRecombinator', () => { expect(summaryMap.get('sfge')).to.deep.equal({fileCount: 1, violationCount: 1}, 'SFGE summary should be correct'); }); + it ('Using --verbose-violations', async () => { + const results = (await RuleResultRecombinator.recombineAndReformatResults(retireJsVerboseViolations, OUTPUT_FORMAT.JSON, new Set(['retire-js']), true)).results; + const ruleResults: RuleResult[] = JSON.parse(results as string); + expect(ruleResults[0].violations[0].message).to.equal("jquery 3.1.0 has known vulnerabilities: severity: medium; summary: jQuery before 3.4.0, as used in Drupal, Backdrop CMS, and other products, mishandles jQuery.extend(true, {}, ...) because of Object.prototype pollution; CVE: CVE-2019-11358; https://blog.jquery.com/2019/04/10/jquery-3-4-0-released/ https://nvd.nist.gov/vuln/detail/CVE-2019-11358 https://github.com/jquery/jquery/commit/753d591aea698e57d6db58c9f722cd0808619b1b; severity: medium; summary: Regex in its jQuery.htmlPrefilter sometimes may introduce XSS; CVE: CVE-2020-11022; https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/; severity: medium; summary: Regex in its jQuery.htmlPrefilter sometimes may introduce XSS; CVE: CVE-2020-11023; https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/"); + }); + it ('Edge Cases', async () => { const results = await (await RuleResultRecombinator.recombineAndReformatResults(edgeCaseResults, OUTPUT_FORMAT.JSON, new Set(['eslint']))).results; const ruleResults: RuleResult[] = JSON.parse(results as string); From e6032773a81ab68ddb192e5e97aaa5584e3b8fd9 Mon Sep 17 00:00:00 2001 From: Roopa Mohan Date: Tue, 21 Jun 2022 09:48:50 -0700 Subject: [PATCH 21/22] RetireJs updates + package number update to 3.2.0 --- package.json | 2 +- retire-js/RetireJsVulns.json | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 42eeb200e..756d0a15f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@salesforce/sfdx-scanner", "description": "Static code scanner that applies quality and security rules to Apex code, and provides feedback.", - "version": "3.1.2", + "version": "3.2.0", "author": "ISV SWAT", "bugs": "https://github.com/forcedotcom/sfdx-scanner/issues", "dependencies": { diff --git a/retire-js/RetireJsVulns.json b/retire-js/RetireJsVulns.json index 390af2407..f81658e43 100644 --- a/retire-js/RetireJsVulns.json +++ b/retire-js/RetireJsVulns.json @@ -3146,6 +3146,35 @@ ] } }, + "AlaSQL": { + "vulnerabilities": [ + { + "below": "0.7.0", + "severity": "high", + "identifiers": { + "CVE": [ + "CVE-XXXX-XXXX" + ], + "bug": "SNYK-JS-ALASQL-1082932", + "summary": "An arbitrary code execution exists as AlaSQL doesn't sanitize input when characters are placed between square brackets [] or preceded with a backtik (accent grave) ` character. Versions older that 0.7.0 were deprecated in March of 2021 and should no longer be used." + }, + "info": [ + "https://security.snyk.io/vuln/SNYK-JS-ALASQL-1082932" + ] + } + ], + "extractors": { + "uri": [ + "/alasql[/@](§§version§§)/.*\\.js" + ], + "filename": [ + "alasql-(§§version§§)(\\.min)?\\.js" + ], + "filecontent": [ + "/\\*!?[ \n]*AlaSQL v(§§version§§)" + ] + } + }, "dont check": { "extractors": { "uri": [ From f30a914052826e658e08c16a9a92cf34d7256fad Mon Sep 17 00:00:00 2001 From: Roopa Mohan Date: Wed, 22 Jun 2022 09:29:05 -0700 Subject: [PATCH 22/22] @W-11321290@ Updating retireJs local repo again for 3.2.0 --- retire-js/RetireJsVulns.json | 158 +++++++++++++++++++++++++++++++++-- 1 file changed, 149 insertions(+), 9 deletions(-) diff --git a/retire-js/RetireJsVulns.json b/retire-js/RetireJsVulns.json index 390af2407..1c8d04ba9 100644 --- a/retire-js/RetireJsVulns.json +++ b/retire-js/RetireJsVulns.json @@ -253,17 +253,41 @@ "hashes": {} } }, - "jquery.validator": { + "jquery-validation": { "bowername": [ - "jquery-validator" + "jquery-validation" + ], + "vulnerabilities": [ + { + "below": "1.19.4", + "severity": "medium", + "identifiers": { + "summary": "ReDoS vulnerability in URL2 validation" + }, + "info": [ + "https://github.com/jquery-validation/jquery-validation/blob/master/changelog.md#1194--2022-05-19" + ] + }, + { + "below": "1.19.3", + "severity": "medium", + "identifiers": { + "CVE": [ + "CVE-2021-21252" + ], + "summary": "Regular Expression Denial of Service vulnerability" + }, + "info": [ + "https://github.com/jquery-validation/jquery-validation/blob/master/changelog.md#1193--2021-01-09" + ] + } ], - "vulnerabilities": [], "extractors": { "filename": [ - "jquery.validation-(§§version§§)(.min)?\\.js" + "jquery.validat(?:ion|e)-(§§version§§)(.min)?\\.js" ], "uri": [ - "/(§§version§§)/jquery.validation(\\.min)?\\.js" + "/(§§version§§)/jquery.validat(ion|e)(\\.min)?\\.js" ], "filecontent": [ "/\\*!?(?:\n \\*)? jQuery Validation Plugin v(§§version§§)" @@ -783,6 +807,46 @@ "info": [ "https://www.tiny.cloud/docs/release-notes/release-notes54/" ] + }, + { + "below": "5.6.0", + "severity": "medium", + "identifiers": { + "summary": "security issue where URLs in attributes weren’t correctly sanitized. security issue in the codesample plugin" + }, + "info": [ + "https://www.tiny.cloud/docs/release-notes/release-notes56/#securityfixes" + ] + }, + { + "below": "5.7.1", + "severity": "medium", + "identifiers": { + "summary": "URLs are not correctly filtered in some cases." + }, + "info": [ + "https://www.tiny.cloud/docs/release-notes/release-notes571/#securityfixes" + ] + }, + { + "below": "5.9.0", + "severity": "medium", + "identifiers": { + "summary": "Inserting certain HTML content into the editor could result in invalid HTML once parsed. This caused a medium severity Cross Site Scripting (XSS) vulnerability" + }, + "info": [ + "https://www.tiny.cloud/docs/release-notes/release-notes59/#securityfixes" + ] + }, + { + "below": "5.10.0", + "severity": "medium", + "identifiers": { + "summary": "URLs not cleaned correctly in some cases in the link and image plugins" + }, + "info": [ + "https://www.tiny.cloud/docs/release-notes/release-notes510/#securityfixes" + ] } ], "extractors": { @@ -1898,6 +1962,26 @@ "info": [ "https://github.com/wycats/handlebars.js/blob/master/release-notes.md#v453---november-18th-2019" ] + }, + { + "below": "4.6.0", + "severity": "medium", + "identifiers": { + "summary": "Denial of service" + }, + "info": [ + "https://github.com/handlebars-lang/handlebars.js/pull/1633" + ] + }, + { + "below": "4.7.7", + "severity": "medium", + "identifiers": { + "summary": "Prototype pollution" + }, + "info": [ + "https://github.com/handlebars-lang/handlebars.js/commit/f0589701698268578199be25285b2ebea1c1e427" + ] } ], "extractors": { @@ -2985,11 +3069,38 @@ } }, "svelte": { - "vulnerabilities": [], + "vulnerabilities": [ + { + "below": "3.46.5", + "severity": "medium", + "identifiers": { + "summary": "XSS" + }, + "info": [ + "https://github.com/sveltejs/svelte/pull/7333" + ] + }, + { + "below": "2.9.8", + "severity": "medium", + "identifiers": { + "summary": "XSS" + }, + "info": [ + "https://github.com/sveltejs/svelte/pull/1623" + ] + } + ], "extractors": { - "uri": [], - "filename": [], - "filecontent": [] + "uri": [ + "/svelte@(§§version§§)/index.js" + ], + "filename": [ + "svelte[@\\-](§§version§§)(.min)?\\.js" + ], + "filecontent": [ + "generated by Svelte v\\$\\{'(§§version§§)'\\}" + ] } }, "axios": { @@ -3146,6 +3257,35 @@ ] } }, + "AlaSQL": { + "vulnerabilities": [ + { + "below": "0.7.0", + "severity": "high", + "identifiers": { + "CVE": [ + "CVE-XXXX-XXXX" + ], + "bug": "SNYK-JS-ALASQL-1082932", + "summary": "An arbitrary code execution exists as AlaSQL doesn't sanitize input when characters are placed between square brackets [] or preceded with a backtik (accent grave) ` character. Versions older that 0.7.0 were deprecated in March of 2021 and should no longer be used." + }, + "info": [ + "https://security.snyk.io/vuln/SNYK-JS-ALASQL-1082932" + ] + } + ], + "extractors": { + "uri": [ + "/alasql[/@](§§version§§)/.*\\.js" + ], + "filename": [ + "alasql-(§§version§§)(\\.min)?\\.js" + ], + "filecontent": [ + "/\\*!?[ \n]*AlaSQL v(§§version§§)" + ] + } + }, "dont check": { "extractors": { "uri": [