metrumresearchgroup / review

helpful tools for organizing and performing quality control (QC) tasks
https://metrumresearchgroup.github.io/review/
2 stars 0 forks source link

clean up messages in test suite #10

Closed seth127 closed 1 year ago

seth127 commented 1 year ago

This isn't urgent, but at some point we should clean it up, mostly just to improve developer experience.

The output of devtools::test() is riddled with messages that get printed as side effects of the functions we're testing. Output below:

devtools::test() output **output should look like this:** ``` > devtools::test() ℹ Testing review ✔ | F W S OK | Context ✔ | 13 | diffPreviousRevisions [1.1s] ✔ | 3 | diffQC [0.5s] ✔ | 3 | getQcedRevision [0.5s] ✔ | 2 | logAccept [0.9s] ✔ | 1 | logAssign [0.3s] ✔ | 1 | logCreate ✔ | 3 | logPending [0.7s] ✔ | 2 | logSummary [0.4s] ══ Results ═════════════════════════════════════════════════════════════════════════════════════════════════════════════ Duration: 4.4 s [ FAIL 0 | WARN 0 | SKIP 0 | PASS 21 ] ``` **but it looks like this:** ``` > devtools::test() ℹ Testing review ✔ | F W S OK | Context ⠏ | 0 | diffPreviousRevisions Checked out revision 0. A QClog.csv A file.txt Adding QClog.csv Adding file.txt Transmitting file data ..done Committing transaction... Committed revision 1. Sending QClog.csv Sending file.txt Transmitting file data ..done Committing transaction... Committed revision 2. Sending QClog.csv Sending file.txt Transmitting file data ..done Committing transaction... Committed revision 3. Sending QClog.csv Sending file.txt Transmitting file data ..done Committing transaction... Committed revision 4. A /tmp/Rtmpj4JLZu/file209b42457afe.txt Export complete. A /tmp/Rtmpj4JLZu/file209b668af9b2.txt Export complete. ⠋ | 1 | diffPreviousRevisions A /tmp/Rtmpj4JLZu/file209b6c346fb0.txt Export complete. ⠸ | 4 | diffPreviousRevisions A /tmp/Rtmpj4JLZu/file209b3975c53b.txt Export complete. ✔ | 8 | diffPreviousRevisions [1.1s] ⠏ | 0 | diffQC Checked out revision 0. A QClog.csv A file.txt Adding QClog.csv Adding file.txt Transmitting file data ..done Committing transaction... Committed revision 1. A /tmp/Rtmpj4JLZu/file209b21fbeed9.txt Export complete. Specified files are identical ⠋ | 1 | diffQC A /tmp/Rtmpj4JLZu/file209b4994c698.txt Export complete. ✔ | 2 | diffQC [0.5s] ⠏ | 0 | getQcedRevision Checked out revision 0. A QClog.csv A file.txt Adding QClog.csv Adding file.txt Transmitting file data ..done Committing transaction... Committed revision 1. ⠋ | 1 | getQcedRevision Sending QClog.csv Sending file.txt Transmitting file data ..done Committing transaction... Committed revision 2. ✔ | 2 | getQcedRevision [0.5s] ⠏ | 0 | logAccept Checked out revision 0. A QClog.csv A file.txt Adding QClog.csv Adding file.txt Transmitting file data ..done Committing transaction... Committed revision 1. ✔ | 2 | logAccept [0.9s] ⠏ | 0 | logAssign Checked out revision 0. A QClog.csv A file.txt Adding QClog.csv Adding file.txt Transmitting file data ..done Committing transaction... Committed revision 1. ✔ | 1 | logAssign [0.3s] ⠏ | 0 | logCreate Checked out revision 0. ✔ | 1 | logCreate ⠏ | 0 | logPending Checked out revision 0. A QClog.csv A file.txt A file2.txt A file3.txt Adding QClog.csv Adding file.txt Adding file2.txt Adding file3.txt Transmitting file data ....done Committing transaction... Committed revision 1. ✔ | 3 | logPending [0.7s] ⠏ | 0 | logSummary Checked out revision 0. A QClog.csv A file.txt Adding QClog.csv Adding file.txt Transmitting file data ..done Committing transaction... Committed revision 1. ✔ | 2 | logSummary [0.4s] ══ Results ═════════════════════════════════════════════════════════════════════════════════════════════════════════════ Duration: 4.4 s [ FAIL 0 | WARN 0 | SKIP 0 | PASS 21 ] ```

These can be suppressed in several different ways. Feel free to reach out to me or @kyleam if you want to consult on which one will be cleanest in this case.

andersone1 commented 1 year ago

@michaelmcd18 this is done, right?

michaelmcd18 commented 1 year ago

This is all set, I'll close the issue now