Right way to test Serverless Plugins?

[ubaniabalogun]

Hi there, what's the right way to test a serverless plugin?
So far, I've written a plugin and have unit-tests for my business logic. However, I'm unsure how to write tests to ensure that my plugin behaves correctly when called as part of Serverless frameworks lifecycle.

I stumbled on the runServerless util. Should framework plugins be using this utility as well? Or is it purely for testing Serverless framework internals? If it is purely internal, is there an alternative that plugin developers should use
Thanks,

[medikoo]

I stumbled on the runServerless util. Should framework plugins be using this utility as well? Or is it purely for testing Serverless framework internals? If it is purely internal, is there an alternative that plugin developers should use
Thanks,

I'd highly recommend using runServerless util to test plugins, as it tests against full cycle, and it's the only reliable way to confirm all works as expected.

I believe it can be relatively easily used to test plugins, but please ask if you stumble on any issues

[medikoo]

@ubaniabalogun ensure to install @serverless/test in your project

[medikoo]

Sorry, wrong answer. Documentation was not updated after async-leaks-detector hook was removed. I've just updated documentation, to provide an up to date setup version.

[ubaniabalogun]

Thanks for the update @medikoo. I'm hitting a different bug now, which I take as a sign of progress 😄

Here's the new bug I'm hitting

Provided 'serverlessPath' (/private/var/folders/t6/dwgv3yfs25x69rd9nvrfplrh0000gn/T/tmpdirs-serverless/9436/838673/test/mock-service) doesn't point a working node module: Cannot find module '/private/var/folders/t6/dwgv3yfs25x69rd9nvrfplrh0000gn/T/tmpdirs-serverless/9436/838673/test/mock-service'
Require stack:
- /Users/ubalogun/Projects/socless_repos/sls-apb/node_modules/@serverless/test/run-serverless.js
- /Users/ubalogun/Projects/socless_repos/sls-apb/test/test_slsApb.js
- /Users/ubalogun/Projects/socless_repos/sls-apb/node_modules/mocha/lib/esm-utils.js
- /Users/ubalogun/Projects/socless_repos/sls-apb/node_modules/mocha/lib/mocha.js
- /Users/ubalogun/Projects/socless_repos/sls-apb/node_modules/mocha/lib/cli/one-and-dones.js
- /Users/ubalogun/Projects/socless_repos/sls-apb/node_modules/mocha/lib/cli/options.js
- /Users/ubalogun/Projects/socless_repos/sls-apb/node_modules/mocha/bin/mocha

I think part of why I'm hitting this bug is that i'm unclear what the serverlessDir value should be set to for runServerless.
Any chance you can give me a minimal example of runServerless being used in a simple 3rd party plugin please?

[medikoo]

@ubaniabalogun please check the docs: https://github.com/serverless/test/blob/master/docs/run-serverless.md#usage

serverlessDir should point a path to Serverless Framework directory which we want to run test against.

You can also inspect a bit more advanced runServerless setup (with fixtures engine) which is done in context of dashboard plugin -> https://github.com/serverless/dashboard-plugin/blob/2c8c599f815b2d12b3323f9f23c2f34f3b267e7b/test/run-serverless.js

[ubaniabalogun]

Thanks so very much for your responses @medikoo! I was finally able to get it working!