commit 4c49bde2bfe0bd6260f56b81b34cf551f1cff6ca Author: Oliver Davies Date: Sat Oct 21 15:12:25 2017 +0100 Initial commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..4125f53 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# TDD Dublin demo module + +A demo module to accompany my [TDD Test Driven Drupal][0] talk at DrupalCamp +Dublin 2017. + +## Acceptance Criteria + +This module will be used to demonstrate how to take a test-driven approach to +develop a module to the following acceptance criteria: + +- As a site visitor +- I want to see a list of all published pages at `/pages` +- Ordered alphabetically by title + +## Running the Tests + +These tests are functional tests based on the `BrowserTestBase` class so need +to be executed with PHPUnit (which is required in core's `composer.json` file). +The path to your `vendor` directory may be different depending on your setup. + +Because of autoloading, you will need to be inside Drupal's `core` subdirectory +when running the tests for them to execute successfully. + +This also assumes that the module is within a `modules/custom` directory and +named `tdd_dublin` as per the repository name. + +``` +cd core + +../vendor/bin/phpunit ../modules/custom/tdd_dublin +``` + +You can use PHPUnit's `--filter` option to specify a single test method to run, +rather than all of the tests within the module. For example: + +``` +../vendor/bin/phpunit ../modules/custom/tdd_dublin --filter=testOnlyPublishedPagesAreShown +``` + +[0]: https://www.oliverdavies.uk/talks/tdd-test-driven-drupal diff --git a/tdd_dublin.info.yml b/tdd_dublin.info.yml new file mode 100644 index 0000000..4698633 --- /dev/null +++ b/tdd_dublin.info.yml @@ -0,0 +1,4 @@ +name: 'TDD Dublin' +description: 'A demo module for DrupalCamp Dublin to show test driven module development.' +core: 8.x +type: module