Skip to content

Add cypress tests to validate docs pages #7254

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 28, 2025
Merged

Add cypress tests to validate docs pages #7254

merged 1 commit into from
May 28, 2025

Conversation

sean1588
Copy link
Contributor

@sean1588 sean1588 commented Apr 15, 2025 •
edited
Loading

fixes: #6774

Adds a schema to represent a test provider that we can use to validate e2e from schema file to html rendered page is structured and contains all the elements as we expect.

If we want to go as far as rendering everything from overview page to clicking through navigation and then clicking through all the resources, then we could potentially do that, though not sure if that is necessary as what we really want to test is the pages generated contain everything we expect to guard against regressions. Though if we feel this is necessary we can follow on with that.

TODO:

  • add testing for function pages (can possibly follow up with this)

@github-actions GitHub Actions
Copy link

Your site preview for commit 3be2dba is ready! 🎉

http://registry--origin-pr-7254-3be2dba9.s3-website.us-west-2.amazonaws.com/registry.

@sean1588 sean1588 changed the title Add visual tests registry Add cypress tests to validate docs pages Apr 15, 2025
@iwahbe
Copy link
Member

iwahbe commented Apr 16, 2025

This was originally motivated by #6641, and it looks like the fix for #6641 (#6642) reverts cleanly. Does this test fail if #6642 is reverted?

@github-actions GitHub Actions
Copy link

Your site preview for commit 173cb54 is ready! 🎉

http://registry--origin-pr-7254-173cb54e.s3-website.us-west-2.amazonaws.com/registry.

@sean1588 sean1588 force-pushed the sean/add-visual-tests-registry branch from 173cb54 to af5faee Compare April 17, 2025 00:09
@github-actions GitHub Actions
Copy link

Your site preview for commit af5faee is ready! 🎉

http://registry--origin-pr-7254-af5faee0.s3-website.us-west-2.amazonaws.com/registry.

@sean1588 sean1588 force-pushed the sean/add-visual-tests-registry branch from 87ed893 to babe1b0 Compare April 17, 2025 00:42
@sean1588
Copy link
Contributor Author

@iwahbe - good idea! I reverted that commit locally and was able to repro. I also added an extra resource to the schema, one with the <!-- Start PulumiCodeChooser --> fences and one with the {{% examples %}} fences as those tend to be handled differently and are still in use depending on the provider. I also wired it into the workflow.

@sean1588 sean1588 marked this pull request as ready for review April 17, 2025 00:44
@iwahbe iwahbe force-pushed the sean/add-visual-tests-registry branch 2 times, most recently from 101ac46 to 2de1474 Compare May 28, 2025 12:34
@iwahbe iwahbe force-pushed the sean/add-visual-tests-registry branch from 2de1474 to 27febda Compare May 28, 2025 12:36
@iwahbe iwahbe force-pushed the sean/add-visual-tests-registry branch from 27febda to 4c9d36f Compare May 28, 2025 12:38
@iwahbe iwahbe force-pushed the sean/add-visual-tests-registry branch from 4c9d36f to cdd2500 Compare May 28, 2025 12:49
@github-actions GitHub Actions
Copy link

Your site preview for commit 2de1474 is ready! 🎉

http://registry--origin-pr-7254-2de1474f.s3-website.us-west-2.amazonaws.com/registry.

@github-actions GitHub Actions
Copy link

Your site preview for commit 4c9d36f is ready! 🎉

http://registry--origin-pr-7254-4c9d36fd.s3-website.us-west-2.amazonaws.com/registry.

@github-actions GitHub Actions
Copy link

Your site preview for commit 27febda is ready! 🎉

http://registry--origin-pr-7254-27febda3.s3-website.us-west-2.amazonaws.com/registry.

@iwahbe iwahbe force-pushed the sean/add-visual-tests-registry branch from cdd2500 to ae77625 Compare May 28, 2025 12:59
@iwahbe iwahbe force-pushed the sean/add-visual-tests-registry branch from ae77625 to 1a37538 Compare May 28, 2025 13:06
@github-actions GitHub Actions
Copy link

Your site preview for commit cdd2500 is ready! 🎉

http://registry--origin-pr-7254-cdd2500b.s3-website.us-west-2.amazonaws.com/registry.

@iwahbe iwahbe enabled auto-merge (squash) May 28, 2025 13:06
@github-actions GitHub Actions
Copy link

Your site preview for commit ae77625 is ready! 🎉

http://registry--origin-pr-7254-ae776250.s3-website.us-west-2.amazonaws.com/registry.

@sean1588 @iwahbe
Add cypress tests to validate resource docs pages
3016cea 
Adds a schema to represent a test provider that we can use to validate e2e from schema
file to HTML rendered page is structured and contains all the elements as we expect.

Fixes #6774
@iwahbe iwahbe force-pushed the sean/add-visual-tests-registry branch from 1a37538 to 3016cea Compare May 28, 2025 13:15
@github-actions GitHub Actions
Copy link

Your site preview for commit 1a37538 is ready! 🎉

http://registry--origin-pr-7254-1a37538b.s3-website.us-west-2.amazonaws.com/registry.

@github-actions GitHub Actions
Copy link

Your site preview for commit 3016cea is ready! 🎉

http://registry--origin-pr-7254-3016cea0.s3-website.us-west-2.amazonaws.com/registry.

@iwahbe iwahbe merged commit 3f253de into master May 28, 2025
14 checks passed
@iwahbe iwahbe deleted the sean/add-visual-tests-registry branch May 28, 2025 13:31
@github-actions GitHub Actions
Copy link

Site previews for this pull request have been removed. ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iwahbe iwahbe iwahbe approved these changes

@flostadler flostadler Awaiting requested review from flostadler

@danielrbradley danielrbradley Awaiting requested review from danielrbradley

@mjeffryes mjeffryes Awaiting requested review from mjeffryes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add visual tests to the registry
2 participants
@sean1588 @iwahbe