1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146# Insomnia Smoke Tests
[](https://github.com/microsoft/playwright)
This project contains the smoke testing suite for Insomnia App.
> To find more about Inso CLI smoke tests, check [this document](CLI.md).
- [Insomnia Smoke Tests](#insomnia-smoke-tests)
- [Quick-start](#quick-start)
- [Debugging and Developing Tests locally](#debugging-and-developing-tests-locally)
- [Playwright VS Code extension](#playwright-vs-code-extension)
- [Playwright Inspector](#playwright-inspector)
- [Playwright Trace viewer](#playwright-trace-viewer)
- [Additional Log levels](#additional-log-levels)
- [Reproducing CI Failures](#reproducing-ci-failures)
- [Getting traces from CI](#getting-traces-from-ci)
- [Build and package methods](#build-and-package-methods)
- [Non recurring tests](#non-recurring-tests)
## Quick-start
Prerequisites:
- Clone the project
- Run `npm install`
To run all tests:
- In one terminal run: `npm run watch:app`
- In another terminal run: `npm run test:smoke:dev`
To run single tests:
- Filter by the file or test title, e.g. `npm run test:smoke:dev -- oauth`
## Debugging and Developing Tests locally
### Playwright VS Code extension
In order to run/debug tests directly from VS Code:
- Install the [Playwright extension](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright).
- With the extension installed, run on terminal `npm run watch:app`.
You can trigger tests from the `Testing` tab, or within the test files clicking the run button.
If no tests appear, you may need to run "Refresh playwright tests". This can be done from the command palette, or by using the button at the top of the `Testing` tab.
### Playwright Inspector
You can step through tests with playwright inspector: `PWDEBUG=1 npm run test:smoke:dev`
This is also useful to help create new tests.
### Playwright Trace viewer
We generate [Playwright Traces](https://playwright.dev/docs/trace-viewer) when tests run. These can be used to debug local and CI test failures.
To open a local trace viewer for a given test output, run:
```shell
# Example:
npx playwright show-trace packages/insomnia-smoke-test/traces/app-can-send-requests/trace.zip
```
Alternatively you can upload this trace to [trace.playwright.dev](https://trace.playwright.dev/).
### Additional Log levels
You can enable additional logging to help you debug tests:
- Playwright logs: `DEBUG=pw:api npm run test:smoke:dev`
- Insomnia console logs: `DEBUG=pw:browser npm run test:smoke:dev`
- WebServer console logs: `DEBUG=pw:WebServer npm run test:smoke:dev`
## Reproducing CI Failures
### Getting traces from CI
Traces from CI execution can be found in the failed CI job's artifacts.
After downloading the artifacts, these can be extracted and loaded up into the [Trace viewer](#playwright-trace-viewer).
### Build and package methods
It's possible to run the smoke tests for:
- A `build`, the JS bundle that is loaded into an electron client
- A `package`, the executable binary (e.g. `.dmg` or `.exe`)
For `build`:
```shell
# Transpile js bundle
npm run app-build
# Run tests
npm run test:smoke:build
```
For `package`:
```shell
# Build executable in /packages/insomnia/dist
npm run app-package
# Run tests
npm run test:smoke:package
```
> Note: for local testing of the packaged app on macOS you need to change the entitlements temporarily to allow unsigned apps to run. You can do this by changing the `com.apple.security.cs.disable-library-validation` key in `entitlements.mac.inherit.plist` file to
> to ` <key>com.apple.security.cs.disable-library-validation</key>
<false/>`
Each of the above commands will automatically run the Express server, so you do not need to take any extra steps.
### Non recurring tests
Non recurring / non-CI tests, like pre-release ones, can be run using [Playwright VS Code extension](#playwright-vs-code-extension) or by running `test:dev` against the desired test file:
```shell
npm run test:dev -w packages/insomnia-smoke-test -- preferences-interactions
```
### Refresh certs
The certs might need to be replaced after 2026 to fix the custom ca cert test
```sh
mkcert -install
mkcert localhost
mkcert -CAROOT
```