Skip to content

Commit 3376e7c

Browse files
NsidorencoNsidorenco
committed
initial commit
0 parents  commit 3376e7c

37 files changed

+2570
-0
lines changed

‎.busted‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
return {
2+
_all = {
3+
coverage = false,
4+
lpath = "lua/?.lua;lua/?/init.lua",
5+
lua = "nlua",
6+
},
7+
default = {
8+
verbose = true,
9+
},
10+
tests = {
11+
verbose = true,
12+
},
13+
}

‎.editorconfig‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
root = true
2+
3+
[*.lua]
4+
charset = utf-8
5+
indent_style = space
6+
indent_size = 2
7+
trim_trailing_whitespace = true
8+
insert_final_newline = true

‎.github/workflows/luarocks.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Push to Luarocks
3+
4+
on:
5+
push:
6+
tags:
7+
- "*"
8+
release:
9+
types:
10+
- created
11+
tags:
12+
- "*"
13+
pull_request: # Tests installing the generated rockspec on PR without uploading
14+
workflow_dispatch:
15+
16+
jobs:
17+
luarocks-upload:
18+
runs-on: ubuntu-22.04
19+
steps:
20+
- uses: actions/checkout@v3
21+
with:
22+
fetch-depth: 0 # Required to count the commits
23+
- name: Get Version
24+
run: echo "LUAROCKS_VERSION=$(git describe --abbrev=0 --tags)" >> $GITHUB_ENV
25+
26+
# Needed to install the tree-sitter parser dependency
27+
- name: Install C/C++ Compiler
28+
uses: rlalik/setup-cpp-compiler@master
29+
with:
30+
compiler: clang-latest
31+
- name: Install tree-sitter CLI
32+
uses: baptiste0928/cargo-install@v3
33+
with:
34+
crate: tree-sitter-cli
35+
36+
- name: LuaRocks Upload
37+
uses: nvim-neorocks/luarocks-tag-release@v7
38+
env:
39+
LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
40+
with:
41+
version: ${{ env.LUAROCKS_VERSION }}
42+
dependencies: |
43+
neotest
44+
tree-sitter-c_sharp
45+
tree-sitter-fsharp

‎.github/workflows/main.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: main
2+
on:
3+
push:
4+
branches: [main]
5+
pull_request:
6+
concurrency:
7+
group: github.head_ref
8+
cancel-in-progress: true
9+
jobs:
10+
lint:
11+
runs-on: ubuntu-latest
12+
name: lint
13+
steps:
14+
- uses: actions/checkout@v3
15+
- uses: JohnnyMorganz/stylua-action@v2
16+
with:
17+
token: ${{ secrets.GITHUB_TOKEN }}
18+
version: latest
19+
args: --check .
20+
21+
tests:
22+
needs:
23+
- lint
24+
runs-on: ubuntu-latest
25+
timeout-minutes: 6
26+
strategy:
27+
matrix:
28+
os: [ubuntu-latest, macos-latest, windows-latest]
29+
neovim_version: ["v0.10.0"]
30+
include:
31+
- os: ubuntu-latest
32+
neovim_version: "nightly"
33+
34+
steps:
35+
- uses: actions/checkout@v4
36+
- uses: actions/setup-dotnet@v4
37+
with:
38+
dotnet-version: "9.0.x"
39+
40+
- name: Install C/C++ Compiler
41+
uses: rlalik/setup-cpp-compiler@master
42+
with:
43+
compiler: clang-latest
44+
45+
- name: Install tree-sitter CLI
46+
uses: baptiste0928/cargo-install@v3
47+
with:
48+
crate: tree-sitter-cli
49+
50+
- name: Run tests
51+
id: test
52+
uses: nvim-neorocks/nvim-busted-action@v1
53+
with:
54+
nvim_version: ${{ matrix.neovim_version }}
55+
56+
- name: Save neotest log
57+
if: always() && steps.test.outcome == 'failure'
58+
uses: actions/upload-artifact@v4
59+
with:
60+
name: neotest-log-${{ matrix.neovim_version }}-${{ matrix.os }}
61+
path: ~/.local/state/nvim/neotest.log

