-
-
Notifications
You must be signed in to change notification settings - Fork 364
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
Update Init.php to change how Laravel is detected #1213
base: 2.x
Are you sure you want to change the base?
Conversation
The init currently checks for Laravel by looking for laravel/laravel however a new Laravel 11 install does not include that. As a result `isLaravelInstalled()` incorrectly returns false That means it does not add the Laravel stub and so defaults to using phpunit for the base case in TestCase.php. Which then causes an undefined error when running any Feature test, including the example one.
@@ -119,6 +119,6 @@ public function init(): void | |||
*/ | |||
private function isLaravelInstalled(): bool | |||
{ | |||
return InstalledVersions::isInstalled('laravel/laravel'); | |||
return InstalledVersions::isInstalled('laravel/laravel') || InstalledVersions::isInstalled('laravel/framework'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think an additional check is required (along with this one), as this would trigger on things such Laravel packages which shouldn't extend this testcase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, that's a good point. I'm not sure what the check would be to exclude those.
I guess the other way to do this would be for the user to tell the init command that Laravel is installed e.g vendor/bin/pest --init --laravel
. That approach would mean the isLaravelInstalled
check stays the same and so couldn't break anything (like a package). It would be nicer to automate it though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we could check if artisan
exists maybe. 🤷🏻 That would handle most cases.
This is how Tinkerwell does it:
https://github.com/beyondcode/tinkerwell/blob/main/src/Drivers/LaravelTinkerwellDriver.php#L7
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That makes sense. Perhaps:
private function isLaravelInstalled(): bool
{
return file_exists($this->testSuite->rootPath.'/public/index.php') && file_exists($this->testSuite->rootPath.'/artisan');
}
... or get them all in there to cover all the bases ...
private function isLaravelInstalled(): bool
{
return InstalledVersions::isInstalled('laravel/framework') && file_exists($this->testSuite->rootPath.'/public/index.php') && file_exists($this->testSuite->rootPath.'/artisan');
}
... since it looks like the equivalent to Tinkerwell's path is $this->testSuite->rootPath
.
Perhaps checking for artisan
alone is enough? I can't imagine you'd have one without the other, or create a file called artisan
if not using Laravel.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what if someone changed the name of that command file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@henzeb If they did, yep, the new check would also fail to detect Laravel. Just like Tinkerwell would fail to.
Doing that seems less likely (to me anyway) than someone changing the name
in composer.json.
What:
Description:
Running
vendor/bin/pest --init
currently checks for Laravel by looking forlaravel/laravel
however a new Laravel 11 install does not include that.As a result
isLaravelInstalled()
incorrectly returns falseThat means it does not add the Laravel stub and so defaults to using phpunit for the base case in TestCase.php. Which then causes an undefined error when running any Feature test, including the example one.
(I'm not sure if this is the only file that does this check however manually changing this file and then running
vendor/bin/pest --init
appears to fix it for me.)Related:
#1192