Adds factory functions for WooCommerce to be used with wp-browser integration tests.

Level Level

Last update: Dec 29, 2022

Related tags

Miscellaneous testing integration-testing codeception woocommerce wp-browser

Overview

wp-browser-woocommerce

This library simplifies testing of WooCommerce themes and plugins with wp-browser. Several Unit Test Factories are added that allow you to quickly create WooCommerce products and orders within an integration test.

Getting started

Before getting started with wp-browser-woocommerce, make sure you read the excellent documentation for wp-browser first.

Installation

To install wp-browser-woocommerce you use composer. The library is published on packagist.

composer require --dev level-level/wp-browser-woocommerce

Your first WooCommerce test

Tests written with wp-browser-woocommerce are a lot like regular wp-browser integration tests. By extending from \LevelLevel\WPBrowserWooCommerce\WCTestCase instead of the regular \WPTestCase, you will get access to WooCommerce unit test factories.

<?php // ./tests/wpunit/ExampleTest.php

use LevelLevel\WPBrowserWooCommerce\WCTestCase;

class ExampleTest extends WCTestCase{
    public function test_something(){
        // Create a WooCommerce product.
        $product = $this->factory()->product->create_and_get(
			array(
				'name'          => 'test',
				'regular_price' => '12.12',
			)
		);

        // Create a WooCommerce order with two products.
		$order   = $this->factory()->order->create_and_get(
			array(
				'payment_method'       => 'bacs',
				'payment_method_title' => 'BACS',
				'set_paid'             => true,
				'line_items'           => array(
					array(
						'product_id' => $product->get_id(),
						'quantity'   => 2,
					),
				),
			)
		);

        // Make sure the order total price is correct.
        $this->assertEquals( 24.24, $order->get_total() );
    }
}

Factories

The factories provide methods to allow for quick object creation. The factories are access with the $this->factory() method on a testcase.

In the background, the factories use the WooCommerce REST API methods to create and retrieve objects. These are not actual GET/POST requests, but rather internal calls to the methods that would process the regular requests to the API.

All factories extend from the WordPress default WP_UnitTest_Factory_For_Thing. All methods that are specified on this base class are available on the factories you will use in WooCommerce tests.

In this documentation you will only find the most used ones, refer to the base class or WordPress documentation for others.

Orders

You can access the order factory by using $this->factory()->order within a WooCommerce integration test.

The main method you'll use is create_and_get( $args ). The input you can give to an order are the same as you can give to the order creation API endpoint.

create_and_get($args) returns the result of wc_get_order() for the created object.

See https://woocommerce.github.io/woocommerce-rest-api-docs/#create-an-order

Example:

$order = $this->factory()->order->create_and_get(
    array(
        'payment_method'       => 'bacs',
        'payment_method_title' => 'BACS',
        'set_paid'             => true,
        'billing'              => array(
            'first_name'   => 'John',
            'last_name'    => 'Doe',
            'address_1'    => 'Market',
            'house_number' => '1',
            'address_2'    => '',
            'city'         => 'Rotterdam',
            'postcode'     => '3456AB',
            'country'      => 'NL',
            'email'        => '[email protected]',
        ),
        'shipping'             => array(
            'first_name'   => 'John',
            'last_name'    => 'Doe',
            'address_1'    => 'Memory Lane',
            'house_number' => '1',
            'address_2'    => '',
            'city'         => 'Rotterdam',
            'postcode'     => '3456AB',
            'country'      => 'NL',
        ),
        'line_items'           => array(
            array(
                'product_id' => 1,
                'quantity'   => 1,
                'meta_data'  => array(
                    array(
                        'key'   => 'made_by',
                        'value' => 'Level Level',
                    ),
                    array(
                        'key'   => 'with_love',
                        'value' => 'obviously'
                    ),
                ),
            ),
        ),
        'shipping_lines': array(
            array(
                'method_id': 'flat_rate',
                'method_title': 'Flat Rate',
                'total': '10.00'
            )
        )
    )
);

Products

You can access the order factory by using $this->factory()->product within a WooCommerce integration test.

The main method you'll use is create_and_get( $args ). The input you can give to an order are the same as you can give to the product creation API endpoint.

create_and_get($args) returns the result of wc_get_product() for the created object.

See https://woocommerce.github.io/woocommerce-rest-api-docs/#create-a-product

Example:

$this->factory()->product->create_and_get(
    array(
        'name'            => 'test',
        'regular_price'   => '103.11',
        'weight'          => '14',
        'dimensions'      => array(
            'height' => '1',
        ),
        'reviews_allowed' => false,
        'manage_stock'    => true,
        'stock_status'    => 'onbackorder',
        'backorders'      => 'yes',
        'meta_data'       => array(
            array(
                'key'   => 'made_in',
                'value' => 'Rotterdam',
            ),
        ),
    )
);

