aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api/apidoc/functest.core.rst1
-rw-r--r--docs/api/apidoc/functest.core.unit.rst7
-rw-r--r--docs/com/pres/framework/framework.md56
3 files changed, 64 insertions, 0 deletions
diff --git a/docs/api/apidoc/functest.core.rst b/docs/api/apidoc/functest.core.rst
index 27b2ed1fb..55c795be0 100644
--- a/docs/api/apidoc/functest.core.rst
+++ b/docs/api/apidoc/functest.core.rst
@@ -14,4 +14,5 @@ Submodules
functest.core.feature
functest.core.testcase
functest.core.vnf
+ functest.core.unit
diff --git a/docs/api/apidoc/functest.core.unit.rst b/docs/api/apidoc/functest.core.unit.rst
new file mode 100644
index 000000000..5dd6880ed
--- /dev/null
+++ b/docs/api/apidoc/functest.core.unit.rst
@@ -0,0 +1,7 @@
+functest.core.unit module
+=========================
+
+.. automodule:: functest.core.unit
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/com/pres/framework/framework.md b/docs/com/pres/framework/framework.md
index 3c1aae1b8..1b07a8e0b 100644
--- a/docs/com/pres/framework/framework.md
+++ b/docs/com/pres/framework/framework.md
@@ -252,6 +252,62 @@ run:
+## class Suite
+bases: TestCase
+
+base model for running unittest.TestSuite
+
+
+### run(**kwargs)
+
+- allows running any unittest.TestSuite
+- sets the following attributes required to push the results to DB:
+ - result
+ - start_time
+ - stop_time
+ - details
+
+
+
+## Your fourth test case
+
+
+### fourth.py
+
+```python
+#!/usr/bin/env python
+
+import unittest
+
+class TestStringMethods(unittest.TestCase):
+
+ def test_upper(self):
+ self.assertEqual('Hello World'.upper(),
+ 'HELLO WORLD')
+```
+
+
+### functest/ci/testcases.yaml
+
+```
+case_name: fourth
+project_name: functest
+criteria: 100
+blocking: true
+clean_flag: false
+description: ''
+dependencies:
+ installer: ''
+ scenario: ''
+run:
+ module: 'functest.core.unit'
+ class: 'Suite'
+ args:
+ name: 'fourth'
+```
+
+
+
## Euphrates