.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0

Promise installation
====================

Install nodejs, npm and promise

.. code-block:: bash

    curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
    sudo apt-get install -y nodejs
    sudo npm -g install npm@latest
    git clone https://gerrit.opnfv.org/gerrit/promise
    cd promise/source
    npm install
    npm ls

Please note that the last command 'npm ls' will list all needed dependencies
for promise (including yangforge and mocha)

.. figure:: images/screenshot_promise_install.png
   :name: figure1
      :width: 90%


Validation
==========
Please perform the following preparation steps:

1. Set OpenStack environment parameters properly (e.g. source openrc admin demo
   in DevStack)
2. Create OpenStack project (e.g. promise) and user (e.g. myuser) in e.g. the
   default domain
3. Create a flavor in Nova with 1 vCPU and 512 MB RAM
4. Create a private network, subnet and router in Neutron
5. Create an image in Glance

Once done, the promise test script can be invoked as follows:

.. code-block:: bash

   export OS_PROJECT_NAME=promise
   export OS_TENANT_NAME=promise
   export OS_PROJECT_DOMAIN_NAME=Default
   export OS_USERNAME=myuser
   export OS_USER_DOMAIN_NAME=Default
   export OS_PASSWORD=<user password from Step 2>
   export OS_TEST_FLAVOR=<flavor ID from Step 3>
   export OS_TEST_NETWORK=<network ID from Step 4>
   export OS_TEST_IMAGE=<image ID from Step 5>
   npm run -s test -- --reporter json > promise-results.json

The results of the tests will be stored in the promise-results.json file.

The results can also be seen in the console ("npm run -s test")

.. figure:: images/screenshot_promise.png
   :name: figure2
   :width: 90%

All 33 tests passing?!
Congratulations, Promise has been successfully installed and configured.