Merge "Get auth token when checking deployment"

[functest-xtesting.git] / docs / com / pres / framework / framework.md

diff --git a/docs/com/pres/framework/framework.md b/docs/com/pres/framework/framework.md
index 1b07a8e..109d8a0 100644 (file)
--- a/docs/com/pres/framework/framework.md
+++ b/docs/com/pres/framework/framework.md
@@ -2,7 +2,7 @@
 
 created by [Cédric Ollivier](mailto:cedric.ollivier@orange.com)
 
-2017/05/06
+2017/06/05
 
 Note:
 
@@ -59,12 +59,13 @@ base model for single test case
 
 ### methods
 
-| Method            | Purpose                                    |
-|-------------------|--------------------------------------------|
-| run(**kwargs)     | run the test case                          |
-| is_successful()   | interpret the results of the test case     |
-| get_duration()    | return the duration of the test case       |
-| push_to_db()      | push the results of the test case to the DB|
+| Method            | Purpose                      |
+|-------------------|------------------------------|
+| run(**kwargs)     | run the test case            |
+| is_successful()   | interpret the results        |
+| get_duration()    | return the duration          |
+| push_to_db()      | push the results to the DB   |
+| clean()           | clean the resources          |
 
 
 ### run(**kwargs)
@@ -136,7 +137,6 @@ case_name: first
 project_name: functest
 criteria: 100
 blocking: true
-clean_flag: false
 description: ''
 dependencies:
     installer: ''
@@ -204,7 +204,6 @@ case_name: second
 project_name: functest
 criteria: 100
 blocking: true
-clean_flag: false
 description: ''
 dependencies:
     installer: ''
@@ -238,7 +237,6 @@ case_name: third
 project_name: functest
 criteria: 100
 blocking: true
-clean_flag: false
 description: ''
 dependencies:
     installer: ''
@@ -294,7 +292,6 @@ case_name: fourth
 project_name: functest
 criteria: 100
 blocking: true
-clean_flag: false
 description: ''
 dependencies:
     installer: ''
@@ -308,16 +305,102 @@ run:
 
 
 
-## Euphrates
+## class VNF
+bases: TestCase
+
+base model for VNF onboarding testing
+
+
+### methods
+
+| Method                | Purpose                                           |
+|-----------------------|---------------------------------------------------|
+| prepare()             | prepare VNF env (user, tenant, security group,..) |
+| run(**kwargs)         | run VNF test case                                 |
+| deploy_orchestrator() | deploy cloudify, ONAP, OpenBaton,... (optional)   |
+| deploy_vnf()          | deploy the VNF                                    |
+| test_vnf()            | run tests on the VNF                              |
+
+
+### run(**kwargs)
+
+- deploys an orchestrator if needed (e.g. heat, OpenBaton, Cloudify, ONAP, Juju)
+- deploys the VNF
+- performs tests on the VNF
+
+
+### prepare()
+
+- creates a user
+- creates a Tenant/Project
+- allocates admin role to the user on this tenant
+
+
+### deploy_orchestrator()
+
+- deploys an orchestrator (optional)
+- if this function is overridden then raise orchestratorDeploymentException if error during orchestrator deployment
+
+
+### deploy_vnf()
+
+- **MUST be implemented** by vnf test cases. The details section MAY be updated in the vnf test cases.
+- The deployment can be executed via a specific orchestrator or using build-in orchestrators such as heat, openbaton, cloudify, juju, ONAP, ...
+- returns:
+  True if the VNF is properly deployed
+  False if the VNF is not deployed
+- raises VnfDeploymentException if error during VNF deployment
+
+
+### test_vnf()
+
+- **MUST be implemented** by vnf test cases. The details section MAY be updated in the vnf test cases.
+- Once a VNF is deployed, it is assumed that specific test suite can be run to validate the VNF.
+- returns:
+  True if VNF tests are PASS
+  False if test suite is FAIL
+- raises VnfTestException if error during VNF tests
+
+
 
+## Your fifth test case
 
-### Next actions
 
-- __to finish VNF abstraction (coverage + pylint)__
-- to publish doc API
-- to manage criteria as written in testcases.yaml
+### fifth.py
 
-Please see [Functest Euphrates page](https://wiki.opnfv.org/display/functest/Functest+Euphrates+page) for more details
+```python
+#!/usr/bin/env python
+
+from functest.core import vnf
+
+class Vnf(vnf.VnfOnBoarding):
+
+    def deploy_vnf(self):
+        print "Deploy your VNF here"
+        print "Feed orchestrator with VNF descriptor"
+        return 0
+
+    def test_vnf(self):
+        print "Test your VNF here"
+        return 0
+```
+
+
+### functest/ci/testcases.yaml
+
+```yaml
+case_name: fifth
+project_name: functest
+criteria: 100
+blocking: true
+description: ''
+dependencies:
+    installer: ''
+    scenario: ''
+run:
+    module: 'fifth'
+    class: 'Vnf'
+```