test: add automated testing using plenary

olimorris / neotest-rspec

🧪 Neotest adapter for RSpec. Works in Docker containers too

MIT License

88 stars 25 forks source link

test: add automated testing using plenary #8

Closed compactcode closed 2 years ago

compactcode commented 2 years ago

Why

To help new contributors understand how the plugin works and what input/output functions expect.
To give instant feedback when making changes.

What

I added some busted style tests according the to the plenary guide and run them using the neotest plenary adapter.

1655336801

I added two test files:

init_spec.lua this would contain high level tests for the public functions that neotest depends on. Ideally stuff like given a test file (e.g. spec/basic_example_spec.rb) I expect discover_positions to return a tree containing the ids we want to see in the summary window.
utils_spec.lua this would contain unit tests for internal functions that might require a lot of tests that are a pain to test at higher levels.

Discussion

I'm probably doing some things wrong here so not expecting this to be merged as is. Wanted to get some early feedback on whether this is an idea you be interested in pursuing.

If so I'm happy to flesh the examples out and incorporate any feedback before merging.

olimorris commented 2 years ago

Firstly thanks very much for you contribution. I agree with all of this in principle and it was something I started playing around with at the weekend and came across the same errors as you did. I raised a discussion over in the neotest repo too and we could always ask rcarriga for his help.

compactcode commented 2 years ago

Didn't get much time today and tomorrow will be busy so will try to pick this up again over the weekend.

olimorris commented 2 years ago

Look forward to it. Never get to collaborate with open source + Neovim so this is fun! 😄

olimorris commented 2 years ago

As a heads up, there's likely to be some merge conflicts as I've pushed some changes through in the last 24 hours. Nothing major, just some minor tweaks to formatting and outputing. Let me know if you need me to resolve the conflicts

compactcode commented 2 years ago

As a heads up, there's likely to be some merge conflicts as I've pushed some changes through in the last 24 hours. Nothing major, just some minor tweaks to formatting and outputing. Let me know if you need me to resolve the conflicts

Thanks for the notification, the conflicts were straightforward to resolve.

I'm happy enough with the discover_positions now. I've also moved parse_json_output to utils and added a test for that.

Let me know what you think.

olimorris commented 2 years ago

This looks great. I'll pull it down and test tomorrow.

Keen to get GitHub workflows working for this as well so will put that together in another PR.

Thanks so much.

olimorris commented 2 years ago

Lovely work. Thanks so much for all of your efforts.