@salesforce/plugin-apex 3.7.0 → 3.8.0

package/oclif.manifest.json

@@ -569,7 +569,7 @@
       ],
       "args": {},
       "deprecateAliases": true,
-      "description": "Specify which tests to run by using the --class-names, --suite-names, or --tests flags. Alternatively, use the --test-level flag to run all the tests in your org, local tests, or specified tests.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for classes in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.\n\nBy default, Apex tests run asynchronously and immediately return a test run ID. You can use the --wait flag to specify the number of minutes to wait; if the tests finish in that timeframe, the command displays the results. If the tests haven't finished by the end of the wait time, the command displays a test run ID. Use the \"<%= config.bin %> apex get test --test-run-id\" command to get the results.\n\nYou must have the \"View All Data\" system permission to use this command. The permission is disabled by default and can be enabled only by a system administrator.\n\nNOTE: The testRunCoverage value (JSON and JUnit result formats) is a percentage of the covered lines and total lines from all the Apex classes evaluated by the tests in this run.",
+      "description": "Specify which tests to run by using the --class-names, --suite-names, or --tests flags. Alternatively, use the --test-level flag to run all the tests in your org, local tests, or specified tests.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for classes in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.\n\nBy default, Apex tests run asynchronously and immediately return a test run ID. You can use the --wait flag to specify the number of minutes to wait; if the tests finish in that timeframe, the command displays the results. If the tests haven't finished by the end of the wait time, the command displays a test run ID. Use the \"<%= config.bin %> apex get test --test-run-id\" command to get the results.\n\nTo run both Apex and Flow tests together, run the \"sf logic run test\" CLI command, which has similar flags as this command, but expands the --tests flag to also include Flow tests.\n\nYou must have the \"View All Data\" system permission to use this command. The permission is disabled by default and can be enabled only by a system administrator.\n\nNOTE: The testRunCoverage value (JSON and JUnit result formats) is a percentage of the covered lines and total lines from all the Apex classes evaluated by the tests in this run.",
       "examples": [
         "Run all Apex tests and suites in your default org:\n<%= config.bin %> <%= command.id %>",
         "Run the specified Apex test classes in your default org and display results in human-readable form:\n<%= config.bin %> <%= command.id %> --class-names MyClassTest --class-names MyOtherClassTest --result-format human",
@@ -1115,6 +1115,7 @@
       "pluginAlias": "@salesforce/plugin-apex",
       "pluginName": "@salesforce/plugin-apex",
       "pluginType": "core",
+      "state": "beta",
       "strict": true,
       "summary": "Get the results of a test run.",
       "enableJsonFlag": true,
@@ -1135,7 +1136,259 @@
         "test:logic:get",
         "test:get:logic"
       ]
