Windows
Authoring tests that work on Windows
In order to maximize platform coverage, we have tests that run on macOS, Ubuntu Linux, and Windows. If you are a developer on macOS or Linux, there are a few additional considerations to ensure that your tests will pass on Windows:
- Check that asserts verifying the presence of a file at a specific directory are platform agnostic (forward slash and back slash issues). Furthermore, some API's differ in using a lower-case vs upper-case for the drive prefix; i.e. c:\ vs C:. Always do case-insensitive string comparisons when doing file path checks. Solve these issues by using the
pathAPI when joining paths and always do case-insensitive checks.
Bad:
expect(actualPath).toEqual(
"root/vault/beta.md")
);
Good:
expect(actualPath.toLowerCase()).toEqual(
path.join("root", "vault", "beta.md").toLowerCase()
);
- Tests that execute some code where a command-line executable is run (for example, Git operations via
execa). On Windows, these commands will run under a cmd shell instead of a bash shell and may interpret argument syntax differently.
For reference, take a look at a few example PR's below that fix issues similar to the ones mentioned above.
Skipping Windows Test (Last Resort)
If a test continues to fail despite trying the methods listed above, the test may be skipped using the following test runner for the plugin: runTestButSkipForWindows
Troubleshooting Windows CI Failures on Github Actions
The github actions CI test pass for windows can be finicky and there are sometimes issues there that don't show up locally. If you are debugging a github actions windows integration test issue and need to actually run the integration test using github action, we have a specific workflow here that triggers when you push to a branch matching the following pattern: chore/windows-ci-*
This is an example of a pull request that makes use of this