‎.gitignore‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Compiled Lua sources
2+
luac.out
3+
4+
# luarocks build files
5+
*.src.rock
6+
*.zip
7+
*.tar.gz
8+
9+
# Object files
10+
*.o
11+
*.os
12+
*.ko
13+
*.obj
14+
*.elf
15+
16+
# Precompiled Headers
17+
*.gch
18+
*.pch
19+
20+
# Libraries
21+
*.lib
22+
*.a
23+
*.la
24+
*.lo
25+
*.def
26+
*.exp
27+
28+
# Shared objects (inc. Windows DLLs)
29+
*.dll
30+
*.so
31+
*.so.*
32+
*.dylib
33+
34+
# Executables
35+
*.exe
36+
*.out
37+
*.app
38+
*.i*86
39+
*.x86_64
40+
*.hex
41+
42+
# Test dependencies
43+
deps/
44+
**/obj/*
45+
/luarocks
46+
/lua_modules
47+
/.luarocks
48+
49+
obj/
50+
bin/

‎.luacheckrc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
ignore = {
2+
"631", -- max_line_length
3+
"122", -- read-only field of global variable
4+
}
5+
read_globals = {
6+
"vim",
7+
"describe",
8+
"it",
9+
"assert",
10+
}

‎CONTRIBUTING.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing
2+
3+
Any help on this plugin would is much appreciated.
4+
5+
## First steps
6+
7+
If you have a use case that the adapter isn't quite able to cover, a more detailed understanding of why can be achieved by following these steps:
8+
9+
1. Setting the `loglevel` property in your `neotest` setup config to `1` to reveal all the debug logs from neotest-vstest
10+
2. Open up your tests file and do what your normally do to run the tests
11+
3. Look through the neotest log files for logs prefixed with `neotest-vstest` (can be found by running the command `echo stdpath("log")`)
12+
13+
The general flow for test discovery and execution is as follows:
14+
15+
1. Spawn VSTest instance at start-up.
16+
2. On test discovery: Send list of files to VSTest instance.
17+
- VSTest write the discovered test cases to a file.
18+
3. Read result file and parse tests.
19+
4. Use treesitter to determine line ranges for test cases.
20+
5. On test execution: Send list of test ids to VSTest instance.
21+
- Once test results are in the VSTest instance will write the results to a file.
22+
6. Read test result file and parse results.
23+
24+
## Running tests
25+
26+
To run the tests from CLI, make sure that `luarocks` is installed and executable.
27+
Then, Run `luarocks test` from the project root.
28+
29+
If you see a module 'busted.runner' not found error you need to update your `LUA_PATH`:
30+
31+
```sh
32+
eval $(luarocks path --no-bin)
33+
```

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Nikolaj Sidorenco
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎Makefile‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# we disable the `all` command because some external tool might run it automatically
2+
.SUFFIXES:
3+
4+
all:
5+
6+
# runs all the test files.
7+
test:
8+
luarocks test --local
9+
10+
# performs a lint check and fixes issue if possible, following the config in `stylua.toml`.
11+
lint:
12+
stylua .

‎README.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<p align="center">
2+
<a href="https://github.com/nsidorenco/neotest-vstest/releases">
3+
<img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/nsidorenco/neotest-vstest?style=for-the-badge">
4+
</a>
5+
<a href="https://luarocks.org/modules/nsidorenco/neotest-vstest">
6+
<img alt="LuaRocks Package" src="https://img.shields.io/luarocks/v/nsidorenco/neotest-vstest?logo=lua&color=purple&style=for-the-badge">
7+
</a>
8+
</p>
9+
10+
# Neotest VSTest
11+
12+
Neotest adapter for dotnet
13+
14+
- Integrates with the VSTest runner to support all testing frameworks.
15+
- DAP strategy for attaching debug adapter to test execution.
16+
- Supports both C# and F# projects.
17+
- Fine-grained test discovery and execution allowing running individual parameterized tests.
18+
19+
## Pre-requisites
20+
21+
neotest-vstest requires makes a number of assumptions about your environment:
22+
23+
1. The `dotnet sdk`, and the `dotnet` cli executable in the users runtime path.
24+
2. (For Debugging) `netcoredbg` is installed and `nvim-dap` plugin has been configured for `netcoredbg` (see debug config for more details)
25+
3. Requires treesitter parser for either `C#` or `F#`
26+
4. `neovim v0.10.0` or later
27+
28+
## Installation
29+
30+
### [lazy.nvim](https://github.com/folke/lazy.nvim)
31+
32+
```
33+
{
34+
"nvim-neotest/neotest-vstest"
35+
}
36+
```
37+
38+
## Usage
39+
40+
```lua
41+
require("neotest").setup({
42+
adapters = {
43+
require("neotest-vstest")
44+
}
45+
})
46+
```
47+
48+
The adapter optionally supports extra settings:
49+
50+
```lua
51+
require("neotest").setup({
52+
adapters = {
53+
require("neotest-vstest")({
54+
-- Path to dotnet sdk path.
55+
-- Used in cases where the sdk path cannot be auto discovered.
56+
sdk_path = "/usr/local/dotnet/sdk/9.0.101/",
57+
-- table is passed directly to DAP when debugging tests.
58+
dap_settings = {
59+
adapter = "netcoredbg",
60+
}
61+
})
62+
}
63+
})
64+
```
65+
66+
## Debugging adapter
67+
68+
- Install `netcoredbg` to a location of your choosing and configure `nvim-dap` to point to the correct path
69+
70+
This adapter uses that standard dap strategy in `neotest`. Run it like so:
71+
72+
- `lua require("neotest").run.run({strategy = "dap"})`
73+
74+
## Acknowledgements
75+
76+
- [Issafalcon](https://github.com/Issafalcon) for the original [neotest-dotnet](https://github.com/Issafalcon/neotest-dotnet) adapter which inspired this adapter.
77+
- [Wayne Bowie](https://github.com/waynebowie99) for helping test and troubleshoot the adapter.
78+
- [Dynge](https://github.com/Dynge) for testing and contributing to the adapter.

0 commit comments

Comments
 (0)