[User story] cleanup

[gbraad]

Description

The cleanup command removes files and reverses actions that have been taken during the setup phase.

Exit codes and behaviour

Notes

This needs further discussion as this is probably the bane of a lot of confusion.

[gbraad]

@jsliacan can you explain in a comment what you are expecting this command should do?

[cfergeau]

#1897 is most likely related.

[jsliacan]

Here's what I'd expect as a user:

0. cleanup seems to be the same thing as uninstall or reset-to-factory-settings. No semantic difference as far as I can tell. So...
1. I'd expect crc cleanup is a super-command of crc delete --force --clear-cache, i.e. achieving crc cleanup amounts to running crc delete with all options and doing additional actions.
2. It removes all configuration settings (in crc.json). Re: Should crc cleaup remove everything except the config file? #1897, we could have a flag for opting out: crc cleanup --keep-config.
3. Do not revert all setup changes unless they could prevent next start (maybe something version related). E.g. user is a member of libvirt group... It is possible that crc setup added the user in that group, but now programs other than CRC rely on that setting. Reverting this could break the other usage that we don't know about. If we were nice, we would output a list of "changes" which we are not reverting.

Corrollaries:

1. After running crc cleanup, all crc commands return 1 except version, config, setup, help, and cleanup itself.
   • BTW, this is an inconsistency among the commands: cleanup & setup are projections, whereas delete or stop aren't -- they fail when run 2x in a row.
2. Running crc cleanup gives the user a clean slate to try again (whatever failed). As a consequence, it is also an entry point for a new binary or CRC version if the user is upgrading.

Exit codes:
Once we settle on what the command should achieve, we can figure out what steps it needs to do. Then each of those steps needs to succeed for the final exit code to be 0.