Browse Library
Sign In Start Free Trial
Close icon Search icon
Account
Browse Library Advanced Search Sign In Start Free Trial

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying Drupal 8 Development Cookbook
  • Table Of Contents Toc
  • Feedback & Rating feedback
Drupal 8 Development Cookbook

Drupal 8 Development Cookbook - Second Edition

By : Matt Glaman
4.7 (3)
Buy this Book
close
close
Drupal 8 Development Cookbook

Drupal 8 Development Cookbook

4.7 (3)
By: Matt Glaman
Buy this Book

Overview of this book

Began as a message board, Drupal today is open source software maintained and developed by a community of over 1,000,000 users and developers. Drupal is used by numerous local businesses to global corporations and diverse organizations all across the globe. With Drupal 8’s exciting features it brings, this book will be your go-to guide to experimenting with all of these features through helpful recipes. We’ll start by showing you how to customize and configure the Drupal environment as per your requirements, as well as how to install third-party libraries and then use them in the Drupal environment. Then we will move on to creating blocks and custom modules with the help of libraries. We will show you how to use the latest mobile-first feature of Drupal 8, which will help you make your apps responsive across all the major platforms. This book will also show you how to incorporate multilingual facilities in your sites, use web services and third-party plugins with your applications from inside Drupal 8, and test and deploy your apps.
Table of Contents (20 chapters)
close
close
close
Title Page
Icon
Title Page
Credits
Icon
Credits
About the Author
Icon
About the Author
About the Reviewer
Icon
About the Reviewer
www.PacktPub.com
Icon
www.PacktPub.com
Customer Feedback
Icon
Customer Feedback
Preface
Icon
Preface
Lock Free Chapter
1
Up and Running with Drupal 8
chevron up
Icon
Up and Running with Drupal 8
Icon
Introduction
Icon
Installing Drupal
Icon
Using a distribution with Drupal
Icon
Installing modules and themes
Icon
Using multisites in Drupal 8
Icon
Tools for setting up an environment
Icon
Running tests - Simpletest and PHPUnit
2
The Content Authoring Experience
Icon
The Content Authoring Experience
Icon
Introduction
Icon
Configuring the WYSIWYG editor
Icon
Adding and editing content
Icon
Creating a menu and linking content
Icon
Providing inline editing
Icon
Creating a custom content type
Icon
Applying new Drupal 8 core field types
Icon
Customizing the form display of a node
Icon
Customizing the display output of a node
3
Displaying Content through Views
Icon
Displaying Content through Views
Icon
Introduction
Icon
Listing content
Icon
Editing the default admin interfaces
Icon
Creating a block from a View
Icon
Utilizing dynamic arguments
Icon
Adding a relationship in a View
Icon
Providing an Entity Reference result View
4
Extending Drupal
Icon
Extending Drupal
Icon
Introduction
Icon
Creating a module
Icon
Defining a custom page
Icon
Defining permissions
Icon
Providing the configuration on the installation or update
Icon
Creating an event subscriber
Icon
Using Features 3.0
5
Frontend for the Win
Icon
Frontend for the Win
Icon
Introduction
Icon
Creating a custom theme based on Classy
Icon
Using the new asset management system
Icon
Twig templating
Icon
Using the Breakpoint module
Icon
Using the Responsive Image module
6
Creating Forms with the Form API
Icon
Creating Forms with the Form API
Icon
Introduction
Icon
Creating a form
Icon
Using new HTML5 elements
Icon
Validating form data
Icon
Processing submitted form data
Icon
Altering other forms
7
Plug and Play with Plugins
Icon
Plug and Play with Plugins
Icon
Introduction
Icon
Creating blocks using plugins
Icon
Creating a custom field type
Icon
Creating a custom field widget
Icon
Creating a custom field formatter
Icon
Creating a custom plugin type
8
Multilingual and Internationalization
Icon
Multilingual and Internationalization
Icon
Introduction
Icon
Translating administrative interfaces
Icon
Translating configuration
Icon
Translating content
Icon
Creating multilingual views
9
Configuration Management - Deploying in Drupal 8
Icon
Configuration Management - Deploying in Drupal 8
Icon
Introduction
Icon
Importing and exporting configurations
Icon
Synchronizing site configurations
Icon
Using command-line workflow processes
Icon
Updating and installing new module configurations
10
The Entity API
Icon
The Entity API
Icon
Introduction
Icon
Creating a configuration entity type
Icon
Creating a content entity type
Icon
Creating a bundle for a content entity type
Icon
Implementing custom access control for an entity
Icon
Providing a custom storage handler
Icon
Creating a route provider
11
Off the Drupalicon Island
Icon
Off the Drupalicon Island
Icon
Introduction
Icon
Implementing and using a third-party JavaScript library
Icon
Implementing and using a third-party CSS library
Icon
Implementing and using a third-party PHP library
12
Web Services
Icon
Web Services
Icon
Introduction
Icon
Enabling RESTful interfaces
Icon
Using POST to create data
Icon
Using PATCH to update data
Icon
Using Views to provide custom data sources
Icon
Authentication
Icon
Using JSON API
13
The Drupal CLI
Icon
The Drupal CLI
Icon
Introduction
Icon
Rebuilding cache in Drupal Console or Drush
Icon
Using Drush to interact with the database
Icon
Using Drush to manage users
Icon
Scaffolding code through Console
Icon
Making a Drush command
Icon
Making a Console command

