Merge pull request #456 from sf-aastha-paruthi/u/aparuthi/relatedflagandonlyflag

@W-20471492 Execution should be stopped - If the assessment command is run with related objects with only single components

Author: sf-aastha-paruthi

messages/assess.json

@@ -33,6 +33,7 @@
   "noPackageInstalled": "No valid package found in your org.",
   "alreadyStandardModel": "Your org already uses the standard data model.",
   "invalidRelatedObjectsOption": "Invalid entry for -r: %s. Enter either apex, lwc, flexipage or expsites.",
+  "relatedFlagsNotSupportedWithOnly": "Related objects [ex: Apex, lwc, expsites and flexipages] are not supported with only flag.",
   "formulaSyntaxError": "We couldn't update the syntax of this formula. Verify the syntax and try again: %s",
   "errorDuringFlexCardAssessment": "We've encountered errors during the Flexcard assessment: %s",
   "errorDuringOmniScriptAssessment": "We've encountered errors during the Omniscript assessment: %s",

messages/migrate.json

@@ -35,6 +35,7 @@
   "unknownNamespace": "A valid namespace is not configured in this org. Configure the namespace and try again",
   "noOmniStudioLicenses": "OmniStudio licenses are not found in the org. OmniStudio licenses are required for migration",
   "invalidRelatedObjectsOption": "Invalid option provided for -r: %s. Valid options are apex, lwc, expsites, flexipage.",
+  "relatedFlagsNotSupportedWithOnly": "Related objects [ex: Apex, lwc, expsites and flexipages] are not supported with only flag.",
   "userConsentMessage": "By proceeding further, you hereby consent to accept changes to your custom code, and the accompanying terms and conditions associated with the use of the Omnistudio Migration Tool. Do you want to proceed? [y/n]",
   "existingApexPrompt": "Do you have a sfdc project that already contains the related objects retrieved from your org? [y/n]",
   "enterExistingProjectPath": "Enter the path to the project folder that contains the retrieved APEX classes",

src/commands/omnistudio/migration/assess.ts

@@ -115,6 +115,13 @@ export default class Assess extends SfCommand<AssessmentInfo> {
     // To-Do: Add LWC to valid options when GA is released
     const validOptions = [Constants.Apex, Constants.ExpSites, Constants.FlexiPage, Constants.LWC];
     const apiVersion = conn.getApiVersion();
+
+    // Validate that --only and --relatedobjects flags are not used together
+    if (assessOnly && relatedObjects) {
+      Logger.error(messages.getMessage('relatedFlagsNotSupportedWithOnly'));
+      process.exit(1);
+    }
+
     const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn);
 
     // Initialize global data model service

src/commands/omnistudio/migration/migrate.ts

@@ -130,6 +130,12 @@ export default class Migrate extends SfCommand<MigrateResult> {
     const conn = org.getConnection();
     const apiVersion = conn.getApiVersion();
 
+    // Validate that --only and --relatedobjects flags are not used together
+    if (migrateOnly && relatedObjects) {
+      Logger.error(messages.getMessage('relatedFlagsNotSupportedWithOnly'));
+      process.exit(1);
+    }
+
     const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn);
 
     // Initialize global data model service

src/migration/dataraptor.ts

