As we start to integrate more and more inputs, we must test actual and real inputs from users to ensure the library behaves as expected. For now, the best way is to add them as BlackBox tests. The BlackBox tests are focused on catching syntax errors and not logical errors, although they can be manually used for this.
The documents being tested can be found under docs, which contain documents for the following input types:
- AsyncAPI 2.0
- AsyncAPI 2.1
- AsyncAPI 2.2
- AsyncAPI 2.3
- AsyncAPI 2.4
- AsyncAPI 2.5
- AsyncAPI 2.6
- JSON Schema draft 4
- JSON Schema draft 6
- JSON Schema draft 7
- Swagger 2.0
- OpenAPI 3.0
Each document is tested across all output languages and output will be written to ./output folder in appropriate sub-folders, for easier access.
The tests can either be run by installing all dependencies locally or running it through docker.
If you want to run the BlackBox tests locally, you have to install a couple of dependencies:
- To run the
JavaBlackBox tests, you need to have JDK installed. - To run the
TypeScriptBlackBox tests, you need to have TypeScript installed globally -npm install -g typescript. - To run the
C#BlackBox tests, you need to have C# compiler installed globally. - https://www.mono-project.com/download/stable/ - To run the
GoBlackBox tests, you need to have GoLang installed - https://golang.org/doc/install - To run the
PythonBlackBox tests, you need to have python installed - https://www.python.org/downloads/ - To run the
PHPBlackBox tests, you need to have PHP installed - https://www.php.net/downloads.php/ - To run the
RustBlackBox tests, you need to have rust installed - https://www.rust-lang.org/tools/install (if you are on mac you might also need to install xcodexcode-select --install) - To run the
KotlinBlackBox tests, you need to have a JDK >= 8 as well as kotlinc installed - https://kotlinlang.org/docs/command-line.html - To run the
C++BlackBox tests, you need to have a GNU C++ compiler installed - https://gcc.gnu.org/install/
By default, the BlackBox tests are not run with the regular npm run test, but can be run with npm run test:blackbox. Or run individual BlackBox tests you can run the commands npm run test:blackbox:${language} where language is one of csharp, go, java, javascript, python, php, rust, typescript, etc.
To run the BlackBox tests through Docker, run the command npm run docker:test:blackbox.