Refactors 'pp solution publish' to use util. Closes #5248

Author: nicodecleyre

src/m365/pp/commands/solution/solution-publish.spec.ts

@@ -12,7 +12,6 @@ import { powerPlatform } from '../../../../utils/powerPlatform.js';
 import { session } from '../../../../utils/session.js';
 import { sinonUtil } from '../../../../utils/sinonUtil.js';
 import commands from '../../commands.js';
-import ppSolutionGetCommand from './solution-get.js';
 import command from './solution-publish.js';
 import { accessToken } from '../../../../utils/accessToken.js';
 
@@ -38,6 +37,19 @@ describe(commands.SOLUTION_PUBLISH, () => {
       }
     ]
   };
+  const solutionResponse = {
+    solutionid: validId,
+    uniquename: validName,
+    version: '1.0.0.0',
+    installedon: '2021-10-01T21:54:14Z',
+    solutionpackageversion: null,
+    friendlyname: validName,
+    versionnumber: 860052,
+    publisherid: {
+      friendlyname: 'CDS Default Publisher',
+      publisherid: '00000001-0000-0000-0000-00000000005a'
+    }
+  };
   //#endregion
 
   let log: string[];
@@ -76,7 +88,8 @@ describe(commands.SOLUTION_PUBLISH, () => {
       request.get,
       powerPlatform.getDynamicsInstanceApiUrl,
       cli.promptForConfirmation,
-      cli.executeCommandWithOutput
+      cli.executeCommandWithOutput,
+      powerPlatform.getSolutionByName
     ]);
   });
 
