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

End-to-End Tests + Screenshot capability #582

Merged
merged 26 commits into from
Feb 12, 2024

Conversation

garrettmflynn
Copy link
Member

This PR will use the data generated from #530 to run end-to-end tests using Puppeteer and automatically produce screenshots for a new tutorial on the GUIDE.

@garrettmflynn garrettmflynn self-assigned this Feb 1, 2024
garrettmflynn and others added 20 commits February 1, 2024 12:40
@garrettmflynn
Copy link
Member Author

@CodyCBakerPhD Full end-to-end test is completed, including DANDI upload! Just have to tweak a few of the test timeout values so this works across all CI platforms.

@garrettmflynn
Copy link
Member Author

garrettmflynn commented Feb 9, 2024

Looks like it works! Let's collect some suggested improvements for these screenshots here then?

@CodyCBakerPhD
Copy link
Collaborator

including DANDI upload!

Just checking really quick - that's to staging, right?

@CodyCBakerPhD
Copy link
Collaborator

CodyCBakerPhD commented Feb 10, 2024

Let's collect some suggested improvements for these screenshots here then?

I would say having e2e tests at all is a fantastic thing to have; fine tuning of screenshots can always fall into a follow-up that specifically writes the tutorial

BTW, where are the screenshots found?

@garrettmflynn
Copy link
Member Author

garrettmflynn commented Feb 12, 2024

Just checking really quick - that's to staging, right?

Yep! It's to a hardcoded Dandiset that I made on staging. I've started passing my API key as an Action secret to support this behavior.

@garrettmflynn
Copy link
Member Author

garrettmflynn commented Feb 12, 2024

I would say having e2e tests at all is a fantastic thing to have; fine tuning of screenshots can always fall into a follow-up that specifically writes the tutorial

Sounds good!

BTW, where are the screenshots found?

Screenshots are placed in tests/screenshots at the moment, though this is ignored in the .gitignore file.

Do you want these to show up in the public repo?

@CodyCBakerPhD
Copy link
Collaborator

Do you want these to show up in the public repo?

I say let's decide that in the follow-up focusing on the tutorial specifically; will have to think about upsides/downsides

@CodyCBakerPhD CodyCBakerPhD marked this pull request as ready for review February 12, 2024 17:37
@CodyCBakerPhD CodyCBakerPhD enabled auto-merge (squash) February 12, 2024 17:40
@CodyCBakerPhD CodyCBakerPhD changed the title End-to-End Tests + Screenshots using Tutorial Data End-to-End Tests + Screenshot capability Feb 12, 2024
@CodyCBakerPhD
Copy link
Collaborator

@CodyCBakerPhD CodyCBakerPhD merged commit 60742f6 into main Feb 12, 2024
11 of 12 checks passed
@CodyCBakerPhD CodyCBakerPhD deleted the tutorial-pipeline-puppeteer branch February 12, 2024 18:31
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.

2 participants