feat: add a soqlqueryfile parameter to allow longer queries

command-snapshot.json

@@ -2,12 +2,14 @@
   {
     "command": "force:data:bulk:delete",
     "plugin": "@salesforce/plugin-data",
-    "flags": ["apiversion", "csvfile", "json", "loglevel", "sobjecttype", "targetusername", "wait"]
+    "flags": ["apiversion", "csvfile", "json", "loglevel", "sobjecttype", "targetusername", "wait"],
+    "alias": []
   },
   {
     "command": "force:data:bulk:status",
     "plugin": "@salesforce/plugin-data",
-    "flags": ["apiversion", "batchid", "jobid", "json", "loglevel", "targetusername"]
+    "flags": ["apiversion", "batchid", "jobid", "json", "loglevel", "targetusername"],
+    "alias": []
   },
   {
     "command": "force:data:bulk:upsert",
@@ -22,12 +24,14 @@
       "sobjecttype",
       "targetusername",
       "wait"
-    ]
+    ],
+    "alias": []
   },
   {
     "command": "force:data:record:create",
     "plugin": "@salesforce/plugin-data",
-    "flags": ["apiversion", "json", "loglevel", "perflog", "sobjecttype", "targetusername", "usetoolingapi", "values"]
+    "flags": ["apiversion", "json", "loglevel", "perflog", "sobjecttype", "targetusername", "usetoolingapi", "values"],
+    "alias": []
   },
   {
     "command": "force:data:record:delete",
@@ -42,7 +46,8 @@
       "targetusername",
       "usetoolingapi",
       "where"
-    ]
+    ],
+    "alias": []
   },
   {
     "command": "force:data:record:get",
@@ -57,7 +62,8 @@
       "targetusername",
       "usetoolingapi",
       "where"
-    ]
+    ],
+    "alias": []
   },
   {
     "command": "force:data:record:update",
@@ -73,17 +79,30 @@
       "usetoolingapi",
       "values",
       "where"
-    ]
+    ],
+    "alias": []
   },
   {
     "command": "force:data:soql:query",
     "plugin": "@salesforce/plugin-data",
-    "flags": ["apiversion", "json", "loglevel", "perflog", "query", "resultformat", "targetusername", "usetoolingapi"]
+    "flags": [
+      "apiversion",
+      "json",
+      "loglevel",
+      "perflog",
+      "query",
+      "resultformat",
+      "soqlqueryfile",
+      "targetusername",
+      "usetoolingapi"
+    ],
+    "alias": []
   },
   {
     "command": "force:data:tree:export",
     "plugin": "@salesforce/plugin-data",
-    "flags": ["apiversion", "json", "loglevel", "outputdir", "plan", "prefix", "query", "targetusername"]
+    "flags": ["apiversion", "json", "loglevel", "outputdir", "plan", "prefix", "query", "targetusername"],
+    "alias": []
   },
   {
     "command": "force:data:tree:import",
@@ -97,6 +116,7 @@
       "plan",
       "sobjecttreefiles",
       "targetusername"
-    ]
+    ],
+    "alias": []
   }
 ]

messages/soql.query.json

@@ -11,10 +11,13 @@
   "queryNoResults": "Your query returned no results.",
   "queryRunningMessage": "Querying Data",
   "queryMoreUpdateMessage": "Result size is %d, current count is %d",
+  "soqlqueryfile": "A SOQL query stored in a file",
   "examples": [
     "$ sfdx force:data:soql:query -q \"SELECT Id, Name, Account.Name FROM Contact\"",
     "$ sfdx force:data:soql:query -q \"SELECT Id, Name FROM Account WHERE ShippingState IN ('CA', 'NY')\"",
     "$ sfdx force:data:soql:query -q \"SELECT Id, Name FROM Account WHERE ShippingState IN ('CA', 'NY')\" --perflog --json",
-    "$ sfdx force:data:soql:query -q \"SELECT Name FROM ApexTrigger\" -t"
+    "$ sfdx force:data:soql:query -q \"SELECT Name FROM ApexTrigger\" -t",
+    "$ sfdx force:data:soql:query --soqlqueryfile query.txt",
+    "$ sfdx force:data:soql:query --soqlqueryfile query.txt -t"
   ]
 }

src/commands/force/data/soql/query.ts

@@ -6,6 +6,7 @@
  */
 
 import * as os from 'os';
+import * as fs from 'fs';
 import { flags, FlagsConfig } from '@salesforce/command';
 import { CliUx } from '@oclif/core';
 import { Connection, Logger, Messages, SfdxConfigAggregator } from '@salesforce/core';