Tax rates

You can access the order factory by using $this->factory()->tax_rate within a WooCommerce integration test.

The main method you'll use is create_and_get( $args ). The input you can give to an order are the same as you can give to the product creation API endpoint.

create_and_get($args) returns an array, as tax rates have no data class/model within WooCommerce.

See https://woocommerce.github.io/woocommerce-rest-api-docs/#create-a-tax-rate

Example:

$this->factory()->tax_rate->create_and_get(
    array(
        'country'=>'NL',
        'rate'=> '21',
        'name'=>'BTW hoog tarief',
        'shipping'=>false,
    )
);

Coupons

You can access the coupon factory by using $this->factory()->coupon within a WooCommerce integration test.

The main method you'll use is create_and_get( $args ). The input you can give to a coupon are the same as you can give to the coupon creation API endpoint.

create_and_get($args) returns the result of new WC_Coupon( $coupon_id ) for the created object.

See https://woocommerce.github.io/woocommerce-rest-api-docs/#create-a-coupon

Example:

$this->factory()->coupon->create_and_get(
    array(
        'code'               => '25off',
        'discount_type'      => 'percent',
        'amount'             => '10',
        'individual_use'     => true,
        'exclude_sale_items' => true,
        'minimum_amount'     => '100.00',
    )
);

Subscriptions

The subscription factory can only be used when the WooCommerce Subscriptions plugin is installed and activated.

You can access the subscription factory by using $this->factory()->subscription within a WooCommerce integration test.

The main method you'll use is create_and_get( $args ). The input you can give to a subscription are the same as you can give to the subscription creation API endpoint.

create_and_get($args) returns the result of wcs_get_subscription( $subscription_id ) for the created object.

See https://woocommerce.github.io/subscriptions-rest-api-docs/v1.html#create-a-subscription

Example:

$this->factory()->subscription->create_and_get(
    array(
        'customer_id' => 1,
        'parent_id' => 1,
        'status' => 'pending',
        'billing_period' => 'month',
        'billing_interval' => 1,
        'start_date' => ( new DateTime( 'now', wp_timezone() ) )->format( 'Y-m-d H:i:s' ),
        'next_payment_date' => ( new DateTime( '+1 month', wp_timezone() ) )->format( 'Y-m-d H:i:s' ),
        'payment_method' => '',
        'billing' => array(
            'first_name' => 'John',
            'last_name' => 'Doe',
            'address_1' => 'Market',
            'house_number' => '1',
            'address_2' => '',
            'city' => 'Rotterdam',
            'postcode' => '3456AB',
            'country' => 'NL',
            'email' => '[email protected]',
        ),
        'shipping' => array(
            'first_name' => 'John',
            'last_name' => 'Doe',
            'address_1' => 'Memory Lane',
            'house_number' => '1',
            'address_2' => '',
            'city' => 'Rotterdam',
            'postcode' => '3456AB',
            'country' => 'NL',
        ),
        'line_items' => array(
            array(
                'product_id' => 1,
                'quantity' => 1,
                'subtotal' => '10.00',
                'total' => '10.00',
            )
        )
    )
);

Testcases

For most testcases you will want to use \LevelLevel\WPBrowserWooCommerce\WCTestCase

Ajax calls

For ajax calls, the regular \WPAjaxTestCase would be replaced with \LevelLevel\WPBrowserWooCommerce\WCAjaxTestCase

Example:

public function test_can_add_sample_to_cart() {
    WC_AJAX::init();

    $product = $this->factory()->product->create_and_get(
        array(
            'name'          => 'test',
            'regular_price' => '12.12',
        )
    );
    
    // ... testing logic ...
    
    try {
        $this->_handleAjax( 'woocommerce_add_to_cart' );
    } catch ( WPAjaxDieContinueException $e ) {
        ob_end_flush();
    }
    $this->assertEmpty( wc_get_notices( 'error' ), 'There should be no error notices after making this ajax call.' );
}

Development

wp-browser-woocommerce is actively being used at Level Level. The library will get new features as we need them for client projects.

Roadmap

The main focus is on implementing more factories for other WooCommerce objects such as customers, refunds and shipping methods.

After this, focus might shift to popular extensions for WooCommerce, such as Subscriptions or Bookings.

Contributing

Feel free to open issues or create pull requests if you feel something is missing or working incorrectly.

Comments

Fix Getting and setting current user

Thanks for the handy addition to wp-browser.

While using it, I noticed that the user is incorrectly backed up and restored - used functions expect the user ID, not the entire WP_User object.

opened by matczar 2

add coupon factory

Description

Adds coupon factory for creating WooCommerce Coupons.

How Has This Been Tested?

