insomnia/packages/insomnia-smoke-test/CLI.md
Jack Kavanagh 87953708ab
git sync ux add->authenticate (#6260)
* add->authenticate

* update doc

* fix test
2023-08-11 11:54:39 +00:00

83 lines
2.2 KiB
Markdown

# CLI
## install node version of libcurl
npm install will download the electron version of libcurl but for inso we need the node version
```shell
node_modules/.bin/node-pre-gyp install --update-binary --directory node_modules/@getinsomnia/node-libcurl
```
to download the electron version of node-libcurl you should remove the module and npm install again
```shell
rm -rf node_modules/@getinsomnia/
npm install
```
## Run CLI Smoke Tests
```shell
# Package the Inso CLI binaries
npm run inso-package
# Run CLI tests
npm run test:smoke:cli
```
## Debugging CLI tests using watcher
This is helpful for debugging failing api tests and changing the send-request abstraction
From project root, in separate terminals:
```sh
# start smoke test api
npm run serve --prefix packages/insomnia-smoke-test
# build send-request
npm run build:sr --prefix packages/insomnia
# watch inso
npm run start --prefix packages/insomnia-inso
# run api test with dev bundle
$PWD/packages/insomnia-inso/bin/inso run test "Echo Test Suite" --src $PWD/packages/insomnia-smoke-test/fixtures/inso-nedb --env Dev --verbose
```
## How to debug pkg
```sh
# run modify package command and then a unit test
npm run package --prefix packages/insomnia-inso && \
$PWD/packages/insomnia-inso/binaries/inso run test "Echo Test Suite" --src $PWD/packages/insomnia-smoke-test/fixtures/inso-nedb --env Dev --verbose
```
## How to update the `inso-nedb` fixtures
Run Insomnia with `INSOMNIA_DATA_PATH` environment variable set to `fixtures/inso-nedb`, e.g.:
```bash
INSOMNIA_DATA_PATH=packages/insomnia-smoke-test/fixtures/inso-nedb /Applications/Insomnia.app/Contents/MacOS/Insomnia
```
Relaunch the app one more time, so that Insomnia compacts the database.
The `.gitignore` file will explicitly ignore certain database files, to keep the directory size down and avoid prevent sensitive data leaks.
## How to run inso with the `inso-nedb` fixture locally?
Set the `--src` argument pointed to `packages/insomnia-smoke-test/fixtures/inso-nedb`:
```bash
# if installed globally
inso --src <INSO_NEDB_PATH>
# using the package bin
./packages/insomnia-inso/bin/inso --src <INSO_NEDB_PATH>
# using a binary
./packages/insomnia-inso/binaries/insomnia-inso --src <INSO_NEDB_PATH>
```