BML Unit Tests (BMLT)

Overview

To support modular testing and development, CPQ Developer Toolkit introduces BML Unit Tests (BMLT) for Util and Commerce Libraries. Unit tests are similar to test scripts in the debugger and are written to ensure that BML code functions as intended.

Administration

BMLT functions return a Boolean result:

"true" for pass.
"false" for fail.

Unit Test Directories

BMLT Files

BML unit tests need two files, a ".bml" file and a "-meta.json" file. The BML file contains the unit test and the "-meta.json" files represent BML Editor options.

Util BML Sample Files

developerTools/bmlLibrary/_tests/testEmail/testEmail.bml

// inject a value into the system attributes
setattribute("_user_email", "ben.baker@oracle.com");

actual = util.getEmail();
 
expected = "ben.baker@oracle.com";
 
if(expected <> actual){
    print "Error: " + actual;
    return false;
}
 
print "Success: " + actual;
return true;

developertools/bmlLibrary/_tests/testEmail-meta.json

{
  "name" : "Test Email String",
  "variableName" : "testEmail",
  "description" : "will confirm that this returns a users email",
  "libraryFunctions" : [ "util.getEmail" ]
}

Commerce BMLT Sample Files

commerceAndDocuments/processDefinition/transaction_bmClone_2/quote/libraries/_tests/testQuoteNumber.bml

importtransactiondata(16274150);

expected = "Quote #48";

actual = commerce.quoteNumber();
 
if (actual <> expected) {
  print actual + " when " + expected + " was expected";
  return false;
}
 
print "Success! No asserts failed!";
return true;

commerceAndDocuments/processDefinition/transaction_bmClone_2/quote/libraries/_tests/testQuoteNumber-meta.json

{
  "name": "Test Quote Number",
  "variableName": "testQuoteNumber",
  "description": "Will make sure the quote number returns the correct string",
  "libraryFunctions": ["commerce.quoteNumber"]
}

Run BML Unit Tests

BMLT Functions

To write unit tests for Commerce Libraries, developers can use the following functions:

Import Transaction Data

importtransactiondata
Description	This function uses the BSID to load all buy-side transaction data into the BMLT.
Syntax	importtransactiondata(bsId)
Parameters	bsId	Integer	Use this parameter to specify the Commerce Transaction ID.

Set Attribute

setAttribute
Description	Unit Tests for Util functions with imported attributes are facilitated with the setAttribute() function
Syntax	setAttribute(attrVarName,attrValue)
Parameters	attrVarName	The variable name of the Commerce attribute, as a String Literal.
Parameters	attrValue	The value to be set, as the correct type for that attribute.

Note: setAttribute can only be used for Unit test functions.

Notes

If a test fails, it will not run any further operations, such as save and deploy.
If the result of a BML unit test is a null value, the BMLT will return a "false" value even though the unit test passed.
Unit Tests cannot be deleted from the server. Administrators can deprecate the unit test by deleting contents of the file.
The structure of a test function versus a standard util function is similar, with a few key exceptions:
- All test functions have a return type of Boolean.
- Test functions do not have parameters and do not allow importing attributes.

Limit the number of developers that can perform pull, save, or deploy commands directly to CPQ.
Use your source control system to manage a master version of the site contents.
Push specs should only include BML Library functions that the developer is currently working on.
At a given time, only one developer should be working on a specific BML function or test.