Add adapter for C assuming Meson build system and Criterion unit testing framework #1

oyvindaakre · 2024-06-20T12:42:49Z

Add an adapter for unit tests written in C using the Criterion unit test framework and assuming the meson build system.

Note: Build directory assumptions:

Defaults to build unless set by the user when configuring the adapter
build directory has been set up and configured by a previous call to meson setup build (the adapter will automatically build the project before each test).

Dependencies

meson installed on the system
ninja installed on the system

Supported features

Run test closest to the cursor
Run all tests in the file

quolpr · 2024-06-20T15:02:08Z

@oyvindaakre looks great! Ready for merge?

quolpr · 2024-06-20T15:15:18Z

@oyvindaakre also, could add please example to test dir, like I did for go - test/gotest. The implementation should be very simple, just text for like 1 + 1 == 2, or as you want

oyvindaakre · 2024-06-21T07:11:10Z

Hi @quolpr, thanks for checking in :) I'm still fixing bugs and adding functionality, so the PR is not ready just yet :) I'll change the status back to a draft to reflect that. I will also clean up the implementation and add documentation before trying to merge this :)

I have to say, kudos to you! This is the first plugin I work on and as a lua-noob I found this as a good starting point and I think it was easy to get going on my own adapter.

quolpr · 2024-06-21T15:54:06Z

Btw, I reload plugin while developing with this command, could be helpful for you:

vim.api.nvim_create_user_command("C", function()
  require("lazy.core.loader").reload("quicktest.nvim")
end)

So, what I usually do:

Add sample project to test folder
Edit adapter
Run :C command
Rerun test

quolpr · 2024-06-21T16:14:24Z

@oyvindaakre

I made some breaking changes in API. Changes are not so much, please check Readme 🙂

oyvindaakre · 2024-06-21T18:52:01Z

@quolpr Should this PR update the doc too?

quolpr · 2024-06-22T05:31:29Z

@oyvindaakre the doc will be generated from Readme once PR is merged to main. So, please, mention your adapter in Readme 🙂

oyvindaakre · 2024-06-23T20:36:35Z

@quolpr Finally, I think the adapter is ready. I have two questions though:

The adapter needs to know the path to the build directory. Currently I hardcode build here: https://github.com/oyvindaakre/quicktest.nvim/blob/ea9396b6660116e220f575a5aa33743fe8a1a13a/lua/quicktest/adapters/criterion/init.lua#L12. Is it possible for users to override this and set a custom path if they want?
I added a sample project to tests/support/criterion. I also added a readme in an attempt to explain how to set up the project (+ some notes on the adapter itself).
I'm not sure how to run it with the makefile. When I run make test it only seems to run the plugin_name_spec.lua test. Is that expected?

$ make test
Starting...	
Scheduling: tests/plugin_name/plugin_name_spec.lua

========================================	
Testing: 	/home/oyvind/.local/share/nvim/lazy/quicktest.nvim/tests/plugin_name/plugin_name_spec.lua	
Success	||	setup works with default	
	
Success: 	1	
Failed : 	0	
Errors : 	0	
========================================

quolpr · 2024-06-24T17:35:21Z

@oyvindaakre as for

The adapter needs to know the path to the build directory. Currently I hardcode build here: https://github.com/oyvindaakre/quicktest.nvim/blob/ea9396b6660116e220f575a5aa33743fe8a1a13a/lua/quicktest/adapters/criterion/init.lua#L12. Is it possible for users to override this and set a custom path if they want?

Yep, I think the best way will be to make your plugin to work like this:

qt.setup({
  adapters = {
    require("quicktest.adapters.golang")({
       exec_path = function(params)
       end
    }),
  }
})

You can do this with meta table, check example here
https://github.com/fredrikaverpil/neotest-golang/blob/main/lua/neotest-golang/init.lua#L179

I will be adding the same API to other adapters too soon. Also, notice that function is supplied for param, that's how user will be able to change behaviour per project. Based on what vim.fn.bufname(params.bufnr)(returns buffer path) contains, they will be able to dynamically configure exec_path.

Or you can support both functions and strings, like here https://github.com/olimorris/neotest-rspec?tab=readme-ov-file#setting-the-root-directory

Let me know what you think

I'm not sure how to run it with the makefile. When I run make test it only seems to run the plugin_name_spec.lua test. Is that expected?