Running tests - Simpletest and PHPUnit

Drupal 8 ships with two testing suites. Previously, Drupal only supported Simpletest. Now, there are PHPUnit tests as well. In the official change record, PHPUnit was added to provide testing without requiring a full Drupal Bootstrap, which occurs with each Simpletest test. You can read the change record at https://www.drupal.org/node/2012184.

There is currently a PHPUnit initiative active in Drupal core development. The goal is to fully remove the Simpletest framework by Drupal 9. No new Simpletest tests are being written, at least since 8.2. All current tests are currently being converted by contributors. More about the initiative can be found in this issue, https://www.drupal.org/node/2807237, where it is being coordinated.

We will be running tests using the run-tests.sh test runner. This is a test runner provided by Drupal that supports concurrency and running all of the various test suites. Running tests directly with PHPUnit will be covered in the following There's more... section.

Getting ready

Drupal 8.1.0 introduced the ability to perform JavaScript browser tests. This is powered using PhantomJS (http://phantomjs.org/), which uses a browser emulator powered by the Mink PHP library (http://mink.behat.org/). In order to run the FunctionalJavascript test suite, you must have PhantomJS running.

To install PhantomJS, refer to the official installation instructions at http://phantomjs.org/download.html.

How to do it...

  1. First, install the Simpletest module. Even though you might only want to run PHPUnit, this is a soft dependency for running the test runner script.
  2. Open a command-line terminal and navigate to your Drupal installation directory.
  3. Next, we will run the test runner script. We will pass it a url option so that the Functional tests can run the browser emulator properly. We will also specify the test suites to run. This allows us to skip FunctionalJavascript tests due to PhantomJS not handling concurrency properly in the test runner:
$ php core/scripts/run-tests.sh --url http://localhost--types Simpletest,PHPUnit-Unit,PHPUnit-Kernel,PHPUnit-Functional --concurrency 20 --all
  1. Running FunctionalJavascripts tests require PhantomJS to be running. Since PhantomJS prints output to the terminal, open a new tab or terminal and run the following command:
phantomjs --ssl-protocol=any --ignore-ssl-errors=true vendor/jcalderonzumba/gastonjs/src/Client/main.js 8510 1024 768
  1. With PhantomJS running, we can now execute the FunctionalJavascript test suite:
php core/scripts/run-tests.sh --url http://localhost--types PHPUnit-FunctionalJavascript --concurrency 1 --all
  1. Review test output from each test suite run.

How it works...

The run-tests.sh script has been shipped with Drupal since 2008, then namedrun-functional-tests.php. This command interacts with the test suites in Drupal to run all or specific tests and sets up other configuration items.

There are several different test suites that operate in specific ways:

  • Simpletest: The deprecated test system, full bootstraps and installs Drupal and uses its own browser emulator pattern using curl and XPath.
  • PHPUnit-Unit: Unit tests backed by PHPUnit. These are intended to test specific classes and not interact with the database.
  • PHPUnit-Kernel: Integration-level tests backed by PHPUnit. It is a test that has the ability to install schema and configuration to the database, minimally bootstrapping Drupal for basic integration testing.
  • PHPUnit-Functional: Functional tests are tests that require a fully bootstrapped Drupal and provide browser emulation via Mink. These can be considered a direct replacement of Simpletest tests but leveraging third-party testing libraries.
  • PHPUnit-FunctionalJavascript: Functional tests that have the ability to interact with PhantomJS in order to test JavaScript, such as AJAX operations and specific user interface interactions.

The following are some of the useful options:

  • --help: This displays the items covered in the following bullets
  • --list: This displays the available test groups that can be run
  • --url: This is required unless the Drupal site is accessible through http://localhost:80
  • --sqlite: This allows you to run tests without having Drupal installed
  • --concurrency: This allows you to define how many tests run in parallel

There's more...

We will now discuss more techniques and information for running Drupal's test suites.

Is run-tests a shell script?

The run-tests.sh isn't actually a shell script. It is a PHP script--which is why you must execute it with PHP. In fact, within core/scripts, each file is a PHP script file meant to be executed using the command line. These scripts are not intended to be run through a web server, which is one of the reasons for the .sh extension.

There can be issues with PHP across platforms that prevent providing a shebang line to allow executing the file as a normal bash or bat script. For more information, refer to this Drupal.org issue at https://www.drupal.org/node/655178.

Running tests without Drupal installed

With Drupal 8, tests can also be run from SQLlite and no longer requires an installed database. This can be accomplished by passing the sqlite and dburl options to therun-tests.sh script. This requires the PHP SQLite extension to be installed.

Here is an example adapted from the DrupalCI test runner for Drupal core. DrupalCI is the continuous integration service, which runs on Drupal.org for all submitted patches and commits:

php core/scripts/run-tests.sh --sqlite /tmp/.ht.sqlite --die-on-fail --dburl sqlite://tmp/.ht.sqlite --all

Combined with the built-in PHP web server for debugging, you can run test suites without a full-fledged environment.

Running specific tests

Each example so far has used the all option to run every Simpletest available. There are various ways to run specific tests:

  • --module: This allows you to run all the tests of a specific module
  • --class: This runs a specific path, identified by a full namespace path
  • --file: This runs tests from a specified file
  • --directory: This run tests within a specified directory

Note

Previously in Drupal, tests were grouped inside the module.test files, which is where the file option derives from. Drupal 8 utilizes the PSR-4 autoloading method and requires one class per file.

PhpStorm - Drupal Test Runner

Drupal 8 has seen a surge in test coverage for both Drupal core and contributed projects, most likely due to PHPUnit adoption. In response to this, the author has written a PhpStorm plugin called Drupal Test Runner that simplifies executing the run-tests.sh script runner.

The plugin's page can be found at https://plugins.jetbrains.com/plugin/8384-drupal-test-runner, and it's public source code can be found at https://github.com/mglaman/intellij-drupal-run-tests.

DrupalCI

With Drupal 8 came a new initiative to upgrade the testing infrastructure on Drupal.org. The outcome was DrupalCI. DrupalCI is open source and can be downloaded and run locally. The project page for DrupalCI is https://www.drupal.org/project/drupalci.

The test bot utilizes Docker and can be downloaded locally to run tests. The project ships with a Vagrant file that allows it to be run within a virtual machine or locally. Learn more on the testbot's project page at https://www.drupal.org/project/drupalci_testbot.

See also...

 

End of Chapter 1
Next Chapter
notes
bookmark Notes and Bookmarks search Search in title playlist Add to playlist font-size Font size

Change the font size

margin-width Margin width

Change margin width

day-mode Day/Sepia/Night Modes

Change background colour

Close icon Search
Country selected
Close icon Your notes and bookmarks

Confirmation

Modal Close icon
claim successful
Order Page Read Now

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY

Submit Your Feedback

Modal Close icon
Modal Close icon
Modal Close icon