Merge pull request #765 from forcedotcom/dev-3

@W-11445992@ Merging dev-3 to release-3

Author: ranekere-sfdc

.circleci/config.yml

@@ -80,6 +80,9 @@ commands:
       - gradle/collect_test_results:
           reports_path: pmd-cataloger/build/reports/
           test_results_path: pmd-cataloger/build/test-results/
+      - gradle/collect_test_results:
+          reports_path: sfge/build/reports/
+          test_results_path: sfge/build/test-results/
       - store_test_results:
           path: test-results
       - store_artifacts: # upload nyc test coverage as artifact.
@@ -218,12 +221,21 @@ jobs:
 
   # Purpose: Runs the unit tests in a Windows environment.
   windows-unit-tests:
+    # `parallelism` indicates how many simultaneous executors should be run, allowing us to split
+    # long-running tasks across multiple executors.
+    parallelism: 4 # larger values didn't seem to affect performance greatly
     executor:
       name: win/default # executor type
-      size: "medium"
+      size: "large"
       shell: bash.exe
     parameters:
       node-version: *node_version_param
+      # Specify a subset of unit tests to be run, instead of the whole suite.
+      # This allows us to work around the suboptimal performance of the Windows executor by running
+      # multiple executors in parallel where different unit tests are ran in each.
+      test-type:
+          type: string
+          default: all
     working_directory: C:\repo
     steps:
       - attach_workspace:
@@ -259,12 +271,90 @@ jobs:
       - run: mkdir test-results
 
       # Unit tests
-      - run:
-          name: test
-          # Necessary to explicitly use bash, otherwise gradlew's status code won't be received and the job will hang.
-          shell: bash.exe
-          command: yarn test --reporter mocha-junit-reporter --reporter-option mochaFile=test-results/mocha/test-results.xml
-          when: always
+      - when:
+          condition:
+              equal: [ all, << parameters.test-type >> ]
+          steps:
+              - run:
+                  name: test
+                  # Necessary to explicitly use bash, otherwise gradlew's status code won't be received and the job will hang.
+                  shell: bash.exe
+                  command: yarn test --reporter mocha-junit-reporter --reporter-option mochaFile=test-results/mocha/test-results.xml
+                  when: always
+
+      - when:
+          condition:
+            equal: [ sfge, << parameters.test-type >> ]
+          steps:
+              - run:
+                  name: test-sfge
+                  # Necessary to explicitly use bash, otherwise gradlew's status code won't be received and the job will hang.
+                  shell: bash.exe
+                  # Identify all the test files and allocate them between parallelized executors by timing data.
+                  # Then turn the array of tests into something that gradle can accept, and run the tests.
+                  command: |
+                      TESTGLOB=$(circleci tests glob "sfge/src/test/**/*Test.java" | circleci tests split --split-by=timings)
+                      echo $TESTGLOB
+                      TESTARRAY=($TESTGLOB)
+                      TESTARG=""
+                      for element in "${TESTARRAY[@]}"
+                      do
+                        TESTARG="$TESTARG --tests `basename $element .java`"
+                      done
+                      echo $TESTARG
+                      yarn test-sfge $TESTARG
+                  when: always
+
+      - when:
+          condition:
+            equal: [ cli-messaging, << parameters.test-type >> ]
+          steps:
+            - run:
+                name: test-cli-messaging
+                # Necessary to explicitly use bash, otherwise gradlew's status code won't be received and the job will hang.
+                shell: bash.exe
+                # This unit test suite is fast, so we have the first parallel executor run the tests, and all others exit early.
+                command: |
+                      if [[ $CIRCLE_NODE_INDEX -gt 0 ]]
+                      then
+                        exit 0
+                      fi
+                      yarn test-cli-messaging 
+                when: always
+
+      - when:
+          condition:
+              equal: [ pmd-cataloger, << parameters.test-type >> ]
+          steps:
+              - run:
+                  name: test-pmd-cataloger
+                  # Necessary to explicitly use bash, otherwise gradlew's status code won't be received and the job will hang.
+                  shell: bash.exe
+                  # This unit test suite is fast, so we have the first parallel executor run the tests, and all others exit early.
+                  command: |
+                      if [[ $CIRCLE_NODE_INDEX -gt 0 ]]
+                      then
+                        exit 0
+                      fi
+                      yarn test-pmd-cataloger
+                  when: always
+
+      - when:
+          condition:
+              equal: [ ts, << parameters.test-type >> ]
+          steps:
+              - run:
+                  name: test-ts
+                  # Explicitly using bash, for simplicity of required shell script.
+                  shell: bash.exe
+                  # This unit test suite is relatively fast, so we have the first parallel executor run the tests, and all others exit early.
+                  command: |
+                      if [[ $CIRCLE_NODE_INDEX -gt 0 ]]
+                      then
+                        exit 0
+                      fi
+                      yarn test-ts --reporter mocha-junit-reporter --reporter-option mochaFile=test-results/mocha/test-results.xml
+                  when: always
 
       # Linting
       - run:
@@ -510,6 +600,11 @@ workflows:
             <<: *testing_filters
           requires:
             - setup
+          matrix:
+            parameters:
+              # The values of the parameters will be appended to the jobs they create.
+              # So we'll get "windows-unit-tests-pmd-cataloger", "windows-unit-tests-ts", etc.
+              test-type: [pmd-cataloger, cli-messaging, ts, sfge]
       - linux-tarball-test:
           filters:
             <<: *testing_filters

.editorconfig