Ha-ha, I didn't make tests for quicktet 😄 So only manual tests for now

lua/quicktest.lua

lua/quicktest/adapters/criterion/init.lua

oyvindaakre · 2024-06-25T14:03:18Z

Let me know what you think

It sounds neat to support both function and string, but I don't have enough Lua-experience under my belt to know the implications of supporting both :) Metatable is a new concept for me, so I have to read up on it, but I'm happy to take suggestions on how to implement it for this adapter.

quolpr · 2024-06-25T16:01:53Z

@oyvindaakre I made config options support for golang, could you do the same way? a3bb0b6

This is assuming the test executable is named after the test file, so: test_something.c -> exe == test_something So that the command line becomes meson test -C build test_something

…data Uses 'meson introspect --targets' to find the test executable that contains the source file in the currently open buffer. This fixes an issue with the existing implementation that assumed the name of the test executable from the name of the buffer. However this is not bullet proof. It is possible that the source file is used in multiple test executables, for instance to run with different parameters and flags.

Try to keep meson specific interaction in its own module for reusing later

Use empty parameter table to signal that the test can't be run

Update API for capturing JSOn Store result in M

Locate line number with error and update diagnostics UI

…d of through `meson test` Should have done this all along. This adapter is all about criterion, not meson. We still use meson introspect to find the link between the source file and the test exectuable. The primary difference is that we now call the test executable directly instead of through `meson test -C build test_exe`. This allows for some simplifications: - Depend only on how the test executable behaves - Test output can be read directly instead of being captured in the output stream of meson (lots of text + some json + lots of text) - Simpler command line since test arguments don't have to be wrapped with meson's --test-args="" - Perhaps slighly easier to modify adapter later if we need to support a different build system delete test_parser

Let util parse the results and return the error messages.

Update diagnostics namespace Update adapter path Update adatper name

Replace the external json5 decoder with the built-in vim.json module. During development I had been testing vim.fn.json_decode whichs turns out to be a vimscript function that cannot be used in lua loop callbacks. I did not know there was also a module called vim.json which I'm using now...

The criterion and util modules return an empty string instead of nil value when a test exe was not found or if a test was not found in the buffer

Realized that M.can_run is not called by quicktest, so need to call internally to make sure error handling still works

The comment was valid when running the test through `meson test` which would automatically compile. Now we run the test executable directly and need to do compilation ourselves (which we do anyway).

…ectory

oyvindaakre · 2024-06-25T20:04:44Z

@oyvindaakre I made config options support for golang, could you do the same way? a3bb0b6

Looks good! Copied your steps. Does it look okay?

…ng of the adapter

quolpr · 2024-06-26T16:54:54Z

@oyvindaakre LGTM! Thank you for the contribution, merging it now :)

oyvindaakre marked this pull request as draft June 21, 2024 07:11

oyvindaakre force-pushed the add-meson-plugin branch 3 times, most recently from 0e3a69e to f559b31 Compare June 21, 2024 10:47

oyvindaakre force-pushed the add-meson-plugin branch 2 times, most recently from b5731e2 to fc8a1c9 Compare June 21, 2024 18:51

oyvindaakre force-pushed the add-meson-plugin branch from fc8a1c9 to 1aef5c1 Compare June 22, 2024 17:29

oyvindaakre marked this pull request as ready for review June 23, 2024 20:36

oyvindaakre force-pushed the add-meson-plugin branch from ea9396b to 2904c89 Compare June 23, 2024 21:57

quolpr reviewed Jun 24, 2024

View reviewed changes

lua/quicktest.lua Outdated Show resolved Hide resolved

quolpr requested changes Jun 24, 2024

View reviewed changes

lua/quicktest/adapters/criterion/init.lua Outdated Show resolved Hide resolved

lua/quicktest/adapters/criterion/init.lua Outdated Show resolved Hide resolved

oyvindaakre added 8 commits June 25, 2024 21:51

quick and dirty can invoke meson

cb048a1

enable meson plugin if file starts with 'test_` and ends with '.c'

e9ed2e7

Basic support for running all tests from the open buffer

4844f97

This is assuming the test executable is named after the test file, so: test_something.c -> exe == test_something So that the command line becomes meson test -C build test_something

Define name

89d764c

Run test closest to cursor

80d76bc

Set proper title

8e1aaab