@@ -121,34 +134,14 @@ describe(commands.SOLUTION_PUBLISH, () => {
   it('publishes the components of a specified solution owned by the currently signed-in user', async () => {
     sinon.stub(powerPlatform, 'getDynamicsInstanceApiUrl').callsFake(async () => envUrl);
 
-    sinon.stub(cli, 'executeCommandWithOutput').callsFake(async (command): Promise<any> => {
-      if (command === ppSolutionGetCommand) {
-        return ({
-          stdout: `{
-            "solutionid": "${validId}",
-            "uniquename": "${validName}",
-            "version": "1.0.0.0",
-            "installedon": "2022-10-30T13:59:26Z",
-            "solutionpackageversion": null,
-            "friendlyname": "${validName}",
-            "versionnumber": 1209676,
-            "publisherid": {
-              "friendlyname": "Default Publisher for org1547b730",
-              "publisherid": "d21aab71-79e7-11dd-8874-00188b01e34f"
-            }
-          }`
-        });
-      }
-
-      throw new CommandError('Unknown case');
-    });
+    sinon.stub(powerPlatform, 'getSolutionByName').resolves(solutionResponse);
 
     sinon.stub(request, 'get').callsFake(async (opts) => {
       if (opts.url === `https://contoso-dev.api.crm4.dynamics.com/api/data/v9.0/msdyn_solutioncomponentsummaries?$filter=(msdyn_solutionid eq ${validId})&$select=msdyn_componentlogicalname,msdyn_name&$orderby=msdyn_componentlogicalname asc&api-version=9.1`) {
         return validSolutionComponentsResult;
       }
 
-      throw 'Invalid request';
+      throw `Invalid request with opts ${JSON.stringify(opts)}`;
     });
 
     sinon.stub(request, 'post').callsFake(async (opts) => {
@@ -158,7 +151,7 @@ describe(commands.SOLUTION_PUBLISH, () => {
         }
       }
 
-      throw 'Invalid request';
+      throw `Invalid request with opts ${JSON.stringify(opts)}`;
     });
 
     await assert.doesNotReject(command.action(logger, {
@@ -173,34 +166,14 @@ describe(commands.SOLUTION_PUBLISH, () => {
   it('publishes the components of a specified solution owned by the currently signed-in user and waits for completion', async () => {
     sinon.stub(powerPlatform, 'getDynamicsInstanceApiUrl').callsFake(async () => envUrl);
 
-    sinon.stub(cli, 'executeCommandWithOutput').callsFake(async (command): Promise<any> => {
-      if (command === ppSolutionGetCommand) {
-        return ({
-          stdout: `{
-            "solutionid": "${validId}",
-            "uniquename": "${validName}",
-            "version": "1.0.0.0",
-            "installedon": "2022-10-30T13:59:26Z",
-            "solutionpackageversion": null,
-            "friendlyname": "${validName}",
-            "versionnumber": 1209676,
-            "publisherid": {
-              "friendlyname": "Default Publisher for org1547b730",
-              "publisherid": "d21aab71-79e7-11dd-8874-00188b01e34f"
-            }
-          }`
-        });
-      }
-
-      throw new CommandError('Unknown case');
-    });
+    sinon.stub(powerPlatform, 'getSolutionByName').resolves(solutionResponse);
 
     sinon.stub(request, 'get').callsFake(async (opts) => {
       if (opts.url === `https://contoso-dev.api.crm4.dynamics.com/api/data/v9.0/msdyn_solutioncomponentsummaries?$filter=(msdyn_solutionid eq ${validId})&$select=msdyn_componentlogicalname,msdyn_name&$orderby=msdyn_componentlogicalname asc&api-version=9.1`) {
         return validSolutionComponentsResult;
       }
 
-      throw 'Invalid request';
+      throw `Invalid request with opts ${JSON.stringify(opts)}`;
     });
 
     sinon.stub(request, 'post').callsFake(async (opts) => {
@@ -210,7 +183,7 @@ describe(commands.SOLUTION_PUBLISH, () => {
         }
       }
 
-      throw 'Invalid request';
+      throw `Invalid request with opts ${JSON.stringify(opts)}`;
     });
 
     await command.action(logger, {

src/m365/pp/commands/solution/solution-publish.ts

@@ -1,15 +1,12 @@
 import { AxiosRequestConfig } from 'axios';
-import { cli } from '../../../../cli/cli.js';
 import { Logger } from '../../../../cli/Logger.js';
-import Command from '../../../../Command.js';
 import GlobalOptions from '../../../../GlobalOptions.js';
 import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
 import { powerPlatform } from '../../../../utils/powerPlatform.js';
 import { validation } from '../../../../utils/validation.js';
 import PowerPlatformCommand from '../../../base/PowerPlatformCommand.js';
 import commands from '../../commands.js';
-import ppSolutionGetCommand, { Options as PpSolutionGetCommandOptions } from './solution-get.js';
 
 interface CommandArgs {
   options: Options;
@@ -97,8 +94,8 @@ class PpSolutionPublishCommand extends PowerPlatformCommand {
 
   public async commandAction(logger: Logger, args: any): Promise<void> {
     try {
-      const dynamicsApiUrl = await powerPlatform.getDynamicsInstanceApiUrl(args.options.environmentName, args.options.asAdmin);
-      const solutionId = await this.getSolutionId(args, logger);
+      const dynamicsApiUrl = await powerPlatform.getDynamicsInstanceApiUrl(args.options.environment, args.options.asAdmin);
+      const solutionId = await this.getSolutionId(args, dynamicsApiUrl, logger);
       const solutionComponents = await this.getSolutionComponents(dynamicsApiUrl, solutionId, logger);
       const parameterXml = await this.buildXmlRequestObject(solutionComponents, logger);
 
@@ -147,26 +144,17 @@ class PpSolutionPublishCommand extends PowerPlatformCommand {
     return response.value;
   }
 
-  private async getSolutionId(args: CommandArgs, logger: Logger): Promise<string> {
+  private async getSolutionId(args: CommandArgs, dynamicsApiUrl: string, logger: Logger): Promise<string> {
     if (args.options.id) {
       return args.options.id;
     }
 
     if (this.verbose) {
-      await logger.logToStderr(`Retrieving solutionId`);
+      await logger.logToStderr(`Retrieving solutionId...`);
     }
 
-    const options: PpSolutionGetCommandOptions = {
-      environmentName: args.options.environmentName,
-      name: args.options.name,
-      output: 'json',
-      debug: this.debug,
-      verbose: this.verbose
-    };
-
-    const output = await cli.executeCommandWithOutput(ppSolutionGetCommand as Command, { options: { ...options, _: [] } });
-    const getSolutionOutput = JSON.parse(output.stdout);
-    return getSolutionOutput.solutionid;
+    const solution = await powerPlatform.getSolutionByName(dynamicsApiUrl, args.options.name!);
+    return solution.solutionid;
   }
 
   private async buildXmlRequestObject(solutionComponents: SolutionComponent[], logger: Logger): Promise<string> {