[Coldbox 5.6.2] Testing HMVC REST APIs

Communities ColdBox HMVC
1

I am hitting a seemingly basic issue while testing an API in two ways: one directly via URL, the other by calling the corresponding event. Here are the two tests (results are attached):

scenario( “I request a list of all carriers”, function(){
given( “A call to the /api/v1/carriers route”, function(){
then( “I should get all carriers in the system”, function(){
var e = execute( event=“api.v1.carriers.index”, renderResults = true );
var response = getRequestContext().getPrivateValue( “response” );
expect( e.getRenderedContent() ).toBeJSON();
expect( response.getError() ).toBeFalse( “Error in call” );
expect( response.getStatusCode() ).toBe( 200 );
});
});

// Another way to test (via the URL)

it( “index - get all carriers”, function(){
var cfhttpResponse = “”;
http url=“http://127.0.0.1:50427/api/v1/carriers” result=“cfhttpResponse”;
expect( cfhttpResponse.statusCode ).toBe(200);
});

});

The test using the URL passes while the scenario based test fails with the error: “event: api.v1.carriers.index is not a valid registered event”.
The locations of my files follow the default implementation of the REST HMVC template (see Directory Structure). Any suggestion?

Directory structure.png
Directory structure.png3360×2100 1.14 MB

Test results.png
Test results.png3360×2100 1.01 MB

2

Because “api” is a module, you need to use a colon (:slight_smile: instead of a dot (.)
Try this var e = execute( event=“api:v1.carriers.index”, renderResults = true );

II

3

Wow, thanks a lot for the pointer! In fact, here is the answer that works now:

var e = execute( event=“v1:carriers.index”, renderResults = true );

v1 is the module.