Support 8.0+ #[Test] attributes

[mimre25]

With PHP 8.0 attributes were introduced and can be used to annotate tests.

I have a larger code base that mixes the traditional (/** @test */) and the modern (#[Test]) style of annotating test functions.

I've dug a bit into the neotest-phpunit codebase¹ but I'm hitting a wall either with the treesitter query, or the lack of its result being passed around.

This is the query that I came up with:

    ( 
     (method_declaration
      (attribute_list
        (attribute_group
            (attribute) @test_attribute (#match? @test_attribute "Test")
        )
      )
      (
        (name) @test.name
      )
     ) @test.definition
    )

This neatly matches the test, however, the problem stems from the attribute (#[Test]) being considered part of the function declaration, ultimately leading to an off-by-one when it comes to line-number for the test ids.

<?php

namespace Tests\Feature\Api;

use PHPUnit\Framework\Attributes\Test;
use Tests\TestCase;

class DemoTest extends TestCase
{
    #[Test] // is considered part of the method declaration
    public function impersonationCanReturnADemoToken() //PHPUnit output uses this linenumber though
    {}
}
?.

I'd love to contribute, but I'm just hitting a wall and would need a pointer to get past it.

Footnotes

1. I'm also implementing Laravel Sail support right now (which would probably also cover docker). Hopefully I can create a PR for this soon 🙂 ↩

[olimorris]

What about trying:

((method_declaration
  (attribute_list) @attribute (#eq? @attribute "#[Test]")
))

Just had a quick play with the following code:

<?php

use PHPUnit\Framework\TestCase;

class ExampleTest extends TestCase
{
    public function test_that_true_is_true()
    {
        $this->assertTrue(true);
    }
    
    #[Test]
    public function it_does_something(): void
    {
        $this->assertTrue(true);
    }
}

and it feels like it's on the right line. Writing Tree-sitter queries is a real trial and error!

If I get some time in the week I'll try and look into it.

[olimorris]

I'm about 90% of the way there with this query:

((method_declaration
      (attribute_list (_) @attribute (#eq? @attribute "#[Test]"))
      name: (name) @test.name
    )) @test.definition

It's just selecting the #[Test] attribute as part of the test_definition. I can't workout if we actually want that and therefore need to adapt the logic of the plugin.

[olimorris]

So with this code:

<?php

use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;

class AttributeTest extends TestCase
{
    #[Test]
    public function it_should_pass_if_attributes_work()
    {
        $this->assertTrue(true);
    }
}

The issue is that my query, it's picking up two @test.name values. Both #[Test] and it_should_pass_if_attributes_work!

[mimre25]

I've done some googling and it seems like that a treesitter capture can only contain a single node.
That means, we can only capture the whole method_declaration including the attribute.

Now I can see two solutions for this:

1. Adapt the code to read the files, checking for the #[Test] attribute and fixing the off-by-one
2. Just capturing some other node that represents the first line of the test (eg the visibility_modifier)

I've tested (2) as it seems pretty simple, and it works.
However, I don't know if there are any nasty side-effects of just saying the keyword public is the @test.definition in the query.

    ( 
     (method_declaration
      (attribute_list
        (attribute_group
            (attribute) @test_attribute (#match? @test_attribute "Test")
        )
      )
      (
        (visibility_modifier) @test.definition    
        (name) @test.name
      )
     ) 
    )

[olimorris]

Fantastic! That works brilliantly. We may need to add TestDox support at some point but thanks so much for your efforts. Great to keep this plugin moving with the times.

[mimre25]

TestDox alone doesn't define a test, so it would need any of the other "identifiers" for being a test anyway.

Or am I missing something?