Eloquent error: A facade root has not been set

Question

I have been using Eloquent as a standalone package in Slim Framework 2 successfully.

But now that I want to make use of Illuminate\Support\Facades\DB since I need to show some statistics by getting the info from 2 tables and using a Left Join and a Counter from the database like this:

use Illuminate\Support\Facades\DB;
$projectsbyarea = DB::table('projects AS p')
        ->select(DB::raw('DISTINCT a.area, COUNT(a.area) AS Quantity'))
        ->leftJoin('areas AS a','p.area_id','=','a.id')
        ->where('p.status','in_process')
        ->where('a.area','<>','NULL')
        ->orderBy('p.area_id');

I get the following error:

Type: RuntimeException
Message: A facade root has not been set.
File: ...\vendor\illuminate\support\Facades\Facade.php
Line: 206

How can I solve it?

So far I have found out, in this link that I need to create a new app container and then bind it to the Facade. But I haven't found out how to make it work.

This is how I started the rest of my Eloquent and working fine:

use Illuminate\Database\Capsule\Manager as Capsule;

$capsule = new Capsule();

$capsule->addConnection([
    'my'         =>  $app->config->get('settings'),
    /* more settings ...*/
]);

/*booting Eloquent*/
$capsule->bootEloquent();

How do I fix this?

Fixed As @user5972059 said, I had to add $capsule->setAsGlobal();//This is important to make work the DB (Capsule) just above $capsule->bootEloquent();

Then, the query is executed like this:

use Illuminate\Database\Capsule\Manager as Capsule;
$projectsbyarea = Capsule::table('projects AS p')
            ->select(DB::raw('DISTINCT a.area, COUNT(a.area) AS Quantity'))
            ->leftJoin('areas AS a','p.area_id','=','a.id')
            ->where('p.status','in_process')
            ->where('a.area','<>','NULL')
            ->orderBy('p.area_id')
            ->get();

Answer 1

You have to change your code to:

$Capsule = new Capsule;
$Capsule->addConnection(config::get('database'));
$Capsule->setAsGlobal();  //this is important
$Capsule->bootEloquent();

And at the beginning of your class file you have to import:

use Illuminate\Database\Capsule\Manager as DB;

Answer 2

One random problem using phpUnit tests for laravel is that the laravel facades have not been initialized when testing.

Instead of using the standard PHPUnit TestCase class

class MyTestClass extends PHPUnit\Framework\TestCase

one can use

class UserTest extends Illuminate\Foundation\Testing\TestCase

and this problem is solved.

Answer 3

Had the same issue with laravel 8. I replaced

   use PHPUnit\Framework\TestCase;

with:

 use Tests\TestCase;

Answer 4

Upgrade version for php, I encountered this error while calling the interface.

$ php artisan config:cache

Deleting the /bootstrap/cache/config.php file is a very effective way.

Answer 5

I received the following message while running tests using PHPUnit v.9.5.4, PHP v.8.0.3 and Lumen v. 8.2.2:

PHP Fatal error: Uncaught RuntimeException: A facade root has not been set. in path_to_project/vendor/illuminate/support/Facades/Facade.php:258

And that happened although I had apparently already configured my app.php to enable facades ($app->withFacades();), still I received this error message whenever I tried to run tests using Illuminate\Support\Facades\DB. Unfortunately, none of the other answers helped me.

This error was actually been thrown due to my configs in phpunit.xml, which didn't point to my app.php file, where I actually enabled facades.

I just had to change

<phpunit (...OTHER_PARAMS_HERE) bootstrap="vendor/autoload.php">

to

<phpunit (...OTHER_PARAMS_HERE) bootstrap="bootstrap/app.php">

Hope it helps.

Answer 6

I got this error after running:

$ php artisan config:cache

The solution for me was to delete the /bootstrap/cache/config.php file. I'm running Laravel 5.5.

The seems to arise in multiple situation, and not just about facades.

Answer 7

Tested on Laravel 8.78

tests/bootstrap.php

<?php

use Illuminate\Foundation\Bootstrap\RegisterFacades;
use Illuminate\Foundation\Bootstrap\LoadConfiguration;

require_once __DIR__ . '/../vendor/autoload.php';

$app = require_once __DIR__ . '/../bootstrap/app.php';

(new LoadConfiguration())->bootstrap($app);//  <------- Required for next line
(new RegisterFacades())->bootstrap($app);//  <------- Add this line

Answer 8

Here is yet another instance of this error, happened to me after upgrading Laravel 8 to 9.

