Resolves: MTV-3641 | Added custom scripts to plan details via Automation tab

Signed-off-by: Jeff Puzzo <jpuzzo@redhat.com>

Author: jpuzz0

locales/en/plugin__forklift-console-plugin.json

@@ -190,6 +190,8 @@
   "Authentication type": "Authentication type",
   "Automatic VM renaming": "Automatic VM renaming",
   "Automatically decrypt LUKS-encrypted disks using Tang servers during migration. The Tang servers must be accessible from the OpenShift cluster.": "Automatically decrypt LUKS-encrypted disks using Tang servers during migration. The Tang servers must be accessible from the OpenShift cluster.",
+  "Automation": "Automation",
+  "Automation (optional)": "Automation (optional)",
   "Back": "Back",
   "Bandwidth": "Bandwidth",
   "Basic setup": "Basic setup",
@@ -273,11 +275,13 @@
   "Configure certificate validation": "Configure certificate validation",
   "Configure certificate validation (Recommended):": "Configure certificate validation (Recommended):",
   "Configure disk decryption settings including passphrases for LUKS-encrypted devices or network-bound disk encryption (NBDE/Clevis) for the VMs you want to migrate.": "Configure disk decryption settings including passphrases for LUKS-encrypted devices or network-bound disk encryption (NBDE/Clevis) for the VMs you want to migrate.",
+  "Configured": "Configured",
   "Confirm selections": "Confirm selections",
   "Confirm selections with critical issues": "Confirm selections with critical issues",
   "Connection Failed": "Connection Failed",
   "Considerations": "Considerations",
   "Container": "Container",
+  "Content": "Content",
   "Controller inventory container memory limit": "Controller inventory container memory limit",
   "Controller main container CPU limit": "Controller main container CPU limit",
   "Controller main container memory limit": "Controller main container memory limit",
@@ -317,7 +321,7 @@
   "critical concerns impacting your migration plan": "critical concerns impacting your migration plan",
   "Critical issues detected in your selected VMs will cause the migration to fail. Resolve these issues or remove the VMs from the plan before starting the migration.": "Critical issues detected in your selected VMs will cause the migration to fail. Resolve these issues or remove the VMs from the plan before starting the migration.",
   "Custom name template": "Custom name template",
-  "Customization scripts (optional)": "Customization scripts (optional)",
+  "Customization scripts": "Customization scripts",
   "Cutover": "Cutover",
   "Data centers": "Data centers",
   "Data is loading, please wait.": "Data is loading, please wait.",
@@ -384,6 +388,7 @@
   "Edit convertor pod affinity rules": "Edit convertor pod affinity rules",
   "Edit convertor pod labels": "Edit convertor pod labels",
   "Edit convertor pod node selector": "Edit convertor pod node selector",
+  "Edit customization scripts": "Edit customization scripts",
   "Edit cutover": "Edit cutover",
   "Edit default transfer network": "Edit default transfer network",
   "Edit description": "Edit description",
@@ -962,6 +967,7 @@
   "Region": "Region",
   "Regions": "Regions",
   "Remove cutover": "Remove cutover",
+  "Remove script": "Remove script",
   "Reorder": "Reorder",
   "Requests persistent volume (PV) resources without having specific knowledge of the underlying storage infrastructure.": "Requests persistent volume (PV) resources without having specific knowledge of the underlying storage infrastructure.",
   "Required during scheduling": "Required during scheduling",
@@ -991,8 +997,10 @@
   "Save target power state": "Save target power state",
   "Schedule cutover": "Schedule cutover",
   "Script content": "Script content",
+  "Script content is required.": "Script content is required.",
   "Script name": "Script name",
   "Script name is required.": "Script name is required.",
+  "Script name must be unique.": "Script name must be unique.",
   "Script name must contain only lowercase letters, numbers, hyphens, and underscores, and start with a letter or number.": "Script name must contain only lowercase letters, numbers, hyphens, and underscores, and start with a letter or number.",
   "Script type": "Script type",
   "Scripts": "Scripts",
@@ -1080,6 +1088,8 @@
   "Short snapshot polling interval": "Short snapshot polling interval",
   "Show archived": "Show archived",
   "Show default projects": "Show default projects",
+  "Show less": "Show less",
+  "Show more": "Show more",
   "Show variables": "Show variables",
   "Since the VM is offline, there are no live changes to track, making the data copy a one-time, full-disk transfer.": "Since the VM is offline, there are no live changes to track, making the data copy a one-time, full-disk transfer.",
   "Skip certificate validation": "Skip certificate validation",

