From 1d02282aa324ffe59e67369bf5f4bbabd16d2b2a Mon Sep 17 00:00:00 2001
From: morganrOL <morgan.richomme@orange.com>
Date: Tue, 7 Apr 2015 12:07:37 +0200
Subject: Functional test documentation

This document describes how to run functional tests on OPNFV platform
it shall include
- testcase description
- installation procedure
- automation procedure
- any recommendation for result analysis

JIRA: FUNCTEST-9

Change-Id: If2cce9cdf9bca2f8136a5ed904b36cd82ecebe7f
Signed-off-by: morganrOL <morgan.richomme@orange.com>
---
 functest.rst | 144 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 144 insertions(+)
 create mode 100644 functest.rst

diff --git a/functest.rst b/functest.rst
new file mode 100644
index 00000000..ecb9768a
--- /dev/null
+++ b/functest.rst
@@ -0,0 +1,144 @@
+===========================
+OPNFV functional test guide
+===========================
+
+The goal of this document consists in describing how to run functional tests on OPNFV solution and how to automate these tests.
+
+For release 1, several test cases have been selected:
+ * Rally Bench test suite
+ * Tempest tes suite
+ * OpenDaylight test suite
+ * vPing
+ * vIMS
+
+.. _prereqs:
+
+-------------
+Prerequisites
+-------------
+We assume that an OPNFV solution has been installed (System Under Test).
+For release 1, the tools needed for functional testing are not part of the installer and are not automatically installed.
+
+.. _pharos: https://wiki.opnfv.org/pharos
+
+It is recommended to install the tools on the jump host server as defined in the Pharos project.
+
+.. _installation:
+
+------------
+Installation
+------------
+
+Rally bench test suite
+======================
+
+Create or enter a folder where you want to check out the tool repos. Follow `Rally installation procedure`_.
+
+.. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
+
+
+Tempest
+=======
+
+It is possible to use Rally to perform Tempest tests. See `tempest installation guide using Rally`_.
+
+.. _`tempest installation guide using Rally`: https://www.mirantis.com/blog/rally-openstack-tempest-testing-made-simpler/
+
+OpenDaylight
+============
+
+vPing
+=====
+
+vIMS
+====
+
+
+.. _manualtest:
+
+--------------
+Manual testing
+--------------
+
+Rally
+=====
+Check your deployment::
+
+    # rally deployment check
+    keystone endpoints are valid and following service are available:
+    +-------------+-----------+------------+
+    | Services  | Type        | Status     |
+    +-----------+-------------+------------+
+    | cinder    | volume      | Available  |
+    | cinderv2  | volumev2    | Available  |
+    | glance    | image       | Available  |
+    | keystone  | identity    | Available  |
+    | neutron   | network     | Available  |
+    | nova      | compute     | Available  |
+    | nova_ec2  | compute_ec2 | Available  |
+    | novav3    | computev3   | Available  |
+    +-----------+-------------+------------+
+
+Create a new opnfv scenario directory and run test suite::
+
+    # cd ~/rally/samples/tasks/scenario/
+    # mkdir opnfv
+    # wget http://git.opnfv.org/.. <TODO>
+    # rally task start --abort-on-sla-failure ./opnfv.json
+
+Tempest
+=======
+
+If we consider running Tempest suite with Rally::
+
+    # rally verify start
+    # rally verify list
+
+
+
+
+OpenDaylight
+============
+
+vPing
+=====
+
+vIMS
+====
+
+
+.. _automatictest:
+
+------------------
+Testing Automation
+------------------
+
+Connection of your platform
+===========================
+If you want to add your platform to the community automation, you need to declare your machine as a Jenkins slave.
+ * Send a mail to OPNFV LF Helpdesk (opnfv-helpdesk@rt.linuxfoundation.org)
+ * Create a local user jenkins on your machine
+ * wget http://mirrors.jenkins-ci.org/war/1.599/jenkins.war
+ * Extract contents, find the file named slave.jar and copy it to somewhere which jenkins user created in first step can access.
+ * Create a directory /home/jenkins/opnfv_slave_root
+ * check the java version (>1.7.0_75)
+ * Contact Linux Foundation to manage authentication of your server
+ * A key/token will be produced. Establish connection towards OPNFV Jenkins by using below command: java -jar slave.jar -jnlpUrl https://build.opnfv.org/ci/computer/<slave_name>/slave-agent.jnlp -secret <token>
+
+Continuous integration scripts
+==============================
+
+.. _references:
+
+----------
+References
+----------
+
+OPNFV main site: opnfvmain_.
+
+OPNFV functional test page: opnfvfunctest_.
+
+IRC support chan: #opnfv-testperf
+
+.. _opnfvmain: http://www.opnfv.org
+.. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
-- 
cgit 

