Merge branch 'release-v0.2.1' of github.com:wp-graphql/wp-graphql-woocommerce into bugfix/checkout-mutation

Author: kidunot89

README.md

@@ -12,10 +12,12 @@
 ## What does this plugin do?
 It adds WooCommerce functionality to the WPGraphQL schema using WooCommerce's [CRUD](https://github.com/woocommerce/woocommerce/wiki/CRUD-Objects-in-3.0) objects.
 
-## Working Features
-- Query product, customers, coupons, order, refund, product variations.
+## Features
+- Query product, customers, coupons, order, refund, product variations with complex filtering options.
+- Add items to cart and process user store session using HTTP header defined by WooGraphQL's built-in session handler
+- Create/process user checkout with the `checkout` mutation.
 
-## Upcoming Features
+## Future Features
 - Adminstrator mutations. Eg. Creating and deleting products, coupons, and refunds.
 
 ## Playground
@@ -31,42 +33,47 @@ Until the documentation is in full effect, it's recommended that a [GraphiQL](ht
 
 ### Setup
 1. Make sure all dependencies are install by running `composer install` from the CMD/Terminal in the project directory.
-2. Next the copy 5 distributed files with the `.dist` in there filenames. For instance `.env.dist` becomes `.env` and `wpunit.suite.dist.yml` becomes `wpunit.suite.yml`. The distributed files and what their copied names should are as follows.
-    - `tests/acceptance.suite.dist.yml` => `tests/acceptance.suite.yml`
-    - `tests/functional.suite.dist.yml` => `tests/functional.suite.yml`
-    - `tests/wpunit.suite.dist.yml` => `tests/wpunit.suite.yml`
+2. Next the copy 2 distributed files with the `.dist` in there filenames. For instance `.env.dist` becomes `.env` and `wpunit.suite.dist.yml` becomes `wpunit.suite.yml`. The distributed files and what their copied names should are as follows.
     - `codeception.dist.yml` => `codeception.yml`
     - `.env.dist` => `.env`
 3. Next open `.env` and alter to make you usage.
 	```
-	# Shared
-	TEST_DB_NAME="wpgraphql_woocommerce_test"
-	TEST_DB_HOST="127.0.0.1"
-	TEST_DB_USER="root"
-	TEST_DB_PASSWORD=""
-
-	# Install script
+	# docker ENV variables
+	DB_NAME=wordpress
+	DB_HOST=app_db
+	DB_USER=wordpress
+	DB_PASSWORD=wordpress
+	WP_TABLE_PREFIX=wp_
+	WP_URL=http://localhost
+	WP_DOMAIN=localhost
+	[email protected]
+	ADMIN_USERNAME=admin
+	ADMIN_PASSWORD=password
+	ADMIN_PATH=/wp-admin
+
+	# local codeception/install-wp-tests ENV variables
+	TEST_DB_NAME=woographql_tests
+	TEST_DB_HOST=127.0.0.1
+	TEST_DB_USER=wordpress
+	TEST_DB_PASSWORD=wordpress
+	TEST_WP_TABLE_PREFIX=wp_
+
+	# install-wp-tests ENV variables
 	SKIP_DB_CREATE=false
-
-	# Codeception
-	TEST_SITE_WP_ADMIN_PATH="/wp-admin"
-	TEST_SITE_DB_NAME="wpgraphql_woocommerce_test"
-	TEST_SITE_DB_HOST="127.0.0.1"
-	TEST_SITE_DB_USER="root"
-	TEST_SITE_DB_PASSWORD=""
-	TEST_SITE_TABLE_PREFIX="wp_"
-	TEST_TABLE_PREFIX="wp_"
-	TEST_SITE_WP_URL="http://localhost"
-	TEST_SITE_WP_DOMAIN="localhost"
-	TEST_SITE_ADMIN_EMAIL="admin@localhost"
-	TEST_SITE_ADMIN_USERNAME="admin"
-	TEST_SITE_ADMIN_PASSWORD="password"
+	TEST_WP_ROOT_FOLDER=/tmp/wordpress
+	[email protected]
+
+	# codeception ENV variables
+	TESTS_DIR=tests
+	TESTS_OUTPUT=tests/_output
+	TESTS_DATA=tests/_data
+	TESTS_SUPPORT=tests/_support
+	TESTS_ENVS=tests/_envs
 	```
