feat(Cypress): Add response handler for Connector Testing #4624

Sakilmostak · 2024-05-10T13:25:53Z

Type of Change

Description

For testing scenarios, response were hardcoded rather than being specific to the connectors and their flows. This resulted in panic when multiple cases arrives for a same flow. This have been removed by adding configs specific to connectors to test them.

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

How did you test it?

Tested through Cypress

Stripe

Cybersource

Bankofamerica

Adyen

Paypal

Bluesnap

Note: Paypal,Bluesnap 3ds is not handled so the tests are failing. Adyen has status issue that we will handle it in different PR.

Checklist

I formatted the code cargo +nightly fmt --all
I addressed lints thrown by cargo clippy
I reviewed the submitted code
I added unit tests for my changes where possible

prasunna09 · 2024-05-20T07:45:17Z

cypress-tests/cypress/support/commands.js

    body: requestBody,
  }).then((response) => {
    logRequestId(response.headers['x-request-id']);
-
+    console.log(response);


remove the logs.

prasunna09 · 2024-05-20T07:52:22Z

cypress-tests/cypress/support/commands.js

-      } else {
+        for(const key in res_data.body) {
+          expect(res_data.body[key]).to.equal(response.body[key]);
+        }      } else {


could you format this?

this will be linted by the corresponding PR raised by @pixincreate

prasunna09 · 2024-05-20T07:55:41Z

cypress-tests/cypress/support/commands.js

    body: requestBody,
  }).then((response) => {
    logRequestId(response.headers['x-request-id']);
-
+    console.log(response);


remove this log

prasunna09 · 2024-05-20T07:55:54Z

cypress-tests/cypress/support/commands.js

  }).then((response) => {
    logRequestId(response.headers['x-request-id']);
-
+    console.log(response);


remove this log

prasunna09 · 2024-05-20T07:56:19Z

cypress-tests/cypress/support/commands.js

    body: requestBody
  }).then((response) => {
    logRequestId(response.headers['x-request-id']);
-
+    console.log(response);


here. logs are for debug purpose, lets not have them in the framework

prasunna09 · 2024-05-20T07:57:57Z

cypress-tests/cypress/support/commands.js

    body: confirmBody,
  }).then((response) => {
    logRequestId(response.headers['x-request-id']);
    console.log(response);
+
+    expect(res_data.status).to.equal(response.status);
    expect(response.headers["content-type"]).to.include("application/json");
    globalState.set("paymentID", paymentIntentID);
    if (response.body.capture_method === "automatic") {


could you check on status code whether it is 2xx or 4xx, instead of checking response fields?

the status is being picked based on flow and connector from the configs, if it will always expect the respective http code for the test

yes, that is correct but here, can we have if condition on status 2xx, and 4xx for better readability

could you resolve this comment?

prasunna09 · 2024-05-20T08:17:58Z

cypress-tests/cypress/support/commands.js

    expect(request.amount).to.equal(response.body.amount);
    expect(null).to.equal(response.body.amount_received);
    expect(request.amount).to.equal(response.body.amount_capturable);


@Sakilmostak aren't we expecting all assertions from connector config?

as we discussed, revert this change, we have to combine all such common assertions into one file and for every test case, we should execute these assertions

prasunna09 · 2024-05-20T17:42:02Z

cypress-tests/cypress/e2e/ConnectorTest/00004-ThreeDSAutoCapture.cy.js

+});
+
+function should_continue_further(res_data) {


this function is repetitive, can we have this in utils.js?!?

prasunna09 · 2024-05-20T17:42:28Z

cypress-tests/cypress/e2e/ConnectorTest/00005-NoThreeDSManualCapture.cy.js

+                let data = getConnectorDetails(globalState.get("connectorId"))["card_pm"]["No3DSManualCapture"];
+                let req_data = data["Request"];
+                let res_data = data["Response"];
+                console.log("det -> " + data.card);


remove the logs.

prasunna09 · 2024-05-20T17:42:38Z

cypress-tests/cypress/e2e/ConnectorTest/00005-NoThreeDSManualCapture.cy.js

+                let data = getConnectorDetails(globalState.get("connectorId"))["card_pm"]["Capture"];
+                let req_data = data["Request"];
+                let res_data = data["Response"];
+                console.log("det -> " + data.card);


prasunna09 · 2024-05-20T17:42:49Z

cypress-tests/cypress/e2e/ConnectorTest/00005-NoThreeDSManualCapture.cy.js

+                let data = getConnectorDetails(globalState.get("connectorId"))["card_pm"]["No3DSManualCapture"];
+                let req_data = data["Request"];
+                let res_data = data["Response"];
+                console.log("det -> " + data.card);


prasunna09 · 2024-05-20T17:42:57Z

cypress-tests/cypress/e2e/ConnectorTest/00005-NoThreeDSManualCapture.cy.js

+                let data = getConnectorDetails(globalState.get("connectorId"))["card_pm"]["Capture"];
+                let req_data = data["Request"];
+                let res_data = data["Response"];
+                console.log("det -> " + data.card);


@prasunna09, You added these log lines, and they are present in all your initial commits. Removing them will take a significant amount of time. We'll address this issue later. For now, could you please approve this so we can proceed with the other changes? We are currently blocked by this.

yes, this can be taken up in separate pr

prasunna09 · 2024-05-20T18:11:19Z

cypress-tests/cypress/support/commands.js

+    if(response.status === "200"){
+
+    }


prasunna09 · 2024-05-20T18:11:45Z

cypress-tests/cypress/support/commands.js

+    if(response.status === "200"){
+      globalState.set("clientSecret", clientSecret);
+      globalState.set("paymentID", response.body.payment_id);
+      cy.log(clientSecret);


remove this log if not needed

prasunna09 · 2024-05-20T18:13:23Z

cypress-tests/cypress/support/commands.js

    body: confirmBody,
  }).then((response) => {
    logRequestId(response.headers['x-request-id']);
    console.log(response);
+
+    expect(res_data.status).to.equal(response.status);
    expect(response.headers["content-type"]).to.include("application/json");
    globalState.set("paymentID", paymentIntentID);
    if (response.body.capture_method === "automatic") {


could you resolve this comment?

prasunna09 · 2024-05-20T18:18:41Z

cypress-tests/cypress/support/commands.js

-    expect(response.body.amount).to.equal(refund_amount);
-    expect(response.body.payment_id).to.equal(payment_id);
+
+    if(response.body.status !== undefined) {


why are we having this condition? instead we could have response.body.status === "success" | "pending" right?

status was being used to check whether the response was for 2xx, checking specifically for success and pending status would fail for 2xx which failed

it has been update to check based on http code

prasunna09 · 2024-05-20T18:24:50Z

cypress-tests/cypress/support/commands.js

    expect(response.headers["content-type"]).to.include("application/json");
-    expect(response.body).to.have.property("mandate_id");
    globalState.set("mandateId", response.body.mandate_id);
    globalState.set("paymentID", response.body.payment_id);

    if (response.body.capture_method === "automatic") {


same here. can we have if statement with http status 2xx or 4xx condition for better readability

prasunna09 · 2024-05-21T08:19:40Z

cypress-tests/cypress/e2e/ConnectorTest/00005-NoThreeDSManualCapture.cy.js

+                let data = getConnectorDetails(globalState.get("connectorId"))["card_pm"]["Capture"];
+                let req_data = data["Request"];
+                let res_data = data["Response"];
+                console.log("det -> " + data.card);


yes, this can be taken up in separate pr

prasunna09 · 2024-05-21T08:20:19Z

cypress-tests/cypress/e2e/ConnectorTest/00006-VoidPayment.cy.js

+            let req_data = data["Request"];
+            let res_data = data["Response"];
+            cy.createPaymentIntentTest(createPaymentBody, req_data, res_data, "no_three_ds", "manual", globalState);
+            if(should_continue) should_continue = utils.hould_continue_further(res_data);


Suggested change

if(should_continue) should_continue = utils.hould_continue_further(res_data);

if(should_continue) should_continue = utils.should_continue_further(res_data);

prasunna09 · 2024-05-21T08:20:58Z

cypress-tests/cypress/fixtures/create-confirm-body.json

@@ -1,10 +1,10 @@
 {
-  "amount": 6540,
+  "amount": 6500,


prasunna09 · 2024-05-21T08:23:41Z

cypress-tests/cypress/support/commands.js

-    // expect(response.body.amount_capturable).to.equal(0);
-    expect(response.body.amount_received).to.be.oneOf([0, null]);
-    expect(response.body.status).to.equal("cancelled");
+    if(response.body.payment_id !== undefined) {


why are we have a condition on payment_id? why not on status code?

it has been converted to status code

Sakilmostak added 7 commits May 8, 2024 18:00

feat: make response connector specific

c88ed07

refactor: non-3ds flow with auto capture

f67d1de

refactor: non 3ds with manual capture

ad68c27

Merge branch 'main' into cypress_framework_enhancement

46a2801

feat: refactor flows for void, sync and refund

6a8d4c7

refactor: flow for sync refund, single , multiple and revoke mandate

f2224e8

refactor: flow for save card, manual capture and zero auth mandate

d8951f4

Sakilmostak added C-feature Category: Feature request or enhancement C-test Category: Tests labels May 10, 2024

Sakilmostak self-assigned this May 10, 2024

Sakilmostak requested a review from a team as a code owner May 10, 2024 13:25

Sakilmostak and others added 5 commits May 14, 2024 14:58

Merge branch 'main' into cypress_framework_enhancement

0fa132a

feat: handle breaking of flow in failure cases

02ed37b

Merge branch 'main' into cypress_framework_enhancement

f431bd9

refactor: flows for mandates

53dd322

Resolved conflicts

c1d894e

Gnanasundari24 requested review from a team as code owners May 16, 2024 08:19

Handling 2xx 4xx for all connectors

f4e21fa

Sakilmostak removed the request for review from a team May 20, 2024 06:53

prasunna09 requested changes May 20, 2024

View reviewed changes

Sakilmostak added 3 commits May 20, 2024 17:30

refactor: comments

ef8e599

Merge branch 'main' into cypress_framework_enhancement

9815bc9

refactor: comments

566444b

prasunna09 requested changes May 20, 2024

View reviewed changes

refactor: resolve comments

288ff77

prasunna09 requested changes May 21, 2024

View reviewed changes

Sakilmostak added 2 commits May 21, 2024 13:54

refactor: spell check

ca93089

refactor: resolve comments

271bcf8

prasunna09 approved these changes May 21, 2024

View reviewed changes

Gnanasundari24 approved these changes May 21, 2024

View reviewed changes

SamraatBansal approved these changes May 21, 2024

View reviewed changes

Gnanasundari24 enabled auto-merge May 21, 2024 10:08

Gnanasundari24 added this pull request to the merge queue May 21, 2024

Merged via the queue into main with commit 2e79ee0 May 21, 2024
10 checks passed

Gnanasundari24 deleted the cypress_framework_enhancement branch May 21, 2024 10:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(Cypress): Add response handler for Connector Testing #4624

feat(Cypress): Add response handler for Connector Testing #4624

Sakilmostak commented May 10, 2024 •

edited by Gnanasundari24

prasunna09 May 20, 2024

prasunna09 May 20, 2024

Sakilmostak May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

Sakilmostak May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

Gnanasundari24 May 21, 2024

prasunna09 May 21, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

prasunna09 May 20, 2024

Sakilmostak May 21, 2024

Sakilmostak May 21, 2024

prasunna09 May 20, 2024

prasunna09 May 21, 2024

prasunna09 May 21, 2024

prasunna09 May 21, 2024

prasunna09 May 21, 2024

Sakilmostak May 21, 2024

	if(should_continue) should_continue = utils.hould_continue_further(res_data);
	if(should_continue) should_continue = utils.should_continue_further(res_data);

feat(Cypress): Add response handler for Connector Testing #4624

feat(Cypress): Add response handler for Connector Testing #4624

Conversation

Sakilmostak commented May 10, 2024 • edited by Gnanasundari24

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sakilmostak commented May 10, 2024 •

edited by Gnanasundari24