Developing custom MicroMVDs
Authoring a custom MicroMVD
If you wish to write your own custom MicroMVD, some basic technical knowledge is required. The first is how to structure a MicroMVD. Each MicroMVD must follow the generic format shown below:
Feature: Name of the exchange requirement In order to achieve a business goal As a particular user or stakeholder We need to satisfy specific technical requirements Scenario: Check a particular technical requirement * Some data must be in a certain way * Some other data must be in another way Scenario: Check another particular technical requirement * Some data must be in a certain way * Some other data must be in another way
A feature file always starts by defining the name of the
Feature. Below the feature name is an three sentence paragraph which describes the value this MicroMVD delivers to the project. This paragraph is optional, but encouraged to help align both technical and non-technical project participants.
The individual audits are then categorised into one or more
Scenario blocks. Each scenario has a name that focuses on a particular technical requirement of the exchange requirement, and contains one or more test sentences. Each sentence checks data related to the scenario. The feature name and scenario names can be anything, but must be prefixed by
Scenario: respectively. The test sentences within each
Scenario block must match a pattern defined in the MicroMVD for the project.
These MicroMVDs are templates to be used as a starting point for projects to describe exchange requirements. It is encouraged to modify it to project requirements, delete irrelevant tests, and add new tests as required.
Packaging test suites for recipients
The author of the test suite will provide a folder named
features/. The contents of this folder will contain:
features/test-suite-A.feature # This is a test suite features/test-suite-B.feature # This is another test suite, you can have multiple features/environment.py # This defines the test environment features/template.html # This is the HTML report template features/steps/steps.py # The defines the test sentences
These files constitute the full test system, and must be shared in full to all recipients and all authors. This ensures full transparency of exchange requirements.
steps.py file requires basic programming knowledge to understand and modify, and is generally only modified by the test author. Recipients are free to inspect it to gain a better understanding of what constitutes test compliance.
environment.py file contains the environment settings to run the tests, using the Behave system. An intermediate knowledge of Behave and Python is required to modify this file. For most recipients, this file must be left alone.
template.html file contains a HTML report template. It is plain HTML code with Mustache for the templating language. A basic knowledge of HTML and Mustache is required to modify this file, which is self-explanatory.
Receiving and running test suites
A recipient will receive a
features/ directory. They are not required to modify the files in any way.
The cross-platform, free software BIMTester tool is capable of running the test suite and generating reports. The BIMTester tool expects the
features/ directory to be in the current working directory.
Recipients are encouraged to run the tests and generate reports at their convenience. The test author may optionally provide an automated platform which runs tests and generate downloadable reports, as well as track progress on test results.
Maintaining test suites
The test suite will be working document that will grow throughout the project lifecycle to ensure that data quality regressions are not made, and that the level of information which has been audited is clearly documented.
The test author will advise all recipients whenever new tests are being introduced or new test sentences are being defined.