src/plans/create/CreatePlanWizardInner.tsx

@@ -118,8 +118,8 @@ const CreatePlanWizardInner: FC<CreatePlanWizardInnerProps> = ({
             <OtherSettingsStep isLiveMigrationFeatureEnabled={isLiveMigrationFeatureEnabled} />
           </WizardStep>,
           <WizardStep
-            key={PlanWizardStepId.CustomizationScripts}
-            {...getStepProps(PlanWizardStepId.CustomizationScripts)}
+            key={PlanWizardStepId.Automation}
+            {...getStepProps(PlanWizardStepId.Automation)}
           >
             <CustomScriptsStep />
           </WizardStep>,

src/plans/create/constants.ts

@@ -22,15 +22,15 @@ export enum PlanWizardStepId {
   MigrationType = 'migration-type',
   AdditionalSetup = 'additional-setup',
   OtherSettings = 'other-settings',
-  CustomizationScripts = 'customization-scripts',
+  Automation = 'automation',
   Hooks = 'hooks',
   ReviewAndCreate = 'review-and-create',
 }
 
 export const planStepNames: Record<PlanWizardStepId, ReturnType<typeof t>> = {
   [PlanWizardStepId.AdditionalSetup]: t('Additional setup'),
+  [PlanWizardStepId.Automation]: t('Automation (optional)'),
   [PlanWizardStepId.BasicSetup]: t('Basic setup'),
-  [PlanWizardStepId.CustomizationScripts]: t('Customization scripts (optional)'),
   [PlanWizardStepId.General]: t('General'),
   [PlanWizardStepId.Hooks]: t('Hooks (optional)'),
   [PlanWizardStepId.MigrationType]: t('Migration type'),
@@ -43,8 +43,8 @@ export const planStepNames: Record<PlanWizardStepId, ReturnType<typeof t>> = {
 
 export const planStepOrder: Record<PlanWizardStepId, number> = {
   [PlanWizardStepId.AdditionalSetup]: 7,
+  [PlanWizardStepId.Automation]: 9,
   [PlanWizardStepId.BasicSetup]: 1,
-  [PlanWizardStepId.CustomizationScripts]: 9,
   [PlanWizardStepId.General]: 2,
   [PlanWizardStepId.Hooks]: 10,
   [PlanWizardStepId.MigrationType]: 6,
@@ -66,8 +66,8 @@ export const CreatePlanWizardContext = createContext({} as CreatePlanWizardConte
 
 export const stepFieldMap: Record<PlanWizardStepId, string[]> = {
   [PlanWizardStepId.AdditionalSetup]: [],
+  [PlanWizardStepId.Automation]: Object.values(CustomScriptsFieldId),
   [PlanWizardStepId.BasicSetup]: [],
-  [PlanWizardStepId.CustomizationScripts]: Object.values(CustomScriptsFieldId),
   [PlanWizardStepId.General]: Object.values(GeneralFormFieldId),
   [PlanWizardStepId.Hooks]: Object.values(HooksFormFieldId),
   [PlanWizardStepId.MigrationType]: Object.values(MigrationTypeFieldId),

src/plans/create/steps/customization-scripts/CustomScriptsStep.tsx

@@ -19,7 +19,7 @@ const CustomScriptsStep: FC = () => {
 
   return (
     <WizardStepContainer
-      title={planStepNames[PlanWizardStepId.CustomizationScripts]}
+      title={planStepNames[PlanWizardStepId.Automation]}
       description={
         <Flex spaceItems={{ default: 'spaceItemsSm' }} alignItems={{ default: 'alignItemsCenter' }}>
           <FlexItem>

src/plans/create/steps/review/CustomScriptsReviewSection.tsx

@@ -38,10 +38,10 @@ const CustomScriptsReviewSection: FC = () => {
 
   return (
     <ExpandableReviewSection
-      title={planStepNames[PlanWizardStepId.CustomizationScripts]}
+      title={planStepNames[PlanWizardStepId.Automation]}
       testId="review-custom-scripts-section"
       onEditClick={() => {
-        goToStepById(PlanWizardStepId.CustomizationScripts);
+        goToStepById(PlanWizardStepId.Automation);
       }}
     >
       <DescriptionList isHorizontal horizontalTermWidthModifier={{ default: '18ch' }}>

src/plans/details/hooks/usePlanPages.tsx

@@ -3,6 +3,7 @@ import { useMemo } from 'react';
 import type { NavPage } from '@openshift-console/dynamic-plugin-sdk';
 import { useForkliftTranslation } from '@utils/i18n';
 
+import PlanAutomationPage from '../tabs/Automation/PlanAutomationPage';
 import PlanDetailsPage from '../tabs/Details/PlanDetailsPage';
 import PlanHooksPage from '../tabs/Hooks/PlanHooksPage';
 import PlanMappingsPage from '../tabs/Mappings/PlanMappingsPage';
@@ -39,6 +40,11 @@ const usePlanPages = (name: string, namespace: string) => {
         href: 'mappings',
         name: t('Mappings'),
       },
+      {
+        component: () => <PlanAutomationPage name={name} namespace={namespace} />,
+        href: 'automation',
+        name: t('Automation'),
+      },
       {
         component: () => <PlanHooksPage name={name} namespace={namespace} />,
         href: 'hooks',

src/plans/details/tabs/Automation/PlanAutomationPage.tsx

@@ -0,0 +1,36 @@
+import type { FC } from 'react';
+
+import LoadingSuspend from '@components/LoadingSuspend';
+import { Flex, PageSection } from '@patternfly/react-core';
+
+import { usePlan } from '../../hooks/usePlan';
+import type { PlanPageProps } from '../../utils/types';
+
+import ScriptsSection from './components/ScriptsSection/ScriptsSection';
+import { usePlanCustomScripts } from './hooks/usePlanCustomScripts';
+
+const PlanAutomationPage: FC<PlanPageProps> = ({ name, namespace }) => {
+  const { loaded: loadedPlan, loadError: planError, plan } = usePlan(name, namespace);
+  const {
+    configMap,
+    error: scriptsError,
+    loaded: loadedScripts,
+    scripts,
+  } = usePlanCustomScripts(plan);
+
+  return (
+    <LoadingSuspend
+      obj={plan}
+      loaded={loadedPlan && loadedScripts}
+      loadError={planError ?? scriptsError}
+    >
+      <PageSection hasBodyWrapper={false} className="pf-v6-u-h-100">
+        <Flex direction={{ default: 'column' }}>
+          <ScriptsSection configMap={configMap} plan={plan} scripts={scripts} />
+        </Flex>
+      </PageSection>
+    </LoadingSuspend>
+  );
+};
+
+export default PlanAutomationPage;

src/plans/details/tabs/Automation/__tests__/ScriptsSection.test.tsx

@@ -0,0 +1,92 @@
+import { GuestType, ScriptType } from 'src/plans/create/steps/customization-scripts/constants';
+import type { CustomScript } from 'src/plans/create/steps/customization-scripts/types';
+
+import type { IoK8sApiCoreV1ConfigMap, V1beta1Plan } from '@forklift-ui/types';
+import { beforeEach, describe, expect, it } from '@jest/globals';
+import { render, screen } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+
+import ScriptsSection from '../components/ScriptsSection/ScriptsSection';
+
+const mockIsPlanEditable = jest.fn();
+jest.mock('src/plans/details/components/PlanStatus/utils/utils', () => ({
+  isPlanEditable: jest.fn((...args) => mockIsPlanEditable(...args)),
+}));
+
+const mockLaunchOverlay = jest.fn();
+jest.mock('@openshift-console/dynamic-plugin-sdk', () => ({
+  getGroupVersionKindForModel: jest.fn(() => ({ group: '', kind: 'ConfigMap', version: 'v1' })),
+  ResourceLink: ({ name }: { name: string }) => <span data-testid="resource-link">{name}</span>,
+  useOverlay: jest.fn(() => mockLaunchOverlay),
+}));
+
+const mockPlan = {
+  metadata: { name: 'test-plan', namespace: 'test-ns' },
+  spec: {},
+} as unknown as V1beta1Plan;
+
+const mockConfigMap = {
+  data: {},
+  metadata: { name: 'test-plan-scripts', namespace: 'test-ns' },
+} as unknown as IoK8sApiCoreV1ConfigMap;
+
+const mockScripts: CustomScript[] = [
+  {
+    content: '#!/bin/bash\necho hello',
+    guestType: GuestType.Linux,
+    name: 'setup-network',
+    scriptType: ScriptType.Firstboot,
+  },
+  {
+    content: 'Write-Host "cleanup complete"',
+    guestType: GuestType.Windows,
+    name: 'cleanup',
+    scriptType: ScriptType.Firstboot,
+  },
+];
+
+describe('ScriptsSection', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('shows "None" when no scripts are configured', () => {
+    render(<ScriptsSection configMap={undefined} plan={mockPlan} scripts={[]} />);
+
+    expect(screen.getByText('Customization scripts')).toBeInTheDocument();
+    expect(screen.getByText('None')).toBeInTheDocument();
+  });
+
+  it('displays script details when scripts exist', () => {
+    mockIsPlanEditable.mockReturnValue(true);
+
+    render(<ScriptsSection configMap={mockConfigMap} plan={mockPlan} scripts={mockScripts} />);
+
+    expect(screen.getByText('test-plan-scripts')).toBeInTheDocument();
+    expect(screen.getByText('setup-network')).toBeInTheDocument();
+    expect(screen.getByText('cleanup')).toBeInTheDocument();
+    expect(screen.getByText('Linux')).toBeInTheDocument();
+    expect(screen.getByText('Windows')).toBeInTheDocument();
+  });
+
+  it('shows edit button and launches overlay on click', async () => {
+    const user = userEvent.setup();
+    mockIsPlanEditable.mockReturnValue(true);
+
+    render(<ScriptsSection configMap={mockConfigMap} plan={mockPlan} scripts={mockScripts} />);
+
+    const editButton = screen.getByRole('button', { name: /edit/i });
+    await user.click(editButton);
+
+    expect(mockLaunchOverlay).toHaveBeenCalledTimes(1);
+  });
+
+  it('disables edit button when plan is not editable', () => {
+    mockIsPlanEditable.mockReturnValue(false);
+
+    render(<ScriptsSection configMap={mockConfigMap} plan={mockPlan} scripts={mockScripts} />);
+
+    const editButton = screen.getByRole('button', { name: /edit/i });
+    expect(editButton).toBeDisabled();
+  });
+});

src/plans/details/tabs/Automation/__tests__/parseConfigMapScripts.test.ts

@@ -0,0 +1,75 @@
+import { GuestType, ScriptType } from 'src/plans/create/steps/customization-scripts/constants';
+
+import { describe, expect, it } from '@jest/globals';
+
+import { parseConfigMapScripts } from '../utils/parseConfigMapScripts';
+
+describe('parseConfigMapScripts', () => {
+  it('parses a Linux firstboot script key', () => {
+    const data = { '99999_linux_firstboot_setup-network.sh': '#!/bin/bash\necho hello' };
+    const result = parseConfigMapScripts(data);
+
+    expect(result).toEqual([
+      {
+        content: '#!/bin/bash\necho hello',
+        guestType: GuestType.Linux,
+        name: 'setup-network',
+        scriptType: ScriptType.Firstboot,
+      },
+    ]);
+  });
+
+  it('parses a Windows firstboot script key', () => {
+    const data = { '99999_win_firstboot_cleanup.ps1': 'Write-Host "cleanup complete"' };
+    const result = parseConfigMapScripts(data);
+
+    expect(result).toEqual([
+      {
+        content: 'Write-Host "cleanup complete"',
+        guestType: GuestType.Windows,
+        name: 'cleanup',
+        scriptType: ScriptType.Firstboot,
+      },
+    ]);
+  });
+
+  it('parses a Linux run script key', () => {
+    const data = { '99999_linux_run_remove-tools.sh': 'yum remove open-vm-tools' };
+    const result = parseConfigMapScripts(data);
+
+    expect(result).toEqual([
+      {
+        content: 'yum remove open-vm-tools',
+        guestType: GuestType.Linux,
+        name: 'remove-tools',
+        scriptType: ScriptType.Run,
+      },
+    ]);
+  });
+
+  it('skips non-script keys', () => {
+    const data = {
+      '99999_linux_firstboot_setup.sh': 'echo setup',
+      'some-other-key': 'ignored',
+    };
+    const result = parseConfigMapScripts(data);
+
+    expect(result).toHaveLength(1);
+    expect(result[0].name).toBe('setup');
+  });
+
+  it('returns empty array for undefined data', () => {
+    expect(parseConfigMapScripts(undefined)).toEqual([]);
+  });
+
+  it('returns empty array for data with no script keys', () => {
+    expect(parseConfigMapScripts({ 'not-a-script': 'value' })).toEqual([]);
+  });
+
+  it('handles script names with underscores', () => {
+    const data = { '99999_linux_firstboot_setup_my_network.sh': 'echo hi' };
+    const result = parseConfigMapScripts(data);
+
+    expect(result[0].name).toBe('setup_my_network');
+  });
+});