nucivic/dkanextension

Provides base DKAN class for Drupal Extension

DEPRECATED: This module has been moved into DKAN core for release 7.x-1.13. To maintain backward compatibility this project will remain on Github but new features will be applied directly to the DKAN core folder test/dkanextension., _(*1)

Behat DKAN Context

This creates a feature context for DKAN and NuCivic specific steps., _(*2)

Install

1. Create a composer.json file with the following:

{
  "require": {
    "nucivic/dkanextension": "dev-master"
  },
  "config": {
    "bin-dir": "bin/"
  },
}

1. Install dependencies: composer install, _(*3)

2. Initialize: behat --init, _(*4)

Contexts

DKANExtension ships with a bunch of "Contexts" or Classes that Behat uses to add step functions or other functionality. By default, none of those contexts are loaded. You need to add each context that you want to use to your behat.yml file. Here is an example where we add all the contexts, but you can instead choose to only load the ones you want. This can be very useful if you want to override one of these contexts and use your custom version instead. If you've used the DrupalExtension, which DKANExtension depends on, it works the same way., _(*5)

Setting up your behat.yml

default:
  suites:
     default:
        contexts:
          - FeatureContext
          # Load the Drupal Context from DrupalExtension
          - Drupal\DrupalExtension\Context\DrupalContext
          # Load the generic DKAN context
          - Drupal\DKANExtension\Context\DKANContext
          # Load DKAN Groups functionality
          - Drupal\DKANExtension\Context\GroupContext
          # Load DevinciExtension debug functionality
          - Devinci\DevinciExtension\Context\DebugContext:
              asset_dump_path: %paths.base%/../assets/
          # Set the default max wait time when testing JS "wait for.." tests.
          - Devinci\DevinciExtension\Context\JavascriptContext:
              maximum_wait: 30
...

Contexts Available

All contexts are in the src/Drupal/DKANExtension/Context folder. We're only showing the contexts that you'll consider loading in your behat.yml and only the custom steps they provide., _(*6)

DKANContext.php

The generic context that holds some helper steps, _(*7)

• Sets the default php timezone to date_default_timezone_set('America/New_York');
• @When I search for :term
• @Then /^I should see the administration menu$/
• @Then /^I should have an "([^"]*)" text format option$/

DKANDataStoryContext.php

Extends RawDKANEntityContext, _(*8)

• @Given data stories:, _(*9)

  Data Story Field Mappings:
  'title' => 'title' - Title of the data story (string)
  'author' => 'author' - Author of the data story (username)
  'status' => 'status', - Is this published or not ('Yes', 'No')
  'description' => 'body' - Description of the data story (string)
  'tags' => 'field_tags' - Tags (comma separated strings)
  

  Examples:, _(*10)

  Given data stories:
  | author    | title     | description       | status | tags     |
  | TestUser  | Story 01  | Some Description  | Yes    | some tag |
  And I am on the "Story 01" page
  

DataDashboardContext.php

Extends RawDKANEntityContext, _(*11)

• @Given data dashboards:, _(*12)

  Dashboard Field Mappings:
  'title' => 'title' - Title of the Data Dashboard (string)
  

  Examples:, _(*13)

  Given data dashboards:
  | title         |
  | Dashboard 01  |
  

DatasetContext.php

Extends RawDKANEntityContext, _(*14)

• @Given datasets:, _(*15)

  Dataset Field Mappings:
  'author' => 'author' - author of the Dataset (username)
  'title' => 'title' - Dataset title (string)
  'description' => 'body' - Dataset description (string)
  'publisher' => 'og_group_ref' - Group name (string)
  'published' => 'status' - Published? ('Yes', 'No')
  'tags' => 'field_tags' - Tags to add (comma separated strings)
  

  Examples:, _(*16)

  Given groups:
  | author    | title     | published     |
  | TestUser  | Group 01  | Yes           |
  Given datasets:
  | author    | title       | description       | publisher  | published | tags     |
  | TestUser  | Dataset 01  | Some Description  | Group 01   | Yes       | some tag |
  And I am on the "Dataset 01" page
  

• @Then I should see a dataset called :text, _(*17)

  • :text - Title of the dataset (string)

  Examples:, _(*18)

  Given groups:
  | author    | title     | published     |
  | TestUser  | Group 01  | Yes           |
  Given datasets:
  | author    | title       | description       | publisher  | published | tags     |
  | TestUser  | Dataset 01  | Some Description  | Group 01   | Yes       | some tag |
  And I am on the "Group 01" page
  Then I should see a dataset called "Dataset 01"
  

• @Then the Dataset search updates behind the scenes, _(*19)

  (Deprecated), _(*20)

GroupContext.php

Extends RawDKANEntityContext, _(*21)

• @Given groups:, _(*22)

  Group Field Mappings:
  'author' => 'author' -  Author of the Group (username)
  'title' => 'title' - Group Name (string)
  'published' => 'status' - Published? ('Yes', 'No')
  

  Examples:, _(*23)

  Given groups:
  | author    | title     | published     |
  | TestUser  | Group 01  | Yes           |
  And I am on the "Group 01" page
  

• @Given group memberships:, _(*24)

  Assigns users as members of a group with specific roles., _(*25)

  Table fields:
  'user' - (username)
  'group' - Group Name (string)
  'role on group' - ('administrator member', 'member')
  'membership status' - What is the user's group status? ('Active')
  

  Examples:, _(*26)

  Given groups:
  | author    | title     | published     |
  | TestUser  | Group 01  | Yes           |
  Given group memberships
  | user       | group     | role on group        | membership status |
  | TestUser   | Group 01  | administrator member | Active            |
  

