From 13c34ad295d0ab007971183a2e7d0761e522af07 Mon Sep 17 00:00:00 2001 From: nigeljamesstevenson <105309450+nigeljamesstevenson@users.noreply.github.com> Date: Tue, 11 Oct 2022 14:54:48 +0100 Subject: [PATCH] api-core-tests product properties tests (#34998) * api-core-tests product properties tests * api-core-tests products tests * api-core-tests products tests --- ...i-core-tests-product-properties-crud-tests | 4 + .../tests/products/products-crud.test.js | 1014 +++++++++++++++-- 2 files changed, 920 insertions(+), 98 deletions(-) create mode 100644 plugins/woocommerce/changelog/add-api-core-tests-product-properties-crud-tests diff --git a/plugins/woocommerce/changelog/add-api-core-tests-product-properties-crud-tests b/plugins/woocommerce/changelog/add-api-core-tests-product-properties-crud-tests new file mode 100644 index 00000000000..d3126c324b7 --- /dev/null +++ b/plugins/woocommerce/changelog/add-api-core-tests-product-properties-crud-tests @@ -0,0 +1,4 @@ +Significance: patch +Type: add + +Add playwright api-core-tests for product properties crud operations \ No newline at end of file diff --git a/plugins/woocommerce/tests/api-core-tests/tests/products/products-crud.test.js b/plugins/woocommerce/tests/api-core-tests/tests/products/products-crud.test.js index b05dcb32750..017fdc10285 100644 --- a/plugins/woocommerce/tests/api-core-tests/tests/products/products-crud.test.js +++ b/plugins/woocommerce/tests/api-core-tests/tests/products/products-crud.test.js @@ -1,4 +1,7 @@ -const { test, expect } = require( '@playwright/test' ); +const { + test, + expect +} = require('@playwright/test'); /** * Internal dependencies @@ -7,8 +10,10 @@ const { simpleProduct, virtualProduct, variableProduct, -} = require( '../../data/products-crud' ); -const { batch } = require( '../../data/shared/batch-update' ); +} = require('../../data/products-crud'); +const { + batch +} = require('../../data/shared/batch-update'); /** * Tests for the WooCommerce Products API. @@ -18,101 +23,903 @@ const { batch } = require( '../../data/shared/batch-update' ); * @group products * */ -test.describe( 'Products API tests: CRUD', () => { +test.describe('Products API tests: CRUD', () => { let productId; - test( 'can add a simple product', async ( { request } ) => { - const response = await request.post( 'wp-json/wc/v3/products', { + test('can add a simple product', async ({ + request + }) => { + const response = await request.post('wp-json/wc/v3/products', { data: simpleProduct, - } ); + }); const responseJSON = await response.json(); productId = responseJSON.id; - expect( response.status() ).toEqual( 201 ); - expect( typeof productId ).toEqual( 'number' ); - expect( responseJSON ).toMatchObject( simpleProduct ); - expect( responseJSON.type ).toEqual( 'simple' ); - expect( responseJSON.status ).toEqual( 'publish' ); - expect( responseJSON.virtual ).toEqual( false ); - expect( responseJSON.downloadable ).toEqual( false ); - expect( responseJSON.shipping_required ).toEqual( true ); - } ); + expect(response.status()).toEqual(201); + expect(typeof productId).toEqual('number'); + expect(responseJSON).toMatchObject(simpleProduct); + expect(responseJSON.type).toEqual('simple'); + expect(responseJSON.status).toEqual('publish'); + expect(responseJSON.virtual).toEqual(false); + expect(responseJSON.downloadable).toEqual(false); + expect(responseJSON.shipping_required).toEqual(true); + }); - test( 'can add a virtual product', async ( { request } ) => { - const response = await request.post( 'wp-json/wc/v3/products', { + test.describe('Product attributes tests: CRUD', () => { + let productAttributeId; + + test('can add a product attribute', async ({ + request + }) => { + const response = await request.post('wp-json/wc/v3/products/attributes', { + data: { + name: "Shape", + slug: "pa_shape", + type: "select", + order_by: "menu_order", + has_archives: true + } + }); + const responseJSON = await response.json(); + productAttributeId = responseJSON.id; + + expect(response.status()).toEqual(201); + expect(typeof productAttributeId).toEqual('number'); + expect(responseJSON.name).toEqual('Shape'); + expect(responseJSON.slug).toEqual('pa_shape'); + expect(responseJSON.type).toEqual('select'); + expect(responseJSON.order_by).toEqual('menu_order'); + expect(responseJSON.has_archives).toEqual(true); + + }); + + test.describe('Product attribute terms tests: CRUD', () => { + let productAttributeTermId; + + test('can add a product attribute term', async ({ + request + }) => { + const response = await request.post(`wp-json/wc/v3/products/attributes/${productAttributeId}/terms`, { + data: { + name: "Circle", + } + }); + const responseJSON = await response.json(); + productAttributeTermId = responseJSON.id; + + expect(response.status()).toEqual(201); + expect(typeof productAttributeTermId).toEqual('number'); + expect(responseJSON.name).toEqual('Circle'); + expect(responseJSON.slug).toEqual('circle'); + expect(responseJSON.menu_order).toEqual(0); + expect(responseJSON.count).toEqual(0); + }); + + test('can retrieve a product attribute term', async ({ + request + }) => { + const response = await request.get(`wp-json/wc/v3/products/attributes/${productAttributeId}/terms/${productAttributeTermId}`); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productAttributeTermId); + expect(responseJSON.name).toEqual('Circle'); + expect(responseJSON.slug).toEqual('circle'); + expect(responseJSON.menu_order).toEqual(0); + expect(responseJSON.count).toEqual(0); + }); + + test('can retrieve all product attribute terms', async ({ + request + }) => { + // call API to retrieve all product attributes + const response = await request.get(`wp-json/wc/v3/products/attributes/${productAttributeId}/terms`); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(Array.isArray(responseJSON)).toBe(true); + expect(responseJSON.length).toBeGreaterThan(0); + }); + + test('can update a product attribute term', async ({ + request + }) => { + // call API to update a product attribute term + const response = await request.put(`wp-json/wc/v3/products/attributes/${productAttributeId}/terms/${productAttributeTermId}`, { + data: { + name:'Square' + } + }); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productAttributeTermId); + expect(responseJSON.name).toEqual('Square'); + expect(responseJSON.slug).toEqual('circle'); + expect(responseJSON.menu_order).toEqual(0); + expect(responseJSON.count).toEqual(0); + }); + + test('can permanently delete a product attribute term', async ({ + request + }) => { + // Delete the product attribute term. + const response = await request.delete( + `wp-json/wc/v3/products/attributes/${productAttributeId}/terms/${productAttributeTermId}`, { + data: { + force: true, + }, + } + ); + expect(response.status()).toEqual(200); + + // Verify that the product attribute term can no longer be retrieved. + const getDeletedProductAttributeTermResponse = await request.get( + `wp-json/wc/v3/products/attributes/${productAttributeId}/terms/${productAttributeTermId}` + ); + expect(getDeletedProductAttributeTermResponse.status()).toEqual(404); + }); + + test('can batch update product attribute terms', async ({ + request + }) => { + // Batch create 2 product attribute terms + const response = await request.post( + `wp-json/wc/v3/products/attributes/${productAttributeId}/terms/batch`, { + data: { + create: [{ + name: "Rectangle" + }, + { + name: "Oblong" + } + ] + } + } + ); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.create[0].name).toEqual('Rectangle'); + expect(responseJSON.create[1].name).toEqual('Oblong'); + const termId1 = responseJSON.create[0].id; + const termId2 = responseJSON.create[1].id; + + // Batch create a new attribute term, update a term and delete another. + const responseBatchUpdate = await request.post( + `wp-json/wc/v3/products/attributes/${productAttributeId}/terms/batch`, { + data: { + create: [{ + name: "Triangle" + }, ], + update: [{ + id: termId1, + description: "description for a Rectangle" + }], + delete: [ + termId2 + ] + } + } + ); + const responseBatchUpdateJSON = await responseBatchUpdate.json(); + const termId3 = responseBatchUpdateJSON.create[0].id; + expect(responseBatchUpdate.status()).toEqual(200); + + const responseUpdatedTerm1 = await request.get(`wp-json/wc/v3/products/attributes/${productAttributeId}/terms/${termId1}`); + const responseUpdatedTerm1JSON = await responseUpdatedTerm1.json(); + expect(responseUpdatedTerm1JSON.description).toEqual('description for a Rectangle'); + + // Verify that the deleted product attribute can no longer be retrieved. + const getDeletedTermResponse = await request.get( + `wp-json/wc/v3/products/attributes/${productAttributeId}/terms/${termId2}` + ); + expect(getDeletedTermResponse.status()).toEqual(404); + + // Batch delete the created terms + await request.post( + `wp-json/wc/v3/products/attributes/${productAttributeId}/terms/batch`, { + data: { + delete: [termId1, termId3] + } + } + ); + }); + }); + + test('can retrieve a product attribute', async ({ + request + }) => { + const response = await request.get(`wp-json/wc/v3/products/attributes/${productAttributeId}`); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productAttributeId); + expect(responseJSON.name).toEqual('Shape'); + expect(responseJSON.slug).toEqual('pa_shape'); + expect(responseJSON.type).toEqual('select'); + expect(responseJSON.order_by).toEqual('menu_order'); + expect(responseJSON.has_archives).toEqual(true); + }); + + test('can retrieve all product attribute', async ({ + request + }) => { + // call API to retrieve all product attributes + const response = await request.get('/wp-json/wc/v3/products/attributes'); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(Array.isArray(responseJSON)).toBe(true); + expect(responseJSON.length).toBeGreaterThan(0); + }); + + test('can update a product attribute', async ({ + request + }) => { + // call API to update a product attribute + const response = await request.put(`wp-json/wc/v3/products/attributes/${productAttributeId}`, { + data: { + order_by: 'name', + } + }); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productAttributeId); + expect(responseJSON.name).toEqual('Shape'); + expect(responseJSON.slug).toEqual('pa_shape'); + expect(responseJSON.type).toEqual('select'); + expect(responseJSON.order_by).toEqual('name'); + // the below has_archives test is currently not working as expected + // an issue (https://github.com/woocommerce/woocommerce/issues/34991) + // has been raised and this test can be + // updated as appropriate after triage + // expect(responseJSON.has_archives).toEqual(true); + }); + + test('can permanently delete a product attribute', async ({ + request + }) => { + // Delete the product attribute. + const response = await request.delete( + `wp-json/wc/v3/products/attributes/${productAttributeId}`, { + data: { + force: true, + }, + } + ); + expect(response.status()).toEqual(200); + + // Verify that the product attribute can no longer be retrieved. + const getDeletedProductAttributeResponse = await request.get( + `wp-json/wc/v3/products/attributes/${productAttributeId}` + ); + expect(getDeletedProductAttributeResponse.status()).toEqual(404); + }); + + test('can batch update product attributes', async ({ + request + }) => { + // Batch create 2 product attributes + const response = await request.post( + `wp-json/wc/v3/products/attributes/batch`, { + data: { + create: [{ + name: "Smell" + }, + { + name: "Weight" + } + ] + } + } + ); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.create[0].name).toEqual('Smell'); + expect(responseJSON.create[1].name).toEqual('Weight'); + const attributeId1 = responseJSON.create[0].id; + const attributeId2 = responseJSON.create[1].id; + + // Batch create a new attribute, update an attribute and delete another. + const responseBatchUpdate = await request.post( + `wp-json/wc/v3/products/attributes/batch`, { + data: { + create: [{ + name: "Height" + }, ], + update: [{ + id: attributeId1, + order_by: "name_num" + }], + delete: [ + attributeId2 + ] + } + } + ); + const responseBatchUpdateJSON = await responseBatchUpdate.json(); + const attributeId3 = responseBatchUpdateJSON.create[0].id; + expect(responseBatchUpdate.status()).toEqual(200); + + const responseUpdatedAttribute1 = await request.get(`wp-json/wc/v3/products/attributes/${attributeId1}`); + const responseUpdatedAttribute1JSON = await responseUpdatedAttribute1.json(); + expect(responseUpdatedAttribute1JSON.order_by).toEqual('name_num'); + + // Verify that the deleted product attribute can no longer be retrieved. + const getDeletedAttributeResponse = await request.get( + `wp-json/wc/v3/products/attributes/${attributeId2}` + ); + expect(getDeletedAttributeResponse.status()).toEqual(404); + + // Batch delete the created attribute + await request.post( + `wp-json/wc/v3/products/attributes/batch`, { + data: { + delete: [attributeId1, attributeId3] + } + } + ); + }); + }); + + test.describe('Product categories tests: CRUD', () => { + let productCategoryId; + + test('can add a product category', async ({ + request + }) => { + const response = await request.post('wp-json/wc/v3/products/categories', { + data: { + name: 'Video Games' + }, + }); + const responseJSON = await response.json(); + productCategoryId = responseJSON.id; + + expect(response.status()).toEqual(201); + expect(typeof productCategoryId).toEqual('number'); + expect(responseJSON.name).toEqual('Video Games'); + expect(responseJSON.slug).toEqual('video-games'); + expect(responseJSON.parent).toEqual(0); + expect(responseJSON.description).toEqual(''); + expect(responseJSON.display).toEqual('default'); + expect(responseJSON.image).toEqual(null); + expect(responseJSON.menu_order).toEqual(0); + expect(responseJSON.count).toEqual(0); + }); + + test('can retrieve a product category', async ({ + request + }) => { + const response = await request.get(`wp-json/wc/v3/products/categories/${productCategoryId}`); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productCategoryId); + expect(responseJSON.name).toEqual('Video Games'); + expect(responseJSON.slug).toEqual('video-games'); + expect(responseJSON.parent).toEqual(0); + expect(responseJSON.description).toEqual(''); + expect(responseJSON.display).toEqual('default'); + expect(responseJSON.image).toEqual(null); + expect(responseJSON.menu_order).toEqual(0); + expect(responseJSON.count).toEqual(0); + + }); + + + test('can retrieve all product categories', async ({ + request + }) => { + // call API to retrieve all product tags + const response = await request.get('/wp-json/wc/v3/products/categories'); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(Array.isArray(responseJSON)).toBe(true); + // There will initially be a product category of 'Uncategorized' + expect(responseJSON.length).toBeGreaterThan(1); + }); + + test('can update a product category', async ({ + request + }) => { + // call API to retrieve all product tags + const response = await request.put(`wp-json/wc/v3/products/categories/${productCategoryId}`, { + data: { + description: 'Games played on a video games console or computer.' + } + }); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productCategoryId); + expect(responseJSON.name).toEqual('Video Games'); + expect(responseJSON.slug).toEqual('video-games'); + expect(responseJSON.parent).toEqual(0); + expect(responseJSON.description).toEqual('Games played on a video games console or computer.'); + expect(responseJSON.display).toEqual('default'); + expect(responseJSON.image).toEqual(null); + expect(responseJSON.menu_order).toEqual(0); + expect(responseJSON.count).toEqual(0); + }); + + test('can permanently delete a product tag', async ({ + request + }) => { + // Delete the product category. + const response = await request.delete( + `wp-json/wc/v3/products/categories/${productCategoryId}`, { + data: { + force: true, + }, + } + ); + expect(response.status()).toEqual(200); + + // Verify that the product category can no longer be retrieved. + const getDeletedProductCategoryResponse = await request.get( + `wp-json/wc/v3/products/categories/${productCategoryId}` + ); + expect(getDeletedProductCategoryResponse.status()).toEqual(404); + }); + + test('can batch update product categories', async ({ + request + }) => { + // Batch create product categories. + const response = await request.post( + `wp-json/wc/v3/products/categories/batch`, { + data: { + create: [{ + name: "Hats" + }, + { + name: "Sweets" + } + ] + } + } + ); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.create[0].name).toEqual('Hats'); + expect(responseJSON.create[1].name).toEqual('Sweets'); + const category1Id = responseJSON.create[0].id; + const category2Id = responseJSON.create[1].id; + + // Batch create a new category, update a category and delete another. + const responseBatchUpdate = await request.post( + `wp-json/wc/v3/products/categories/batch`, { + data: { + create: [{ + name: "" + }, ], + update: [{ + id: category1Id, + description: "Put them on your head." + } + ], + delete: [ + category2Id + ] + } + } + ); + const responseBatchUpdateJSON = await responseBatchUpdate.json(); + const category3Id = responseBatchUpdateJSON.create[0].id; + expect(response.status()).toEqual(200); + + const responseUpdatedCategory = await request.get(`wp-json/wc/v3/products/categories/${category1Id}`); + const responseUpdatedCategoryJSON = await responseUpdatedCategory.json(); + expect(responseUpdatedCategoryJSON.description).toEqual('Put them on your head.'); + + // Verify that the product tag can no longer be retrieved. + const getDeletedProductCategoryResponse = await request.get( + `wp-json/wc/v3/products/categories/${category2Id}` + ); + expect(getDeletedProductCategoryResponse.status()).toEqual(404); + + // Batch delete the created tags + await request.post( + `wp-json/wc/v3/products/categories/batch`, { + data: { + delete: [category1Id, category3Id] + } + } + ); + }); + }); + + test.describe('Product shipping classes tests: CRUD', () => { + let productShippingClassId; + + test('can add a product shipping class', async ({ + request + }) => { + const response = await request.post('wp-json/wc/v3/products/shipping_classes', { + data: { + name: 'Priority' + }, + }); + const responseJSON = await response.json(); + productShippingClassId = responseJSON.id; + + expect(response.status()).toEqual(201); + expect(typeof productShippingClassId).toEqual('number'); + expect(responseJSON.name).toEqual('Priority'); + expect(responseJSON.slug).toEqual('priority'); + expect(responseJSON.description).toEqual(''); + expect(responseJSON.count).toEqual(0); + }); + + test('can retrieve a product shipping class', async ({ + request + }) => { + const response = await request.get(`wp-json/wc/v3/products/shipping_classes/${productShippingClassId}`); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productShippingClassId); + expect(responseJSON.name).toEqual('Priority'); + expect(responseJSON.slug).toEqual('priority'); + expect(responseJSON.description).toEqual(''); + expect(responseJSON.count).toEqual(0); + + }); + + + test('can retrieve all product shipping classes', async ({ + request + }) => { + // call API to retrieve all product tags + const response = await request.get('/wp-json/wc/v3/products/shipping_classes'); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(Array.isArray(responseJSON)).toBe(true); + expect(responseJSON.length).toBeGreaterThan(0); + }); + + test('can update a product shipping class', async ({ + request + }) => { + // call API to retrieve all product tags + const response = await request.put(`wp-json/wc/v3/products/shipping_classes/${productShippingClassId}`, { + data: { + description: 'This is a description for the Priority shipping class.' + } + }); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productShippingClassId); + expect(responseJSON.name).toEqual('Priority'); + expect(responseJSON.slug).toEqual('priority'); + expect(responseJSON.description).toEqual('This is a description for the Priority shipping class.'); + expect(responseJSON.count).toEqual(0); + }); + + test('can permanently delete a product shipping class', async ({ + request + }) => { + // Delete the product shipping class. + const response = await request.delete( + `wp-json/wc/v3/products/shipping_classes/${productShippingClassId}`, { + data: { + force: true, + }, + } + ); + expect(response.status()).toEqual(200); + + // Verify that the product shipping class can no longer be retrieved. + const getDeletedProductShippingClassResponse = await request.get( + `wp-json/wc/v3/products/shipping_classes/${productShippingClassId}` + ); + expect(getDeletedProductShippingClassResponse.status()).toEqual(404); + }); + + test('can batch update product shipping classes', async ({ + request + }) => { + // Batch create product shipping classes. + const response = await request.post( + `wp-json/wc/v3/products/shipping_classes/batch`, { + data: { + create: [{ + name: "Small Items" + }, + { + name: "Large Items" + } + ] + } + } + ); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.create[0].name).toEqual('Small Items'); + expect(responseJSON.create[1].name).toEqual('Large Items'); + const shippingClass1Id = responseJSON.create[0].id; + const shippingClass2Id = responseJSON.create[1].id; + + // Batch create a new shipping class, update a shipping class and delete another. + const responseBatchUpdate = await request.post( + `wp-json/wc/v3/products/shipping_classes/batch`, { + data: { + create: [{ + name: "Express" + }, ], + update: [{ + id: shippingClass1Id, + description: "Priority shipping." + } + ], + delete: [ + shippingClass2Id + ] + } + } + ); + const responseBatchUpdateJSON = await responseBatchUpdate.json(); + const shippingClass3Id = responseBatchUpdateJSON.create[0].id; + expect(response.status()).toEqual(200); + + const responseUpdatedShippingClass = await request.get(`wp-json/wc/v3/products/shipping_classes/${shippingClass1Id}`); + const responseUpdatedShippingClassJSON = await responseUpdatedShippingClass.json(); + expect(responseUpdatedShippingClassJSON.description).toEqual('Priority shipping.'); + + // Verify that the product tag can no longer be retrieved. + const getDeletedProductShippingClassResponse = await request.get( + `wp-json/wc/v3/products/shipping_classes/${shippingClass2Id}` + ); + expect(getDeletedProductShippingClassResponse.status()).toEqual(404); + + // Batch delete the created tags + await request.post( + `wp-json/wc/v3/products/shipping_classes/batch`, { + data: { + delete: [shippingClass1Id, shippingClass3Id] + } + } + ); + }); + }); + + + test.describe('Product tags tests: CRUD', () => { + let productTagId; + + test('can add a product tag', async ({ + request + }) => { + const response = await request.post('wp-json/wc/v3/products/tags', { + data: { + name: 'Leather Shoes' + }, + }); + const responseJSON = await response.json(); + productTagId = responseJSON.id; + + expect(response.status()).toEqual(201); + expect(typeof productId).toEqual('number'); + expect(responseJSON.name).toEqual('Leather Shoes'); + expect(responseJSON.slug).toEqual('leather-shoes'); + }); + + test('can retrieve a product tag', async ({ + request + }) => { + const response = await request.get(`wp-json/wc/v3/products/tags/${productTagId}`); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productTagId); + expect(responseJSON.name).toEqual('Leather Shoes'); + expect(responseJSON.slug).toEqual('leather-shoes'); + }); + + test('can retrieve all product tags', async ({ + request + }) => { + // call API to retrieve all product tags + const response = await request.get('/wp-json/wc/v3/products/tags'); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(Array.isArray(responseJSON)).toBe(true); + expect(responseJSON.length).toBeGreaterThan(0); + }); + + test('can update a product tag', async ({ + request + }) => { + // call API to retrieve all product tags + const response = await request.put(`wp-json/wc/v3/products/tags/${productTagId}`, { + data: { + description: 'Genuine leather.' + } + }); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productTagId); + expect(responseJSON.name).toEqual('Leather Shoes'); + expect(responseJSON.description).toEqual('Genuine leather.'); + expect(responseJSON.slug).toEqual('leather-shoes'); + expect(responseJSON.count).toEqual(0); + }); + + test('can permanently delete a product tag', async ({ + request + }) => { + // Delete the product tag. + const response = await request.delete( + `wp-json/wc/v3/products/tags/${productTagId}`, { + data: { + force: true, + }, + } + ); + expect(response.status()).toEqual(200); + + // Verify that the product tag can no longer be retrieved. + const getDeletedProductTagResponse = await request.get( + `wp-json/wc/v3/products/tags/${productTagId}` + ); + expect(getDeletedProductTagResponse.status()).toEqual(404); + }); + + test('can batch update product tags', async ({ + request + }) => { + // Batch create 3 product tags. + const response = await request.post( + `wp-json/wc/v3/products/tags/batch`, { + data: { + create: [{ + name: "Round toe" + }, + { + name: "Flat" + }, + { + name: "High heel" + } + ] + } + } + ); + const responseJSON = await response.json(); + expect(response.status()).toEqual(200); + expect(responseJSON.create[0].name).toEqual('Round toe'); + expect(responseJSON.create[1].name).toEqual('Flat'); + expect(responseJSON.create[2].name).toEqual('High heel'); + const tag1Id = responseJSON.create[0].id; + const tag2Id = responseJSON.create[1].id; + const tag3Id = responseJSON.create[2].id; + + // Batch create a new tag, update 2 tags and delete another. + const responseBatchUpdate = await request.post( + `wp-json/wc/v3/products/tags/batch`, { + data: { + create: [{ + name: "Football boot" + }, ], + update: [{ + id: tag1Id, + description: "Genuine leather." + }, + { + id: tag2Id, + description: "Like a pancake." + } + ], + delete: [ + tag3Id + ] + } + } + ); + const responseBatchUpdateJSON = await responseBatchUpdate.json(); + const tag4Id = responseBatchUpdateJSON.create[0].id; + expect(response.status()).toEqual(200); + + const responseUpdatedTag1 = await request.get(`wp-json/wc/v3/products/tags/${tag1Id}`); + const responseUpdatedTag1JSON = await responseUpdatedTag1.json(); + expect(responseUpdatedTag1JSON.description).toEqual('Genuine leather.'); + + const responseUpdatedTag2 = await request.get(`wp-json/wc/v3/products/tags/${tag2Id}`); + const responseUpdatedTag2JSON = await responseUpdatedTag2.json(); + expect(responseUpdatedTag2JSON.description).toEqual('Like a pancake.'); + + // Verify that the product tag can no longer be retrieved. + const getDeletedProductTagResponse = await request.get( + `wp-json/wc/v3/products/tags/${tag3Id}` + ); + expect(getDeletedProductTagResponse.status()).toEqual(404); + + // Batch delete the created tags + await request.post( + `wp-json/wc/v3/products/tags/batch`, { + data: { + delete: [tag1Id, tag2Id, tag4Id] + } + } + ); + }); + }); + + test('can add a virtual product', async ({ + request + }) => { + const response = await request.post('wp-json/wc/v3/products', { data: virtualProduct, - } ); + }); const responseJSON = await response.json(); const virtualProductId = responseJSON.id; - expect( response.status() ).toEqual( 201 ); - expect( typeof virtualProductId ).toEqual( 'number' ); - expect( responseJSON ).toMatchObject( virtualProduct ); - expect( responseJSON.type ).toEqual( 'simple' ); - expect( responseJSON.status ).toEqual( 'publish' ); - expect( responseJSON.shipping_required ).toEqual( false ); + expect(response.status()).toEqual(201); + expect(typeof virtualProductId).toEqual('number'); + expect(responseJSON).toMatchObject(virtualProduct); + expect(responseJSON.type).toEqual('simple'); + expect(responseJSON.status).toEqual('publish'); + expect(responseJSON.shipping_required).toEqual(false); // Cleanup: Delete the virtual product - await request.delete( `wp-json/wc/v3/products/${ virtualProductId }`, { + await request.delete(`wp-json/wc/v3/products/${ virtualProductId }`, { data: { force: true, }, - } ); - } ); + }); + }); - test( 'can add a variable product', async ( { request } ) => { - const response = await request.post( 'wp-json/wc/v3/products', { + test('can add a variable product', async ({ + request + }) => { + const response = await request.post('wp-json/wc/v3/products', { data: variableProduct, - } ); + }); const responseJSON = await response.json(); const variableProductId = responseJSON.id; - expect( response.status() ).toEqual( 201 ); - expect( typeof variableProductId ).toEqual( 'number' ); - expect( responseJSON ).toMatchObject( variableProduct ); - expect( responseJSON.status ).toEqual( 'publish' ); + expect(response.status()).toEqual(201); + expect(typeof variableProductId).toEqual('number'); + expect(responseJSON).toMatchObject(variableProduct); + expect(responseJSON.status).toEqual('publish'); // Cleanup: Delete the variable product - await request.delete( `wp-json/wc/v3/products/${ variableProductId }`, { + await request.delete(`wp-json/wc/v3/products/${ variableProductId }`, { data: { force: true, }, - } ); - } ); + }); + }); - test( 'can view a single product', async ( { request } ) => { + test('can view a single product', async ({ + request + }) => { const response = await request.get( `wp-json/wc/v3/products/${ productId }` ); const responseJSON = await response.json(); - expect( response.status() ).toEqual( 200 ); - expect( responseJSON.id ).toEqual( productId ); - } ); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productId); + }); - test( 'can update a single product', async ( { request } ) => { + test('can update a single product', async ({ + request + }) => { const updatePayload = { regular_price: '25.99', }; const response = await request.put( - `wp-json/wc/v3/products/${ productId }`, - { + `wp-json/wc/v3/products/${ productId }`, { data: updatePayload, } ); const responseJSON = await response.json(); - expect( response.status() ).toEqual( 200 ); - expect( responseJSON.id ).toEqual( productId ); - expect( responseJSON.regular_price ).toEqual( + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productId); + expect(responseJSON.regular_price).toEqual( updatePayload.regular_price ); - } ); + }); - test( 'can delete a product', async ( { request } ) => { + test('can delete a product', async ({ + request + }) => { const response = await request.delete( - `wp-json/wc/v3/products/${ productId }`, - { + `wp-json/wc/v3/products/${ productId }`, { data: { force: true, }, @@ -120,16 +927,16 @@ test.describe( 'Products API tests: CRUD', () => { ); const responseJSON = await response.json(); - expect( response.status() ).toEqual( 200 ); - expect( responseJSON.id ).toEqual( productId ); + expect(response.status()).toEqual(200); + expect(responseJSON.id).toEqual(productId); const retrieveDeletedProductResponse = await request.get( `wp-json/wc/v3/products/${ productId }` ); - expect( retrieveDeletedProductResponse.status() ).toEqual( 404 ); - } ); + expect(retrieveDeletedProductResponse.status()).toEqual(404); + }); - test.describe( 'Batch update products', () => { + test.describe('Batch update products', () => { const product1 = { ...simpleProduct, name: 'Batch Created Product 1', @@ -138,98 +945,109 @@ test.describe( 'Products API tests: CRUD', () => { ...simpleProduct, name: 'Batch Created Product 2', }; - const expectedProducts = [ product1, product2 ]; + const expectedProducts = [product1, product2]; - test( 'can batch create products', async ( { request } ) => { + test('can batch create products', async ({ + request + }) => { // Send request to batch create products - const batchCreatePayload = batch( 'create', expectedProducts ); + const batchCreatePayload = batch('create', expectedProducts); const response = await request.post( - 'wp-json/wc/v3/products/batch', - { + 'wp-json/wc/v3/products/batch', { data: batchCreatePayload, } ); const responseJSON = await response.json(); const actualBatchCreatedProducts = responseJSON.create; - expect( response.status() ).toEqual( 200 ); - expect( actualBatchCreatedProducts ).toHaveLength( + expect(response.status()).toEqual(200); + expect(actualBatchCreatedProducts).toHaveLength( expectedProducts.length ); // Verify id and name of the batch created products - for ( let i = 0; i < actualBatchCreatedProducts.length; i++ ) { - const { id, name } = actualBatchCreatedProducts[ i ]; + for (let i = 0; i < actualBatchCreatedProducts.length; i++) { + const { + id, + name + } = actualBatchCreatedProducts[i]; - expect( typeof id ).toEqual( 'number' ); - expect( name ).toEqual( expectedProducts[ i ].name ); + expect(typeof id).toEqual('number'); + expect(name).toEqual(expectedProducts[i].name); // Save the product ID for use later in the batch update and delete tests - expectedProducts[ i ].id = id; + expectedProducts[i].id = id; } - } ); + }); - test( 'can batch update products', async ( { request } ) => { + test('can batch update products', async ({ + request + }) => { // Send request to batch update the regular price const newRegularPrice = '12.34'; - for ( let i = 0; i < expectedProducts.length; i++ ) { - expectedProducts[ i ].regular_price = newRegularPrice; + for (let i = 0; i < expectedProducts.length; i++) { + expectedProducts[i].regular_price = newRegularPrice; } - const batchUpdatePayload = batch( 'update', expectedProducts ); + const batchUpdatePayload = batch('update', expectedProducts); const response = await request.put( - 'wp-json/wc/v3/products/batch', - { + 'wp-json/wc/v3/products/batch', { data: batchUpdatePayload, } ); const responseJSON = await response.json(); const actualUpdatedProducts = responseJSON.update; - expect( response.status() ).toEqual( 200 ); - expect( actualUpdatedProducts ).toHaveLength( + expect(response.status()).toEqual(200); + expect(actualUpdatedProducts).toHaveLength( expectedProducts.length ); // Verify that the regular price of each product was updated - for ( let i = 0; i < actualUpdatedProducts.length; i++ ) { - const { id, regular_price } = actualUpdatedProducts[ i ]; + for (let i = 0; i < actualUpdatedProducts.length; i++) { + const { + id, + regular_price + } = actualUpdatedProducts[i]; - expect( id ).toEqual( expectedProducts[ i ].id ); - expect( regular_price ).toEqual( newRegularPrice ); + expect(id).toEqual(expectedProducts[i].id); + expect(regular_price).toEqual(newRegularPrice); } - } ); + }); - test( 'can batch delete products', async ( { request } ) => { + test('can batch delete products', async ({ + request + }) => { // Send request to batch delete the products created earlier - const idsToDelete = expectedProducts.map( ( { id } ) => id ); - const batchDeletePayload = batch( 'delete', idsToDelete ); + const idsToDelete = expectedProducts.map(({ + id + }) => id); + const batchDeletePayload = batch('delete', idsToDelete); const response = await request.post( - 'wp-json/wc/v3/products/batch', - { + 'wp-json/wc/v3/products/batch', { data: batchDeletePayload, } ); const responseJSON = await response.json(); const actualBatchDeletedProducts = responseJSON.delete; - expect( response.status() ).toEqual( 200 ); - expect( actualBatchDeletedProducts ).toHaveLength( + expect(response.status()).toEqual(200); + expect(actualBatchDeletedProducts).toHaveLength( expectedProducts.length ); // Verify that the correct products were deleted - for ( let i = 0; i < actualBatchDeletedProducts.length; i++ ) { - const deletedProduct = actualBatchDeletedProducts[ i ]; - expect( deletedProduct ).toMatchObject( expectedProducts[ i ] ); + for (let i = 0; i < actualBatchDeletedProducts.length; i++) { + const deletedProduct = actualBatchDeletedProducts[i]; + expect(deletedProduct).toMatchObject(expectedProducts[i]); } // Verify that the deleted product ID's can no longer be retrieved - for ( const id of idsToDelete ) { + for (const id of idsToDelete) { const response = await request.get( `wp-json/wc/v3/products/${ id }` ); - expect( response.status() ).toEqual( 404 ); + expect(response.status()).toEqual(404); } - } ); - } ); -} ); + }); + }); +});