#39 add basic behaviour tests

[bofalke]

Ref #39

[bofalke]

Took forever to get Cucumber working with typescript and our project structure but finally found some good guides and explanations on how to configure cucumber properly.

I installed https://github.com/timjroberts/cucumber-js-tsflow for the typescript integration, i hope that is fine

[bofalke]

I was finally able to add a first version of a test

When i run npm run test-scenarios i get the following issue:

Error: Cannot find module '@app/shared/commands/fleet-management/add-car-to-fleet'

I guess the AddCarToFleetSteps.ts is not properly loaded. Probably a small typescript configuration which is not as clear to me currently :D

Also this first attempt would only check if the command handler yields the correct event. Better approach would be to test a little bit more from the outside and check if the command will trigger and store an event in the "database".

[codeliner]

@bofalke I think the error is related to the fact that the namespace is not known within your script. Unfortunately, we have to use the helper package tsconfig-paths/register to tell TS about our namespaces defined in the root tsconfig.

Here you find the command the starts the backend server using ts-node: https://github.com/proophboard/cody-engine/blob/main/packages/be/nodemon.json#L5

As you can see, the helper is passed to ts-node so that the namespaces get registered. You have to do the same when executing cucumber.

[codeliner]

Also this first attempt would only check if the command handler yields the correct event. Better approach would be to test a little bit more from the outside and check if the command will trigger and store an event in the "database".

You should set the env variable NODE_ENV to test if this is not already done by cucumber (Jest does it by default).
Then you can create an environment.test.ts file in the environments folder

Set event store and document store adapter to "memory", so that the default case is triggered and you get back an in-memory event store and document store from the factory functions: getConfiguredEventStore and getConfiguredDocumentStore

Cody Engine will use them during test run and you can check streams and documents afterwards for events and state.

[bofalke]

@bofalke I think the error is related to the fact that the namespace is not known within your script. Unfortunately, we have to use the helper package tsconfig-paths/register to tell TS about our namespaces defined in the root tsconfig.

Here you find the command the starts the backend server using ts-node: https://github.com/proophboard/cody-engine/blob/main/packages/be/nodemon.json#L5

As you can see, the helper is passed to ts-node so that the namespaces get registered. You have to do the same when executing cucumber.

To be honest i was not able to figure this out... I added a tsconfig.json in the features folder that extends the one in the be folder. So shouldn't it be loaded? The example you provided seems to be related to nodemon and references a main.ts, how would that work with my example? I have the issue, that i just don't know exactly what i need to actually register, the features folder into the rest of the project or vice versa. If i just extend the cucumber script in the be/package.json to :

"scripts": {
    "cucumber": "npx ts-node -r tsconfig-paths/register src/main.ts cucumber-js -p default"
  }

I get the error:

/home/bfalke/projects/cody-engine/packages/be/src/extensions/get-external-service.ts:17
    throw new Error(`Service "${name}" is not registered in @extensions/be/services`);
          ^

[codeliner]

@bofalke That's not the same error as you got before, right? So I think the original error got solved :D
A not registered service might have to do with a recent change in Cody Engine. A default AuthService has been added to the system, which needs to be registered in packages/be/src/extensions/services.ts. See services.ts.cetmpl