Update test suite to use transitionProject mutation

Author: CarsonF

test/engagement-changeset-aware.e2e-spec.ts

@@ -2,7 +2,6 @@ import { CalendarDate, ID, Role } from '~/common';
 import { EngagementStatus } from '../src/components/engagement/dto';
 import { Language } from '../src/components/language/dto';
 import { ProjectChangeRequestType } from '../src/components/project-change-request/dto';
-import { ProjectStep } from '../src/components/project/dto';
 import {
   approveProjectChangeRequest,
   createFundingAccount,
@@ -22,10 +21,7 @@ import {
   updateProject,
 } from './utility';
 import { fragments } from './utility/fragments';
-import {
-  changeProjectStep,
-  stepsFromEarlyConversationToBeforeActive,
-} from './utility/transition-project';
+import { forceProjectTo } from './utility/transition-project';
 
 const readEngagements = (app: TestApp, id: string, changeset?: string) =>
   app.graphql.query(
@@ -135,14 +131,7 @@ const activeProject = async (app: TestApp, projectId: ID) => {
     primaryLocationId: location.id,
     fieldRegionId: region.id,
   });
-  await runAsAdmin(app, async () => {
-    for (const next of [
-      ...stepsFromEarlyConversationToBeforeActive,
-      ProjectStep.Active,
-    ]) {
-      await changeProjectStep(app, projectId, next);
-    }
-  });
+  await forceProjectTo(app, projectId, 'Active');
 };
 
 describe('Engagement Changeset Aware e2e', () => {

test/engagement.e2e-spec.ts

@@ -14,11 +14,9 @@ import { Location } from '../src/components/location/dto';
 import { ProductMethodology } from '../src/components/product/dto';
 import {
   Project,
-  ProjectStatus,
   ProjectStep,
   ProjectType,
 } from '../src/components/project/dto';
-import { ProjectWorkflowTransition } from '../src/components/project/workflow/dto';
 import { User } from '../src/components/user/dto';
 import {
   createDirectProduct,
@@ -50,9 +48,10 @@ import {
 } from './utility/transition-engagement';
 import {
   changeProjectStep,
+  forceProjectTo,
+  getProjectTransitions,
   stepsFromEarlyConversationToBeforeActive,
-  stepsFromEarlyConversationToBeforeCompleted,
-  stepsFromEarlyConversationToBeforeTerminated,
+  transitionProject,
 } from './utility/transition-project';
 
 describe('Engagement e2e', () => {
@@ -1006,7 +1005,7 @@ describe('Engagement e2e', () => {
     );
   });
 
-  it('should not enable a Project step transition if the step is FinalizingCompletion and there are Engagements with non-terminal statuses', async () => {
+  it('Projects cannot be completed with engagements not finalizing or terminal', async () => {
     const location = await runAsAdmin(app, async () => {
       const fundingAccount = await createFundingAccount(app);
       const location = await createLocation(app, {
@@ -1022,91 +1021,75 @@ describe('Engagement e2e', () => {
       projectId: project.id,
     });
 
+    // Change the project & engagement to FinalizingCompletion
+    await forceProjectTo(app, project.id, 'FinalizingCompletion');
+
+    // Add another engagement not FinalizingCompletion
     await runAsAdmin(app, async () => {
-      for (const next of stepsFromEarlyConversationToBeforeCompleted) {
-        await changeProjectStep(app, project.id, next);
-      }
-      /**
-       * https://github.com/SeedCompany/cord-api-v3/issues/2526
-       * Need to another non-terminal Engagement (Not FinalizingCompletion)
-       */
       await createLanguageEngagement(app, {
         projectId: project.id,
       });
-      const projectQueryResult = await app.graphql.query(
-        gql`
-          query project($id: ID!) {
-            project(id: $id) {
-              id
-              step {
-                value
-                transitions {
-                  to
-                  disabled
-                  disabledReason
-                }
-              }
-            }
-          }
-        `,
-        {
-          id: project.id,
-        },
-      );
+    });
 
-      const toCompletedTransition =
-        projectQueryResult.project.step.transitions.find(
-          (t: ProjectWorkflowTransition) => t.to === 'Completed',
-        );
+    // Read available transitions
+    const {
+      step: { transitions },
+    } = await getProjectTransitions(app, project.id);
 
-      expect(projectQueryResult.project.step.value).toBe(
-        ProjectStep.FinalizingCompletion,
-      );
-      expect(toCompletedTransition.disabled).toBe(true);
-      expect(toCompletedTransition.disabledReason).toBe(
-        'The project cannot be completed since some ongoing engagements are not "Finalizing Completion"',
-      );
-    });
+    const toCompletedTransition = transitions.find((t) => t.to === 'Completed');
 
-    // can't complete a project if you're not an admin and transition is disabled because of non terminal engagements
-    await app.graphql
-      .mutate(
-        gql`
-          mutation updateProject($id: ID!, $step: ProjectStep) {
-            updateProject(input: { project: { id: $id, step: $step } }) {
-              project {
-                id
-                engagements {
-                  items {
-                    id
-                    status {
-                      value
-                    }
-                  }
-                }
-              }
-            }
-          }
-        `,
-        {
-          id: project.id,
-          step: ProjectStep.Completed,
-        },
-      )
-      .expectError();
+    expect(toCompletedTransition?.disabled).toBe(true);
+    expect(toCompletedTransition?.disabledReason).toBe(
+      'The project cannot be completed since some ongoing engagements are not "Finalizing Completion"',
+    );
+
+    await expect(
+      transitionProject(app, {
+        project: project.id,
+        transition: toCompletedTransition?.key,
+      }),
+    ).rejects.toThrowGqlError(
+      errors.unauthorized({
+        message: 'This transition is not available',
+      }),
+    );
   });
 
   it.each([
-    [EngagementStatus.Active, stepsFromEarlyConversationToBeforeActive],
-    [EngagementStatus.DidNotDevelop, []],
-    [EngagementStatus.Rejected, stepsFromEarlyConversationToBeforeActive],
-    [EngagementStatus.Terminated, stepsFromEarlyConversationToBeforeTerminated],
+    [
+      ProjectStep.PendingFinanceConfirmation,
+      ProjectStep.Active,
+      EngagementStatus.Active,
+    ],
+    [
+      ProjectStep.EarlyConversations,
+      ProjectStep.DidNotDevelop,
+      EngagementStatus.DidNotDevelop,
+    ],
+    [
+      ProjectStep.PendingFinanceConfirmation,
+      ProjectStep.Rejected,
+      EngagementStatus.Rejected,
+    ],
+    [
+      ProjectStep.PendingTerminationApproval,
+      ProjectStep.Terminated,
+      EngagementStatus.Terminated,
+    ],
     // this only happens when an admin overrides to completed
     // this is prohibited if there are non terminal engagements
-    [EngagementStatus.Completed, stepsFromEarlyConversationToBeforeCompleted],
+    [
+      ProjectStep.FinalizingCompletion,
+      ProjectStep.Completed,
+      EngagementStatus.Completed,
+    ],
   ])(
     'should update Engagement status to match Project step when it becomes %s',
-    async (newStatus: EngagementStatus, steps: ProjectStep[] | []) => {
+    async (
+      currentStepSetup: ProjectStep,
+      nextStep: ProjectStep,
+      expectedNewStatus: EngagementStatus,
+    ) => {
       const location = await runAsAdmin(app, async () => {
         const fundingAccount = await createFundingAccount(app);
         const location = await createLocation(app, {
@@ -1117,48 +1100,49 @@ describe('Engagement e2e', () => {
       const project = await createProject(app, {
         primaryLocationId: location.id,
       });
-      expect(project.status).toBe(ProjectStatus.InDevelopment);
-
       const engagement = await createLanguageEngagement(app, {
         projectId: project.id,
       });
-      expect(engagement.status.value === EngagementStatus.InDevelopment).toBe(
-        true,
-      );
+      const {
+        step: { transitions },
+      } = await forceProjectTo(app, project.id, currentStepSetup);
+
+      // ignoring proper transition permissions
       await runAsAdmin(app, async () => {
-        for (const next of steps) {
-          await changeProjectStep(app, project.id, next);
-        }
+        const transition = transitions.find((t) => t.to === nextStep);
+        await transitionProject(app, {
+          project: project.id,
+          transition: transition?.key,
+        });
+      });
 
-        const result = await app.graphql.mutate(
-          gql`
-            mutation updateProject($id: ID!, $step: ProjectStep) {
-              updateProject(input: { project: { id: $id, step: $step } }) {
-                project {
+      const {
+        project: { engagements },
+      } = await app.graphql.query(
+        gql`
+          query ($id: ID!) {
+            project(id: $id) {
+              id
+              engagements {
+                items {
                   id
-                  engagements {
-                    items {
-                      id
-                      status {
-                        value
-                      }
-                    }
+                  status {
+                    value
                   }
                 }
               }
             }
-          `,
-          {
-            id: project.id,
-            step: newStatus,
-          },
-        );
-
-        const actual = result.updateProject.project.engagements.items.find(
-          (e: { id: ID }) => e.id === engagement.id,
-        );
-        expect(actual.status.value).toBe(EngagementStatus[newStatus]);
-      });
+          }
+        `,
+        {
+          id: project.id,
+          step: expectedNewStatus,
+        },
+      );
+      const actual = engagements.items.find(
+        (e: { id: ID }) => e.id === engagement.id,
+      );
+      expect(actual.status.value).toBe(expectedNewStatus);
     },
   );
 

test/language-changeset-aware.e2e-spec.ts

@@ -15,7 +15,7 @@ import {
   TestApp,
 } from './utility';
 import { fragments } from './utility/fragments';
-import { transitionNewProjectToActive } from './utility/transition-project';
+import { forceProjectTo } from './utility/transition-project';
 
 const readLanguage = (app: TestApp, id: string, changeset?: string) =>
   app.graphql.query(
@@ -44,7 +44,7 @@ const activeProject = async (app: TestApp) => {
     primaryLocationId: location.id,
     fieldRegionId: fieldRegion.id,
   });
-  await transitionNewProjectToActive(app, project);
+  await forceProjectTo(app, project.id, 'Active');
 
   return project;
 };

test/partnership-changeset-aware.e2e-spec.ts

@@ -17,7 +17,7 @@ import {
   TestApp,
 } from './utility';
 import { fragments } from './utility/fragments';
-import { transitionNewProjectToActive } from './utility/transition-project';
+import { forceProjectTo } from './utility/transition-project';
 
 const readPartnerships = (app: TestApp, id: string, changeset?: string) =>
   app.graphql.query(
@@ -71,9 +71,7 @@ const activeProject = async (app: TestApp) => {
     primaryLocationId: location.id,
     fieldRegionId: fieldRegion.id,
   });
-  await runAsAdmin(app, async () => {
-    await transitionNewProjectToActive(app, project);
-  });
+  await forceProjectTo(app, project.id, 'Active');
 
   return project;
 };

test/project-workflow.e2e-spec.ts

@@ -69,10 +69,6 @@ describe('Project-Workflow e2e', () => {
   it('should have project step', async () => {
     const project = await createProject(app);
     expect(project.step.value).toBe(ProjectStep.EarlyConversations);
-  });
-
-  it('should have project status', async () => {
-    const project = await createProject(app);
     expect(project.status).toBe(ProjectStatus.InDevelopment);
   });