@@ -7,6 +7,10 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
+[*.java]
+indent_style = space
+indent_size = 4
+
 [*.md]
 trim_trailing_whitespace = false
 

messages/common.js

@@ -0,0 +1,3 @@
+module.exports = {
+	FEEDBACK_SURVEY_BANNER: `We're constantly improving Salesforce Code Analyzer. Tell us what you think! Give feedback at https://research.net/r/SalesforceCA.`
+};

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.2.0",
+	"version": "3.3.0",
 	"author": "ISV SWAT",
 	"bugs": "https://github.com/forcedotcom/sfdx-scanner/issues",
 	"dependencies": {
@@ -133,6 +133,10 @@
 		"postpack": "rm -f oclif.manifest.json",
 		"lint": "eslint ./src --ext .ts",
 		"test": "./gradlew test jacocoTestCoverageVerification && nyc mocha --timeout 10000 --retries 5 \"./test/**/*.test.ts\"",
+		"test-cli-messaging": "./gradlew cli-messaging:test",
+		"test-pmd-cataloger": "./gradlew pmd-cataloger:test",
+		"test-sfge": "./gradlew sfge:test",
+		"test-ts": "nyc mocha --timeout 10000 --retries 5 \"./test/**/*.test.ts\"",
 		"coverage": "nyc report --reporter text",
 		"version": "oclif-dev readme && git add README.md"
 	}

pmd-cataloger/build.gradle.kts

@@ -9,7 +9,7 @@ group = "sfdx"
 version = "1.0"
 
 val distDir = "$buildDir/../../dist"
-val pmdVersion = "6.45.0"
+val pmdVersion = "6.47.0"
 val pmdFile = "pmd-bin-$pmdVersion.zip"
 val pmdUrl = "https://github.com/pmd/pmd/releases/download/pmd_releases%2F${pmdVersion}/${pmdFile}"
 val skippableJarRegexes = setOf("""^common_[\d\.-]*\.jar""".toRegex(),

sfge/.editorconfig

@@ -9,5 +9,5 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.java]
-indent_style = tab
+indent_style = space
 indent_size = 4

sfge/src/main/java/com/salesforce/Main.java

@@ -4,6 +4,7 @@
 import com.salesforce.cli.OutputFormatter;
 import com.salesforce.exception.SfgeException;
 import com.salesforce.exception.SfgeRuntimeException;
+import com.salesforce.exception.UnexpectedException;
 import com.salesforce.graph.ops.GraphUtil;
 import com.salesforce.messaging.CliMessager;
 import com.salesforce.metainfo.MetaInfoCollector;
@@ -88,7 +89,7 @@ private int catalog() {
         LOGGER.info("Invoked CATALOG flow");
         List<AbstractRule> rules;
         try {
-            rules = RuleUtil.getAllRules();
+            rules = RuleUtil.getEnabledRules();
         } catch (SfgeException | SfgeRuntimeException ex) {
             System.err.println(ex.getMessage());
             return INTERNAL_ERROR;
@@ -129,6 +130,11 @@ private int execute(String... args) {
             LOGGER.error("Error while loading graph", ex);
             System.err.println(formatError(ex));
             return INTERNAL_ERROR;
+        } catch (UnexpectedException ex) {
+            LOGGER.error("Unexpected exception while loading graph", ex);
+            System.err.println(
+                    "Unexpected exception while loading graph. See logs for more information.");
+            return INTERNAL_ERROR;
         }
 
         // Run all of the rules.

sfge/src/main/java/com/salesforce/apex/jorje/ModifierNodeWrapper.java

@@ -23,5 +23,7 @@ protected void fillProperties(Map<String, Object> properties) {
         properties.put(Schema.ABSTRACT, Modifier.isAbstract(javaModifiers));
         properties.put(Schema.STATIC, Modifier.isStatic(javaModifiers));
         properties.put(Schema.GLOBAL, getNode().getModifiers().has(ModifierTypeInfos.GLOBAL));
+        properties.put(Schema.VIRTUAL, getNode().getModifiers().has(ModifierTypeInfos.VIRTUAL));
+        properties.put(Schema.OVERRIDE, getNode().getModifiers().has(ModifierTypeInfos.OVERRIDE));
     }
 }

sfge/src/main/java/com/salesforce/cli/CliArgParser.java

@@ -126,9 +126,13 @@ private List<String> readFile(String fileName) throws IOException {
 
         private void identifyRules(List<String> rulesToRun) {
             try {
-                for (String ruleName : rulesToRun) {
-                    AbstractRule rule = RuleUtil.getRule(ruleName);
-                    selectedRules.add(rule);
+                if (rulesToRun.isEmpty()) {
+                    selectedRules.addAll(RuleUtil.getEnabledRules());
+                } else {
+                    for (String ruleName : rulesToRun) {
+                        AbstractRule rule = RuleUtil.getRule(ruleName);
+                        selectedRules.add(rule);
+                    }
                 }
             } catch (RuleUtil.RuleNotFoundException ex) {
                 throw new InvocationException(ex.getMessage(), ex);

sfge/src/main/java/com/salesforce/config/UserFacingErrorMessages.java

@@ -0,0 +1,14 @@
+package com.salesforce.config;
+
+/**
+ * Contains error message constants that will be displayed to users. TODO: move all other
+ * user-facing messages here.
+ */
+public final class UserFacingErrorMessages {
+
+    /** UserActionException * */
+
+    // format: filename,defined type, line number
+    public static final String UNREACHABLE_CODE =
+            "Please remove unreachable code to proceed with analysis: %s,%s:%d";
+}