• @Given /^I am a "([^"]*)" of the group "([^"]*)"$/, _(*27)

  Grants the given role to the current user, for the given group., _(*28)

  • :role - role on group. See @Given group memberships:
  • :group - Group name (string)

  Examples:, _(*29)

  Given groups:
  | author    | title     | published     |
  | TestUser  | Group 01  | Yes           |
  And I am a "administrator member" of the group "Group 01"
  

MailContext.php

• Creates the @mail tag for use when testing email notifications in your scenario

(currently no additinal steps), _(*30)

PageContext.php

• @Given pages:, _(*31)

  Table Fields:
  title - Page Name (string) -- Must be unique per scenario.
  url - Relative Path ('/my-page') or full url ('https://facebook.com')
  

  Examples:, _(*32)

  @Given pages:
  | title        | url    |
  | Content List | /node  |
  

• @Given I am on (the) :page page, _(*33)

  Changes the current page. Knows about pages created by other contexts, like GroupContext as well., _(*34)

  • :page - title of the page created by @Given Pages or one of the other contexts that integrate with PageContext.

  Examples:, _(*35)

  Manually Created Pages:, _(*36)

  Given pages:
  | title        | url    |
  | Content List | /node  |
  And I am on the "Content List" page
  Then I should see "Content"
  

  Use pages created by other contexts., _(*37)

  Given groups:
  | author    | title     | published     |
  | TestUser  | Group 01  | Yes           |
  And I am on the "Group 01" page
  

ResourceContext.php

Extends RawDKANEntityContext, _(*38)

• @Given resources:, _(*39)

  Resource Field Mappings:
  'author' => 'author' - Username of user (string)
  'title' => 'title' - Resource title (string)
  'description' => 'body' - Resource Description (string)
  'publisher' => 'og_group_ref' - Group name (string)
  'published' => 'status' - ('Yes', 'No')
  'resource format' => 'field_format' - ('CSV', 'XML')
  'dataset' => 'field_dataset_ref' - Dataset name (string)
  

About RawDKANEntityContext

RawDKANEntityContext is a base Class that the other Content/Entity contexts extend from. It can be used to easily create new contexts for content that have a following features:, _(*40)

• Automatic Deletion of content on teardown.
• Handles any entity (nodes+)
• Creates "pages" in the PageContext so that you can navigate to an item after it's created.
• Handles mapping of "human" field labels to drupal field names and handles adding entities with Tables.
• Handles author mapping of username to uid.
• Uses entity api metadata wrappers throughout, making it easier to set fields in a consistent way.
• Keeps a list of created entities in $entities[$id] for teardown and other uses like finding an entity by name.

You should use the existing "entity contexts", or create a new one for your project instead of the DrupalExtension's @Given content: which lacks most of these features. Because the entity api needs to be bootstrapped, you can only use the 'drupal driver', not 'drush' or 'blackbox' when using relevant steps., _(*41)

Creating a new Entity Context

To create a new Context for any entity (and nodes), create a new context in your /bootstrap folder. For this example, we'll pretend the entity is a node type called "myentity". Call the file MyEntityContext.php (where MyEntity is the name of your entity.) You can use this template to get started., _(*42)

<?php
namespace Drupal\DKANExtension\Context;
use Behat\Gherkin\Node\TableNode;
/**
 * Defines application features from the specific context.
 */
class MyEntityContext extends RawDKANEntityContext{

  public function __construct(){
    parent::__construct(array(
      // These are the mappings of human readable name => drupal field machine name or entity property name.
      'title' => 'title',
      'author' => 'author',
      'myfield' => 'field_my_field'
    ),
      // This is the bundle name if one exists, or null if one doesn't.
      // for nodes bundle == node_type name
      'myentity',
      // This is the entity type.
      'node'
    );
  }

  /**
   * @Given myentities:
   */
  public function addDataDashboard(TableNode $dashboardtable){
    //This is an example of calling parent helper functions.
    parent::addMultipleFromTable($dashboardtable);
  }

  /**
   * A contrived exmple of hooking into the Entity helpers by overriding them.
   *
   * Set all of the entities to be unpublished before they're created, no matter what.
   */
  public function wrap($entity){
    $wrapper = parent:wrap($wrap);
    $wrapper->status = 0;
    return $wrapper;
  }


  /**
   * @Given myentities:
   *
   * All custom entities will almost all want to add this type of function.
   */
  public function addDataDashboard(TableNode $dashboardtable){
    //This is an example of calling parent helper functions.
    parent::addMultipleFromTable($dashboardtable);
  }

  /**
   * @Given there should be ":number" MyEntities.
   *
   * An example showing how you can creat new step functions and get the entities array from the parent class.
   */
  public function assertNumberEntities($number){
    $actual = count($this->entities);
    if ($number !== count($this->entities) {
      throw new Exception("Asserted that there are $number myEntites, but there are actually $actual.");
    }
  }
}

Now add the new Entity Context to your behat.yml like you'd do for any new custom context:, _(*43)

default:
  suites:
     default:
        contexts:
          - FeatureContext
          # Add the new entity context
          - MyEntityContext
...

TODO

• [ ] Make sure scripts works on install
• [ ] Add tests
• [ ] Deploy on DKAN and related modules