Release 0.8.0

[liamdefty]

To do before merge

• [x] Lots of testing!
• [x] Update documentation and document breaking changes

Change Log

Added

• Add --no-volumes flag to start command for environments that don't support Docker volume mounting. When using this flag any changes will not be reflected in the test container and it will be slower to create a test container [#42]
• Validation for configuration object.
• Added configFile option to config object which allows a path to be provided to a php file to define configuration expected in wp-config.php.
• Allow seeds directory to have sub directories for managing larger projects
• Added support for WordPress Multisite. Defaults to false but can be set to true for subdirectory or subdomain installs. A url is option is available to set a custom domain which is needed if you plan to use subdomain.

Changed

• When using cy.switchUser it uses the bypass auth logic instead of visiting wp-login.php which helps to speed up tests
• Caches WP versions to prevent re-downloading all the WP versions defined in wp.version if it changes.
• Cache vip mu plugins if used
• Perform soft reset between tests for performance benefits.

Fixed

• Mount wp-content directory directly as a volume (ignoring uploads and upgrade directories), instead of flaky intermediary step
• A more aggressive bypass auth logic is used to prevent previous issues [#25]
• Re-generate default values for each post in post fixture
• Only duplicate tests if there are multiple wp versions supplied in config

Breaking Changes

• Can no longer mount additional plugins or themes when mounting a wp-content folder, this is an intentional design decision to simplify things.
• Remove cypress retries plugin and default number of retries. It is now recommended you configure this yourself using the native support in Cypress versions 5 & above https://docs.cypress.io/guides/guides/test-retries.html
• Config object schema has changed. The new schema should be more stable moving forwards. See below examples of how various different config combinations using the new schema can be utilised for different projects.

Example configs

Plugins/Theme

{
 "wp": {
    "version": ["5.5"],
    "plugins": ["./path/to/plugin", "./another/path/to/plugin"],
    "themes": ["./path/to/theme"]
  }
}

Plugins/Theme with VIP

{
 "wp": {
    "version": ["5.5"],
    "plugins": ["./path/to/plugin", "./another/path/to/plugin"],
    "themes": ["./path/to/theme"],
    "muPlugins": {
       "vip": true
     }
  }
}

Plugins/Theme/Mu-plugins

{
 "wp": {
    "version": ["5.5"],
    "plugins": ["./path/to/plugin", "./another/path/to/plugin"],
    "themes": ["./path/to/theme"],
    "muPlugins": {
       "path": "./path/to/mu-plugins "
     }
  }
}

Plugins/Theme/Mu-plugins with VIP

{
 "wp": {
    "version": ["5.5"],
    "plugins": ["./path/to/plugin", "./another/path/to/plugin"],
    "themes": ["./path/to/theme"],
    "muPlugins": {
       "path": "./path/to/client-mu-plugins",
       "vip": true
     }
  }
}

WP Content

{
 "wp": {
      "version": ["5.5"],
      "wpContent": {
        "path": "./wp-content",
        "activeTheme": "twentynineteen",
        "activePlugins": ["my-plugin", "askimet"]
      },
  }
}

WP Content with VIP

{
"wp": {
      "version": ["5.5"],
      "wpContent": {
        "path": "./wp-content",
        "activeTheme": "twentynineteen",
        "activePlugins": ["liam-test"]
      },
      "muPlugins": {
        "vip": true
      },
      "configFile": "./wp-content/vip-config/vip-config.php",
    }
}

Types of changes (if applicable):

• [ ] Bug fix (non-breaking change which fixes an issue).
• [X] New feature (non-breaking change which adds functionality).
• [X] Breaking change (fix or feature that would cause existing functionality to not work as expected).

Checklist (if applicable):

• [X] Meets provided linting standards.