Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add references method for two-way test-source linking #1241

Open
wants to merge 7 commits into
base: 3.x
Choose a base branch
from
Open
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/PendingCalls/TestCall.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ final class TestCall
*/
private readonly bool $descriptionLess;

/**
* This property is not actually used in the codebase, it's only here to make Rector happy.
*
* @var array<int|string, class-string|array<class-string|string>>
*/
public array $references;

/**
* Creates a new Pending Call.
*/
Expand Down Expand Up @@ -615,6 +622,20 @@ public function coversNothing(): self
return $this;
}

/**
* Adds a reference to the tested method or class. This helps to link test
* cases to the source code for easier navigation.
mertasan marked this conversation as resolved.
Show resolved Hide resolved
*
* @param array<class-string|string>|class-string ...$classes
*/
public function references(string|array ...$classes): self
{
// For rector
$this->references = $classes;
mertasan marked this conversation as resolved.
Show resolved Hide resolved

return $this;
}

/**
* Informs the test runner that no expectations happen in this test,
* and its purpose is simply to check whether the given code can
Expand Down