Category: Laravel Testing

sessionでflashをつけてリダイレクトしているが、きちんとリダイレクトされるかのテストコードを書く

controller側

    public function testFormConfirm(Request $request){
        if($request->has('name') & $request->name !== NULL){
            session()->flash('flashmessage',$request->name. 'さん、登録完了');
        } else {
            session()->flash('flashmessage','エラー: 名前を入力してください');
        }

        return redirect('/admin/test/form');
    }

test code

    public function testExample()
    {
        // $this->visit('/admin/test/form')->see('名前');

        $response = $this->post('/admin/test/form/confirm', [
            'name' => 'hpscript'
        ]);

        $response->assertRedirect('/admin/test/form');
    }

$ vendor/bin/phpunit tests/Feature/AdminTest.php
PHPUnit 9.4.2 by Sebastian Bergmann and contributors.

. 1 / 1 (100%)

Time: 00:01.530, Memory: 34.00 MB

OK (1 test, 2 assertions)

なるほど、仕組みはわかってきた。keep goin.

route

Route::get('/admin/test/form', [App\Http\Controllers\AdminController::class, 'testForm']);

controller

    public function testForm(){

        return view('admin.test');
    }

testCase

    public function testExample()
    {
        $this->visit('/admin/test/form')->see('名前');
    }

$ vendor/bin/phpunit tests/Feature/AdminTest.php
PHPUnit 9.4.2 by Sebastian Bergmann and contributors.

E 1 / 1 (100%)

Time: 00:01.715, Memory: 32.00 MB

There was 1 error:

1) Tests\Feature\AdminTest::testExample
Error: Call to undefined method Tests\Feature\AdminTest::visit()

/home/vagrant/dev/testApp/tests/Feature/AdminTest.php:26

ERRORS!
Tests: 1, Assertions: 0, Errors: 1.

ん？　visitを使うにはduskを入れないと駄目らしい。
と言うことで、公式を見ます。

https://laravel.com/docs/8.x/dusk
$ composer require –dev laravel/dusk
$ php artisan dusk:install
$ php artisan dusk:chrome-driver

1) Tests\Browser\ExampleTest::testBasicExample
Facebook\WebDriver\Exception\UnknownErrorException: unknown error: cannot find Chrome binary

/home/vagrant/dev/testApp/vendor/php-webdriver/webdriver/lib/Exception/WebDriverException.php:139
/home/vagrant/dev/testApp/vendor/php-webdriver/webdriver/lib/Remote/HttpCommandExecutor.php:371
/home/vagrant/dev/testApp/vendor/php-webdriver/webdriver/lib/Remote/RemoteWebDriver.php:136
/home/vagrant/dev/testApp/tests/DuskTestCase.php:43
/home/vagrant/dev/testApp/vendor/laravel/dusk/src/Concerns/ProvidesBrowser.php:218
/home/vagrant/dev/testApp/vendor/laravel/framework/src/Illuminate/Support/helpers.php:234
/home/vagrant/dev/testApp/vendor/laravel/dusk/src/Concerns/ProvidesBrowser.php:219
/home/vagrant/dev/testApp/vendor/laravel/dusk/src/Concerns/ProvidesBrowser.php:97
/home/vagrant/dev/testApp/vendor/laravel/dusk/src/Concerns/ProvidesBrowser.php:65
/home/vagrant/dev/testApp/tests/Browser/ExampleTest.php:22

うーん、なんでやろ。。ちょっとよくわからんな。

Unitテストでは、テスト用のデータベースを作り、それでテストする。
Schemaを使う。

mysql> show databases;
mysql> show tables;

mysql> create database unittest;
$ php artisan migrate –env=testing

mysql> use unittest;
mysql> describe users;

use Illuminate\Support\Facades\Schema;
    public function testExample()
    {
        $this->assertTrue(
            Schema::hasColumns('users',[
                'id', 'name', 'email'
            ]),
            1
        );
    }

$ vendor/bin/phpunit tests/Feature/AdminTest.php
PHPUnit 9.4.2 by Sebastian Bergmann and contributors.

. 1 / 1 (100%)

Time: 00:00.086, Memory: 26.00 MB

OK (1 test, 1 assertion)

DBにデータ挿入

    public function testExample()
    {
        $user = new User();
        $user->name ="hpscript";
        $user->email = "info@hpscript.com";
        $user->password = "password";
        $user->role_id = 1;
        $saveUser = $user->save();

        $this->assertTrue($saveUser);
    }

$ vendor/bin/phpunit tests/Feature/AdminTest.php
PHPUnit 9.4.2 by Sebastian Bergmann and contributors.

. 1 / 1 (100%)

Time: 00:00.094, Memory: 26.00 MB

OK (1 test, 1 assertion)

mysql> select * from users;
+—-+———-+——————-+——————-+———-+——————-+—————————+—————-+—————+—————–+——————–+———————+———————+———+
| id | name | email | email_verified_at | password | two_factor_secret | two_factor_recovery_codes | remember_token | last_login_at | current_team_id | profile_photo_path | created_at | updated_at | role_id |
+—-+———-+——————-+——————-+———-+——————-+—————————+—————-+—————+—————–+——————–+———————+———————+———+
| 1 | hpscript | info@hpscript.com | NULL | password | NULL | NULL | NULL | NULL | NULL | NULL | 2021-01-03 16:44:08 | 2021-01-03 16:44:08 | 1 |
+—-+———-+——————-+——————-+———-+——————-+—————————+—————-+—————+—————–+——————–+———————+———————+———+
1 row in set (0.00 sec)

おおお、入ってる。