I had feature tests with a @dataProvider to supply data to those tests. Some of the data supplied by the data provider methods came from an application service. It was being initialised like this:

/**
 * @dataProvider myDataProvider
 */
public function testSomeStuff(...)
{
   ...
}

public function myDataProvider()
{
   $myService = app(Service::class); // This is trouble

   return [
      ['test1_data' => $myService::SOME_CONSTANT],
      [...],
      ...
   ];
}

This worked under Laravel 8, but not in Laravel 9. All other solutions listed in this SO thread were checked and were correctly set up.

The problem is that the application is not being inititialised until after the data provider method is run. It was presumably initialised before this stage in the Laravel 8 install. So app(Service::class) was failing due to it using facades internally.

One workaround could be to force the application to initialise earlier, in the data provider function: $this->createApplication(). I would not recommend this due to potential side effects of the test parts running in the wrong order, though it does appear to work when I tried it.

Best solution is to avoid accessing any part of the application functionality in the data provider methods. In my case it was easy to replace $myService::SOME_CONSTANT with MyService::SOME_CONSTANT after making sure those constants were public.

Hopefully this will help somebody suddenly hitting this problem running feature tests after a Laravel 9 upgrade.

Answer 9

In my project, I managed to fix this issue by using Laravel Dependency Injection when instantiating the object. Previously I had it like this:

$class = new MyClass(
    new Client(),
    env('client_id', 'test'), 
    Config::get('myapp.client_secret')
);

The same error message happened when I used Laravel env() and Config().

I introduced the Client and env in the AppServiceProvider like this:

     $this->app->bind(
         MyClass::class,
         function () {
             return new MyClass(
                 new Client(),
                 env('client_id', 'test')),
                 Config::get('myapp.client_secret')
             );
         }

and then instantiated the class like this:

$class = app(MyClass::class);

See more from https://laravel.com/docs/5.8/container .

Answer 10

@melvin's answer above works correctly.

In case someone is wondering about it, the mistake people do is to choose Yes when VSCode asks them if they are making a Unit Test. Remember, Unit Tests should really be unit tests, independent of other application features (models, factories, routes; basically anything that would require the Laravel app to be fired up). In most scenarios, people really actually want to make Feature Tests and therefore should answer No to the above question. A feature test inherits from Tests\TestCase class (which takes care of firing up Laravel app before running the test) unlike unit tests that inherit from the class PHPUnit\Framework\TestCase which use just PHPUnit and are therefore much faster.

credit with thanks to @Aken Roberts's answer here.

From Laravel Documentation: Generally, most of your tests should be feature tests. These types of tests provide the most confidence that your system as a whole is functioning as intended.

Answer 11

In my case, for a while a ran a PHP project in PHP version 8, and that time I used some PHP 8 features like param definition and method's multiple return type declarations supported by only PHP 8 and above. When I downgraded from PHP 8 to PHP 7.4 I faced this issue. After removing the return types and param hinting the problems are gone.

Answer 12

Do not forget to call parent::setUp(); before.

fails

public function setUp(): void {
    Config::set('something', true);
}

works

public function setUp(): void {
    parent::setUp();

    Config::set('something', true);
}

Answer 13

Try uncommenting in app.php $app->withFacades();

Answer 14

I have just solved this problem by uncommenting $app->withFacades(); in bootstrap/app.php

Answer 15

If you are running test in separate processes, don't forget to use @preserveGlobalState disabled I was seeing this error, and this is how I solved it:

Before

/**
 * @runTestsInSeparateProcesses
 */

After

/**
 * @runTestsInSeparateProcesses
 * @preserveGlobalState disabled
 */

Answer 16

Old Question, new Awnser...

Try to delete composer.lock file.

Work fine in my case, Laravel 9.x after update passport package

Answer 17

After a long back and forth I found that my issue was server setup. More exactly, I had multiple php versions. For some reason the problem was that even though I had installed php8.2 it was not set the default version on the server. But after I disabled 8.1 and set the default php version on the server to 8.2 the problem disappeared.

Answer 18

wrong way

public function register()
   {
       $this->app->bind('Activity', function($app)
       {
            new Activity;
       });
   }

---

right way

public function register()
   {
       $this->app->bind('Activity', function($app)
       {
            return new Activity;
       });
   }

---------------------------------- don't forget return

Answer 19

If you recently upgrade Laravel on Homestead & VirtualBox environment or do not find any reason that causing please be sure your Vagrant is up to date.

Referance

I had Taylor lock this thread. The past several replies have restated the solution, which is to Upgrade to Virtualbox 6.x, the thread is locked to prevent other issues that are not related from being dogpiled on here.