+    },
+    "logic:run:test": {
+      "aliases": [],
+      "args": {},
+      "description": "This command provides a single and unified way to run tests for multiple Salesforce features, such as Apex classes and Flows. Running the tests together with a single command ensures seamless interoperability between the features.\n\nBy default, the command executes asynchronously and returns a test run ID. Then use the \"sf logic get test\" command to retrieve the results. If you want to wait for the test run to complete and see the results in the command output, use the --synchronous flag.\n\nTo run specific tests, use the --tests flag, passing it the Apex test class names or the Flow tests in the form Flowtest.<name>. You can also run specific test methods, although if you run the tests synchronously, the methods must belong to a single Apex class or Flow test. To run all tests of a certain category, use --test-level with --test-category. If neither flag is specified, all local tests for all categories are run by default. You can also use the --class-names and --suite-names flags to run Apex test classes or suites.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for the tested classes or flows. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.\n\nYou must have the \"View All Data\" org system permission to use this command. The permission is disabled by default and can be enabled only by a system administrator.",
+      "examples": [
+        "Run a mix of specific Apex and Flow tests asynchronously in your default org:\n<%= config.bin %> <%= command.id %> --tests MyApexClassTest,FlowTest.ProcessOrder",
+        "Run all local Apex and Flow tests and wait for the results to complete; run the tests in the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --test-level RunLocalTests --test-category Apex --test-category Flow --synchronous --target-org my-scratch",
+        "Run two methods in an Apex test class and an Apex test suite:\n<%= config.bin %> <%= command.id %> --class-names MyApexClassTest.methodA --class-names MyApexClassTest.methodB --suite-names MySuite",
+        "Run all local tests for all categories (the default behavior), save the JUnit results to the \"test-results\" directory, and include code coverage results:\n<%= config.bin %> <%= command.id %> --result-format junit --output-dir test-results --synchronous --code-coverage"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "aliases": [
+            "targetusername",
+            "u"
+          ],
+          "char": "o",
+          "deprecateAliases": true,
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "aliases": [
+            "apiversion"
+          ],
+          "deprecateAliases": true,
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "loglevel": {
+          "deprecated": {
+            "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
+          },
+          "hidden": true,
+          "name": "loglevel",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "code-coverage": {
+          "aliases": [
+            "codecoverage"
+          ],
+          "char": "c",
+          "deprecateAliases": true,
+          "name": "code-coverage",
+          "summary": "Retrieve code coverage results.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "output-dir": {
+          "aliases": [
+            "outputdir",
+            "output-directory"
+          ],
+          "char": "d",
+          "deprecateAliases": true,
+          "name": "output-dir",
+          "summary": "Directory in which to store test run files.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "test-level": {
+          "aliases": [
+            "testlevel"
+          ],
+          "char": "l",
+          "deprecateAliases": true,
+          "description": "Here's what the levels mean:\n\n- RunSpecifiedTests — Only the tests that you specify in the runTests option are run. Code coverage requirements differ from the default coverage requirements when using this test level. The executed tests must cover each class and trigger in the deployment package for a minimum of 75% code coverage. This coverage is computed for each class and triggers individually, and is different than the overall coverage percentage.\n- RunLocalTests — All local tests in your org, including tests that originate from no-namespaced unlocked packages, are run. The tests that originate from installed managed packages and namespaced unlocked packages aren't run. This test level is the default for production deployments that include Apex classes or triggers.\n- RunAllTestsInOrg — All tests are run. The tests include all tests in your org.",
+          "name": "test-level",
+          "summary": "Level of tests to run; default is RunLocalTests.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "RunLocalTests",
+            "RunAllTestsInOrg",
+            "RunSpecifiedTests"
+          ],
+          "type": "option"
+        },
+        "class-names": {
+          "aliases": [
+            "classnames"
+          ],
+          "char": "n",
+          "deprecateAliases": true,
+          "description": "If you select --class-names, you can't specify --suite-names or --tests.\nFor multiple classes, repeat the flag for each.\n--class-names Class1 --class-names Class2",
+          "exclusive": [
+            "suite-names",
+            "tests",
+            "test-category"
+          ],
+          "name": "class-names",
+          "summary": "Apex test class names to run; default is all classes.",
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "result-format": {
+          "aliases": [
+            "resultformat"
+          ],
+          "char": "r",
+          "deprecateAliases": true,
+          "name": "result-format",
+          "summary": "Format of the test results.",
+          "default": "human",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "human",
+            "tap",
+            "junit",
+            "json"
+          ],
+          "type": "option"
+        },
+        "suite-names": {
+          "aliases": [
+            "suitenames"
+          ],
+          "char": "s",
+          "deprecateAliases": true,
+          "description": "If you select --suite-names, you can't specify --class-names or --tests.\nFor multiple suites, repeat the flag for each.\n--suite-names Suite1 --suite-names Suite2",
+          "exclusive": [
+            "class-names",
+            "tests",
+            "test-category"
+          ],
+          "name": "suite-names",
+          "summary": "Apex test suite names to run.",
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "tests": {
+          "char": "t",
+          "description": "If you specify --tests, you can't specify --class-names or --suite-names\nFor multiple tests, repeat the flag for each.\n--tests Test1 --tests Test2",
+          "exclusive": [
+            "class-names",
+            "suite-names",
+            "test-category"
+          ],
+          "name": "tests",
+          "summary": "Comma-separated list of test names to run. Can include Apex test classes and Flow tests.",
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "wait": {
+          "char": "w",
+          "name": "wait",
+          "summary": "Sets the streaming client socket timeout in minutes; specify a longer wait time if timeouts occur frequently.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "synchronous": {
+          "char": "y",
+          "name": "synchronous",
+          "summary": "Runs test methods from a single Apex class synchronously; if not specified, tests are run asynchronously.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "detailed-coverage": {
+          "aliases": [
+            "detailedcoverage"
+          ],
+          "char": "v",
+          "dependsOn": [
+            "code-coverage"
+          ],
+          "deprecateAliases": true,
+          "name": "detailed-coverage",
+          "summary": "Display detailed code coverage per test.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "concise": {
+          "name": "concise",
+          "summary": "Display only failed test results; works with human-readable output only.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "test-category": {
+          "name": "test-category",
+          "summary": "Category of tests to run, such as Apex or Flow.",
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "Apex",
+            "Flow"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "logic:run:test",
+      "pluginAlias": "@salesforce/plugin-apex",
+      "pluginName": "@salesforce/plugin-apex",
+      "pluginType": "core",
+      "state": "beta",
+      "strict": true,
+      "summary": "Invoke tests for Apex and Flows in an org.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "logic",
+        "run",
+        "test.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "logic:run:test",
+        "run:logic:test",
+        "run:test:logic",
+        "logic:test:run",
+        "test:logic:run",
+        "test:run:logic"
+      ]
     }
   },
-  "version": "3.7.0"
+  "version": "3.8.0"
 }

package/package.json

@@ -1,11 +1,11 @@
 {
     "name": "@salesforce/plugin-apex",
     "description": "Apex commands",
-    "version": "3.7.0",
+    "version": "3.8.0",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
-        "@salesforce/apex-node": "^8.3.1",
+        "@salesforce/apex-node": "^8.3.2",
         "@salesforce/core": "^8.10.1",
         "@salesforce/kit": "^3.2.3",
         "@salesforce/sf-plugins-core": "^12.2.1",
@@ -13,9 +13,9 @@
     },
     "devDependencies": {
         "@oclif/core": "^4.2.10",
-        "@oclif/plugin-command-snapshot": "^5.2.37",
+        "@oclif/plugin-command-snapshot": "^5.3.6",
         "@salesforce/cli-plugins-testkit": "^5.3.39",
-        "@salesforce/dev-scripts": "^10.2.11",
+        "@salesforce/dev-scripts": "^11.0.4",
         "@salesforce/plugin-command-reference": "^3.1.52",
         "eslint-plugin-sf-plugin": "^1.20.24",
         "oclif": "^4.17.46",
@@ -42,7 +42,7 @@
         "sfdx",
         "sfdx-plugin"
     ],
-    "license": "BSD-3-Clause",
+    "license": "Apache-2.0",
     "oclif": {
         "commands": "./lib/commands",
         "additionalHelpFlags": [
@@ -72,6 +72,9 @@
                 "subtopics": {
                     "get": {
                         "description": "Get debug logs or test results."
+                    },
+                    "run": {
+                        "description": "Run Apex and Flow tests."
                     }
                 }
             }
@@ -91,6 +94,7 @@
         "clean-all": "sf-clean all",
         "compile": "wireit",
         "docs": "sf-docs",
+        "fix-license": "eslint src test --fix --rule \"header/header: [2]\"",
         "format": "wireit",
         "link-check": "wireit",
         "lint": "wireit",
@@ -225,7 +229,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-apex/3.7.0.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-apex/3.7.0.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-apex/3.8.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-apex/3.8.0.sig"
     }
 }