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

Add e2e test for tutorials content correctness #2055

Closed
wants to merge 5 commits into from
Closed

Conversation

thiskevinwang
Copy link
Contributor

@thiskevinwang thiskevinwang commented Jul 7, 2023

Description

This adds e2e tests to ensure tutorials content correctness.

Why? — During next.js upgrades fro m13.0.5 to 13.4.x, incorrect tutorials have been rendered at certain paths. This test aims to catch those cases.

@vercel
Copy link

vercel bot commented Jul 7, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dev-portal ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 10, 2023 10:34pm

@github-actions
Copy link

github-actions bot commented Jul 7, 2023

📦 Next.js Bundle Analysis

This analysis was generated by the next.js bundle analysis action 🤖

This PR introduced no changes to the javascript bundle 🙌

['/hcp/tutorials/networking', 'HashiCorp Virtual Network'],
['/vault/tutorials/operations/configure-vault', 'Configure Vault'],
['/consul/tutorials/get-started-hcp/hcp-gs-deploy', 'Deploy HCP Consul'],
]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO: add more path+h1 pairs here.

I think having a hard-coded list here should be reasonable for the near future.

  • having no abstraction here should make it easy to delete, modify, and add cases

Depending on test slowness, I think 100+ tutorials should be a reasonably wide net that'll give us confidence during the next Next.js upgrade.

TODO: also add docs routes.

Copy link
Contributor

Choose a reason for hiding this comment

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

💭 Definitely fine for now while we troubleshoot but if we want this test to always run in the future, it should be driven off real api data (staging for tutorials) in case headings / filenames for tutorials change.

@thiskevinwang thiskevinwang changed the title kw.e2e test [WIP] Add e2e test for tutorials content correctness Jul 7, 2023
@thiskevinwang thiskevinwang marked this pull request as ready for review July 10, 2023 20:37
@thiskevinwang thiskevinwang requested a review from a team as a code owner July 10, 2023 20:37
@thiskevinwang thiskevinwang changed the title [WIP] Add e2e test for tutorials content correctness Add e2e test for tutorials content correctness Jul 10, 2023
@thiskevinwang thiskevinwang marked this pull request as draft July 10, 2023 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants