Add missing units tests to CLI package (and standardize fixtures/mocks for existing)

[thedavidprice]

Existing good test coverage:

• db.js
• destroy.js
• generate.js
• lib.js: tests are good but maybe audit

Questions:

• cli/__mocks__ was created for the Destroy tests -- is there overlap with fixtures in cli/lib/__tests__ and/or should there be?

Commands/Options needing test coverage (or test improvements):

• [x] build.js
• [ ] dev.js
• [ ] info.js
• [ ] lint.js
• [ ] open.js
• [ ] test.js
• [ ] upgrade.js
• [ ] redwood-tools.js

Not clear in all cases above how to write effective tests.

[barakcodes]

Hi there! @thedavidprice . I am a new contributor, can I take this on?

[thedavidprice]

Hi @barakcodes! If you're willing, this would be a huge help. I just apologize in advance for the current state of mess. 😬

Because there are some general questions we have around CLI testing in general and one aspect of this would be to improve CLI test structure+process, here's my suggestion for a plan of attack:

1. After you've looked at the code a bit, start with outlining a plan of approach (could be here in this Issue or via a Draft PR). You might need to try some strikes or experiments. Knowing there is some nuanced complexity here, I'd hate to see you spend time on a solution and then have to try it another way.
   • it might be best to break this into smaller PRs per command or set as you feel is manageable
   • these tests don't need to cover every possible command+option, but the more the better. In general, we're looking for an efficient way to be able to trust them, and I'm not sure how that's going to work across the board. E.g. see this current issue with yarn rw db save on Windows -- https://github.com/redwoodjs/redwood/issues/575
2. Loop in @RobertBroersma as a sounding board for questions and ideas -- he's been focused on the Jest test tooling for Redwood Apps, but could likely help out here if/when needed.
3. We should also document this work once you're done to make it easier for others to manage current tests and add tests as new commands are created. Both @jtoar and myself can help with the documentation itself, so don't feel like you have to take that part on. (The document that we'll update specifically is the CLI package README.md.)

Some notes and background:

• the tests for Generators were created initially, which use the lib/ helpers as well as heavily rely on fixtures
  • as a follow-on project, the Windows support for tests (due to fixture paths) was added and then a Windows runner was added to the GH Actions CI
• the tests for Destroy were a separate project and rely on the mocks
• one challenge to testing is our extensive use of Listr for managing the terminal output of sequential tasks. It is possible to run a specific Listr task -- see this comment in the PR for Destroy command for an example.

---

Anything missing or further questions at this time? And, assuming I didn't scare you off, are you still interested? (I hope so! But also know we can break this down into smaller steps as needed if needed 🚀)

[thedavidprice]

FYI: there's a new document coming for CLI and also explains the Generator tests https://github.com/redwoodjs/redwood/pull/663

[barakcodes]

Hey @thedavidprice ! I'm still here. Got a bit occupied I'll get to it and run by you my plan of approach and we can discuss it. I'm very excited about it

[thedavidprice]

@barakcodes sounds fantastic. And grateful in advance for the help 💯