How to write my own engine? Docs?

Hi i found the repository “https://github.com/shoreditch-ops/artillery-engine-kinesis” which seems to solve exactly what i need - writing my own engine… I did it already by forking the whole artillery repository and got it running, but it feels as a total overkill to fork the whole thing just to introduce a new engine.

But when i see code like this:

      let runnerEngines = _.map(
      Object.assign({}, Engines, runnableScript.config.engines),
      function loadEngine(engineConfig, engineName) {
        let moduleName = 'artillery-engine-' + engineName;
        try {
          if (Engines[engineName]) {
            moduleName = './engine_' + engineName;
          }
          let Engine = require(moduleName);
     ....

-> the runner code is hardcoded looking into his own folder relatively with all the entries of “Engines”… i don’t see how this should be dynamically able to pick up some new written engines at all oO

So… how should this work?

[kraenhansen]

Another way to do this is to create a package that has a dependency on both artillery and your custom engine (could be installed from ./artillery-engine-custom), this way artillery core will be able to require in your custom engine correctly.

In your root project folder:

my-script.yml

An artillery script using your custom engine.

package.json

{
  "name": "my-load-tests",
  "version": "0.1.0",
  "scripts": {
    "test": "artillery run ./my-script.yml"
  },
  "dependencies": {
    "artillery": "^1.6.0-27",
    "artillery-engine-realm": "file:artillery-engine-custom"
  }
}

A directory called artillery-engine-custom

This should be a module named “artillery-engine-custom” which main script should export an engine.

[hassy]

Ah sorry, the engine needs to be specified in config.engines like this:

config:
  target: localhost
  phases:
    - duration: 10
      arrivalRate: 1
      name: "Test Phase"
  engines:
    rsocket: {}

I was able to run your script + engine after adding that bit to the config. Let me know if you run into any other issues!