use RefreshDatabase;とすると、データが削除されます。

mysql> select * from users;
Empty set (0.00 sec)

なるほど、ちょっと理解してきた。

単体テストがイマイチ腹に落ちない。
やりたいことは、controllerのメソッド単位でのテスト

$ php artisan make:test AdminTest
/tests/Feature/AdminTest.php

    public function testExample()
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }

$ vendor/bin/phpunit tests/Feature/AdminTest.php
PHPUnit 9.4.2 by Sebastian Bergmann and contributors.

. 1 / 1 (100%)

Time: 00:00.144, Memory: 26.00 MB

OK (1 test, 1 assertion)

route/web.php

Route::get('/admin/test/form', [App\Http\Controllers\AdminController::class, 'testForm']);

AdminController

    public function testForm(){
        return "hello";
        // return view('admin.test');
    }

    public function testExample()
    {
        $response =  $this->get('/admin/test/form');
        $response->assertSee("hello");
    }

$ vendor/bin/phpunit tests/Feature/AdminTest.php
PHPUnit 9.4.2 by Sebastian Bergmann and contributors.

. 1 / 1 (100%)

Time: 00:00.086, Memory: 26.00 MB

OK (1 test, 1 assertion)

なるほど、$response->assertSee(); で確認するのか。assertEqualsとかassertSameで確認してた。

$ vendor/bin/phpunit tests/Feature/AdminTest.php

use App\Models\User;
public function testExample()
    {
        // $response = $this->get('/');
        $response =  User::all(); 
        dd($response);
        
    }

$ vendor/bin/phpunit tests/Feature/AdminTest.php
PHPUnit 9.4.2 by Sebastian Bergmann and contributors.

Illuminate\Database\Eloquent\Collection^ {#1678
#items: []
}
なんでnullになるのか理解できん。
データベースのテストの方法が違うっぽいな。

$ cp .env.example .env.testing
$ php artisan key:generate –env=testing
// test用のDB接続
$ vi .env.testing

$ rm ./tests/Feature/ExampleTest.php
$ rm ./tests/Unit/ExampleTest.php

app/Actions/Fortify/CreateNewUser.php

return User::create([
            'name' => $input['name'],
            'company' => $input['company'],
            'role_id' => 1,
            'email' => $input['email'],
            'password' => Hash::make($input['password']),
        ]);

CreateNewUser.phpと同じようなことを書いていく
$ php artisan make:test UserRegisterTest

tests/Feature/UserRegisterTest.php

public function testUserRegister()
    {
        $email = 'hogehoge@gmail.com';
        $this->post(route('register'), [
            'name' => 'testuser',
            'company' => 'test company',
            'email' => $email,
            'password' => 'password',
            'password_confirmation' => 'password'
        ])
            ->assertStatus(302);
 
        $this->assertDatabaseHas('users', ['email' => $email]);
    }

$ vendor/bin/phpunit –testdox
PHPUnit 9.4.3 by Sebastian Bergmann and contributors.

User Register (Tests\Feature\UserRegister)
✔ User register

Time: 00:00.354, Memory: 26.00 MB

OK (1 test, 2 assertions)

なるほど、わかったようなわかってないようなw

– laravel 6系ではmake:authが無くなりました
$ php artisan –version
Laravel Framework 6.9.0
– unit test -> feature testの順番

$ php artisan make:test BookCheckoutTest

use RefreshDatabase;
    public function test_a_book_can_be_check_out(){

        $this->withoutExceptionHandling();

        $book = factory(Book::class)->create();
        $this->actingAs($user = Factory(User::class)->create())
            ->post('/checkout/' . $book->id);

        $this->assertCount(1, Reservation::all());
        $this->assertEquals($user->id, Reservation::first()->user_id);
        $this->assertEquals($book->id, Reservation::first()->book_id);
        $this->assertEquals(now(), Reservation::first()->checked_out_at);
    }

route

Route::post('/checkout/{book}', 'CheckoutBookController@store');

$ php artisan make:controller CheckoutBookController

public function __construct(){
		$this->middleware('auth');
	}
public function store(Book $book){
    	$book->checkout(auth()->user());
    }

$ phpunit –filter test_a_book_can_be_check_out
OK (1 test, 4 assertions)

$ php artisan make:auth
Command “make:auth” is not defined.

### make:auth
$ composer require laravel/ui –dev
$ php artisan ui vue –auth
$ php artisan migrate:refresh
$ npm install

$ phpunit –filter test_only_signed_in_users_can_be_checkout_book
OK (1 test, 3 assertions)

$ php artisan make:controller CheckinBookController

public function __construct(){
		$this->middleware('auth');
	}
    public function store(Book $book){
    	$book->checkin(auth()->user());
    }

public function test_404_is_thrown_if_a_book_is_not_checked_out(){

        $book = factory(Book::class)->create();
        $user = factory(User::class)->create();

        $this->actingAs($user)
            ->post('/checkin/' . $book->id)
            ->assertStatus(404);

        $this->assertCount(0, Reservation::all());
    }

public function __construct(){
		$this->middleware('auth');
	}
    public function store(Book $book){

    	try {
    		$book->checkin(auth()->user());
    	} catch(\Exception $e){
    		return response([], 404);
    	}
    	
    }

make:authがvueのコンポーネントになったということは、LaravelはReactよりvueを支持しているってこと？フロントエンドは確実にvue.jsが必須になってきました。

それと、テストエンジニアってなんか敬遠されがちだが、そもそもtestはフレームワークの仕組みを深く理解してないとできないから、テストエンジニアを下に見るのは偏見がかなり入っている