QL Events

Quick Install

1. Install & activate The Events Calendar/The Events Calendar Pro

• (Optional) Install & activate Ticket Events/Ticket Events Plus

2. Install & activate WPGraphQL

• (Optional) Install & activate WPGraphQL-JWT-Authentication to add a login mutation that returns a JSON Web Token.

3. Clone or download the zip of this repository into your WordPress plugin directory & activate the QL Events plugin

What does this plugin do?

It adds The Events Calendar's and some of it's extension's functionality to the WPGraphQL schema.

Unit Tests

Until the documentation is in full effect, it's recommended that a GraphiQL-based tool like WPGraphiQL be used to view the GraphQL schema, an alternative to this is viewing the unit tests located in tests/wpunit directory. Which are constantly updated along with the project. If you're interested in contributing when I begin accepting contribution or simply want to run the tests. Follow the instruction below.

Prerequisties

• Shell/CMD access
• Composer
• WP-CLI

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.testing 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.testing => .env

3. Next open .env and alter to make you usage.

    DB_NAME=wordpress
    DB_HOST=app_db
    DB_USER=wordpress
    DB_PASSWORD=wordpress
    WP_TABLE_PREFIX=wp_
    WP_URL=http://localhost
    WP_DOMAIN=localhost
    ADMIN_EMAIL=admin@example.com
    ADMIN_USERNAME=admin
    ADMIN_PASSWORD=password
    ADMIN_PATH=/wp-admin
   
    TEST_DB_NAME=ql_events_tests
    TEST_DB_HOST=127.0.0.1
    TEST_DB_USER=wordpress
    TEST_DB_PASSWORD=wordpress
    TEST_WP_TABLE_PREFIX=wp_
   
    SKIP_DB_CREATE=false
    TEST_WP_ROOT_FOLDER=/tmp/wordpress
    TEST_ADMIN_EMAIL=admin@wp.test
   
    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 for more info on them.

4. Once you have finish modifying the .env file. Run composer install-test-env from the project directory.

5. Upon success you can begin running the tests.

Running tests

To run test use the command vendor/bin/codecept run [suite [test [:test-function]]]. If you use the command with at least a suite specified, Codeception will run all tests, however this is not recommended. Running a suite vendor/bin/codecept run wpunit or a test vendor/bin/codecept run VenueQueriesTest is recommended. Running a single test-function like vendor/bin/codecept run EventQueriesTest:testEventQuery is also possible.

To learn more about the usage of Codeception with WordPress view the Documentation

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.testing to .env.

1. First you must run composer install-test-env to ensure the required dependencies are available.
2. Next run composer run-codeception to run the tests within a docker container.