test: [M3-8433] - Cypress integration test for Object Storage Gen2: E1 Endpoint #10907

jaalah-akamai · 2024-09-09T16:13:59Z

Changes 🔄

New Integration Test for Object Storage Gen2: E1 Endpoint - Bucket Creation

Target release date 🗓️

N/A

How to test 🧪

yarn cy:run -s "cypress/e2e/core/objectStorageGen2/bucket-create-gen2.spec.ts"

Requirements:

Visiting /object-storage/buckets/create causes "Create Bucket" drawer to open
Users can select "E1" endpoint type for regions that support E1 endpoint types
- This will require mocking the response to the API endpoint types request to ensure that "E1" is available for the selected region
Upon selecting "E1" endpoint type, request-per-second notice appears in the drawer:
- This endpoint type supports up to 750 Requests Per Second (RPS). Understand bucket rate limits.
Upon selecting "E1" endpoint type, rate limiting table is not present
Upon clicking "Create Bucket" with "E1" endpoint type selected, Cloud fires an API bucket create request with the following data in its payload:
- cors_enabled is true
- endpoint_type is 'E1'
- s3_endpoint is present if corresponding endpoint mock contains non-null s3_endpoint
  - At least one of these subtasks should test the case when s3_endpoint is specified, and at least one of these subtasks should test the case when s3_endpoint is omitted
Upon creating bucket, the "Create Bucket" drawer closes and new bucket appears in the landing page
- The correct information is displayed alongside the new bucket:
  - Label
  - Region
  - Endpoint type
  - Endpoint URL

As an Author I have considered 🤔

Check all that apply

…1 Endpoint

… Endpoint

github-actions · 2024-09-09T16:41:00Z

Coverage Report: ✅
Base Coverage: 86.4%
Current Coverage: 86.4%

mjac0bs

Test passes and does what was required of it. 🚢

I just left a couple minor comments, mostly clean up.

mjac0bs · 2024-09-09T17:04:55Z

packages/manager/cypress/e2e/core/objectStorageGen2/bucket-create-gen2.spec.ts

@@ -128,11 +128,6 @@ describe('Object Storage Gen2 create bucket tests', () => {
      region: mockRegion.id,
    }).as('createBucket');

