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

Closes #2579 Add test #11 test-derive_vars_query.R Calls assert_db_require… #2634

Closed

Conversation

jimrothstein
Copy link
Collaborator

@jimrothstein jimrothstein commented Jan 11, 2025

…ments() with no argumetns and expects error.

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@jimrothstein
Copy link
Collaborator Author

image

Copy link

github-actions bot commented Jan 11, 2025

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (5215 / 5323)

@bms63
Copy link
Collaborator

bms63 commented Jan 11, 2025

image

If you go into checks and find the failing jobs - you can rerun the failed jobs. Usually is an option where it says Re-run all jobs if any of them failed. Sometimes the plumbing of GH gets twisted and things don't always work and if i can't make sense of the error message then I rerrun the job

image

Comment on lines 353 to 354
## Test 11: assert_db_requirements_
test_that("assert_db_requirements 11: assert_db_requirements checks", {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Always tough to come up with short lines on what we are testing - but can you say something of what you are tresting in the subject?

Suggested change
## Test 11: assert_db_requirements_
test_that("assert_db_requirements 11: assert_db_requirements checks", {
## Test 11: assert_db_requirements_
test_that("assert_db_requirements 11: assert_db_requirements errors when no arguments used", {

Does this enhance our test coverage?

Copy link
Collaborator Author

@jimrothstein jimrothstein Jan 11, 2025

Choose a reason for hiding this comment

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

Your patience and tack is admired! (passive voice)

  1. tried to improve test description; yes, testing the assert_db_requirements()
  2. but specifically when formal argument fun is missing, which should increase test code coverage.
  3. now up to 98.8%
  4. I have not done anything (yet) with other functions in issue Enhance test coverage for get_vars_query(), assert_valid_queries(), validate_query(), basket_select() #2579 in need of more code testing

Copy link
Collaborator

Choose a reason for hiding this comment

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

Might be better to break them up into separate issues - or if this satisfies all coverage for assert_db_requirement() then make separate issue for that one and remove it from #2579.

I like small issues!!

@jimrothstein
Copy link
Collaborator Author

image

@bms63
Copy link
Collaborator

bms63 commented Jan 14, 2025

I am assuming this is the same as your other PR?

@bms63 bms63 closed this Jan 14, 2025
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