NEW: @W-16371174@: Make all configuration settings case insensitive

Author: stephen-carter-at-sf

packages/T-E-M-P-L-A-T-E/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/t-e-m-p-l-a-t-e",
     "description": "T-E-M-P-L-A-T-E",
-    "version": "0.15.0",
+    "version": "0.16.0-SNAPSHOT",
     "author": "The Salesforce Code Analyzer Team",
     "license": "BSD-3-Clause",
     "homepage": "https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/overview",
@@ -14,7 +14,7 @@
     "types": "dist/index.d.ts",
     "dependencies": {
       "@types/node": "^20.0.0",
-      "@salesforce/code-analyzer-engine-api": "0.15.0"
+      "@salesforce/code-analyzer-engine-api": "0.16.0-SNAPSHOT"
     },
     "devDependencies": {
       "@eslint/js": "^8.57.1",

packages/code-analyzer-core/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/code-analyzer-core",
   "description": "Core Package for the Salesforce Code Analyzer",
-  "version": "0.18.1-SNAPSHOT",
+  "version": "0.19.0-SNAPSHOT",
   "author": "The Salesforce Code Analyzer Team",
   "license": "BSD-3-Clause",
   "homepage": "https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/overview",
@@ -13,7 +13,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@salesforce/code-analyzer-engine-api": "0.15.0",
+    "@salesforce/code-analyzer-engine-api": "0.16.0-SNAPSHOT",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^20.0.0",
     "@types/sarif": "^2.1.7",

packages/code-analyzer-core/src/code-analyzer.ts

@@ -269,6 +269,7 @@ export class CodeAnalyzer {
 
         const engineConfigValueExtractor: engApi.ConfigValueExtractor = new engApi.ConfigValueExtractor(
             engineOverrides as engApi.ConfigObject, `${FIELDS.ENGINES}.${engineName}`, this.config.getConfigRoot());
+        engineConfigValueExtractor._addHiddenKeys([FIELDS.DISABLE_ENGINE]);
 
         try {
             const engineConfig: engApi.ConfigObject = await enginePluginV1.createEngineConfig(engineName, engineConfigValueExtractor);

packages/code-analyzer-core/src/config.ts

@@ -10,7 +10,7 @@ import {SeverityLevel} from "./rules";
 export const FIELDS = {
     CONFIG_ROOT: 'config_root',
     LOG_FOLDER: 'log_folder',
-    CUSTOM_ENGINE_PLUGIN_MODULES: 'custom_engine_plugin_modules',
+    CUSTOM_ENGINE_PLUGIN_MODULES: 'custom_engine_plugin_modules', // Hidden
     RULES: 'rules',
     ENGINES: 'engines',
     SEVERITY: 'severity',
@@ -98,6 +98,8 @@ export class CodeAnalyzerConfig {
         configRoot = !rawConfig.config_root ? (configRoot ?? process.cwd()) :
             validateAbsoluteFolder(rawConfig.config_root, FIELDS.CONFIG_ROOT);
         const configExtractor: engApi.ConfigValueExtractor = new engApi.ConfigValueExtractor(rawConfig, '', configRoot);
+        configExtractor._addHiddenKeys([FIELDS.CUSTOM_ENGINE_PLUGIN_MODULES]);
+        configExtractor.validateOnlyContainsKeys([FIELDS.CONFIG_ROOT, FIELDS.LOG_FOLDER ,FIELDS.RULES, FIELDS.ENGINES]);
         const config: TopLevelConfig = {
             config_root: configRoot,
             log_folder: configExtractor.extractFolder(FIELDS.LOG_FOLDER, DEFAULT_CONFIG.log_folder)!,
@@ -159,15 +161,15 @@ export class CodeAnalyzerConfig {
     }
 
     public getRuleOverridesFor(engineName: string): RuleOverrides {
-        return this.config.rules[engineName] || {};
+        return engApi.getValueUsingCaseInsensitiveKey(this.config.rules, engineName) as RuleOverrides || {};
     }
 
     public getRuleOverrideFor(engineName: string, ruleName: string): RuleOverride {
-        return this.getRuleOverridesFor(engineName)[ruleName] || {};
+        return engApi.getValueUsingCaseInsensitiveKey(this.getRuleOverridesFor(engineName), ruleName) as RuleOverride || {};
     }
 
     public getEngineOverridesFor(engineName: string): EngineOverrides {
-        return this.config.engines[engineName] || {};
+        return engApi.getValueUsingCaseInsensitiveKey(this.config.engines, engineName)  as EngineOverrides|| {};
     }
 }
 
@@ -189,6 +191,7 @@ function extractRuleOverridesFrom(engineRuleOverridesExtractor: engApi.ConfigVal
 }
 
 function extractRuleOverrideFrom(ruleOverrideExtractor: engApi.ConfigValueExtractor): RuleOverride {
+    ruleOverrideExtractor.validateOnlyContainsKeys([FIELDS.SEVERITY, FIELDS.TAGS]);
     const engSeverity: engApi.SeverityLevel | undefined = ruleOverrideExtractor.extractSeverityLevel(FIELDS.SEVERITY);
     return {
         tags: ruleOverrideExtractor.extractArray(FIELDS.TAGS, engApi.ValueValidator.validateString),

packages/code-analyzer-core/test/config.test.ts

@@ -57,6 +57,7 @@ describe("Tests for creating and accessing configuration values", () => {
                 tags: ['Security', "SomeNewTag"]
             }
         });
+        expect(conf.getRuleOverrideFor('STUBENGINE1','STUB1RULED')).toEqual(conf.getRuleOverrideFor('stubEngine1','stub1RuleD')); // Sanity test for case insensitivity
         expect(conf.getEngineOverridesFor('stubEngine1')).toEqual({});
         expect(conf.getEngineOverridesFor('stubEngine2')).toEqual({});
     });
@@ -85,13 +86,15 @@ describe("Tests for creating and accessing configuration values", () => {
                 severity: SeverityLevel.Moderate
             }
         });
+        expect(conf.getRuleOverridesFor('STUbengine2')).toEqual(conf.getRuleOverridesFor('stubEngine2'));  // Also test case insensitivity
         expect(conf.getEngineOverridesFor('stubEngine1')).toEqual({
             miscSetting1: true,
             miscSetting2: {
                 miscSetting2A: 3,
                 miscSetting2B: ["hello", "world"]
             }
         });
+        expect(conf.getEngineOverridesFor('stubENGINE1')).toEqual(conf.getEngineOverridesFor('stubEngine1')); // Also test case insensitivity
         expect(conf.getEngineOverridesFor('stubEngine2')).toEqual({});
     });
 
@@ -165,6 +168,12 @@ describe("Tests for creating and accessing configuration values", () => {
             getMessage('ConfigContentNotAnObject','array'));
     });
 
