ci: adopt asdf for internal dev. init WSL test environments

[jthegedus]

Summary

Adopt asdf for out tests, internal dev. Init WSL test envs. Cleanup Vagrantfile.

• remove unused Vagrantfile
• provide .tool-versions for asdf development and CI workflows
• extract Lint and Format GitHub Workflows and use .tool-versions with asdf/actions
  • remove lint.sh as our CI pipeline now enforces all formatting and linting reliably, so no need to run this script manually before release, nor for it to exist outside the CI Workflow definition.
• extract Bats testing to individual jobs per OS type.
  • nix:
    • install test deps as before
    • run on each of macos-10.15, macos-11 (disabled as it's in preview), ubuntu-18.04 & ubuntu-20.04
  • wsl1:
    • setup WSLv1 with various distributions with additional test deps
    • install bats-core manually
    • run on windows-2019. windows-2016 is not supported with WSL GitHub Action https://github.com/Vampire/setup-wsl
    • continue-on-error: true as the failing tests will be addressed later. Tracking in Failing tests on windows. #465

[jthegedus]

This doesn't change our existing Ubuntu/macOS tests, only expands them with an matrix.os list. It adds the scaffolding for WSL1 tests to be fixed.

I am of the mind we should probably not use continue-on-error: true in our WSL1 tests. This gives the false impression our tests are working when they are not. We should be using "required status checks" to set which tests are required vs not required for PRs to be considered valid.

For example, we should require all except WSL1 checks pass for the PR to be valid. We have not been using required status checks as the event trigger filters paths-ignore: ["**.md"] would mean PRs with only .md changes would not trigger the Jobs which are required, thus getting into annoying PR states. I find these filters add very little value.

Are people okay with:

• removing paths-ignore: ["**.md"]?
• Required Status Checks?
• WSL1 tests failing but not being one of Required Status Checks?

[jthegedus]

To other asdf core members:

I am merging as there are no negative side-effects I can see and this can easily be reverted.

Enabling Required Status Checks as well. These can be disabled via https://github.com/asdf-vm/asdf/settings/branches

[Stratus3D]

@jthegedus how do we perform the necessarily shellcheck linting and shfmt formatting when working locally? I don't rely on GitHub actions for validating my changes. I liked the lint.sh script because it ran shellcheck for me locally. I'd like another script for running shfmt locally.

Recently I've been creating PRs with builds that fail because I don't have a good way to run shfmt locally.

[Stratus3D]

Why is this job named nix?

[jthegedus]

It is the job that runs our Bats tests on the *nix OSs. * is invalid in the job name when I tried naming it *nix. Didn't think the job name was particularly important.

The other job is called WSL1 because though it is a Windows OS, the environment we want to test in is different distros on WSL1 environment.

[jthegedus]

We can rename the job to whatever, I just thought this was the most descriptive at the time.

[jthegedus]

I should have separated out this PR, sorry. It was initially just to add .tool-versions here for shfmt, shellcheck etc, but then I thought I would add the use of asdf into our CI pipeline. Then I saw an update to WSL so started playing with that.

---

how do we perform the necessarily shellcheck linting and shfmt formatting when working locally?

I will put back the lint script and add shfmt to it. We are using the default shfmt settings which aligns with .editorconfig where there is overlap.

[jthegedus]

See #961 for the revert of Shellcheck and addition of Shfmt scripts for local execution.

With the addition of .tool-versions in this PR, we should all be using the same versions of all these tools.

[Stratus3D]

Thanks @jthegedus !

[jthegedus]

Sorry for being impatient and breaking your workflow. My distraction with CI took me away from my initial goal of adding .tool-versions so we are all dev-ing with the same versions locally.