-	- `Shared` variables are as the comment implies, variables shared in both the `install-wp-tests` script and the **Codeception** configuration. The variable names should tell you what they mean.
-	- `Install script` variables are specified to the `install-wp-tests` script, and most likely won't changed. I've listed their meaning below.
-    	- `WP_VERSION` WordPress version used for testing
-    	- `SKIP_DB_CREATE` Should database creation be skipped?
-	- `Codeception` variables are specified to the **Codeception** configuration. View the config files and Codeception's [Docs](https://codeception.com/docs/reference/Configuration#Suite-Configuration) for more info on them.
+	- `docker ENV variables`: variables defined for use in the Docker/Docker-Compose setups. These are also used in `codeception.dist.yml` for testing within a Docker container. It's recommend that this file be left unchanged and a `codeception.yml` be created for local codeception unit testing.
+	- `local codeception/install-wp-tests ENV variables`: variable defined for use with codeception testing w/o docker and the `install-wp-tests` script in the `bin` directory. As mentioned above a `codeception.yml` should be created from `codeception.dist.yml` and the variables in the `WPLoader` config should be set accordingly.
+	- `install-wp-tests ENV variables`: variables specific to the `install-wp-tests` script. The script can be run using `composer install-wp-tests` in the terminal from project directory.
+	- `codeception ENV variables`: variables used by codeception. This includes within the docker container as well.
 
 4. Once you have finish modifying the `.env` file. Run `composer install-wp-tests` from the project directory.
 5. Upon success you can begin running the tests.
@@ -81,12 +88,18 @@ To learn more about the usage of Codeception with WordPress view the [Documentat
 It's possible to run functional and acceptance tests, but is very limited at the moment. The script docker entrypoint script runs all three suites (acceptance, functional, and wpunit) at once. This will change eventually, however as of right now, this is the limitation.
 
 ### Running tests
-Even though the two suite use a Docker environment to run, the docker environment relies on a few environmental variables defined in `.env` and a volume source provided by the test install script.
-0. Ensure that you can copy `.env.dist` to `.env`.
-1. First you must run `composer install-wp-tests` to ensure the required dependencies are available.
-2. Next run `docker-compose build` from the terminal in the project root directory, to build the docker image for test environment.
-3. And now you're ready to run the tests. Running `docker-compose run --rm wpbrowser` does just that.
-You can rerun the tests by simply repeating step 3.
+Even though the two suite use a Docker environment to run, the docker environment relies on a few environmental variables defined in `.env.dist` and a volume source provided by the test install script and the configuration `codeception.dist.yml`. If you have created a `codeception.yml` file ensure it is identical to `codeception.dist.yml` or delete it.
+Run the following in the terminal to run all three suites. Isolating specific suites should be simple to figure out.
+```
+docker-compose run --rm -e SUITE=acceptance;wpunit;functional -e DEBUG=1 -e COVERAGE=1 testing --scale app=0
+```
+- The `COVERAGE`, and `DEBUG` vars are optional flags for toggle codecoverage and debug output.
+- `--scale app=0` ensures that the service running a local app doesn't create any instances. It must be added or a collision with `mysql` will occur. More on this service in the next section
+
+## Using docker-compose to run a local installation for live testing.
+This is rather simple just like with testing using docker ensure that `env.dist` and `codeception.dist.yml` are untouched and run `docker-compose up --scale testing=0 app` and wait for `app_1      | Success: Exported to '/var/www/html/wp-content/plugins/wp-graphql-woocommerce/tests/_data/dump.sql'.` to print to the terminal, then navigate to `http://localhost:8091`. And that's it. You can view the configuration for the installation in the `docker-compose.yml`. Note if you get redirected to `http://localhost` run `docker-compose down` to remove any existing containers related to the project, then re-run the `docker-compose up --scale testing=0 app` command.
+- For more information about the docker-image uses in the service, it's on [Docker Hub](https://hub.docker.com/r/kidunot89/woographql-app). 
+
 
 ## HTTP Error 500 :construction: 
 If you get HTTP 500 error upon activation or accessing the `endpoint` and have **CMD/Terminal** access with **Composer** installed. 

README.txt

@@ -1,5 +1,5 @@
 === WP GraphQL WooCommerce ===
-Contributors: kidunot89
+Contributors: kidunot89, ranaaterning
 Tags: GraphQL, WooCommerce, WPGraphQL
 Requires at least: 4.9
 Tested up to: 5.2