Skip to content

Latest commit

 

History

History
130 lines (83 loc) · 6.13 KB

README.md

File metadata and controls

130 lines (83 loc) · 6.13 KB
Raw

Factory Lollipop

The goal of this package is to enable the rapid creation of objects (vocabularies, terms, content types, nodes) for the purpose of testing.

The primary aim of Factory Lollipop is to a fill a void in the world of Drupal Unit testing.

Tests-CI Style-CI Downloads Releases
Build Status Code styles

This module allows you to create templates/blueprints for valid and re-usable Drupal objects.

We created this project in response to fixtures which where fixed global records that had to be loaded into the database.

With Factories, you have more customization when you instantiate the objects & they aim to ensure that you have a valid object to work with. They can be used anywhere in your tests and in your before and after test setup.

Use Factory Lollipop if

  • You are working on a client project containing multiple custom modules and want to test them against specific Client project scenarios (Nodes, Types, Fields, ...).

    Indeed, the Drupal Unit Test system will never load your custom Profile or Drupal Sync Configuration. Therefore, you will need - for each test - to re-create Nodes-Types, Nodes Data, Fields, etc ... By using Factory Lollipop, you will be able to create Blueprint (factory) to be loaded and used by scenarios.

  • You have a Contrib module/theme for Drupal and want to test it against coherent data/scenario.

    By using Factory design pattern throughout Factory Lollipop, you will be able to create Factory blueprint for your scenarios and ensure data consistency across your tests suits.

Usage

Check out the official documentation about Factory Lollipop.

You may also be interested in this article about Factory Lollipop:

Two submodules provide examples of implementing Factory Lollipop.

  • factory_lollipop_example - A carefully documented implementation of Factories scenario, designed to walk you through the basic concepts of the Drupal Factory Test framework.
  • factory_lollipop_example_advanced (still in progress) - Examples of more advanced techniques for Drupal factories.

If you want more information, the following resources are available to you:

Supported Types

At present, Factory Lollipop has support for the following types of data in Drupal:

  • Content Types (Node Types)
  • Nodes
  • Field
  • Vocabularies
  • Taxonomy Terms
  • Users
  • Roles
  • Menus
  • Menu Links
  • File
  • Media Type
  • Media
  • Paragraphs Type
  • Paragraphs

You can easily add/override any FactoryType by using the FactoryType Resolver. See the official documentation about it.

Getting Started

We highly recommend you to install the module using composer.

$ composer require --dev drupal/factory_lollipop

Upgrading

It may be useful for existing users to check out the upgrade guide.

Versions

Factory Lollipop is available for both Drupal 9, Drupal 10 & Drupal 11 (dev) !

Which version should I use?

Drupal Core Factory Lollipop
8.x 1.0.0
9.0 1.0.0
9.x 1.1.x
10.x 1.2.x
11.x-dev 1.2.x

Roadmap

This outlines the development plan from a high level and will be updated as progress are made toward version 1.0.

  • Drush's integration to facilitate the creation of factories based on existing project configuration.
  • Drupal Commerce's Factories (Store, Price, Product, Variation, Payment Method, Workflow, ...).

Everything contained before is in draft form and subject to change. We do not guarantee the accuracy of the information contained in this roadmap, and the information is provided “as is” with no representations or warranties, express or implied.

Dependencies

The Drupal version of Factory Lollipop requires nothing ! Feel free to use it.

Factory Lollipop requires PHP 7.3+ to works properly. We recommend updating to at least PHP 8.1 if possible.

Similar modules

  • Factory Drone A comprehensive solution for using the factory pattern to generate short-lived test data on Drupal 7.

Similar libraries

  • Factory Muffin Enables the rapid creation of objects for testing. It's basically a "Factory Bot", simplified for use with PHP.
  • Foundry A model factory library for creating expressive, auto-completable, on-demand dev/test fixtures with Symfony and Doctrine.
  • Phactory A Database Factory for PHP Unit Tests.
  • Factory Bot A library for setting up Ruby objects as test data.
  • Sham Lightweight flexible factories for Ruby and Rails testing.

Supporting organizations

This project is sponsored by Antistatique, a Swiss Web Agency. Visit us at www.antistatique.net or Contact us.

Credits

Factory Lollipop is currently maintained by Kevin Wenger. Thank you to all our wonderful contributors too.