Adjusted the docs structure according to directives
[promise.git] / docs / installationprocedure / feature.configuration.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 Manual testing
5 ==============
6
7 Promise installation
8 --------------------
9
10 Install nodejs, npm and promise
11
12 .. code-block:: bash
13
14     curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
15     sudo apt-get install -y nodejs
16     sudo npm -g install npm@latest
17     git clone https://github.com/opnfv/promise.git
18     cd promise
19     npm install
20
21 Please note that the last command 'npm install' will install all needed dependencies
22 for promise (including yangforge and mocha)
23
24 .. figure:: images/screenshot_promise_install.png
25    :name: figure1
26       :width: 90%
27
28
29 Validation
30 ----------
31 Please perform the following preparation steps:
32
33 1. Set OpenStack environment parameters properly (e.g. source openrc admin demo
34    in DevStack)
35 2. Create OpenStack tenant (e.g. promise) and tenant user (e.g. promiser)
36 3. Create a flavor in Nova with 1 vCPU and 512 MB RAM
37 4. Create a private network, subnet and router in Neutron
38 5. Create an image in Glance
39
40 Once done, the promise test script can be invoked as follows (as a single line
41 command):
42
43 .. code-block:: bash
44
45    NODE_ENV=mytest \
46    OS_TENANT_NAME=promise \
47    OS_USERNAME=promiser \
48    OS_PASSWORD=<user password from Step 2> \
49    OS_TEST_FLAVOR=<flavor ID from Step 3> \
50    OS_TEST_NETWORK=<network ID from Step 4> \
51    OS_TEST_IMAGE=<image ID from Step 5> \
52    npm run -s test -- --reporter json > promise-results.json
53
54 The results of the tests will be stored in the promise-results.json file.
55
56 The results can also be seen in the console ("npm run -s test")
57
58 .. figure:: images/screenshot_promise.png
59    :name: figure2
60    :width: 90%
61
62 All 33 tests passing?!
63 Congratulations, promise has been successfully installed and configured.