- \n
- To make smooth working functionality<\/li>\n
- Avoid breaking your entire application<\/li>\n
- Code maintainability<\/li>\n
- Application stability<\/li>\n
- Easy debugging when an application crashes<\/li>\n
- Easy fixating of the reason behind app break-down<\/li>\n<\/ul>\n
The best part is testing is it is automated. It finds the gap in your code and allows you to develop features right.<\/p>\n
How Does Feature Testing in Laravel Work?<\/h3>\n
Laravel supports PHPUnit tests. Your web app comes with a phpunit.xml file with all the settings you need to test your Laravel application. Your phpunit.xml file sets your laravel environment for testing. So there is no need to create a new XML file!<\/p>\n
Below is a sample phpunit.xml file that comes with the Laravel 8 framework.<\/p>\n
![\"phpunit.xml](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/phpunit.xml-file-min.png\")
<\/p>\nInitial Set-Up<\/h2>\n
For this tutorial, we will be working with a hotel review api. The end-user can give reviews for a hotel so that hotel reviews can be added, updated, deleted, and hotel review list operation also.<\/p>\n
Create the laravel application by the below command<\/p>\n
composer create-project --prefer-dist laravel\/laravel hotel_review_api_test\r\ncd hotel_review_api_test\r\n<\/pre>\n
Open the .env file and update the database details.<\/p>\n
DB_CONNECTION=mysql\r\nDB_HOST=127.0.0.1\r\nDB_PORT=3306\r\nDB_DATABASE=hotel_test_api\r\nDB_USERNAME=root\r\nDB_PASSWORD=<\/pre>\n
Create Model and Migration<\/h2>\n
For model, run the below commands.<\/p>\n
php artisan make:model Hotel\r\nphp artisan make:model Review<\/pre>\n
For migration, run the below commands.<\/p>\n
php artisan make:migration create_hotel_table\t\r\nphp artisan make:migration create_review_table<\/pre>\n
Develop. Maintain. Optimize. Deploy \u2013 with Bacancy!<\/span>
\nAre you looking for proficient developers to build highly-optimized applications? Get in touch with us to hire Laravel developer<\/a>. Contact the best, to get the best! Period!<\/i><\/strong><\/p>\nCreate Database Table<\/h2>\n
Now update the migration files by below code mentioned below.<\/p>\n
We will update the user table, hotel table, and review table files. Add the columns as directed. You can edit the columns as per your requirement.<\/p>\n
User Table<\/h3>\n
public function up()\r\n{\r\n Schema::create('users', function (Blueprint $table) {\r\n $table->bigIncrements('id')->unsinged();\r\n $table->string('name');\r\n $table->string('email')->unique();\r\n $table->timestamps();\r\n });\r\n }\r\n<\/pre>\nHotel Table<\/h3>\n
public function up()\r\n{\r\n Schema::create('hotels', function (Blueprint $table) {\r\n $table->bigIncrements('id')->unsinged();\r\n $table->string('name', 100);\r\n $table->text('address')->nullable();\r\n $table->float('star')->nullable();\r\n $table->tinyInteger('active')->default(1)->comment = '1 = active,0 = Inactive';\r\n $table->timestamps();\r\n $table->softDeletes();\r\n });\r\n}\r\n<\/pre>\nReview Table<\/h3>\n
public function up()\r\n{\r\n Schema::create('reviews', function (Blueprint $table) {\r\n $table->bigIncrements('id')->unsinged();\r\n $table->string('title', 100);\r\n $table->text('description', 100);\r\n $table->unsignedBigInteger('user_id')->nullable();\r\n $table->unsignedBigInteger('hotel_id')->nullable();\r\n $table->timestamps(); \r\n$table->softDeletes(); $table->foreign('user_id')->references('id')->on('users')->onDelete('CASCADE')->onUpdate('CASCADE'); $table->foreign('hotel_id')->references('id')->on('hotels')->onDelete('CASCADE')->onUpdate('CASCADE');\r\n });\r\n }\r\n<\/pre>\nRun Migration<\/h3>\n
php artisan migrate<\/pre>\n
Generate API Route and CRUD Business Logic<\/h2>\n
Open \\routes\\api.php and use the below code snippet to generate routes for our APIs. We would have five APIs.<\/p>\n
routes\\api.php<\/strong><\/p>\n
\/\/ Fetch all active hotels data\r\nRoute::get('hotels', [HotelController::class,'getAllHotelData']);\r\n \r\n\/\/ Fetch particular hotel data\r\nRoute::get('hotel\/{hotel_id}', [HotelController::class,'getHotelDataById']);\r\n \r\n\/\/ Add a new hotel review\r\nRoute::post('save-hotel-review', [HotelController::class,'storeHotelReviewData']);\r\n \r\n\/\/ Update hotel review\r\nRoute::put('update-hotel-review\/{review_id}', [HotelController::class,'updateHotelReviewData']);\r\n \r\n\/\/ Delete hotel review\r\nRoute::delete('review\/{review_id}', [HotelController::class,'deleteHotelReview']);<\/pre>\nCRUD Business Logic<\/h3>\n
For the business logic of CRUD operations, create a new HotelController.php file. We won\u2019t be specifying the code snippet for the APIs. But here is the Github link to HotelController.php<\/a> if you wish to have a look. We would be following these five APIs.<\/p>\n
- \n
- \/api\/hotels: Returns all hotel data<\/li>\n
- \/api\/hotel\/{hotel_id}: Returns the data of a particular hotel<\/li>\n
- \/api\/save-hotel-review: Add a hotel review<\/li>\n
- \/api\/update-hotel-review\/{review_id}: Update a hotel review<\/li>\n
- \/api\/review\/{review_id}: Delete a hotel review<\/li>\n<\/ul>\n
Create Feature Test in Laravel Application<\/h2>\n
This section will create our first feature test for our app. Run the below command to generate a file for testing named HotelTest.<\/p>\n
php artisan make:test HotelTest<\/pre>\n
The command will create a new file named HotelTest.php in the tests > Feature folder with the below code.<\/p>\n
( ? p h p\r\n\r\nnamespace Tests \\ Feature;\r\n\r\nuse Tests\\TestCase;\r\nuse Illuminate\\Foundation\\Testing\\WithFaker;\r\nuse Illuminate\\Foundation\\Testing\\RefreshDatabase;\r\n\r\nclass HotelTest extends TestCase\r\n{\r\n \/**\r\n * A basic test example.\r\n *\r\n * @return void\r\n *\/\r\n public function testExample()\r\n {\r\n $this->assertTrue(true);\r\n }\r\n}\r\n<\/pre>\nUpdate HotelTest.php<\/h3>\n
We will be writing tests for each unit of our application for application. We have written tests to ensure that: a hotel review can be added, deleted, updated, and listed that are valid<\/strong>. Update the HotelTest.php<\/em> with the following code.<\/p>\n
![\"Update](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/Update-HotelTest.php-min.jpg\")
<\/p>\nTo get active hotel data of specific hotel<\/strong><\/u><\/p>\n
![\"To](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/To-get-active-hotel-data-of-specific-hotel-min.jpg\")
<\/p>\nTo get all active hotel data <\/strong><\/u><\/p>\n
![\"To](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/To-get-all-active-hotel-data-min.jpg\")
<\/p>\nTo get all inactive hotel data of specific hotel<\/strong><\/u><\/p>\n
![\"To](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/To-get-all-inactive-hotel-data-of-specific-hotel-min.jpg\")
<\/p>\nTo add a new review<\/strong><\/u><\/p>\n
![\"To](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/To-add-a-new-review-min.jpg\")
<\/p>\nTo update specific review<\/strong><\/u><\/p>\n
![\"To](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/To-update-specific-review-min.jpg\")
<\/p>\nTo delete hotel review data<\/strong><\/u><\/p>\n
![\"To](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/To-delete-hotel-review-data-min.jpg\")
<\/p>\nTo store new review required data<\/strong><\/u><\/p>\n
![\"To](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/To-store-new-review-required-data-min.jpg\")
<\/p>\nTo update review required data<\/strong><\/u><\/p>\n
![\"To](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/To-update-review-required-data-min.jpg\")
<\/p>\nTo update reviews that do not exist<\/strong><\/u><\/p>\n
![\"To](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/To-update-reviews-that-do-not-exist-min.jpg\")
<\/p>\nTo delete review that does not exist<\/strong><\/u><\/p>\n
![\"To](\"https:\/\/www.bacancytechnology.com\/blog\/wp-content\/uploads\/2022\/06\/To-delete-review-that-does-not-exist-min.jpg\")
<\/p>\nExplanation<\/strong><\/p>\n
- \n
- test_get_all_active_hotels() is the main function that would run test for the app. Now, what are we testing in this function? It tests all the data of active hotels, which will be returned by the endpoint \/api\/hotels.<\/li>\n
- $this->get(‘\/api\/hotels’) fetches hotel data<\/li>\n
- ->assertStatus(200) validates the HTTP status code returned from the API.<\/li>\n
- ->assertJsonStructure( \u2026 ); validates the JSON structure of the response returned from the endpoint. Here\u2019s the sample response of the API.<\/li>\n<\/ul>\n
{\r\n \"code\": \"200\",\r\n \"message\": \"Hotel Data\",\r\n \"data\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"Hyaat\",\r\n \"address\": \"17\/A, Ashram Rd, Usmanpura, Ahmedabad, Gujarat 380014\",\r\n \"star\": 4,\r\n \"create_at\": \"11\/Jan\/2022 15:40:56\",\r\n \"update_at\": \"11\/Jan\/2022 15:40:56\",\r\n \"active\": \"Active\",\r\n \"review\": [\r\n {\r\n \"id\": 2,\r\n \"title\": \"Good Hotel Hyaat\",\r\n \"description\": \"Hyaat is a very nice hotel.\",\r\n \"author\": \"Parth\",\r\n \"create_at\": \"11\/Jan\/2022 15:40:56\",\r\n \"update_at\": \"11\/Jan\/2022 15:40:56\"\r\n }\r\n ]\r\n },\r\n ] \r\n}\r\n<\/pre>\n- \n
- test_get_active_hotel_by_id<\/em> validates the hotel review data based on hotel ID.<\/li>\n
- test_for_get_inactive_hotel_by_id<\/em> validates the hotel review data when passed the inactive hotel ID.<\/li>\n
- test_for_add_hotel_review<\/em> validates the add hotel review functionality when all data are passed valid<\/li>\n
- Function test_for_update_hotel_review<\/em> validates the updated hotel review functionality when all data are passed valid<\/li>\n
- Function test_for_delete_hotel_review<\/em> validate the delete hotel review functionality when passed valid hotel review ID.<\/li>\n
- Function test_for_add_hotel_review_required_fields<\/em> validates the required field validation when no data passed when adding a new hotel review API called.<\/li>\n
- Function test_for_update_hotel_review_required_fields<\/em> validates the required field validation when no data passed when updating the new hotel review API called.<\/li>\n
- Function test_for_update_hotel_review_that_not_exist<\/em> validates the case when hotel review id passed that does not exist in database for update hotel review functionality.<\/li>\n
- Function test_for_delete_review_that_not_exist<\/em> validates the case when a hotel review id passed that does not exist in the database for delete hotel review functionality.<\/li>\n
- Other assertJson like below<\/li>\n
->assertJson([\r\n 'code' => '401',\r\n 'message' => 'Review not found, Please try again',\r\n ]);\r\n<\/pre>\n
- \n
- assertEquals() and assertNull()<\/li>\n<\/ul>\n
assertEquals() is used to compare the actual value of the variable to the expected value. Unlike assertTrue(), assertFalse(), and assertNull(), assertEquals() takes two parameters. The first being the expected value, and the second being the actual value.<\/p>\n
- \n
- assertContains(), assertCount(), and assertEmpty()<\/li>\n<\/ul>\n
assertContains() asserts that an expected value exists within the provided array, assertCount() asserts the number of items in the array matches the specified amount, and assertEmpty() asserts that the provided array is empty.<\/p>\n
Visit Laravel documentation<\/a> to learn about other functions.<\/p>\n
Run the Test Cases<\/h2>\n
Use the below command at the root folder for running the test cases.<\/p>\n
php artisan test<\/pre>\n
Github Repository: Feature Testing in Laravel Example<\/h2>\n
You can visit the source code<\/a> and clone the repository to play around with the code.<\/p>\n
Conclusion<\/h2>\n
- assertContains(), assertCount(), and assertEmpty()<\/li>\n<\/ul>\n
- test_for_get_inactive_hotel_by_id<\/em> validates the hotel review data when passed the inactive hotel ID.<\/li>\n
- test_get_active_hotel_by_id<\/em> validates the hotel review data based on hotel ID.<\/li>\n