Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Descope Testing Strategies Guide #5368

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

allenzhou101
Copy link

@allenzhou101 allenzhou101 commented Jul 10, 2023

This PR is focused on improving the documentation related to end-to-end (E2E) testing with Cypress and Descope. It introduces a new guide titled "Descope Authentication," which provides comprehensive instructions on how to integrate Descope with a Cypress testing suite.

The guide is split into several sections, each one targeting a different aspect of the integration:

Descope Application Setup: Step-by-step instructions to set up Descope in the project's Descope Dashboard.

Setting Descope app credentials in Cypress: Explains how to configure Cypress to use the Descope environment variables.

Custom Command for Descope Authentication: Provides detailed instructions and code examples for creating Cypress custom commands to authenticate with Descope, including both UI login and programmatic login.

Login with UI: Instructions and a code example showing how to login via the user interface, using the Test User Management API.

Programmatic Login: A guide and code example demonstrating how to create a Cypress command to login programmatically, using the Test User Management API and local storage.

@netlify
Copy link

netlify bot commented Jul 10, 2023

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 298950d

@CLAassistant
Copy link

CLAassistant commented Jul 10, 2023

CLA assistant check
All committers have signed the CLA.

@cypress-app-bot
Copy link
Collaborator

@allenzhou101 allenzhou101 changed the title Adding descope testing strat guide Descope Testing Strategies Guide Jul 10, 2023
@allenzhou101 allenzhou101 marked this pull request as draft July 10, 2023 09:32
@allenzhou101 allenzhou101 marked this pull request as ready for review July 10, 2023 09:45
@nagash77 nagash77 requested a review from elylucas July 10, 2023 13:37
@netlify
Copy link

netlify bot commented Jul 15, 2023

Deploy Preview for benevolent-cat-040f48 ready!

Name Link
🔨 Latest commit 6f2057d
🔍 Latest deploy log https://app.netlify.com/sites/benevolent-cat-040f48/deploys/65d5239bec2ad00008938d3f
😎 Deploy Preview https://deploy-preview-5368--benevolent-cat-040f48.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@elylucas elylucas removed their assignment Jul 31, 2023
@allenzhou101
Copy link
Author

Hey @nagash77 ! Could this PR get reassigned a reviewer? Thanks!

@nagash77 nagash77 requested review from jaffrepaul and removed request for elylucas August 15, 2023 20:06
@jaffrepaul
Copy link
Contributor

Thank you for the contribution @allenzhou101!

We'll want to install, configure and test everything in order to assert everything works as expected given this could be first class integration documentation. Right now we don’t have the time to put into reviewing and evaluating the changes proposed but we'll keep this open for when more bandwidth is available.

@jaffrepaul jaffrepaul removed their assignment Aug 25, 2023
@allenzhou101
Copy link
Author

Thanks for the explanation @nagash77 !

Really appreciate all the great work y'all are doing at Cypress. Would love to help smooth out the process in whatever way possible. Would it help if I included a video tutorial or demo of installation and setup?

@allenzhou101
Copy link
Author

@jaffrepaul We're seeing quite a few of our customers at Descope interested in Cypress and would love to be able to reference this documentation. Do you happen to have an update on review timeline?

@jennifer-shehane jennifer-shehane removed the request for review from jaffrepaul November 6, 2024 16:05
Comment on lines +216 to +217
url: `${descopeApiBaseURL}/auth/otp/verify/email`,
headers: authHeader,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The /auth/otp/verify/email endpoint is a public authentication endpoint and should not include the management key in its authorization header. The headers: authHeader line should be removed from this request. This is a security best practice as authentication endpoints are designed to work without administrative credentials.

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

Copy link
Contributor

@MikeMcC399 MikeMcC399 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would need to be moved to docs/app/end-to-end-testing due to repo reorganization

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants