Upload the contribution of vstf as bottleneck network framework.

[bottlenecks.git] / vstf / vstf / controller / reporters / README

diff --git a/vstf/vstf/controller/reporters/README b/vstf/vstf/controller/reporters/README
new file mode 100755 (executable)
index 0000000..1ed6536
--- /dev/null
+++ b/vstf/vstf/controller/reporters/README
@@ -0,0 +1,109 @@
+Tree
+
+├── __init__.py
+├── mail
+│   ├── __init__.py
+│   ├── mail.py
+│   └── sendmail.py
+├── report
+│   ├── data_factory.py
+│   ├── html
+│   │   ├── html_base.py
+│   │   ├── htmlcreater.py
+│   │   ├── html_text.py
+│   │   └── __init__.py
+│   ├── __init__.py
+│   ├── pdf
+│   │   ├── element.py
+│   │   ├── __init__.py
+│   │   ├── pdfcreater.py
+│   │   ├── pdftemplate.py
+│   │   ├── story.py
+│   │   └── styles.py
+│   └── provider
+│       ├── html_provider.py
+│       └── __init__.py
+└── reporter.py
+
+
+Entry:
+    reporter.py
+
+    usage: reporter.py [-h] [-rpath RPATH] [-mail_off] [--taskid TASKID]
+
+    optional arguments:
+        -h, --help       show this help message and exit
+        -rpath RPATH     the path name of test results
+        -mail_off        is need send mail the for the report
+        --taskid TASKID  report depand of a history task id.
+
+Settings:
+    mail_settings
+
+        {
+            "server":
+            {
+                "host": "localhost",
+                "username": null,
+                "password": null
+            },
+            "body":
+            {
+                "from": ["vstf_from@vstf.com"],
+                "to": ["vstf_to@vstf.com"],
+                "cc": ["vstf_cc@vstf.com"],
+                "bcc": ["vstf_bcc@vstf.com"],
+                "subject": "Elastic Virtual Switching Performance Test Report"
+            }
+        }
+
+    html_settings
+
+        {
+            "style":{
+                "table":{
+                    "font-family":"\"Trebuchet MS\", Arial, Helvetica, sans-serif",
+                    "border":"1px solid green",
+                    "border-collapse":"collapse",
+                    "padding":"8px",
+                    "text-align":"center"
+                },
+                "td":{
+                    "border":"1px solid green",
+                    "padding":"8px",
+                    "word-wrap":"break-all"
+                },
+                "th":{
+                    "background-color":"#EAF2D3",
+                    "border":"1px solid green",
+                    "padding":"8px"
+                }
+            }
+        }
+
+    data_settings
+
+        {
+            "ovs":{
+                "content":{
+                    "version":3.0
+                },
+                "title":"Ovs info"
+            },
+            "result":{
+                "content":{},
+                "title":"Performance Result"
+            },
+            "subject":"ATF Performance Test Tnv Model"
+        }
+Module:
+    mail
+    html
+    pdf
+
+
+Others:
+     pip processes the package "reportlab"
+
+     pip install reportlab
+