You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/development.md
+15-3Lines changed: 15 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,26 @@
1
1
# Development guideline
2
2
These are some of the development guidelines and help to setup the library for development.
3
3
4
+
## Docker
5
+
A [Dockerfile](../Dockerfile) is provided and can be used for running test suites or any other command.
6
+
You can either build the image and run the needed commands manually or rather use any of the following npm scripts:
7
+
8
+
-`npm run docker:build` builds the docker image with the tag `asyncapi/modelina` (the rest of the scripts run this one as well).
9
+
-`npm run docker:test` runs the main test suite.
10
+
-`npm run docker:test:blackbox` runs the blackbox test suite.
11
+
4
12
## Environment setup
13
+
5
14
To setup the environment follow these steps:
6
15
1. Setup the project by first installing the dependencies `npm install`
7
-
1. Make sure the tests pass by running `npm run test` script
8
-
-[blackbox testing](#blackbox-testing) are excluded when running the `test` script because it require some extra setup.
9
-
1. Make sure code is well formatted and secure `npm run lint`
16
+
2. Make sure the tests pass by running `npm run test` script
17
+
-[blackbox testing](#blackbox-testing) are excluded when running the `test` script because it require some extra setup. Please refer to [Blackbox testing section](#blackbox-testing) below.
18
+
3. Make sure code is well formatted and secure `npm run lint`
10
19
11
20
## Blackbox testing
21
+
Please refer to [Docker section](#docker) above if you wanna run the tests directly in Docker without configuring anything extra on your machine.
22
+
If you prefer to install all the dependencies locally, keep reading.
23
+
12
24
The blackbox testing have some different requirements in order to successfully run:
13
25
- To to run the `java` blackbox tests, you need to have JDK installed.
14
26
- To to run the `ts` blackbox tests, you need to have TypeScript installed globally - `npm install -g typescript`.
0 commit comments