Basic set up

[ThaFishDance]

I'm new to open source and want to contribute to this project. How can I get this project set up for local development and testing?

[dnalborczyk]

this should give you a good start: https://github.com/dherault/serverless-offline/blob/master/CONTRIBUTING.md

those docs have been updated recently and might have some missing or wrong pieces. please file an issue if you run into any issues.

[rion18]

Hi @dnalborczyk ! I was wondering this miyself. I can install the dependencies using npm ci.
Immediately running npm run test:unit results in a jest: not found error... After installing jest, trying to run npm run test:unit results in this:

Error: Can't find a root directory while resolving a config file path.
Provided path to resolve: jest.config.units.js

The script in package.json is defined as "test:unit": "jest --verbose --silent --runInBand --config jest.config.units.js". Shouldn't this file be included in the repo?

[rion18]

For context, I'm trying to fix #1311, (which in turn will fix more issues). I've tried this locally, and it works, but I can't do any tests on my fork.

[dnalborczyk]

@rion18 thank you for having a look at the issue! a lot of the npm scripts in the package.json are from a previous iteration when serverless-offline used jest. we switched to mocha from v9 onwards, because of some issues with esm. you can just run npm test, which runs all tests (unit and integration). I renamed the jest related scripts to old- in the meanwhile. I try to see if I can find out their initial intend and apply that to a mocha script or remove the script.

[rion18]

Ok... That's what I initially suspected. However, there's something missing (either on my setup, or somewhere else). When I run npm test,
I can see SOME integration tests running. For instance, /tests/integration/authorizer effectively runs. However, /tests/integration/jwt-authorizer does NOT. Is there something I'm missing?

[rion18]

Any ideas @dnalborczyk ?

[dnalborczyk]

they should both run. there's some tests which only run when certain tools are available (e.g. docker, python, ruby etc.), but those 2 tests you mentioned don't have a condition. do you mean the jwt tests fail, or are they skipped?

what operating system/cpu are you running? we run the ci on macos, linux and windows.

[rion18]

You're absolutely right. It did run after a long time, I just wasn't paying close attention. 😓