Add BreakingPoint RESTv2 Python Wraper library and samples. (supported from BreakingPoint Release 9.0 Update2 +)

Author: nutu

MANIFEST.in

@@ -0,0 +1,8 @@
+include LICENSE
+include README.md
+include RELEASENOTES.md
+include setup.py
+include version.txt
+recursive-include ixnetwork_restpy *.py
+recursive-exclude ixnetwork_restpy/docs *.*
+recursive-exclude ixnetwork_restpy/pytest_tests *.*

README.md

@@ -1 +1,139 @@
-# bps_restpy
+## The IxNetwork Python Client 
+[![pypi](https://img.shields.io/pypi/v/breakingpoint-restpy.svg)](https://pypi.org/project/breakingpoint-restpy)
+[![python](https://img.shields.io/pypi/pyversions/breakingpoint-restpy.svg)](https://pypi.python.org/pypi/breakingpoint-restpy)
+[![license](https://img.shields.io/badge/license-MIT-green.svg)](https://en.wikipedia.org/wiki/MIT_License)
+[![downloads](https://pepy.tech/badge/breakingpoint-restpy)](https://pepy.tech/project/breakingpoint-restpy)
+
+## Install the package
+```
+pip install --upgrade breakingpoint-restpy
+```
+
+## Start scripting
+```python
+"""This script demonstrates how to get started with bps_restpy scripting.
+
+# Title:  Python Script Sample To Run a Canned Test.
+# Actions:
+#   1. Login to BPS box
+#   2. Reserve ports
+#   3. Load a test from the box and start the run
+#   4. Wait for the test to finish
+#   5. Get test result
+#   6. Get and print the Synopsis page from report
+#   7. Unreserve ports
+#   8. Logout
+
+
+#================
+
+########################################
+import time, sys, os
+# Import corresponding BPS RESTv2 python2.7/ 3 library from outside the folder with samples.
+sys.path.insert(1, os.path.dirname(os.getcwd()))
+if sys.version_info[0] >= 3:
+    from bps_restpy.bps_restpy import BPS, pp
+else:
+	from bps_restpy.bps_restpy3 import BPS, pp
+
+########################################
+
+
+########################################
+# Demo script global variables
+########################################
+# Demo script global variables
+canned_test_name = 'AppSim'
+#bps system info
+bps_system  = '<BPS_BOX_IP/HOSTNAME>'
+bpsuser     = 'bps user'
+bpspass     = 'bps pass'
+
+
+slot_number = 2
+port_list   = [0, 1]
+
+########################################
+
+
+########################################
+# Login to BPS box
+bps = BPS(bps_system, bpsuser, bpspass)
+bps.login()
+
+
+########################################
+print("Load a canned test: ")
+bps.testmodel.load(canned_test_name)
+
+########################################
+print("Reserve Ports")
+for p in port_list:
+    bps.topology.reserve([{'slot': slot_number, 'port': p, 'group': 2}])
+
+
+########################################
+print("Run test and Get Stats:")
+test_id_json = bps.testmodel.run(modelname=canned_test_name, group=2)
+testid = str( test_id_json["runid"] )
+run_id = 'TEST-' + testid
+print("Test Run Id: %s"%run_id)
+
+#get the ids for all tests running on the chassis
+runningTests_Ids = [test['id'] for  test in bps.topology.runningTest.get()] 
+#wait while the test is still running
+while run_id in runningTests_Ids:
+     run_state =  bps.topology.runningTest[run_id].get()
+     #print progress if test started
+     try: print ('progress: %s%% , runtime %ss' % (run_state['progress'], run_state['runtime'] ))
+     except: print ("Starting...")
+     time.sleep(2)
+     #update the current running tests
+     runningTests_Ids = [test['id'] for  test in bps.topology.runningTest.get()] 
+
+print("~The test finished the execution.")
+results = bps.reports.search(searchString=canned_test_name, limit=10, sort="endTime", sortorder="descending")
+result  = results[0]
+print ("%s execution duration %s ended with status: %s " % (result['name'], result['duration'], result['result']) )
+
+#getting 3.4 Section: Synopsys Summary of Results from the Report
+tabledata = bps.reports.getReportTable(runid=testid, sectionId="3.4")
+pp(tabledata)
+
+print ("Unreserving the ports")
+for p in port_list:
+    bps.topology.unreserve([{'slot': slot_number, 'port': p, 'group': 2}])
+
+bps.logout()
+```
+
+## Documentation
+Documentation is available using the following methods:
+* [Online web based documentation and samples](https://github.com/OpenIxia/BreakingPoint)
+* On your BreakingPoint System RestApi found near the BreakingPoint App  
+* Documentation available in the online doc browser is also inlined in each class, property and method and can be viewed using the python help command
+  ```python
+  from bps_restpy.testplatform.testplatform import TestPlatform
+  
+  #login to your Breaking Point System
+  help(BPS)
+  bps = BPS('your_bps_IP_or_FQDN', 'admin', 'admin')
+  
+  help(bps.testmodel.importModel)
+  
+  ```
+
+## Additional Samples
+Visit the [OpenIxia breakingpoint-restpy sample site maintained by solution architects](https://github.com/OpenIxia/BreakingPoint) for in depth end-to-end samples that demonstrate the following:
+* building a configuration
+  * from scratch
+  * from an existing IxNetwork configuration
+* running the configuration
+  * connecting ports to hardware
+  * starting protocols
+  * starting traffic
+* getting statistics
+  * port stats
+  * traffic stats
+
+

RELEASENOTES.md

@@ -0,0 +1,5 @@
+# Release Notes
+
+### Nov 2019
+* 1.0.1
+  * adding first version of breakingpoint rest wraper library