wip: build test, run test, parse results

8035467

fix issues with running all tests in the file

fc1509f

oyvindaakre added 21 commits June 25, 2024 21:51

Move util.build_tests to meson.compile

28a8d0f

Try to keep meson specific interaction in its own module for reusing later

Add a test_parser module

054e857

Add code documentation

a525c10

Implement M.can_run

ac56ebc

Use empty parameter table to signal that the test can't be run

Move splitstr to util

119c41f

Update handling of the json test results

936dc73

Update API for capturing JSOn Store result in M

Implement M.after_run

99d4e3b

Locate line number with error and update diagnostics UI

Meson API now takes build directory as argument

e975eba

Clean up after_run

85f5ebc

Let util parse the results and return the error messages.

Rename adapter to 'criterion'

d76d2f6

Update diagnostics namespace Update adapter path Update adatper name

Add sample project for testing

a87dcd5

Mention criterion adapter in the readme

20d7d20

Use empty string instead of nil to signal not found

455b872

The criterion and util modules return an empty string instead of nil value when a test exe was not found or if a test was not found in the buffer

Fix bug after rebasing after breaking API changes

30df723

Realized that M.can_run is not called by quicktest, so need to call internally to make sure error handling still works

run_file and run_line returns params and error message as per new API

a9d65d2

Fix outdated comment

aa996ff

The comment was valid when running the test through `meson test` which would automatically compile. Now we run the test executable directly and need to do compilation ourselves (which we do anyway).

Improve error handling when meson introspect can't find the build dir…

d33bfde

…ectory

Add adapter options and make build directory configurable by user

aadec24

oyvindaakre force-pushed the add-meson-plugin branch from 26cdd9f to 84f23f1 Compare June 25, 2024 19:56

oyvindaakre added 4 commits June 25, 2024 22:36

Allow user to pass additional test arguments

6e79351

Show test CLI arguments in the title

f2aa1b0

Update readme with new user options for criterion adapter

04b1a96

Improve error handling when parsing test file and highlight shortcomi…

b32b337

…ng of the adapter

oyvindaakre force-pushed the add-meson-plugin branch from bcdadcb to b32b337 Compare June 25, 2024 20:37

quolpr merged commit c3aab39 into quolpr:main Jun 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add adapter for C assuming Meson build system and Criterion unit testing framework #1

Add adapter for C assuming Meson build system and Criterion unit testing framework #1

oyvindaakre commented Jun 20, 2024 •

edited

Loading

quolpr commented Jun 20, 2024

quolpr commented Jun 20, 2024

oyvindaakre commented Jun 21, 2024 •

edited

Loading

quolpr commented Jun 21, 2024 •

edited

Loading

quolpr commented Jun 21, 2024

oyvindaakre commented Jun 21, 2024

quolpr commented Jun 22, 2024

oyvindaakre commented Jun 23, 2024

quolpr commented Jun 24, 2024 •

edited

Loading

oyvindaakre commented Jun 25, 2024 •

edited

Loading

quolpr commented Jun 25, 2024

oyvindaakre commented Jun 25, 2024

quolpr commented Jun 26, 2024

Add adapter for C assuming Meson build system and Criterion unit testing framework #1

Add adapter for C assuming Meson build system and Criterion unit testing framework #1

Conversation

oyvindaakre commented Jun 20, 2024 • edited Loading

Dependencies

Supported features

quolpr commented Jun 20, 2024

quolpr commented Jun 20, 2024

oyvindaakre commented Jun 21, 2024 • edited Loading

quolpr commented Jun 21, 2024 • edited Loading

quolpr commented Jun 21, 2024

oyvindaakre commented Jun 21, 2024

quolpr commented Jun 22, 2024

oyvindaakre commented Jun 23, 2024

quolpr commented Jun 24, 2024 • edited Loading

oyvindaakre commented Jun 25, 2024 • edited Loading

quolpr commented Jun 25, 2024

oyvindaakre commented Jun 25, 2024

quolpr commented Jun 26, 2024

oyvindaakre commented Jun 20, 2024 •

edited

Loading

oyvindaakre commented Jun 21, 2024 •

edited

Loading

quolpr commented Jun 21, 2024 •

edited

Loading

quolpr commented Jun 24, 2024 •

edited

Loading

oyvindaakre commented Jun 25, 2024 •

edited

Loading