Skip to content

Latest commit

 

History

History
224 lines (154 loc) · 6.97 KB

README.md

File metadata and controls

224 lines (154 loc) · 6.97 KB
Raw

OpenEuropa Agenda

Drupal module that exposes an agenda. The module defines the Agenda, Day, and Session sub-entity types and their default bundles.

Table of contents:+

Requirements

Depends on the following software:

  • PHP >=8.0
  • Virtuoso (or equivalent) triple store

Installation

Install the package and its dependencies:

composer require openeuropa/oe_agenda

It is strongly recommended to use the provisioned Docker image for Virtuoso. To do this, add the image to your docker.compose.yml file:

  sparql:
    image: openeuropa/triple-store-dev
    environment:
    - SPARQL_UPDATE=true
    - DBA_PASSWORD=dba
    ports:
      - "8890:8890"

Otherwise, make sure you have the triple store instance running.

Next, if you are using the Task Runner to set up your site, add the runner.yml configuration for connecting to the triple store. Under the drupal key:

  sparql:
    host: "sparql"
    port: "8890"

Still in the runner.yml, add the instruction to create the Drupal settings for connecting to the triple store. Under the drupal.settings.databases key:

  sparql_default:
    default:
      prefix: ""
      host: ${drupal.sparql.host}
      port: ${drupal.sparql.port}
      namespace: 'Drupal\Driver\Database\sparql'
      driver: 'sparql'

Then you can proceed with the regular Task Runner commands for setting up the site.

Otherwise, ensure that in your site's setting.php file you have the connection information to your own triple store instance:

$databases["sparql_default"] = array(
  'default' => array(
    'prefix' => '',
    'host' => 'your-triple-store-host',
    'port' => '8890',
    'namespace' => 'Drupal\\Driver\\Database\\sparql',
    'driver' => 'sparql'
  )
);

Usage

To enable the module, run:

drush en oe_agenda

Default session type Moderators and Speakers fields

These fields are configured to reference Person reference entities (defined by the oe_content_sub_entity_person submodule of OE Content). There are no target bundles selected for these fields after installation. To make the fields work, you need to create and configure one or more Person sub-entity types (Structure > Person types > Add Person type). Then you need to select the target bundle(s) for the fields on the following admin pages and save the field settings:

/admin/structure/oe_agenda_session_type/oe_default/edit/fields/oe_agenda_session.oe_default.oe_session_moderators
/admin/structure/oe_agenda_session_type/oe_default/edit/fields/oe_agenda_session.oe_default.oe_session_speakers

Development setup

Requirements

Initial setup

You can build the test site by running the following steps.

  • Install Virtuoso. The easiest way to do this is by using the OpenEuropa Triple store development Docker container which also pre-imports the main Europa vocabularies.

  • Install all the composer dependencies:

composer install
  • Customize build settings by copying runner.yml.dist to runner.yml and changing relevant values, like your database credentials.

This will also symlink the module in the proper directory within the test site.

  • Install test site by running:
./vendor/bin/run drupal:site-install

Your test site will be available at ./build.

Please note: project files and directories are symlinked within the test site by using the OpenEuropa Task Runner's Drupal project symlink command.

If you add a new file or directory in the root of the project, you need to re-run drupal:site-setup in order to make sure they are be correctly symlinked.

If you don't want to re-run a full site setup for that, you can simply run:

$ ./vendor/bin/run drupal:symlink-project

Using Docker Compose

Alternatively, you can build a development site using Docker and Docker Compose with the provided configuration.

Docker provides the necessary services and tools such as a web server and a database server to get the site running, regardless of your local host configuration.

Requirements:

Configuration

By default, Docker Compose reads two files, a docker-compose.yml and an optional docker-compose.override.yml file. By convention, the docker-compose.yml contains your base configuration, and it's provided by default. The override file, as its name implies, can contain configuration overrides for existing services or entirely new services. If a service is defined in both files, Docker Compose merges the configurations.

Find more information on Docker Compose extension mechanism on the official Docker Compose documentation.

Usage

To start, run:

docker-compose up

It's advised to not daemonize docker-compose so you can turn it off (CTRL+C) quickly when you're done working. However, if you'd like to daemonize it, you have to add the flag -d:

docker-compose up -d

Then:

docker-compose exec web composer install
docker-compose exec web ./vendor/bin/run drupal:site-install

Using default configuration, the development site files should be available in the build directory and the development site should be available at: http://127.0.0.1:8080/build.

Running the tests

To run the grumphp checks:

docker-compose exec web ./vendor/bin/grumphp run

To run the phpunit tests:

docker-compose exec web ./vendor/bin/phpunit

Step debugging

To enable step debugging from the command line, pass the XDEBUG_SESSION environment variable with any value to the container:

docker-compose exec -e XDEBUG_SESSION=1 web <your command>

Please note that, starting from XDebug 3, a connection error message will be outputted in the console if the variable is set but your client is not listening for debugging connections. The error message will cause false negatives for PHPUnit tests.

To initiate step debugging from the browser, set the correct cookie using a browser extension or a bookmarklet like the ones generated at https://www.jetbrains.com/phpstorm/marklets/.

Contributing

Please read the full documentation for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the available versions, see the tags on this repository.