Download the PHP package sandstorm/neos-init-e2e-tests-plugin without Composer

On this page you can find all versions of the php package sandstorm/neos-init-e2e-tests-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package neos-init-e2e-tests-plugin

Sandstorm.NeosInitE2ETestsPlugin

A Composer plugin that scaffolds end-to-end (E2E) test infrastructure for Neos CMS packages. Run one command and get a fully wired Playwright BDD test suite with Docker-based Neos environments for both Neos 8 and Neos 9.

What it does

When you run composer e2e:init inside a Neos package, the plugin copies a ready-to-use test scaffold into your project. The scaffold includes:

Prerequisites

Installation

Add the plugin to your package's dev dependencies:

Usage (Deprecated)

Deprecation notice: The Composer plugin should not be used anymore - installing a composer plugin just to scaffold a test suite is overkill. Use the bash bootstrap instead (see below).

Inside the root of your Neos package, run:

Usage Without Composer (bash bootstrap)

If you don't want to add a dev dependency just for the one-shot scaffold, run the bundled bash script instead. It downloads the template directly from GitHub and applies the same logic. From the root of your Neos package:

To pin a specific ref, set E2E_REF (usually not necessary):

Requires curl, tar, jq, and sed in PATH.

The plugin reads your composer.json to determine the package name and derives the Neos package key automatically (e.g. vendor/my-package → Vendor.MyPackage). It then copies the template into your project, substituting those values wherever needed.

The operation is non-destructive — existing files are never overwritten. Pass -v to see which files are skipped:

Overriding the package key

If the derived package key doesn't match your Neos package, set it explicitly in your composer.json:

Template variables

The following placeholders are replaced in all copied files:

Placeholder Example value Source
{{PackageName}} vendor/my-package name field in composer.json
{{PackageKey}} Vendor.MyPackage derived from {{PackageName}}, or extra.neos.package-key

Scaffolded structure

See Tests/E2E/README.md (created in your project) for instructions on running tests and writing new ones.

How the SUT works

Each Docker environment starts a full Neos stack (FrankenPHP web server, MariaDB, Redis). On startup the container:

  1. Registers your local package as a Composer path repository
  2. Requires it at @dev
  3. Runs database migrations
  4. Imports the Neos demo site
  5. Publishes static resources
  6. Starts the web server on port 8081

Playwright's webServer configuration starts the containers automatically before each test run and the global teardown stops them afterwards.

Development

Clone the repo and install dependencies:

The plugin source lives in src/ and the template that gets copied into projects lives in template/.

All versions of neos-init-e2e-tests-plugin with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
composer-plugin-api Version ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package sandstorm/neos-init-e2e-tests-plugin contains the following files

Loading the files please wait ...