Resources reference guide for Cypress

This is a comprehensive guide of active Cypress-related resources.

The following helpers and mocks are currently used within Cypress tests on vets-frontend. In addition to their directories, the purpose, an import method, and a reference of the function is supplied.

Cypress & VAOS helpers

Custom helpers are reusable components for commonly needed test situations, like loading custom data, profiles, or appointments. Below is a list of helpers currently written along with import methods, purpose, and a reference guide.

Consider writing a reusable helper when an action is needed to perform certain tests. They are located in src/applications/gi/tests/e2e/cypress-helpers.js and src/applications/vaos/tests/e2e/vaos-cypress-helpers.js.

General

initApplicationMock

Import: import { initApplicationMock } from './cypress-helpers'

Purpose: Sets up search results and a profile. Calling this also loads calculator_constants.

Reference:

export const initApplicationMock = (
  profile = institutionProfile,
  results = searchResults
) => {
  cy.route('GET', '/v0/gi/institutions/autocomplete**', autocomplete).as(
    'defaultAutocomplete'
  );
  cy.route('GET', '/v0/gi/institutions/search**', results).as('defaultSearch');

  initMockProfile(profile);
};

CODE

initAppointmentListMock

Import: import { initAppointmentListMock, createPastVAAppointments, } from './vaos-cypress-helpers'

Purpose: Sets up appointments with confirmed VA & CC dates, a cancellation, and appointment request message.

Reference:

export function initAppointmentListMock() {
  cy.server();
  cy.login();
  mockFeatureToggles();
  mockSupportedSites();

  cy.route({
    method: 'GET',
    url: '/vaos/v0/appointment_requests*',
    response: updateRequestDates(requests),
  });

  cy.route({
    method: 'GET',
    url: /.*\/v0\/appointments.*type=va$/,
    response: updateConfirmedVADates(confirmedVA),
  });

  cy.route({
    method: 'GET',
    url: /.*\/v0\/appointments.*type=cc$/,
    response: updateConfirmedCCDates(confirmedCC),
  });

  cy.route({
    method: 'GET',
    url: '/vaos/v0/facilities/983/cancel_reasons',
    response: cancelReasons,
  });

  cy.route({
    method: 'PUT',
    url: '/vaos/v0/appointments/cancel',
    response: '',
  });

  cy.route({
    method: 'GET',
    url:
      '/vaos/v0/appointment_requests/8a48912a6cab0202016cb4fcaa8b0038/messages',
    response: {
      data: [
        {
          id: '8a48912a6cab0202016cb4fcaa8b0038',
          type: 'messages',
          attributes: {
            surrogateIdentifier: {},
            messageText: 'Request 2 Message 1 Text',
            messageDateTime: '11/11/2019 12:26:13',
            senderId: '1012845331V153043',
            appointmentRequestId: '8a48912a6cab0202016cb4fcaa8b0038',
            date: '2019-11-11T12:26:13.931+0000',
            assigningAuthority: 'ICN',
            systemId: 'var',
          },
        },
      ],
    },
  });
}

CODE

createPastVAAppointments

Import: import { initAppointmentListMock, createPastVAAppointments, } from './vaos-cypress-helpers'

Purpose: Creates two appointments, one three days ago and another four months ago.

Reference:

export function createPastVAAppointments() {
  const appointments = [];
  let appointment = getVAAppointmentMock();
  appointment.attributes = {
    ...appointment.attributes,
    startDate: moment().add(-3, 'days').format(),
    clinicFriendlyName: 'Three day clinic name',
    facilityId: '983',
    sta6aid: '983GC',
  };
  appointment.attributes.vdsAppointments[0].currentStatus = 'CHECKED OUT';
  appointments.push(appointment);

  appointment = getVAAppointmentMock();
  appointment.attributes = {
    ...appointment.attributes,
    startDate: moment().add(-4, 'months').format(),
    clinicFriendlyName: 'Four month clinic name',
    facilityId: '983',
    sta6aid: '983GC',
  };
  appointment.attributes.vdsAppointments[0].currentStatus = 'CHECKED OUT';
  appointments.push(appointment);

  return {
    data: appointments,
  };
}

CODE

initCommunityCareMock

Import: import { initCommunityCareMock } from './vaos-cypress-helpers';

Purpose: Load scheduling mocks, pull up confirmed appointment dates, make sample POST requests for appointments and associated messages.

Reference:

export function initCommunityCareMock() {
  setupSchedulingMocks();

  cy.route({
    method: 'GET',
    url: '/vaos/v0/appointments?start_date=*&end_date=*&type=va',
    response: updateConfirmedVADates(confirmedVA),
  });

  cy.route({
    method: 'POST',
    url: '/vaos/v0/appointment_requests?type=*',
    response: {
      data: {
        id: 'testing',
        attributes: {},
      },
    },
  });

  cy.route({
    method: 'POST',
    url: '/vaos/v0/appointment_requests/testing/messages',
    response: [],
  });
}

CODE

initExpressCareMocks

Import: import { initExpressCareMocks } from './vaos-cypress-helpers';

Purpose: Submits a request with datetime info to a VA facility for an appointment.

Reference:

