1.Giới thiệu
Ở bài viết này(link) mình đã hướng dẫn các bước cài đặt cơ bản. Bài viết này hướng dẫn cách bạn có thể làm việc với cơ sở dữ liệu của mình khi test Laravel Dusk.
Việc đầu tiên là tạo cơ sở dữ liệu riêng phục vụ cho việc test, tránh ảnh huổng tới dữ liệu gốc của Laravel app. Chúng ta sẽ cấu hình trong file .env.dusk như sau.
1 2 3 4 5 6 7 | DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=laravel_dusk DB_USERNAME=root DB_PASSWORD= |
Ở đây mình đã tạo một database là laravel_dusk và sử dụng hệ quản trị cơ sở dữ liệu Mysql
2.Sử dụng DatabaseMigations trong Dusk
Mặc định Laravel cung cấp ba traits là DatabaseMigrations, DatabaseTransactions và RefreshDatabase để làm việc với database trong testing. Tuy nhiên khi testing với dusk chúng ta chỉ có thể sử dụng DatabaseMigrations vì DatabaseTransaction không được áp dụng trong browser test (HTTP Request) và RefreshDatabase thì được xây dựng dựa trên DatabaseTransaction.
Bạn chỉ cần import DatabaseMigrations trong các file chứa test case, nó sẽ chạy toàn bộ các phương thức up() trước mỗi test và sau đó chạy toàn bộ các phương thức down() sau mỗi test. Ngĩa là nó sẽ tạo các table, thêm/sửa các column trước khi test và sau đó drop tất cả sau khi quá trình test kết thúc
Phương thức up() và down() khi tạo một table
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | <span class="token php language-php"><span class="token delimiter important"><?php</span> <span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation"></span>Database<span class="token punctuation"></span>Migrations<span class="token punctuation"></span>Migration</span><span class="token punctuation">;</span> <span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation"></span>Database<span class="token punctuation"></span>Schema<span class="token punctuation"></span>Blueprint</span><span class="token punctuation">;</span> <span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation"></span>Support<span class="token punctuation"></span>Facades<span class="token punctuation"></span>Schema</span><span class="token punctuation">;</span> <span class="token keyword">class</span> <span class="token class-name">CreateUsersTable</span> <span class="token keyword">extends</span> <span class="token class-name">Migration</span> <span class="token punctuation">{</span> <span class="token comment">/** * Run the migrations. * * @return void */</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">up</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> Schema<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'users'</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span>Blueprint <span class="token variable">$table</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">bigIncrements</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'id'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">string</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'name'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">string</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'email'</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">unique</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">timestamp</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'email_verified_at'</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">nullable</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">string</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'password'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">rememberToken</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">timestamps</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token comment">/** * Reverse the migrations. * * @return void */</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">down</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> Schema<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">dropIfExists</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'users'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </span> |
Để sử dụng DatabaseMigrations chỉ cần import từ IlluminateFoundationTestingDatabaseMigrations và use trong class định nghĩa các test case như sau
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <span class="token php language-php"><span class="token delimiter important"><?php</span> <span class="token keyword">namespace</span> <span class="token package">Tests<span class="token punctuation"></span>Browser</span><span class="token punctuation">;</span> <span class="token keyword">use</span> <span class="token package">App<span class="token punctuation"></span>User</span><span class="token punctuation">;</span> <span class="token keyword">use</span> <span class="token package">Tests<span class="token punctuation"></span>DuskTestCase</span><span class="token punctuation">;</span> <span class="token keyword">use</span> <span class="token package">Laravel<span class="token punctuation"></span>Dusk<span class="token punctuation"></span>Chrome</span><span class="token punctuation">;</span> <span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation"></span>Foundation<span class="token punctuation"></span>Testing<span class="token punctuation"></span>DatabaseMigrations</span><span class="token punctuation">;</span> <span class="token keyword">class</span> <span class="token class-name">ExampleTest</span> <span class="token keyword">extends</span> <span class="token class-name">DuskTestCase</span> <span class="token punctuation">{</span> <span class="token keyword">use</span> <span class="token package">DatabaseMigrations</span><span class="token punctuation">;</span> <span class="token comment">/** @test */</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">userLoginTest</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">{</span> <span class="token variable">$user</span> <span class="token operator">=</span> <span class="token function">factory</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'AppUser'</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">create</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">browse</span><span class="token punctuation">(</span><span class="token keyword">function</span> <span class="token punctuation">(</span>Browser <span class="token variable">$browser</span><span class="token punctuation">)</span> <span class="token keyword">use</span><span class="token punctuation">(</span><span class="token variable">$user</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token variable">$browser</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">loginAs</span><span class="token punctuation">(</span><span class="token variable">$user</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">visit</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'/home'</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">assertSee</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'Dashboard'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </span> |
DatabaseMigations thực hiện điều này bằng cách chạy lệnh php artisan migrate trong phương thức setUp() trước khi chạy test và sau đó chạy lệnh php artisan migrate:rollback sau khi chạy mỗi test trong phương thức tearDown(). Xem thêm setUp và tearDown method
Như bạn có thể thấy trong ví dụ trên, ta cũng có thể sử dụng factory methods để tạo dữ liệu test trong cơ sở dữ liệu, sau đó sử dụng các dữ liệu này trong dusk test.
2.1 Tạo dữ liệu mẫu trước khi chạy Dusk Test.
Sau khi tạo các table cho database bằng migrate, ta có thể tạo một số dữ liệu cần thiết vào cơ sở dữ liệu mẫu để phục vụ cho Laravel app bằng seeding sử dụng lệnh
1 2 | php artisan db:seed |
Bạn cũng có thể thực hiện việc này bằng overide lại phương thức setUp() và chạy lệnh trên ngay trong phương thức này
1 2 3 4 5 6 7 | <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">setUp</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">parent</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">setUp</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">artisan</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'db:seed'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> |
Điều này đảm bảo rằng dữ liệu mẫu sẽ được tạo trước khi test.
2.2 Nhược điểm của việc sử dụng DatabaseMigrations
Sử dụng DatabaseMigations sẽ tốn rất nhiều thời gian để thực hiện test. Trong trường hợp cơ sở dữ liệu lớn với rất nhiều table, DatabaseMigations sẽ tạo tất cả các bảng trước khi test và sẽ hủy chúng sau khi test, quá trình này sẽ mất rất nhiều thời gian.
Vì vậy, thay vì sử dụng DatabaseMigations bạn có thể chạy lệnh migrate và db:seed thủ công trước khi test và trong trường hợp bạn chỉ muốn xóa dữ liệu sau khi test nhưng vẫn giữ nguyên các table thì có thể sử dụng phương thức truncate để xóa dữ liệu trong các table trong phương thức tearDown()
1 2 3 4 5 6 | <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">tearDown</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> User<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">truncate</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">parent</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">tearDown</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> |
3.Authentication
3.1 Login và Logout trong Laravel Dusk
Khi muốn test một chức năng nào đó yêu cầu người dùng phải đăng nhập vào trước, bạn có thể sử dụng phương thức loginAs được cung cấp bởi laravel dusk
1 2 3 4 5 6 7 8 9 10 | <span class="token comment">/** @test */</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">testAuthentication</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">browse</span><span class="token punctuation">(</span><span class="token keyword">function</span> <span class="token punctuation">(</span>Browser <span class="token variable">$browser</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token variable">$browser</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">loginAs</span><span class="token punctuation">(</span>User<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">find</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">visit</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'/home'</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">assertSee</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'Dashboard'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> |
Điều này sẽ giúp ta có thể login ngay mà không cần phải đi từ trang login vào và giúp tiết kiệm rất nhiều thời gian. Phương thức loginAs nhận tham số là đối tượng của class User hoặc id của user hay thậm chí là email
1 2 3 4 | <span class="token variable">$browser</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">loginAs</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$browser</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">loginAs</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'<a href="/cdn-cgi/l/email-protection" class="__cf_email__">[email protected]</a>'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$browser</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">loginAs</span><span class="token punctuation">(</span><span class="token variable">$user</span><span class="token punctuation">)</span><span class="token punctuation">;</span> |
Ngược lại, khi bạn muốn đăng xuất, chỉ cần gọi đến phương thức logOut()
3.2 Authentication test
Laravel dusk cung cấp một số phương thức giúp bạn có thể test các chức năng authentication.
Để kiểm tra khi người dùng sử dụng web với role là khách vãng lai (guest) ta có thể sử dụng phương thức assertGuest()
1 2 3 4 5 6 7 8 9 10 11 12 | <span class="token comment">/** @test */</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">testAuthentication</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">browse</span><span class="token punctuation">(</span><span class="token keyword">function</span> <span class="token punctuation">(</span>Browser <span class="token variable">$browser</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token variable">$browser</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">loginAs</span><span class="token punctuation">(</span>User<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">find</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">visit</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'/home'</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">assertSee</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'Dashboard'</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">logout</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">assertGuest</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> |
Và ngược lại bạn cũng có thể kiểm tra người dùng đã đăng nhập thành công hay chưa dựa vào phương thức assertAuthenticated()
1 2 3 4 5 6 7 8 9 10 11 | <span class="token comment">/** @test */</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">testAuthentication</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">browse</span><span class="token punctuation">(</span><span class="token keyword">function</span> <span class="token punctuation">(</span>Browser <span class="token variable">$browser</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token variable">$browser</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">loginAs</span><span class="token punctuation">(</span>User<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">find</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">visit</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'/home'</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">assertSee</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'Dashboard'</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">assertAuthenticated</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> |
Hoặc cũng có thể kiểm tra người dùng đã đăng nhập với một user cụ thể bằng assertAuthenticatedAs()
1 2 3 4 5 6 7 8 9 10 11 | <span class="token comment">/** @test */</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">testAuthentication</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">browse</span><span class="token punctuation">(</span><span class="token keyword">function</span> <span class="token punctuation">(</span>Browser <span class="token variable">$browser</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token variable">$browser</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">loginAs</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">visit</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'/home'</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">assertSee</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'Dashboard'</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span><span class="token function">assertAuthenticatedAs</span><span class="token punctuation">(</span>User<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">find</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> |
4.Kết
Trên đây là phần giới thiệu DatabaseMigations và các cách để làm việc với authentication trong laravel dusk. Cảm ơn các bạn đã quan tâm theo dõi, hẹn gặp lại ở các phần sau ?