openeuropa/eu_login

Name: eu_login

Owner: OpenEuropa

Description: null

Created: 2018-05-08 07:40:51.0

Updated: 2018-05-21 16:00:21.0

Pushed: 2018-05-21 16:00:19.0

Homepage: null

Size: 15

Language: PHP

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

EU Login

The EU Login module allows to authenticate against the EU Login service.

Table of contents:

• Installation
• Development
• Project setup
• Using Docker Compose
• Disable Drupal 8 caching
• Demo module

Installation

The recommended way of installing the EU Login module is via a Composer-based workflow.

In your Drupal project's main composer.json add the following dependency:

"require": {
    "openeuropa/eu_login": "dev-master"
}

And run:

mposer update

Enable the module

In order to enable the module in your project run:

vendor/bin/drush en eu_login

Development

The EU Login project contains all the necessary code and tools for an effective development process, such as:

• All PHP development dependencies (Drupal core included) are required by composer.json
• Project setup and installation can be easily handled thanks to the integration with the Task Runner project.
• All system requirements are containerized using Docker Composer
• A mock server for testing.

Project setup

Download all required PHP code by running:

mposer install

This will build a fully functional Drupal test site in the ./build directory that can be used to develop and showcase the module's functionality.

Before setting up and installing the site make sure to customize default configuration values by copying runner.yml.dist to ./runner.yml and overriding relevant properties.

To set up the project run:

vendor/bin/run drupal:site-setup

This will:

• Symlink the theme in ./build/modules/custom/eu_login so that it's available for the test site
• Setup Drush and Drupal's settings using values from ./runner.yml.dist
• Setup PHPUnit and Behat configuration files using values from ./runner.yml.dist

After a successful setup install the site by running:

vendor/bin/run drupal:site-install

This will:

• Install the test site
• Enable the EU Login module

Using Docker Compose

The setup procedure described above can be sensitively simplified by using Docker Compose.

Requirements:

• Docker
• Docker-compose

Run:

cker-compose up -d

Then:

cker-compose exec -u web web composer install
cker-compose exec -u web web ./vendor/bin/run drupal:site-setup
cker-compose exec -u web web ./vendor/bin/run drupal:site-install

Your test site will be available at http://localhost:8080/build.

Run tests as follows:

cker-compose exec -u web web ./vendor/bin/phpunit
cker-compose exec -u web web ./vendor/bin/behat

Disable Drupal 8 caching

Manually disabling Drupal 8 caching is a laborious process that is well described here.

Alternatively you can use the following Drupal Console commands to disable/enable Drupal 8 caching:

vendor/bin/drupal site:mode dev  # Disable all caches.
vendor/bin/drupal site:mode prod # Enable all caches.

Note: to fully disable Twig caching the following additional manual steps are required:

1. Open ./build/sites/default/services.yml
2. Set cache: false in twig.config: property. E.g.:

   meters:
   .config:
   e: false
   

3. Rebuild Drupal cache: ./vendor/bin/drush cr

This is due to the following Drupal Console issue.