fix feature tests

.github/dependabot.yml

@@ -25,3 +25,12 @@ updates:
       include: "scope"
     labels:
       - "dependencies"
+  - package-ecosystem: "npm"
+    directory: "/tests/cypress" # Cypress testing
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    labels:
+      - "dependencies"

.github/workflows/tests-feature.yml

@@ -1,7 +1,6 @@
 name: Feature tests
 
-on:
-  workflow_dispatch:
+on: push
 
 defaults:
   run:
@@ -14,41 +13,13 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v3
 
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2
-
-      - name: Build Dockerfile
-        id: build-client-image
-        uses: docker/build-push-action@v4
-        with:
-          builder: ${{ steps.buildx.outputs.name }}
-          cache-from: type=gha,scope=cal-itp
-          cache-to: type=gha,scope=cal-itp,mode=max
-          context: .
-          file: appcontainer/Dockerfile
-          push: false
-          load: true
-          tags: benefits_client:${{ github.sha }}
-
       - name: Start app
         run: |
-          docker run \
-            --detach \
-            --env-file tests/cypress/.env.tests \
-            -p 8000:8000 \
-            -v ${{ github.workspace }}/fixtures:/home/calitp/app/fixtures \
-            benefits_client:${{ github.sha }}
-
-      - name: Start server
-        run: |
-          docker run \
-            --detach \
-            -p 5000:5000 \
-            ghcr.io/cal-itp/eligibility-server:dev
+          touch .env
+          docker compose up --detach client server
 
       - name: Run feature tests
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v5
         env:
           CYPRESS_baseUrl: http://localhost:8000
         with:

benefits/core/migrations/0002_sample_data.py

@@ -1,6 +1,7 @@
 """Data migration which loads sample data.
 Set environment variable DJANGO_LOAD_SAMPLE_DATA to False to skip loading sample data.
 """
+import json
 import os
 
 from django.conf import settings
@@ -201,14 +202,19 @@ def load_sample_data(app, *args, **kwargs):
 
     TransitAgency = app.get_model("core", "TransitAgency")
 