eading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */</style><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
<span class="nb">export</span> <span class="nv">LC_ALL</span><span class="o">=</span>C
<span class="nb">export</span> <span class="nv">OS_NO_CACHE</span><span class="o">=</span><span class="s1">&#39;true&#39;</span>
<span class="nb">export</span> <span class="nv">OS_TENANT_NAME</span><span class="o">=</span><span class="s1">&#39;admin&#39;</span>
<span class="nb">export</span> <span class="nv">OS_USERNAME</span><span class="o">=</span><span class="s1">&#39;admin&#39;</span>
<span class="nb">export</span> <span class="nv">OS_PASSWORD</span><span class="o">=</span><span class="s1">&#39;admin&#39;</span>
<span class="nb">export</span> <span class="nv">OS_AUTH_URL</span><span class="o">=</span><span class="s1">&#39;http://172.18.1.5:5000/v2.0&#39;</span>
<span class="nb">export</span> <span class="nv">OS_AUTH_STRATEGY</span><span class="o">=</span><span class="s1">&#39;keystone&#39;</span>
<span class="nb">export</span> <span class="nv">OS_REGION_NAME</span><span class="o">=</span><span class="s1">&#39;RegionOne&#39;</span>
<span class="nb">export</span> <span class="nv">CINDER_ENDPOINT_TYPE</span><span class="o">=</span><span class="s1">&#39;internalURL&#39;</span>
<span class="nb">export</span> <span class="nv">GLANCE_ENDPOINT_TYPE</span><span class="o">=</span><span class="s1">&#39;internalURL&#39;</span>
<span class="nb">export</span> <span class="nv">KEYSTONE_ENDPOINT_TYPE</span><span class="o">=</span><span class="s1">&#39;internalURL&#39;</span>
<span class="nb">export</span> <span class="nv">NOVA_ENDPOINT_TYPE</span><span class="o">=</span><span class="s1">&#39;internalURL&#39;</span>
<span class="nb">export</span> <span class="nv">NEUTRON_ENDPOINT_TYPE</span><span class="o">=</span><span class="s1">&#39;internalURL&#39;</span>
<span class="nb">export</span> <span class="nv">OS_ENDPOINT_TYPE</span><span class="o">=</span><span class="s1">&#39;internalURL&#39;</span>
<span class="nb">export</span> <span class="nv">MURANO_REPO_URL</span><span class="o">=</span><span class="s1">&#39;http://storage.apps.openstack.org/&#39;</span>
</pre></div>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div id="lfcollabprojects-footer">
  <div class="gray-diagonal">
    <div class="footer-inner">
      <p>
        &copy; 2015
        <a href="https://opnfv.org/">Open Platform for NFV Project, Inc</a>., a
        Linux Foundation Collaborative Project. All Rights Reserved.
      </p>
      <p>
        Open Platform for NFV and OPNFV are trademarks of the Open Platform for
        NFV Project, Inc.
      </p>
      <p>
        Linux Foundation is a registered trademark of The Linux Foundation.
        Linux is a registered
        <a
          href="http://www.linuxfoundation.org/programs/legal/trademark"
          title="Linux Mark Institute"
          >trademark</a
        >
        of Linus Torvalds.
      </p>
      <p>
        Please see our
        <a href="https://opnfv.org/about/bylaws-and-policies/terms-use"
          >terms of use</a
        >,
        <a href="https://opnfv.org/about/bylaws-and-policies/trademarks"
          >trademark policy</a
        >, and
        <a href="https://opnfv.org/about/bylaws-and-policies/privacy-policy"
          >privacy policy</a
        >.
      </p>
    </div>
  </div>
</div>
</div> <!-- id=cgit -->
</body>
</html>