TASK: Health Check

[russellmorton]

Description

Taqueria should provide a health check

Health Check areas;

• Taqueria global heath check
  • Is taqueria running in a viable context? Does .taq exist? Is the store, config etc well formed?
  • Is there a working version of node available on the system?
    • If the project doesn't have plugins that rely on node, a recommendation could be surfaced to the user
    • If the project does have plugins that rely on node, an actionable error should be surfaced to the user
  • Plugin health check
    • The plugin interface should define a healthcheck method that reports on the plugins state and ability to fullfill its duties
    • If the plugin, for example, is a compiler, the health check could check for;
      • Do I have a working compiler tool chain, and can I execute it?
      • Is the installed compiler plugin the correct version that I am expecting or that the users project has pinned? (Relates to [Feature]: allow specifying ligo version in config.json #798)
      • Do my output directories have appropriate permissions? ie. Can I write to the output directories? Do the file artifacts that my plugin generates have permissions so that the taqueria user can edit? (We have seen michelson files owned by root which means the taq user can't edit them).

Areas where health check errors or warnings can be surfaced to the user:

• taq output as a result of running taq healthcheck or taq diagnostics`
• VSCode extension UI
• github action logs - making the issues visable/prominent to a person looking at the CI/CD pipelines.

Acceptance Criteria

• Perform health checks on plugins
• return error with remediation actions if errors are found with dependency versions

Additional Context and Related Items