+    # load the sample data from a JSON file so that it can be accessed by Cypress as well
+    sample_agency_data = os.path.join(os.path.dirname(__file__), "sample_agency.json")
+    with open(sample_agency_data) as f:
+        sample_agency = json.load(f)
+
     mst_agency = TransitAgency.objects.create(
-        slug="mst",
-        short_name=os.environ.get("MST_AGENCY_SHORT_NAME", "MST (sample)"),
-        long_name=os.environ.get("MST_AGENCY_LONG_NAME", "Monterey-Salinas Transit (sample)"),
-        agency_id="mst",
-        merchant_id="mst",
-        info_url="https://mst.org/benefits",
-        phone="888-678-2871",
+        slug=sample_agency["slug"],
+        short_name=os.environ.get("MST_AGENCY_SHORT_NAME", sample_agency["short_name"]),
+        long_name=os.environ.get("MST_AGENCY_LONG_NAME", sample_agency["long_name"]),
+        agency_id=sample_agency["agency_id"],
+        merchant_id=sample_agency["merchant_id"],
+        info_url=sample_agency["info_url"],
+        phone=sample_agency["phone"],
         active=True,
         private_key=client_private_key,
         public_key=client_public_key,

benefits/core/migrations/sample_agency.json

@@ -0,0 +1,9 @@
+{
+  "slug": "mst",
+  "short_name": "MST (sample)",
+  "long_name": "Monterey-Salinas Transit (sample)",
+  "agency_id": "mst",
+  "merchant_id": "mst",
+  "info_url": "https://mst.org/benefits",
+  "phone": "888-678-2871"
+}

benefits/settings.py

@@ -232,6 +232,7 @@ def _filter_empty(ls):
 ANALYTICS_KEY = os.environ.get("ANALYTICS_KEY")
 
 # rate limit configuration
+# these should match the values in rate-limit.cy.js
 
 # number of requests allowed in the given period
 RATE_LIMIT = int(os.environ.get("DJANGO_RATE_LIMIT", 5))

docs/tests/README.md

@@ -51,6 +51,8 @@ CYPRESS_baseUrl=http://localhost:8000 npm run cypress:open
 
 See `tests/cypress/package.json` for more cypress scripts.
 
+As of Cypress 12.5.1 with Firefox 109, there is a CSRF issue that prevents the tests from passing; unclear if this is a bug in Cypress or what. Use one of the other browser options.
+
 ## Pytest
 
 The tests done at a request/unit level are run via [pytest-django](https://pytest-django.readthedocs.io/en/latest/index.html).

tests/cypress/fixtures/README.md

@@ -0,0 +1 @@
+The [user data](users.json) corresponds to [the sample data for the eligibility server](https://github.com/cal-itp/eligibility-server/blob/dev/data/server.json).

tests/cypress/fixtures/transit-agencies.js

@@ -1,3 +1,4 @@
-const agencies = require("../../../fixtures/05_transitagency.json");
+const agency = require("../../../benefits/core/migrations/sample_agency.json");
+const agencies = [{ fields: agency }];
 
 export default agencies;

tests/cypress/fixtures/users.json

@@ -1,14 +1,10 @@
 {
   "eligible": {
-    "name": "Garcia",
-    "sub": "A1234567"
+    "name": "Gonzales",
+    "sub": "32587"
   },
   "ineligible": {
     "name": "Bob",
-    "sub": "A1234567"
-  },
-  "invalidSub": {
-    "name": "Garcia",
-    "sub": "A12347"
+    "sub": "12345"
   }
 }

tests/cypress/package.json

@@ -14,6 +14,6 @@
   "license": "AGPL-3.0-or-later",
   "private": true,
   "devDependencies": {
-    "cypress": "^10.9.0"
+    "cypress": "^12.5.1"
   }
 }

tests/cypress/specs/feature/eligibility.cy.js

@@ -1,49 +1,40 @@
 const agencies = require("../../fixtures/transit-agencies");
 const users = require("../../fixtures/users.json");
 
-const eligibility_url = "/eligibility/confirm";
-
 describe("Eligibility confirmation flow", () => {
   beforeEach(() => {
     cy.visit("/");
-    cy.contains(agencies[0].fields.short_name).click();
-    cy.contains("Get started").click();
+
+    // agency selection
+    cy.contains("Choose Your Provider").click();
+    cy.contains(agencies[0].fields.long_name).click();
+
+    // select Courtesy Card
+    // TODO find a more robust way to do this
+    cy.get('#form-verifier-selection [type="radio"]').check("2");
+    cy.get("#form-verifier-selection button[type='submit']").click();
     cy.contains("Continue").click();
   });
 
   it("Confirms an eligible user", () => {
     cy.get("#sub").type(users.eligible.sub);
     cy.get("#name").type(users.eligible.name);
-    cy.get("input[type='submit']").click();
+    cy.get("#form-eligibility-verification button[type='submit']").click();
 
-    cy.contains("Great! You’re eligible for a discount!");
+    cy.contains("Your eligibility is confirmed!");
   });
 
   it("Rejects an ineligible user", () => {
     cy.get("#sub").type(users.ineligible.sub);
     cy.get("#name").type(users.ineligible.name);
-    cy.get("input[type='submit']").click();
+    cy.get("#form-eligibility-verification button[type='submit']").click();
 
-    cy.contains("We can’t confirm your age");
-    cy.contains(
-      "You may still be eligible for a discount, but we can’t verify your age",
-    );
-  });
-
-  it("Validates an invalid number/id field", () => {
-    cy.get("#sub").type(users.invalidSub.sub);
-    cy.get("#name").type(users.invalidSub.name);
-    cy.get("input[type='submit']").click();
-
-    cy.contains("Check your input. The format looks wrong.");
-    cy.get("#id_sub").then(($e) => {
-      expect($e).to.have.css("border-color", "rgb(222, 12, 12)");
-    });
+    cy.contains("could not be verified");
   });
 
   it("Validates an empty name field", () => {
-    cy.get("#sub").type(users.invalidSub.sub);
-    cy.get("input[type='submit']").click();
+    cy.get("#sub").type(users.eligible.sub);
+    cy.get("#form-eligibility-verification button[type='submit']").click();
 
     cy.get("input:invalid").should("have.length", 1);
   });

tests/cypress/specs/feature/rate-limit.cy.js

@@ -4,17 +4,30 @@ const { eligibility_url, post_confirm } = require("../../plugins/eligibility");
 
 describe("Rate limiting feature spec", () => {
   beforeEach(() => {
-    cy.visit("/" + agencies[0].fields.slug);
-    cy.visit(eligibility_url);
+    cy.visit("/");
+
+    // agency selection
+    cy.contains("Choose Your Provider").click();
+    cy.contains(agencies[0].fields.long_name).click();
+
+    // select Courtesy Card
+    // TODO find a more robust way to do this
+    cy.get('#form-verifier-selection [type="radio"]').check("2");
+    cy.get("#form-verifier-selection button[type='submit']").click();
+    cy.contains("Continue").click();
   });
 
   it("Limits excess requests", () => {
-    const sub = users.invalidSub.sub;
-    const name = users.invalidSub.name;
+    const sub = users.ineligible.sub;
+    const name = users.ineligible.name;
 
     // start by making 5 times as many requests as allowed
-    const RATE_LIMIT = Cypress.env("DJANGO_RATE_LIMIT");
+    // these should match the defaults in settings.py
+    const RATE_LIMIT = 5;
     const N_REQUESTS = RATE_LIMIT * 5;
+    const RATE_LIMIT_PERIOD = 60;
+
+    const SUCCESS_STATUS = 302;
 
     // csrfmiddlewaretoken value needed to enable automated form submissions
     // there could be multiple forms on the page, so get() the one with the
@@ -25,11 +38,11 @@ describe("Rate limiting feature spec", () => {
       .then((csrfmiddlewaretoken) => {
         // make excess requests
         for (let i = 0; i < N_REQUESTS; i++) {
-          // continue on non-200 status codes to check response
+          // continue on non-successful status codes to check response
           post_confirm(csrfmiddlewaretoken, sub, name, false).then((res) => {
             if (i < RATE_LIMIT) {
               // allow up to API_RATE_LIMIT requests
-              expect(res.status).to.eq(200);
+              expect(res.status).to.eq(SUCCESS_STATUS);
             } else {
               // we've gone beyond API_RATE_LIMIT
               expect(res.status).to.eq(400);
@@ -38,17 +51,14 @@ describe("Rate limiting feature spec", () => {
         }
 
         // now wait for the rate limit to refresh
-        const RATE_LIMIT_PERIOD = parseInt(
-          Cypress.env("DJANGO_RATE_LIMIT_PERIOD"),
-        );
         // Cypress expects milliseconds, the rate limit period is expressed in seconds
         cy.wait(RATE_LIMIT_PERIOD * 1000);
 
         // and try again with a reasonable number of requests
         for (let i = 0; i < RATE_LIMIT - 1; i++) {
           post_confirm(csrfmiddlewaretoken, sub, name, true).then((res) => {
             // these requests should all succeed
-            expect(res.status).to.eq(200);
+            expect(res.status).to.eq(SUCCESS_STATUS);
           });
         }
       });