brobeson / ctest-lab Goto Github PK

• Add a prettier configuration file.
• Add a prettier check to the GH workflow.
• Add documentation, probably to a contributing file.
• Reformat all the code.

VS Code provides the command Test: Refresh Tests. This invokes CTest Lab's discover_tests() function.

• Remove the command from package.json.
• Remove the command from extension.ts.
• Update the user manual so users know how to discover tests.
• Update the change log.

With webpack (introduced in fb9faf2), the GH workflow fails. It cannot find logo.png because I had stop using the prepublish script.

If I press the stop button in the test view, the extension doesn't actually stop CTest.

The cmake-tools extension runs the build command before running tests. Can CTest-Lab do the same thing?

If any test in a test run fails, open the results display automatically.

If a user runs a single test, and that test requires a fixture, the fixture runs correctly. CTest ensures that. However, the extension cannot update the fixture in the Test view since it was not included in the run request. Try to find a way to update fixtures.

With #13, CTest Lab runs the actual test executables. This prevents some CTest functionality from working, like test fixtures, required files, etc. Change the test runner so it uses CTest.

If the user clicks the Run Test button for a single test in the test view, CTest Lab should run just that test via ctest --tests-regex {test name}.

• Update package.json
• Update README.md
• Add a license
• Add user documentation

Read https://code.visualstudio.com/api/references/extension-manifest and https://code.visualstudio.com/api/working-with-extensions/publishing-extension. Add any additional tasks.

CTest can write test results in JUnit XML format:

ctest --output-junit file.xml

This seems a good method to read the test results. The run tests command can force this output, then read the output to set the tests' status in the VS Code UI. Here is an example file with forced test failure, disabled, and skipped results. After you download the file, change the extension from txt to xml.

test_results.txt

Some tests are not available until the user builds them. This happens, for example, with Catch2's catch_discover_tests() command. In these cases, the test name returned by CTest is foo_NOT_BUILT_<hash>. I can detect these cases and exclude them from discovery.

Using the extension installed from the marketplace, it doesn't seem to activate. The test view doesn't appear in the UI. The output channel is not present. And the CTest command is not in the palette. I introduce this bug in v0.3.0. The extension activates when I debug it though.

I think this might be the best way to support running tests by label. I can't think of another way to get the label from the test view filter to the extension to control the --labels-regex command option.

If the setting exists, use it in the CTest command.

After #15 is complete, I shouldn't need this file.

When the user runs tests, there is no immediate feedback except the spinning icons in the test view. The output channel pops up at the end of the run with the output. Activate the channel before executing CTest so users can get immediate test feedback.

Would it be possible to support older ctest installs that don't have --output-junit support? A simple Yes/No based on the ctest return status would be sufficient for my purposes, but bonus points if you can parse the --log-output format.

I'm currently stuck using ctest version 3.16.3

Just add a simple workflow file that builds the extension. Later, I'll add linters and tests as part of issues specific to those tools.

This function is longer than it should be. Refactor it into separate functions. At first glance, it seems that each .then or .catch block can be a function.

It runs all the tests, not just the failed tests.

If CTest skips a test, returning a status of "not run", then set that test's description in the test view to "(not run)". Be sure to clear that description if a subsequent test run does run the test.

• Use strict settings in .eslintrc.json and tsconfig.json.
• Add linting to the GH workflow
• Fix all the lint errors.

It's possible for VS Code settings to use variables:

{
  "cmake.buildDirectory": "${workspaceFolder}/../build"
}

When I fetch the setting value, I get the literal text ${workspaceFolder}:

const build_directory = vscode.workspace.getConfiguration("cmake")
  .get("buildDirectory");
// build_directory === "${workspaceFolder}/../build"

How can I ask VS Code to evaluate the variable? I haven't found anything in the extension API. I did find the vscode-variables package, but I couldn't get it to work.