@@ -296,9 +296,6 @@ export class DataRaptorMigrationTool extends BaseMigrationTool implements Migrat
   public async assess(): Promise<DataRaptorAssessmentInfo[]> {
     try {
       if (isStandardDataModelWithMetadataAPIEnabled()) {
-        Logger.log(
-          this.messages.getMessage('skippingAssessmentForStandardOrgWithMetadataAPIEnabled', [Constants.DataMapper])
-        );
         return [];
       }
       DebugTimer.getInstance().lap('Query data raptors');

test/commands/omnistudio/migration/assess-flags-validation.test.ts

@@ -0,0 +1,77 @@
+import { expect } from 'chai';
+import * as sinon from 'sinon';
+import { Messages } from '@salesforce/core';
+import { Logger } from '../../../../src/utils/logger';
+
+Messages.importMessagesDirectory(__dirname);
+const messages = Messages.loadMessages('@salesforce/plugin-omnistudio-migration-tool', 'assess');
+
+describe('Assess command flags validation', () => {
+  let loggerErrorStub: sinon.SinonStub;
+  let processExitStub: sinon.SinonStub;
+
+  beforeEach(() => {
+    loggerErrorStub = sinon.stub(Logger, 'error');
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    processExitStub = sinon.stub(process, 'exit' as any);
+  });
+
+  afterEach(() => {
+    loggerErrorStub.restore();
+    processExitStub.restore();
+  });
+
+  it('should validate that --only and --relatedobjects flags cannot be used together', () => {
+    // Simulate the validation logic
+    const assessOnly = 'os';
+    const relatedObjects = 'lwc';
+
+    if (assessOnly && relatedObjects) {
+      Logger.error(messages.getMessage('relatedFlagsNotSupportedWithOnly'));
+      process.exit(1);
+    }
+
+    expect(loggerErrorStub.calledOnce).to.be.true;
+    expect(loggerErrorStub.firstCall.args[0]).to.equal('Related flags are not supported with only flag.');
+    expect(processExitStub.calledWith(1)).to.be.true;
+  });
+
+  it('should allow --only flag without --relatedobjects', () => {
+    const assessOnly = 'os';
+    const relatedObjects = '';
+
+    if (assessOnly && relatedObjects) {
+      Logger.error(messages.getMessage('relatedFlagsNotSupportedWithOnly'));
+      process.exit(1);
+    }
+
+    expect(loggerErrorStub.called).to.be.false;
+    expect(processExitStub.called).to.be.false;
+  });
+
+  it('should allow --relatedobjects flag without --only', () => {
+    const assessOnly = '';
+    const relatedObjects = 'lwc';
+
+    if (assessOnly && relatedObjects) {
+      Logger.error(messages.getMessage('relatedFlagsNotSupportedWithOnly'));
+      process.exit(1);
+    }
+
+    expect(loggerErrorStub.called).to.be.false;
+    expect(processExitStub.called).to.be.false;
+  });
+
+  it('should allow neither flag to be set', () => {
+    const assessOnly = '';
+    const relatedObjects = '';
+
+    if (assessOnly && relatedObjects) {
+      Logger.error(messages.getMessage('relatedFlagsNotSupportedWithOnly'));
+      process.exit(1);
+    }
+
+    expect(loggerErrorStub.called).to.be.false;
+    expect(processExitStub.called).to.be.false;
+  });
+});

test/commands/omnistudio/migration/migrate-flags-validation.test.ts

@@ -0,0 +1,77 @@
+import { expect } from 'chai';
+import * as sinon from 'sinon';
+import { Messages } from '@salesforce/core';
+import { Logger } from '../../../../src/utils/logger';
+
+Messages.importMessagesDirectory(__dirname);
+const messages = Messages.loadMessages('@salesforce/plugin-omnistudio-migration-tool', 'migrate');
+
+describe('Migrate command flags validation', () => {
+  let loggerErrorStub: sinon.SinonStub;
+  let processExitStub: sinon.SinonStub;
+
+  beforeEach(() => {
+    loggerErrorStub = sinon.stub(Logger, 'error');
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    processExitStub = sinon.stub(process, 'exit' as any);
+  });
+
+  afterEach(() => {
+    loggerErrorStub.restore();
+    processExitStub.restore();
+  });
+
+  it('should validate that --only and --relatedobjects flags cannot be used together', () => {
+    // Simulate the validation logic
+    const migrateOnly = 'os';
+    const relatedObjects = 'lwc';
+
+    if (migrateOnly && relatedObjects) {
+      Logger.error(messages.getMessage('relatedFlagsNotSupportedWithOnly'));
+      process.exit(1);
+    }
+
+    expect(loggerErrorStub.calledOnce).to.be.true;
+    expect(loggerErrorStub.firstCall.args[0]).to.equal('Related flags are not supported with only flag.');
+    expect(processExitStub.calledWith(1)).to.be.true;
+  });
+
+  it('should allow --only flag without --relatedobjects', () => {
+    const migrateOnly = 'os';
+    const relatedObjects = '';
+
+    if (migrateOnly && relatedObjects) {
+      Logger.error(messages.getMessage('relatedFlagsNotSupportedWithOnly'));
+      process.exit(1);
+    }
+
+    expect(loggerErrorStub.called).to.be.false;
+    expect(processExitStub.called).to.be.false;
+  });
+
+  it('should allow --relatedobjects flag without --only', () => {
+    const migrateOnly = '';
+    const relatedObjects = 'lwc';
+
+    if (migrateOnly && relatedObjects) {
+      Logger.error(messages.getMessage('relatedFlagsNotSupportedWithOnly'));
+      process.exit(1);
+    }
+
+    expect(loggerErrorStub.called).to.be.false;
+    expect(processExitStub.called).to.be.false;
+  });
+
+  it('should allow neither flag to be set', () => {
+    const migrateOnly = '';
+    const relatedObjects = '';
+
+    if (migrateOnly && relatedObjects) {
+      Logger.error(messages.getMessage('relatedFlagsNotSupportedWithOnly'));
+      process.exit(1);
+    }
+
+    expect(loggerErrorStub.called).to.be.false;
+    expect(processExitStub.called).to.be.false;
+  });
+});

test/migration/metadata-api-enabled-standard-datamodel.test.ts

@@ -65,7 +65,6 @@ describe('Standard Data Model with Metadata API Enabled - Storage Preparation On
           foundDataRaptorsToAssess: `Found ${params?.[0]} DataRaptors to assess`,
           preparingStorageForMetadataEnabledOrg: `Preparing storage for ${params?.[0]} in Metadata API enabled org`,
           updatingStorageForOmniscipt: `Updating storage for OmniScript (${params?.[0]})`,
-          skippingAssessmentForStandardOrgWithMetadataAPIEnabled: `Skipping ${params?.[0]} assessment for Standard org with Metadata API enabled`,
           unexpectedError: 'An unexpected error occurred',
         };
         return messages[key] || `Mock message for ${key}`;