Product reviews API #8772
[Unit Testing]: ProductReviewApi Controller
- Loading branch information
commit e998b59df2c0d9d9443a0c00a3627a7fb22ff779
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,359 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Sylius package. | ||
| * | ||
| * (c) Paweł Jędrzejewski | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Sylius\Tests\Controller; | ||
|
|
||
| use Lakion\ApiTestCase\JsonApiTestCase; | ||
| use Sylius\Component\Core\Model\ProductInterface; | ||
| use Sylius\Component\Core\Model\ProductReview; | ||
| use Symfony\Component\HttpFoundation\Response; | ||
|
|
||
| /** | ||
| * @author Paul Stoica <paul.stoica18@gmail.com> | ||
| */ | ||
| final class ProductReviewApiTest extends JsonApiTestCase | ||
| { | ||
| /** | ||
| * @var array | ||
| */ | ||
| private static $authorizedHeaderWithContentType = [ | ||
| 'HTTP_Authorization' => 'Bearer SampleTokenNjZkNjY2MDEwMTAzMDkxMGE0OTlhYzU3NzYyMTE0ZGQ3ODcyMDAwM2EwMDZjNDI5NDlhMDdlMQ', | ||
| 'CONTENT_TYPE' => 'application/json', | ||
| ]; | ||
|
|
||
| /** | ||
| * @var array | ||
| */ | ||
| private static $authorizedHeaderWithAccept = [ | ||
| 'HTTP_Authorization' => 'Bearer SampleTokenNjZkNjY2MDEwMTAzMDkxMGE0OTlhYzU3NzYyMTE0ZGQ3ODcyMDAwM2EwMDZjNDI5NDlhMDdlMQ', | ||
| 'ACCEPT' => 'application/json', | ||
| ]; | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_does_not_allow_to_show_product_review_list_when_access_is_denied() | ||
| { | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| $this->client->request('GET', $this->getReviewListUrl($product)); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'authentication/access_denied_response', Response::HTTP_UNAUTHORIZED); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_does_not_allow_to_show_product_review_when_it_does_not_exist() | ||
| { | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| $this->client->request('GET', $this->getReviewListUrl($product) . '0', [], [], static::$authorizedHeaderWithAccept); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'error/not_found_response', Response::HTTP_NOT_FOUND); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_allows_showing_product_review() | ||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| /** @var ProductReview $productReview */ | ||
| $productReview = $productReviewsData['productReview1']; | ||
|
|
||
| $this->client->request('GET', $this->getReviewUrl($product, $productReview), [], [], static::$authorizedHeaderWithAccept); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'product_review/show_response', Response::HTTP_OK); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_allows_indexing_product_reviews() | ||
|
There was a problem hiding this comment. @lchrusciel there is a test method: "it_does_not_allows_showing_product_review_list_when_access_is_denied", or what do you mean? |
||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| $this->client->request('GET', $this->getReviewListUrl($product), [], [], static::$authorizedHeaderWithAccept); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'product_review/index_response', Response::HTTP_OK); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_allows_create_product_review() | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. Hello @Zales0123, For these methods names I checked also tests/Controller/ProductVariantApiTest.php witch have added the same method name's logic: "it_allows_create_product_variant"; it means that for tests/Controller/ProductVariantApiTest.php is also incorect? if not, what is the difference between ProductReviewApiTest.php and ProductVariantApiTest.php, why for one is correct and for the other one, not? Thank you. There was a problem hiding this comment. For the name of the methods the most important requirement is language correctness :) So even if somewhere else method names are named incorrectly (from the grammatical point of view) we should on writing new ones as perfect as possible. There was a problem hiding this comment. Alright, then I will rewrite, these methods name, with the good ones, for tests/Controller/ProductReviewApiTest.php. |
||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| $data = | ||
| <<<EOT | ||
| { | ||
| "title": "J_REVIEW", | ||
| "rating": "3", | ||
| "comment": "J_REVIEW_COMMENT", | ||
|
There was a problem hiding this comment. Don't be afraid of using some more natural exemplary data, these are of course not wrong, but less natural to read. Tests are good place to place easter eggs in code (look at our Behat scenarios and I'll see what I mean 😄 ) |
||
| "author": { | ||
| "email": "j@example.com" | ||
| } | ||
| } | ||
| EOT; | ||
|
|
||
| $this->client->request('POST', $this->getReviewListUrl($product), [], [], static::$authorizedHeaderWithContentType, $data); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'product_review/create_response', Response::HTTP_CREATED); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_does_not_allow_to_create_product_review_without_required_fields() | ||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| $this->client->request('POST', $this->getReviewListUrl($product), [], [], static::$authorizedHeaderWithContentType, []); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'product_review/create_validation_fail_response', Response::HTTP_BAD_REQUEST); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_does_not_allow_delete_product_review_if_it_does_not_exist() | ||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| $this->client->request('DELETE', $this->getReviewListUrl($product) . '0', [], [], static::$authorizedHeaderWithAccept); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'error/not_found_response', Response::HTTP_NOT_FOUND); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_allows_delete_product_review() | ||
|
There was a problem hiding this comment.
|
||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| /** @var ProductReview $productReview */ | ||
| $productReview = $productReviewsData['productReview1']; | ||
|
|
||
| $this->client->request('DELETE', $this->getReviewUrl($product, $productReview), [], [], static::$authorizedHeaderWithContentType, []); | ||
|
|
||
| $response = $this->client->getResponse(); | ||
| $this->assertResponseCode($response, Response::HTTP_NO_CONTENT); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| $this->client->request('GET', $this->getReviewUrl($product, $productReview), [], [], static::$authorizedHeaderWithAccept); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'error/not_found_response', Response::HTTP_NOT_FOUND); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_allows_updating_information_about_product_review() | ||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| /** @var ProductReview $productReview */ | ||
| $productReview = $productReviewsData['productReview1']; | ||
|
|
||
| $data = | ||
| <<<EOT | ||
| { | ||
| "title": "NEW_REVIEW_TITLE", | ||
| "rating": "1", | ||
| "comment": "NEW_REVIEW_COMMENT" | ||
| } | ||
| EOT; | ||
| $this->client->request('PUT', $this->getReviewUrl($product, $productReview), [], [], static::$authorizedHeaderWithContentType, $data); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponseCode($response, Response::HTTP_NO_CONTENT); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_allows_updating_partial_information_about_product_review() | ||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
| $this->loadFixturesFromFile('resources/locales.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| /** @var ProductReview $productReview */ | ||
| $productReview = $productReviewsData['productReview1']; | ||
|
|
||
| $data = | ||
| <<<EOT | ||
| { | ||
| "comment": "A_NEW_REVIEW_COMMENT" | ||
| } | ||
| EOT; | ||
|
|
||
| $this->client->request('PATCH', $this->getReviewUrl($product, $productReview), [], [], static::$authorizedHeaderWithContentType, $data); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponseCode($response, Response::HTTP_NO_CONTENT); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_allows_accept_product_review() | ||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| /** @var ProductReview $productReview */ | ||
| $productReview = $productReviewsData['productReview1']; | ||
|
|
||
| $this->client->request('PATCH', $this->getReviewUrl($product, $productReview) . '/accept', [], [], static::$authorizedHeaderWithAccept); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'product_review/accept_response', Response::HTTP_OK); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_does_not_allows_accept_product_review_if_it_has_not_new_status() | ||
|
There was a problem hiding this comment.
|
||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| /** @var ProductReview $productReview */ | ||
| $productReview = $productReviewsData['productReview2']; | ||
|
|
||
| $this->client->request('POST', $this->getReviewUrl($product, $productReview) . '/accept', [], [], static::$authorizedHeaderWithAccept); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'product_review/change_status_fail_response', Response::HTTP_BAD_REQUEST); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_allows_reject_product_review() | ||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| /** @var ProductReview $productReview */ | ||
| $productReview = $productReviewsData['productReview1']; | ||
|
|
||
| $this->client->request('PATCH', $this->getReviewUrl($product, $productReview) . '/reject', [], [], static::$authorizedHeaderWithAccept); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'product_review/reject_response', Response::HTTP_OK); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function it_does_not_allows_reject_product_review_if_it_has_not_new_status() | ||
| { | ||
| $this->loadFixturesFromFile('authentication/api_administrator.yml'); | ||
| $productReviewsData = $this->loadFixturesFromFile('resources/product_reviews.yml'); | ||
|
|
||
| /** @var ProductInterface $product */ | ||
| $product = $productReviewsData['product1']; | ||
|
|
||
| /** @var ProductReview $productReview */ | ||
| $productReview = $productReviewsData['productReview3']; | ||
|
|
||
| $this->client->request('POST', $this->getReviewUrl($product, $productReview) . '/accept', [], [], static::$authorizedHeaderWithAccept); | ||
| $response = $this->client->getResponse(); | ||
|
|
||
| $this->assertResponse($response, 'product_review/change_status_fail_response', Response::HTTP_BAD_REQUEST); | ||
| } | ||
|
|
||
| /** | ||
| * @param ProductInterface $product | ||
| * | ||
| * @return string | ||
| */ | ||
| private function getReviewListUrl(ProductInterface $product) | ||
| { | ||
| return sprintf('/api/v1/products/%s/reviews/', $product->getCode()); | ||
| } | ||
|
|
||
| /** | ||
| * @param ProductInterface $product | ||
| * @param ProductReview $productReview | ||
|
There was a problem hiding this comment. Hi, There was a problem hiding this comment. My bad, there should be |
||
| * | ||
| * @return string | ||
| */ | ||
| private function getReviewUrl(ProductInterface $product, ProductReview $productReview) | ||
|
There was a problem hiding this comment.
|
||
| { | ||
| return sprintf('%s%s', $this->getReviewListUrl($product), $productReview->getId()); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
We are not adding author doc blocks anymore. Relevant PR #8882