export function initExpressCareMocks() {
  const today = moment();
  initAppointmentListMock();

  cy.route({
    method: 'GET',
    url: '/vaos/v0/request_eligibility_criteria*',
    response: {
      data: getExpressCareRequestCriteriaMock('983', [
        {
          day: today.clone().tz('America/Denver').format('dddd').toUpperCase(),
          canSchedule: true,
          startTime: today
            .clone()
            .subtract('2', 'minutes')
            .tz('America/Denver')
            .format('HH:mm'),
          endTime: today
            .clone()
            .add('2', 'minutes')
            .tz('America/Denver')
            .format('HH:mm'),
        },
      ]),
    },
  }).as('getRequestEligibilityCriteria');

  mockRequestLimits();

  cy.route({
    method: 'GET',
    url: '/vaos/v0/facilities?facility_codes[]=983',
    response: {
      data: [
        {
          id: '983',
          attributes: {
            ...getParentSiteMock().attributes,
            institutionCode: '983',
            authoritativeName: 'Some VA facility',
            rootStationCode: '983',
            parentStationCode: '983',
          },
        },
      ],
    },
  });

  cy.route({
    method: 'POST',
    url: '/vaos/v0/appointment_requests?type=va',
    response: {
      data: {
        id: 'testing',
        attributes: {
          typeOfCareId: 'CR1',
          email: 'test@va.gov',
          phoneNumber: '5555555555',
          reasonForVisit: 'Cough',
          additionalInformation: 'Whatever',
          status: 'Submitted',
        },
      },
    },
  });
}

CODE

initVAAppointmentMock

Import: import { initVAAppointmentMock } from './vaos-cypress-helpers';

Purpose: A full-fledged helper to mock primary care eligibility, facilities, clinics; request limiting; duration of visits; appointment slots; and submitting an appointment.

Reference:

export function initVAAppointmentMock() {
  setupSchedulingMocks();
  mockRequestLimits();
  mockVisits();
  mockDirectScheduleSlots();
  mockSubmitVAAppointment();
}

CODE

Appointment helpers

Imports: Appointment helpers are typically imported altogether as the parent package using import * as newApptTests from './vaos-cypress-schedule-appointment-helpers'; then invoked according to the function name, i.e. newApptTests.chooseTypeOfCareTest(param);.

chooseTypeOfCareTest

Purpose: Sets a type of care test via passing a param, i.e. 'Primary care', 'Sleep medicine', 'Eye care'.

Reference:

export function chooseTypeOfCareTest(label) {
  cy.url().should('include', '/new-appointment');
  cy.axeCheck();
  cy.findByLabelText(label).click();
  cy.findByText(/Continue/).click();
}

CODE

chooseVAFacilityTest

Purpose: Sets a VA facility by default to Cheyenne, WY.

Reference:

export function chooseVAFacilityTest() {
  cy.url().should('include', '/va-facility');
  cy.axeCheck();
  cy.findByLabelText(/CHYSHR/).click();
  cy.findByLabelText(
    'CHYSHR-Cheyenne VA Medical Center (Cheyenne, WY)'
  ).click();
  cy.findByText(/Continue/).click();
}

CODE

chooseClinicTest

Purpose: Sets a clinic to 'CHY PC CASSIDY'

Reference:

export function chooseClinicTest() {
  cy.url().should('include', '/clinics');
  cy.axeCheck();
  cy.findByLabelText('CHY PC CASSIDY').click();
  cy.findByText(/Continue/).click();
}

CODE

choosePreferredDateTest

Purpose: Sets a preferred date to 4 days from now.

Reference:

export function choosePreferredDateTest() {
  cy.url().should('include', '/preferred-date');
  cy.axeCheck();

  const preferredDate = today.add(4, 'days');

  cy.findByLabelText('Month').select(preferredDate.format('MMM'));
  cy.findByLabelText('Day').select(preferredDate.format('D'));
  cy.findByLabelText('Year').type(preferredDate.format('YYYY'));
  cy.findByText(/Continue/).click();
}

CODE

selectTimeSlotTest

Purpose: Selects a timeslot from calendar component.

Reference:

export function selectTimeSlotTest() {
  cy.url().should('include', '/select-date');
  cy.get(
    '.vaos-calendar__calendars button[id^="date-cell"]:not([disabled])'
  ).click();
  cy.get(
    '.vaos-calendar__day--current .vaos-calendar__options input[id$="_0"]'
  ).click();
  cy.axeCheck();
  cy.findByText(/Continue/).click();
}

CODE

reasonForAppointmentTest

Purpose: Chooses a reason for an appointment, using 'Routine or follow-up visit'.

Reference:

export function reasonForAppointmentTest(l) {
  cy.url().should('include', '/reason-appointment');
  cy.axeCheck();
  cy.findByLabelText('Routine or follow-up visit').click();
  cy.findByLabelText(/Please provide any additional details/).type(l);
  cy.findByText(/Continue/).click();
}

CODE

contactInfoTest <a name="contact-info-test>

Purpose: Sets preferred contact to morning.

Reference:

export function contactInfoTest() {
  cy.url().should('include', '/contact-info');
  cy.axeCheck();
  cy.findByLabelText(/Morning/).click();
  cy.findByText(/Continue/).click();
}

CODE

reviewTest

Purpose: Checks to confirm appointment.

Reference:

export function reviewTest() {
  cy.url().should('include', '/review');
  cy.axeCheck();
  cy.findByText('Confirm appointment').click();
}

CODE

confirmationPageTest

Purpose: Confirms proper appointment scheduling response.

Reference:

export function confirmationPageTest(additionalInfo) {
  cy.findByText('Your appointment has been scheduled');
  cy.findByText('VA Appointment');
  cy.findByText('Follow-up/Routine');
  cy.findByText(additionalInfo);
}

CODE

Mocks

Many Cypress test and helpers are dependent on JSON data located within the /services/mocks directory. The following provides context to mocks used in various Cypress testing.