Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Add mock theme with Woo Templates for E2E tests #5920

Merged
merged 3 commits into from
Mar 2, 2022

Conversation

sunyatasattva
Copy link
Contributor

This PR adds a block-enabled theme with templates for WooCommerce which is intended to be used when testing the more complex scenarios described in #5660. In order to test our logic, we need two templates:

  1. One block-enabled but Woo-unaware template to test default behaviours. (Such template was added in E2E tests for Single Product Template #5722)
  2. Another block-enabled theme with Woo templates to test theme overrides.

Both themes are required. Tests for scenario 1 where added in #5722, #5748, #5820 and #5888. This PR does not add any test, but merely the basis for further E2E test scenarios.

Additionally, since theme-dependent logic seems to be becoming more and more useful (see #5913), this PR also adds a utility function used to explicitly declare theme dependencies of a test. Said function will activate the theme before running a given suite and then reactivate the previous theme, as to make sure to not have any side-effects (such as the ones described in #5913 above).

Closes #5660


@dinhtungdu I refactored my previous code to not activate TT1 once done, but to reactivate the previously active theme (as discussed here).

If you come across tests which are dependent on a specific theme activation, I suggest you refactor / create those using the code introduced in this PR. It's a simple test "hook", just using it at the top level of your describe closure should do the trick of activating the required theme and reactivating the previous one on teardown, like so:

describe( 'My test suite', () => {
  useTheme( 'storefront' );

  it( 'tests something', async () => { /* ... */ } );
} );

@sunyatasattva sunyatasattva added skip-changelog PRs that you don't want to appear in the changelog. category: tests focus: FSE Work related to prepare WooCommerce for FSE. labels Feb 22, 2022
@sunyatasattva sunyatasattva self-assigned this Feb 22, 2022
@rubikuserbot rubikuserbot requested a review from a team February 22, 2022 22:02
@github-actions
Copy link
Contributor

github-actions bot commented Feb 22, 2022

Size Change: 0 B

Total Size: 817 kB

ℹ️ View Unchanged
Filename Size
build/active-filters-frontend.js 6.27 kB
build/active-filters.js 6.95 kB
build/all-products-frontend.js 18.6 kB
build/all-products.js 34.2 kB
build/all-reviews.js 8.06 kB
build/atomic-block-components/add-to-cart--atomic-block-components/button--atomic-block-components/catego--214e300a.js 151 B
build/atomic-block-components/add-to-cart--atomic-block-components/button--atomic-block-components/image---a7e2bb9b.js 2.66 kB
build/atomic-block-components/add-to-cart--atomic-block-components/category-list--atomic-block-components--68f6c1c4.js 203 B
build/atomic-block-components/add-to-cart-frontend.js 7.01 kB
build/atomic-block-components/add-to-cart.js 7.5 kB
build/atomic-block-components/button-frontend.js 1.53 kB
build/atomic-block-components/button.js 2.15 kB
build/atomic-block-components/category-list--atomic-block-components/image--atomic-block-components/ratin--2614069e.js 497 B
build/atomic-block-components/category-list-frontend.js 922 B
build/atomic-block-components/category-list.js 501 B
build/atomic-block-components/image-frontend.js 1.86 kB
build/atomic-block-components/image.js 1.49 kB
build/atomic-block-components/price-frontend.js 1.74 kB
build/atomic-block-components/price.js 1.7 kB
build/atomic-block-components/rating-frontend.js 1.13 kB
build/atomic-block-components/rating.js 719 B
build/atomic-block-components/sale-badge-frontend.js 1.09 kB
build/atomic-block-components/sale-badge.js 686 B
build/atomic-block-components/sku-frontend.js 386 B
build/atomic-block-components/sku.js 385 B
build/atomic-block-components/stock-indicator-frontend.js 1.04 kB
build/atomic-block-components/stock-indicator.js 624 B
build/atomic-block-components/summary-frontend.js 1.34 kB
build/atomic-block-components/summary.js 924 B
build/atomic-block-components/tag-list-frontend.js 922 B
build/atomic-block-components/tag-list.js 499 B
build/atomic-block-components/title-frontend.js 1.31 kB
build/atomic-block-components/title.js 934 B
build/attribute-filter-frontend.js 16.8 kB
build/attribute-filter.js 13.1 kB
build/blocks-checkout.js 17.6 kB
build/cart-blocks/accepted-payment-methods-frontend.js 1.14 kB
build/cart-blocks/checkout-button-frontend.js 1.15 kB
build/cart-blocks/empty-cart-frontend.js 346 B
build/cart-blocks/express-payment-frontend.js 5.19 kB
build/cart-blocks/filled-cart-frontend.js 765 B
build/cart-blocks/items-frontend.js 299 B
build/cart-blocks/line-items-frontend.js 5.5 kB
build/cart-blocks/order-summary-frontend.js 8.88 kB
build/cart-blocks/totals-frontend.js 320 B
build/cart-frontend.js 45.2 kB
build/cart.js 43.4 kB
build/checkout-blocks/actions-frontend.js 1.41 kB
build/checkout-blocks/billing-address--checkout-blocks/shipping-address-frontend.js 4.12 kB
build/checkout-blocks/billing-address-frontend.js 890 B
build/checkout-blocks/contact-information-frontend.js 2.84 kB
build/checkout-blocks/express-payment-frontend.js 5.48 kB
build/checkout-blocks/fields-frontend.js 343 B
build/checkout-blocks/order-note-frontend.js 1.13 kB
build/checkout-blocks/order-summary-frontend.js 11.3 kB
build/checkout-blocks/payment-frontend.js 7.76 kB
build/checkout-blocks/shipping-address-frontend.js 997 B
build/checkout-blocks/shipping-methods-frontend.js 4.73 kB
build/checkout-blocks/terms-frontend.js 1.22 kB
build/checkout-blocks/totals-frontend.js 323 B
build/checkout-frontend.js 47.3 kB
build/checkout.js 44.8 kB
build/featured-category.js 8.61 kB
build/featured-product.js 9.62 kB
build/handpicked-products.js 7.09 kB
build/legacy-template.js 2.18 kB
build/mini-cart-component-frontend.js 14.3 kB
build/mini-cart-contents.js 3.83 kB
build/mini-cart-frontend.js 1.71 kB
build/mini-cart.js 6.39 kB
build/price-filter-frontend.js 12.6 kB
build/price-filter.js 8.48 kB
build/price-format.js 1.19 kB
build/product-best-sellers.js 7.36 kB
build/product-categories.js 3.17 kB
build/product-category.js 8.48 kB
build/product-new.js 7.66 kB
build/product-on-sale.js 7.98 kB
build/product-search.js 2.18 kB
build/product-tag.js 7.8 kB
build/product-top-rated.js 7.9 kB
build/products-by-attribute.js 8.38 kB
build/reviews-by-category.js 11.5 kB
build/reviews-by-product.js 12.6 kB
build/reviews-frontend.js 7.34 kB
build/single-product-frontend.js 22 kB
build/single-product.js 10 kB
build/stock-filter-frontend.js 6.49 kB
build/stock-filter.js 6.57 kB
build/vendors--atomic-block-components/add-to-cart--cart-blocks/order-summary--checkout-blocks/billing-ad--c5eb4dcd-frontend.js 19 kB
build/vendors--atomic-block-components/add-to-cart-frontend.js 7.51 kB
build/vendors--atomic-block-components/price--cart-blocks/line-items--cart-blocks/order-summary--checkout--8a3571de-frontend.js 5.71 kB
build/vendors--cart-blocks/line-items--checkout-blocks/order-summary-frontend.js 3.14 kB
build/vendors--cart-blocks/order-summary--checkout-blocks/billing-address--checkout-blocks/order-summary---eb4d2cec-frontend.js 4.75 kB
build/wc-blocks-data.js 9.78 kB
build/wc-blocks-editor-style-rtl.css 4.84 kB
build/wc-blocks-editor-style.css 4.84 kB
build/wc-blocks-google-analytics.js 1.56 kB
build/wc-blocks-middleware.js 949 B
build/wc-blocks-registry.js 2.7 kB
build/wc-blocks-shared-context.js 1.52 kB
build/wc-blocks-shared-hocs.js 1.14 kB
build/wc-blocks-style-rtl.css 22.2 kB
build/wc-blocks-style.css 22.2 kB
build/wc-blocks-vendors-style-rtl.css 1.28 kB
build/wc-blocks-vendors-style.css 1.28 kB
build/wc-blocks-vendors.js 69.7 kB
build/wc-blocks.js 2.62 kB
build/wc-payment-method-bacs.js 816 B
build/wc-payment-method-cheque.js 811 B
build/wc-payment-method-cod.js 909 B
build/wc-payment-method-paypal.js 837 B
build/wc-settings.js 2.61 kB

compressed-size-action

Copy link
Contributor

@tjcafferkey tjcafferkey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work @sunyatasattva, I really like the useTheme hook and how you've considered it enough to only activate the specified theme just for the suite of tests it's being used in to prevent the chances of its usage breaking any subsequent test suites.

All the checks seem to be passing, and the code LGTM so I'm going to approve this.

@github-actions github-actions bot added this to the 7.2.0 milestone Mar 2, 2022
@sunyatasattva sunyatasattva merged commit 73d704c into trunk Mar 2, 2022
@sunyatasattva sunyatasattva deleted the test/5660-fse-test-overrides branch March 2, 2022 14:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
focus: FSE Work related to prepare WooCommerce for FSE. skip-changelog PRs that you don't want to appear in the changelog.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Store Editing Templates: Explore if we can cover scenarios of themes overriding block templates with E2E tests
2 participants