+    it("When top level config has an unknown key, then we error", () => {
+        expect(() => CodeAnalyzerConfig.fromObject({doesNotExist: 3})).toThrow(
+            getMessageFromCatalog(SHARED_MESSAGE_CATALOG,'ConfigObjectContainsInvalidKey','<TopLevel>', 'doesNotExist',
+                '["config_root","log_folder","rules","engines"]'));
+    });
+
     it("When engines value is not an object then we throw an error", () => {
         expect(() => CodeAnalyzerConfig.fromObject({engines: ['oops']})).toThrow(
             getMessageFromCatalog(SHARED_MESSAGE_CATALOG,'ConfigValueMustBeOfType','engines', 'object', 'array'));
@@ -190,6 +199,12 @@ describe("Tests for creating and accessing configuration values", () => {
             getMessageFromCatalog(SHARED_MESSAGE_CATALOG,'ConfigValueMustBeOfType','rules.someEngine.someRule', 'object', 'array'));
     });
 
+    it("When rules.someEngine.someRule contains an unknown key then we throw an error", () => {
+        expect(() => CodeAnalyzerConfig.fromObject({rules: {someEngine: {someRule: {oops: 3, tags: []}}}})).toThrow(
+            getMessageFromCatalog(SHARED_MESSAGE_CATALOG,'ConfigObjectContainsInvalidKey','rules.someEngine.someRule', 'oops',
+                '["severity","tags"]'));
+    });
+
     it("When the severity of a rule not a valid value then we throw an error", () => {
         expect(() => CodeAnalyzerConfig.fromObject({rules: {someEngine: {
             goodSevRule1: {severity: 3},

packages/code-analyzer-engine-api/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/code-analyzer-engine-api",
   "description": "Engine API Package for the Salesforce Code Analyzer",
-  "version": "0.15.0",
+  "version": "0.16.0-SNAPSHOT",
   "author": "The Salesforce Code Analyzer Team",
   "license": "BSD-3-Clause",
   "homepage": "https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/overview",