-    mockAppendFeatureFlags({


We can also remove L139, @getFeatureFlags.

mjac0bs · 2024-09-09T17:23:06Z

packages/manager/cypress/e2e/core/objectStorageGen2/bucket-create-gen2.spec.ts

+    cy.wait('@createBucket').then((xhr) => {
+      const requestPayload = xhr.request.body;
+      expect(requestPayload['endpoint_type']).to.equal('E1');
+      expect(requestPayload['cors_enabled']).to.equal(true);
+    });


s3_endpoint is present if corresponding endpoint mock contains non-null s3_endpoint

Did we still want to verify the s3_endpoint?

mjac0bs · 2024-09-09T17:26:02Z

packages/manager/cypress/e2e/core/objectStorageGen2/bucket-create-gen2.spec.ts

+    const endpointTypeE1 = 'Standard (E1)';
+    const bucketLabel = randomLabel();
+
+    //wait for the newly 'created' mocked bucket to appear


Nit: Does this comment make more sense down before Line 307-308?

Moved it as far down as I could given placement now

mjac0bs · 2024-09-09T17:30:34Z

packages/manager/cypress/e2e/core/objectStorageGen2/bucket-create-gen2.spec.ts

+    ui.drawer.find().should('not.exist');
+
+    // Confirm that bucket is created, initiate deletion for cleanup
+    cy.findByText(endpointTypeE1).should('be.visible');


The correct information is displayed alongside the new bucket:
Label
Region
Endpoint type
Endpoint URL

Just noticed - are we missing a check for the endpoint URL? I see endpoint type, label, and region.

Endpoint URL is the s3_endpoint - added 👍

abailly-akamai

I have no idea why, but when running

yarn cy:debug all tests are passing, but with

yarn cy:run -s "cypress/e2e/core/objectStorageGen2/bucket-create-gen2.spec.ts"
it's failing.

anyone else?

mjac0bs · 2024-09-09T20:26:39Z

anyone else?

Actually, yes. I'd tested with yarn cy:debug earlier, but I'm seeing the same as you with yarn cy:run. It looks like every test is failing at the point where it's looking for the created bucket, and the landing page shows none.

I don't know why that is, though...

It does pass in CI:

abailly-akamai

Approving since test passes as expected locally and in CI, but curious to know if @jdamore-linode has any insight into the discrepancy shown discussed above

jdamore-linode · 2024-09-09T21:14:00Z

@abailly-akamai @mjac0bs @jaalah-akamai I'm able to reproduce the failures via yarn cy:run, too -- in my case, I'm seeing all 3 fail intermittently, and I think I see two reasons why:

Sometimes the "Object Storage Endpoint Type" drop-down doesn't get populated. Judging by the recording, Cypress is clicking the "Create Bucket" button before the OBJ landing page has finished loading. In the past, we've had issues where drawers behave unexpectedly when they're opened before certain API requests have resolved, and this resembles that type of issue.
- Normally I don't consider this type of bug that serious since the user usually has to race as quickly as they can to trigger it, but because the OBJ landing page takes so long to load we might want to take a closer look at this and rule it out as an issue
- If this really is causing failures, we can work around it in Cypress by waiting for the page to load (using cy.findByText() to find one of the blurbs that appears once the page has loaded is usually reliable)
In each test, we're clicking "Create Bucket" and then setting up the mocks that would reflect the new bucket being created. If the browser fires off an HTTP request in the split second before Cypress has set up the request intercept, the request won't be mocked.
- I think this is what's causing most of the flakiness, and probably explains why this works in yarn cy:debug but not in yarn cy:run: the debugger is probably just slow enough compared to cy:run not to trigger the issue
- We're doing this twice in each test: when the bucket is created, and when the bucket is deleted, so it'll need to be fixed for all 6 instances
- To fix, we just have to move mockGetBuckets() to right before the preceding command that ends with .click().

bucket-create-gen2.spec.ts.mp4

Edit: Deleted second recording because I realized after the fact that I accidentally overrode the recording that showed the failure :(

cc @jaalah-akamai -- Sorry about this! I should've caught this when I reviewed the original E0 test.

jaalah-akamai · 2024-09-09T23:49:55Z

Thanks @jdamore-linode I'll make those changes and confirm back here when it's done 👍

…1 Endpoint

…1 Endpoint (linode#10907) * test: [M3-8433] - Cypress integration test for Object Storage Gen2: E1 Endpoint * Added changeset: Cypress integration test for Object Storage Gen2: E1 Endpoint * test: [M3-8433] - Cypress integration test for Object Storage Gen2: E1 Endpoint --------- Co-authored-by: Jaalah Ramos <[email protected]>

test: [M3-8433] - Cypress integration test for Object Storage Gen2: E…

40b794b

…1 Endpoint

jaalah-akamai requested a review from a team as a code owner September 9, 2024 16:13

jaalah-akamai requested review from cliu-akamai and removed request for a team September 9, 2024 16:14

Added changeset: Cypress integration test for Object Storage Gen2: E1…

d703356

… Endpoint

jaalah-akamai self-assigned this Sep 9, 2024

jaalah-akamai added e2e Indicates that a PR touches Cypress tests in some way Object Storage Gen2 labels Sep 9, 2024

jaalah-akamai requested review from a team, cpathipa and abailly-akamai and removed request for a team September 9, 2024 16:14

jaalah-akamai requested a review from a team as a code owner September 9, 2024 16:14

jaalah-akamai requested review from mjac0bs and hana-akamai and removed request for a team September 9, 2024 16:15

jaalah-akamai added the Ready for Review label Sep 9, 2024

mjac0bs approved these changes Sep 9, 2024

View reviewed changes

mjac0bs added the Add'tl Approval Needed Waiting on another approval! label Sep 9, 2024

mjac0bs reviewed Sep 9, 2024

View reviewed changes

abailly-akamai reviewed Sep 9, 2024

View reviewed changes

abailly-akamai approved these changes Sep 9, 2024

View reviewed changes

mjac0bs added Approved Multiple approvals and ready to merge! and removed Add'tl Approval Needed Waiting on another approval! Ready for Review labels Sep 9, 2024

jaalah-akamai added the Requires Changes label Sep 9, 2024

test: [M3-8433] - Cypress integration test for Object Storage Gen2: E…

f3de2f7

…1 Endpoint

jaalah-akamai removed the Requires Changes label Sep 10, 2024

jaalah-akamai merged commit da99b76 into linode:develop Sep 10, 2024
18 of 19 checks passed

This was referenced Sep 13, 2024

Release v1.128.0 - release → staging #10935

Merged

Release v1.128.0 - staging → master #10946

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: [M3-8433] - Cypress integration test for Object Storage Gen2: E1 Endpoint #10907

test: [M3-8433] - Cypress integration test for Object Storage Gen2: E1 Endpoint #10907

jaalah-akamai commented Sep 9, 2024

github-actions bot commented Sep 9, 2024 •

edited

Loading

mjac0bs left a comment

mjac0bs Sep 9, 2024

jaalah-akamai Sep 10, 2024

mjac0bs Sep 9, 2024

mjac0bs Sep 9, 2024

jaalah-akamai Sep 10, 2024

mjac0bs Sep 9, 2024

jaalah-akamai Sep 10, 2024

abailly-akamai left a comment

mjac0bs commented Sep 9, 2024

abailly-akamai left a comment

jdamore-linode commented Sep 9, 2024 •

edited

Loading

jaalah-akamai commented Sep 9, 2024

test: [M3-8433] - Cypress integration test for Object Storage Gen2: E1 Endpoint #10907

test: [M3-8433] - Cypress integration test for Object Storage Gen2: E1 Endpoint #10907

Conversation

jaalah-akamai commented Sep 9, 2024

Changes 🔄

Target release date 🗓️

How to test 🧪

As an Author I have considered 🤔

github-actions bot commented Sep 9, 2024 • edited Loading

mjac0bs left a comment

Choose a reason for hiding this comment

mjac0bs Sep 9, 2024

Choose a reason for hiding this comment

jaalah-akamai Sep 10, 2024

Choose a reason for hiding this comment

mjac0bs Sep 9, 2024

Choose a reason for hiding this comment

mjac0bs Sep 9, 2024

Choose a reason for hiding this comment

jaalah-akamai Sep 10, 2024

Choose a reason for hiding this comment

mjac0bs Sep 9, 2024

Choose a reason for hiding this comment

jaalah-akamai Sep 10, 2024

Choose a reason for hiding this comment

abailly-akamai left a comment

Choose a reason for hiding this comment

mjac0bs commented Sep 9, 2024

abailly-akamai left a comment

Choose a reason for hiding this comment

jdamore-linode commented Sep 9, 2024 • edited Loading

jaalah-akamai commented Sep 9, 2024

github-actions bot commented Sep 9, 2024 •

edited

Loading

jdamore-linode commented Sep 9, 2024 •

edited

Loading