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

What to do if a test fails #310

Open
hadley opened this issue Dec 9, 2023 · 4 comments
Open

What to do if a test fails #310

hadley opened this issue Dec 9, 2023 · 4 comments

Comments

@hadley
Copy link
Member

hadley commented Dec 9, 2023

It would be useful to provide some more concrete advice on what to do if a test fails or error. For example, when I see this error:

Error ('test-SQLServer.R:19:3'): DBItest[SQLServer]: Result: send_query_only_one_result_set

How do I go about finding the individual test code so I can run it line by line and understand what is happening.

@krlmlr
Copy link
Member

krlmlr commented Dec 9, 2023

Can you run DBItest::test_some("send_query_only_one_result_set", dblog = FALSE) in your package?

@hadley
Copy link
Member Author

hadley commented Dec 9, 2023

That's the sort of advice that you need to write somewhere.

@krlmlr
Copy link
Member

krlmlr commented Dec 21, 2023

We have vignette("DBItest"), what is missing there?

@hadley
Copy link
Member Author

hadley commented Dec 21, 2023

I'm really looking for a heading that says "When a test fails" that says:

  • How to run a single test
  • How to find the source code for that test

I guess that information is maybe currently present in the vignette, but it's currently rather buried. You want to make it as clear as possible because people will be visiting when a test fails and they just want to understand what's happening, not learn the full details of DBItest.

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

No branches or pull requests

2 participants