I've created a coupon in one of our projects using the following code, which worked flawlessly.


		$this->coupon = $this->factory()->coupon->create_and_get(
			array(
				'code'               => '25off',
				'discount_type'      => 'percent',
				'amount'             => '25',
				'individual_use'     => true,
				'exclude_sale_items' => true,
			)
		);

opened by menno-ll 1

Update set_zone_locations to return code

According to https://woocommerce.github.io/woocommerce-rest-api-docs/?shell#update-a-locations-of-a-shipping-zone, and debugging, the response from the PUT on the /locations endpoint will return a JSON string containing a "code" and a "type" property. ID does not exist, and this will break unit tests on PHP8+

opened by Mike-Hermans 0
Implement ShippingZone and ShippingZoneMethods.

See https://woocommerce.github.io/woocommerce-rest-api-docs/?shell#shipping-zones And https://woocommerce.github.io/woocommerce-rest-api-docs/?shell#shipping-zone-methods

opened by NielsdeBlaauw 0
Remove duplicate api-call code.

Every class has its own implementation of user switching and API call processing. Abstracting this logic to a trait removes a lot of duplicate code and simplifies new factory implementation.

opened by NielsdeBlaauw 0

add subscriptions factory

Description

Adds subscription factory for woocommerce subscriptions. Uses the subscriptions rest api https://woocommerce.github.io/subscriptions-rest-api-docs/v1.html

Tested

Has been tested using following code.

		$address = array(
			'first_name' => 'Firstname',
			'last_name'  => 'Lastname',
			'company'    => 'Company',
			'address_1'  => 'Streetname 1',
			'address_2'  => '',
			'city'       => 'City',
			'state'      => '',
			'postcode'   => '1234AB',
			'country'    => 'NL',
			'email'      => '[email protected]',
		);
		$this->subscription = $this->factory()->subscription->create_and_get(
			array(
				'customer_id' => 1,
				'parent_id' => $this->order->get_id(),
				'status' => 'pending',
				'billing_period' => 'month',
				'billing_interval' => 1,
				'start_date' => ( new DateTime( 'now', wp_timezone() ) )->format( 'Y-m-d H:i:s' ),
				'next_payment_date' => ( new DateTime( '+1 month', wp_timezone() ) )->format( 'Y-m-d H:i:s' ),
				'payment_method' => '',
				'billing' => $address,
				'shipping' => $address,
				'line_items' => array(
					array(
						'product_id' => $this->product->get_id(),
						'quantity' => 1,
						'subtotal' => '10.00',
						'total' => '10.00',
					)
				)
			)
		);

opened by menno-ll 0

Releases(0.1.8)

0.1.8(Dec 30, 2022)

Full Changelog: https://github.com/level-level/wp-browser-woocommerce/compare/0.1.7...0.1.8
Source code(tar.gz)
Source code(zip)
0.1.7(Dec 30, 2022)
What's Changed

Update set_zone_locations to return code by @Mike-Hermans in https://github.com/level-level/wp-browser-woocommerce/pull/11

New Contributors

@Mike-Hermans made their first contribution in https://github.com/level-level/wp-browser-woocommerce/pull/11

Full Changelog: https://github.com/level-level/wp-browser-woocommerce/compare/0.1.6...0.1.7
Source code(tar.gz)
Source code(zip)
0.1.6(Sep 23, 2022)
What's Changed

Adds shipping zone locations support. by @NielsdeBlaauw in https://github.com/level-level/wp-browser-woocommerce/pull/10

Full Changelog: https://github.com/level-level/wp-browser-woocommerce/compare/0.1.5...0.1.6
Source code(tar.gz)
Source code(zip)
0.1.5(May 16, 2022)
What's Changed

Enhancement: Adds a trait for API-calls by @NielsdeBlaauw in https://github.com/level-level/wp-browser-woocommerce/pull/6

Feature: Adds Shipping factory methods by @NielsdeBlaauw in https://github.com/level-level/wp-browser-woocommerce/pull/9

Full Changelog: https://github.com/level-level/wp-browser-woocommerce/compare/0.1.4...0.1.5
Source code(tar.gz)
Source code(zip)
0.1.4(Aug 12, 2021)
Adds subscriptions factory (#4)

Source code(tar.gz)
Source code(zip)
0.1.3(Jul 23, 2021)
Adds coupon factory (https://github.com/level-level/wp-browser-woocommerce/pull/3)

Fixes Getting and setting current user (https://github.com/level-level/wp-browser-woocommerce/pull/2)

Source code(tar.gz)
Source code(zip)
0.1.2(Jun 24, 2021)
Adds TaxRate factory.

Source code(tar.gz)
Source code(zip)
0.1.0(Jun 15, 2021)
Initial release.

Source code(tar.gz)
Source code(zip)