modernizing the example

Author: simingy

README.md

@@ -30,13 +30,13 @@ $ git clone https://github.com/CiscoDevNet/pyats-sample-scripts.git
 
 There are two ways to run a typical pyATS script:
 
-1. through `easypy`, which generates log and archives
+1. through `pyats run job`, which generates log and archives
 2. as standalone, and prints results to screen
 
 ```bash
 $ cd pyats-sample-scripts/basic
 
-$ easypy job/basic_example_job.py
+$ pyats run job job/basic_example_job.py
 
 $ python basic_example_script.py
 ```

basic/job/basic_example_job.py basic/basic_example_job.pybasic/job/basic_example_job.py renamed to basic/basic_example_job.py

@@ -7,7 +7,7 @@
 To run:
     
     cd pyats-sample-scripts/basic
-    easypy job/basic_example_job.py
+    pyats run job basic_example_job.py
 
 '''
 
@@ -20,7 +20,7 @@ def main():
     '''
 
     # find the location of the script in relation to the job file
-    script_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    script_path = os.path.dirname(os.path.abspath(__file__))
     testscript = os.path.join(script_path, 'basic_example_script.py')
 
     # execute the testscript

basic/basic_example_script.py

@@ -107,13 +107,18 @@ def test_1(self, section):
     @aetest.test
     def test_2(self, section):
         '''
-        same content as last testcase - notice the section id difference.
+        you can also provide explicit results, reason and data using result API.
+        These information will be captured in the result summary.
         '''
         log.info("test section: %s in testcase %s" % (section.uid, self.uid))
 
-        # testcase instance is preserved, eg
-        assert self.b == 2
-
+        if self.b == 2:
+            self.passed('variable b contains the expected value',
+                        data = {'b': self.b})
+        else:
+            self.failed('variable b did not contains the expected value',
+                        data = {'b': self.b})
+            
     @aetest.cleanup
     def cleanup(self):
         '''cleanup section

comprehensive/README.md

@@ -20,8 +20,9 @@ walking users through important features and explaining them using live
 examples, supplementing the full user guide at:
     https://developer.cisco.com/site/pyats/docs/
 
-This example is executable both under standalone execution, and through `easypy`.
-You can modify parts of this code to see how it changes execution behaviors.
+This example is executable both under standalone execution, and through 
+pyATS command line `pyats run job`. You can modify parts of this code to see 
+how it changes execution behaviors.
 
 ```
     Folder Structure
@@ -55,7 +56,7 @@ $ cd pyats-sample-scripts/comprehensive/
 $ python base_example.py --testbed etc/example_testbed.yaml
 $ python variant_example.py --testbed etc/example_testbed.yaml
 
-# easypy execution
-# ----------------
-$ easypy job/example_job.py -testbed_file etc/example_testbed.yaml
+# pyats job execution
+# -------------------
+$ pyats run job job/example_job.py --testbed-file etc/example_testbed.yaml
 ```

comprehensive/base_example.py

@@ -37,8 +37,8 @@
     # to run with datafile under command-line
     bash$ python base_example.py -datafile=data/base_datafile.yaml
 
-    # to run under easypy
-    bash$ easypy job/example_job.py
+    # to run under pyats job engine
+    bash$ pyats run job job/example_job.py
 
 References:
    For the complete and up-to-date user guide on pyATS, visit:
@@ -89,8 +89,8 @@
 #*******************************************************************************
 #* LOGGING
 #*
-#*   Logging should be done by using the standard Python logging module. AEtest
-#*   and Easypy will take care of configuring the log outputs to be Cisco Logs
+#*   Logging should be done by using the standard Python logging module. The
+#*   engine will take care of configuring the log outputs to be Cisco Logs
 #*   format. There's not much more to say beyond that. :-)
 #*   
 #* Convention:
@@ -380,7 +380,7 @@ def access_runtime(self):
     #******************************
     #* Access Testbed Information
     #* 
-    #*  when easypy is called with -testbed_file argument, the 'testbed' 
+    #*  when pyats run job is called with --testbed-file argument, the 'testbed' 
     #*  parameter is automatically provided to the testscript with the 
     #*  corresponding topology objects. 
     #*  in standalone execution, users need to create their own testbed

comprehensive/job/example_job.py

@@ -10,8 +10,8 @@
     # to run under standalone execution
     bash$ python base_example.py
 
-    # to run under easypy
-    bash$ easypy job/example_job.py
+    # to run under pyats job engine
+    bash$ pyats run job example_job.py
 
 References:
    For the complete and up-to-date user guide on pyATS, visit:
@@ -101,11 +101,11 @@
 #*******************************************************************************
 #* TESTBED INFORMATION
 #*
-#*  when executing a jobfile using easypy, testbed file should be provided to 
-#*  easypy launcher using argument -testbed_file. Easypy will automatically 
+#*  when executing a jobfile using pyats, testbed file should be provided to 
+#*  pyats job launcher using argument --testbed-file. The engine will then 
 #*  load this provided testbed file into topology objects, and pass it to each
 #*  testscript as script argument "testbed". 
-#*       easypy myjobfile.py -testbed_file mytestbed.yaml
+#*       pyats run job myjobfile.py --testbed-file mytestbed.yaml
 #*
 #*  as long as the argument is used properly, there's nothing extra the user 
 #*  has to do. Testscripts will automatically be passed the parameter 'testbed',
@@ -189,11 +189,11 @@
 #* MAIN FUNCTION
 #*
 #*  Each job file must have a main() function where testscripts/task runs are
-#*  defined. After a job file is imported, easypy will lookup main() function
+#*  defined. After a job file is imported, pyats will lookup main() function
 #*  to run. 
 #*
 #*  main() funtion shall have a single argument called 'runtime'. This allows
-#*  the engine to automatically pass in the current Easypy runtime object. The
+#*  the engine to automatically pass in the current runtime object. The
 #*  following should be performed within the main() function:
 #*      - parse any custom command-line arguments
 #*      - configure logger log-levels, if any

comprehensive/variant_example.py

@@ -25,8 +25,8 @@
     # to run under standalone execution
     bash$ python variant_example.py
 
-    # to run under easypy
-    bash$ easypy job/example_job.py
+    # to run under pyats job engine
+    bash$ pyats run job job/example_job.py
 
 References:
    For the complete and up-to-date user guide on pyATS, visit: