Difference between revisions of "MicroMVDs for exchange requirements"
m (Moult moved page Using BIMTester for exchange requirements to Using MicroMVDs for exchange requirements without leaving a redirect) |
|||
Line 17: | Line 17: | ||
An example of the content of a single <code>*.feature</code> file is shown below. Each <code>*.feature</code> file represents a test suite and must follow the format below. | An example of the content of a single <code>*.feature</code> file is shown below. Each <code>*.feature</code> file represents a test suite and must follow the format below. | ||
− | <pre>Feature: | + | <pre>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 | ||
</pre> | </pre> | ||
− | A feature file always starts by defining the name of the <code>Feature | + | A feature file always starts by defining the name of the <code>Feature</code>. It is then followed by one or more <code>Scenario</code> 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 <code>Feature: </code> and <code>Scenario: </code> respectively. The test sentences within each <code>Scenario</code> 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 == | == Packaging test suites for recipients == |
Revision as of 23:59, 20 July 2020
To guarantee the consistent and correct delivery of BIM data, exchange requirements and quality checks can be converted into computer-automated tests to check that data is entered, appropriately formatted, and that important semantic relationships between BIM entities exist. A test is a single sentence that a computer can use to automatically validate data.
For example, if an exchange requirement is to provide an IFC4 file, it may be written as the file should be an IFC4 file
. An automated test running system will read this sentence, and verify that the requirement has been met. This automated test can be run on Windows, Mac, Linux, or any BIM server. A report will be automatically generated for stakeholders to review.
Three things are required to apply this testing workflow:
- BIM data in OpenBIM format, usually supplied by a BIM author
- A list of exchange requirement tests, taken from the List of MicroMVDs, or custom-built by a software developer
- A test execution program, such as BIMTester
Unlike other testing solutions like Solibri, MicroMVDs are non-proprietary, do not expire, are free, much lighter, are easy to change and develop, and are cross-platform.
Authoring test suites
Each test suite is composed of one or more plain text files, given the file extension of .feature
. It can be edited in any text editor, such as Vim, Apple TextEdit, or Microsoft Notepad. The file name is arbitrary, but may be used to describe what it is testing.
An example of the content of a single *.feature
file is shown below. Each *.feature
file represents a test suite and must follow the format 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
. It is then followed by 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 Feature:
and 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.
The 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.
The 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.
The 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.