Update README.md Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/ac3c63cf Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/ac3c63cf Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/ac3c63cf
Branch: refs/heads/ignite-7777 Commit: ac3c63cfaa4026021cee8dd3f2f141e258ab9147 Parents: a7280b6 Author: alexey-nbl <[email protected]> Authored: Sat May 19 12:17:11 2018 +0300 Committer: GitHub <[email protected]> Committed: Sat May 19 12:17:11 2018 +0300 ---------------------------------------------------------------------- modules/platforms/nodejs/spec/README.md | 31 ++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/ac3c63cf/modules/platforms/nodejs/spec/README.md ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/spec/README.md b/modules/platforms/nodejs/spec/README.md index 02969a5..4b947c4 100644 --- a/modules/platforms/nodejs/spec/README.md +++ b/modules/platforms/nodejs/spec/README.md @@ -1,6 +1,9 @@ -# Test Instructions # +# Tests # -NodeJS Client for Apache Ignite contains [Jasmine](https://www.npmjs.com/package/jasmine) tests to check the behavior of the client. +NodeJS Client for Apache Ignite contains [Jasmine](https://www.npmjs.com/package/jasmine) tests to check the behavior of the client. the tests include: +- functional tests which cover all API methods of the client +- examples executors which run all examples except AuthTlsExample +- AuthTlsExample executor ## Tests Installation ## @@ -11,9 +14,29 @@ Follow the [instructions in the main readme](../README.md#installation). ## Tests Running ## -1. Run Apache Ignite server - locally or remotely. +1. Run Apache Ignite server locally or remotely with default configuration. 2. Set the environment variable: - **APACHE_IGNITE_CLIENT_ENDPOINTS** - comma separated list of Ignite node endpoints. - **APACHE_IGNITE_CLIENT_DEBUG** - (optional) if *true*, tests will display additional output (default: *false*). 3. Alternatively, instead of the environment variables setting, you can directly specify the values of the corresponding variables in [local_ignite_path/modules/platforms/nodejspec/config.js](./config.js) file. -4. Run the tests by calling `npm test` command from `local_ignite_path/modules/platforms/nodejs` folder. +4. Run the tests: + +### Run Functional Tests ### + +Call `npm test` command from `local_ignite_path/modules/platforms/nodejs` folder. + +### Run Examples Executors ### + +Call `npm run test:examples` command from `local_ignite_path/modules/platforms/nodejs` folder. + +### Run AuthTlsExample Executor ### + +It requires running Apache Ignite server with non-default configuration (authentication and TLS switched on). + +If the server runs locally: +- setup the server to accept TLS. During the setup use `keystore.jks` and `truststore.jks` certificates from `local_ignite_path/modules/platforms/nodejs/examples/certs/` folder. Password for the files: `123456` +- switch on the authentication on the server. Use the default username/password. + +If the server runs remotely, and/or other certificates are required, and/or non-default username/password is required - see this [instruction](../examples/README.md#additional-setup-for-authtlsexample). + +Call `npm run test:auth_example` command from `local_ignite_path/modules/platforms/nodejs` folder.