@@ -182,8 +183,15 @@ export class DataSoqlQueryCommand extends DataCommand {
   public static readonly flagsConfig: FlagsConfig = {
     query: flags.string({
       char: 'q',
-      required: true,
       description: messages.getMessage('queryToExecute'),
+      exclusive: ['soqlqueryfile'],
+      exactlyOne: ['query', 'soqlqueryfile'],
+    }),
+    soqlqueryfile: flags.filepath({
+      char: 'f',
+      description: messages.getMessage('soqlqueryfile'),
+      exclusive: ['query'],
+      exactlyOne: ['query', 'soqlqueryfile'],
     }),
     usetoolingapi: flags.boolean({
       char: 't',
@@ -220,9 +228,10 @@ export class DataSoqlQueryCommand extends DataCommand {
       if (this.flags.resultformat !== 'json') this.ux.startSpinner(messages.getMessage('queryRunningMessage'));
       const query = new SoqlQuery();
       const conn = this.getConnection();
+      const queryString = (this.flags.query as string) ?? fs.readFileSync(this.flags.soqlqueryfile, 'utf8');
       const queryResult: SoqlQueryResult = await query.runSoqlQuery(
         conn as Connection,
-        this.flags.query,
+        queryString,
         this.logger,
         this.configAggregator
       );

test/commands/force/data/bulk/status.test.ts

@@ -15,7 +15,6 @@ interface StatusResult {
 
 describe('force:data:bulk:status', () => {
   test
-    .skip()
     .do(() => {
       const Job = {
         getAuthInfoFields: () => {
@@ -70,7 +69,6 @@ describe('force:data:bulk:status', () => {
     });
 
   test
-    .skip()
     .do(() => {
       const Job = {
         getAuthInfoFields: () => {

test/commands/force/data/soql/query/dataSoqlQuery.nut.ts

@@ -5,11 +5,11 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import * as path from 'path';
+import * as fs from 'fs';
 import * as shell from 'shelljs';
-import { isArray, AnyJson, ensureString } from '@salesforce/ts-types';
+import { AnyJson, Dictionary, ensureString, getString, isArray } from '@salesforce/ts-types';
 import { expect } from 'chai';
 import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
-import { Dictionary, getString } from '@salesforce/ts-types';
 
 export interface QueryResult {
   totalSize: number;
@@ -116,6 +116,16 @@ describe('data:soql:query command', () => {
       expect(stdError).to.include('unexpected token');
     });
 
+    it('should produce correct error when invalid soql provided', () => {
+      const filepath = path.join(testSession.dir, 'soql.txt');
+      fs.writeFileSync(filepath, 'SELECT');
+
+      const result = execCmd(`force:data:soql:query --soqlqueryfile ${filepath}`, { ensureExitCode: 1 }).shellOutput
+        .stderr;
+      const stdError = result?.toLowerCase();
+      expect(stdError).to.include('unexpected token');
+    });
+
     it('should error with no such column', () => {
       // querying ApexClass including SymbolTable column w/o using tooling api will cause "no such column" error
       const result = runQuery('SELECT Id, Name, SymbolTable from ApexClass', {
@@ -194,6 +204,20 @@ describe('data:soql:query command', () => {
       expect(queryResult).to.match(/ID\s+?NAME\s+?PHONE\s+?WEBSITE\s+?NUMBEROFEMPLOYEES\s+?INDUSTRY/g);
       expect(queryResult).to.match(/Total number of records retrieved: 1\./g);
     });
+
+    it('should return account records, from --soqlqueryfile', () => {
+      const query =
+        "SELECT Id, Name, Phone, Website, NumberOfEmployees, Industry FROM Account WHERE Name LIKE 'SampleAccount%' limit 1";
+      const filepath = path.join(testSession.dir, 'soql.txt');
+      fs.writeFileSync(filepath, query);
+
+      const queryResult = execCmd(`force:data:soql:query --soqlqueryfile ${filepath}`, { ensureExitCode: 0 })
+        .shellOutput.stdout;
+
+      expect(queryResult).to.match(/ID\s+?NAME\s+?PHONE\s+?WEBSITE\s+?NUMBEROFEMPLOYEES\s+?INDUSTRY/g);
+      expect(queryResult).to.match(/Total number of records retrieved: 1\./g);
+    });
+
     it('should return account records with nested contacts', () => {
       const query =
         "SELECT Id, Name, Phone, Website, NumberOfEmployees, Industry, (SELECT Lastname, Title, Email FROM Contacts) FROM Account  WHERE Name LIKE 'SampleAccount%'";

test/commands/force/data/soql/query/dataSoqlQueryCommand.test.ts

@@ -23,7 +23,7 @@ interface QueryResult {
   result: { totalSize: number; records: [] };
 }
 
-describe.skip('Execute a SOQL statement', function (): void {
+describe('Execute a SOQL statement', function (): void {
   let sandbox: SinonSandbox;
   beforeEach(() => {
     sandbox = sinon.createSandbox();
@@ -148,6 +148,23 @@ describe.skip('Execute a SOQL statement', function (): void {
           expect(ctx.stdout).to.include('records retrieved: 1');
         });
     });
+    describe('flag validation between --query and --soqlqueryfile', () => {
+      test
+        .withOrg({ username: '[email protected]' }, true)
+        .stderr()
+        .command([
+          QUERY_COMMAND,
+          '--targetusername',
+          '[email protected]',
+          '--query',
+          'SELECT Amount, Id, Name,StageName, CloseDate, (SELECT Id,  ListPrice, PriceBookEntry.UnitPrice, PricebookEntry.Name, PricebookEntry.Id, PricebookEntry.product2.Family FROM OpportunityLineItems) FROM Opportunity',
+          '--soqlqueryfile',
+          'soql.txt',
+        ])
+        .it('should throw an error when both query (inline/file query) flags are specified', (ctx) => {
+          expect(ctx.stderr).to.include('--soqlqueryfile= cannot also be provided when using --query=');
+        });
+    });
     describe('reporters produce the correct aggregate query', () => {
       beforeEach(() => {
         soqlQuerySpy = sandbox