Merge pull request #6 from tahigash/tahigash_aci_sample

Tahigash aci sample

Author: jeaubin

aci_tenant/README.md

@@ -0,0 +1,85 @@
+# Overview
+
+Connect to API via Rest Connecor, and create tenant, check the tenant and delete the tenant. This will check if the tenant exists, or not to make sure REST API is properly done.
+
+No python knowledge required. All is done in YAML by using `Blitz`(Quick Trigger).
+
+# Steps
+
+Please check `trigger_datafile.yaml`. The test is written in YAML. So, easy to find corresponding steps in the YAML.
+
+1. Check Tenant doesn't exist
+2. Create Tenant
+3. Check Tenant exist
+4. Delete Tenant
+5. Check Tenant was deleted 
+
+# Preparation
+
+Install pyATS|Genie and Rest Connector.
+
+```
+pip install 'pyats[full]' rest.connector
+```
+
+# Running
+
+By pyats run job command
+```
+pyats run job job.py --testbed-file aci_devnet_sandbox.yaml
+```
+
+By pyats run genie command (without `job.py`)
+```
+pyats run genie --testbed-file aci_devnet_sandbox.yaml --trigger-datafile trigger_datafile.yaml --trigger-groups "And('tenant')" --subsection-datafile subsection_datafile.yaml
+```
+
+# Try customization in YAML
+
+### Try #1
+As quick customize, change `tenant` name under `vars` at top of `trigger_datafile.yaml`.
+
+```
+vars:
+  tenant: new_tenant_by_pyATS
+(snip)
+```
+### Try #2
+
+Comment whole step4(`delete_tenant`).
+
+```
+(snip)
+              - contains('.*%{vars.tenant}.*', regex=True)
+    # - delete_tenant:
+    #     - api:
+    #         device: uut
+    #         function: apic_rest_post
+    #         arguments:
+    #           dn: "/api/node/mo/uni/tn-%{vars.tenant}.json"
+    #           payload: |
+    #             {
+    #               "fvTenant": {
+    #                   "attributes": {
+    #                     "dn": "uni/tn-%{vars.tenant}",
+    #                     "status": "deleted"
+    #                   },
+    #                   "children": []
+    #               }
+    #             }
+    #         include:
+    #           - contains_key_value("totalCount", '0')
+    - check_tenant_was_deleted:
+(snip)
+```
+
+`check_tenant_was_deleted` step will be failed. but it's fine since we didn't delete. So, it's expected.
+
+Go to https://sandboxapicdc.cisco.com (Check username/password from `aci_devnet_sandbox.yaml`). 
+
+After login to APIC, click `Tenants` tab. And then the created tenant should be there.
+
+
+
+
+

aci_tenant/aci_devnet_sandbox.yaml

@@ -0,0 +1,17 @@
+devices:
+  APIC:
+    os: apic
+    alias: uut
+    type: apic
+    connections:
+      defaults:
+        via: rest
+      rest:
+        class: rest.connector.Rest
+        host: sandboxapicdc.cisco.com
+        ip: sandboxapicdc.cisco.com
+        port: 443
+        credentials:
+          rest:
+            username: admin
+            password: ciscopsdt

aci_tenant/job.py

@@ -0,0 +1,16 @@
+import os
+import time
+
+from pyats import aetest
+
+# Needed for logic
+from pyats.datastructures.logic import And, Not, Or
+from genie.harness.main import gRun
+
+def main():
+    test_path = os.path.dirname(os.path.abspath(__file__))
+    gRun(
+        trigger_datafile=test_path+'/trigger_datafile.yaml',
+        subsection_datafile=test_path+'/subsection_datafile.yaml',
+        trigger_groups=And('tenant'),
+    )

aci_tenant/subsection_datafile.yaml

@@ -0,0 +1,8 @@
+setup:
+    sections:
+      connect:
+        method: genie.harness.commons.connect
+    order: ['connect']
+
+cleanup:
+    order: []

aci_tenant/trigger_datafile.yaml

@@ -0,0 +1,70 @@
+vars:
+  tenant: pyATS_awesome
+
+Create_Tenant:
+  groups: ["tenant"]
+  source:
+    pkg: genie.libs.sdk
+    class: triggers.blitz.blitz.Blitz
+  test_sections:
+    - check_tenant_does_not_exist:
+        - api:
+            device: uut
+            function: apic_rest_get
+            arguments:
+              dn: /api/node/class/fvTenant.json
+            exclude:
+              - contains('.*%{vars.tenant}.*', regex=True)
+    - create_tenant:
+        - api:
+            device: uut
+            function: apic_rest_post
+            arguments:
+              dn: "/api/node/mo/uni/tn-%{vars.tenant}.json"
+              payload: |
+                {
+                  "fvTenant": {
+                    "attributes": {
+                      "descr": "Tenant Created Using pyATS",
+                      "dn": "uni/tn-%{vars.tenant}"
+                      "name": "%{vars.tenant}",
+                      "rn": "%{vars.tenant}",
+                      "status": "created"
+                    },
+                    "children": []
+                  }
+                }
+    - check_tenant_exists:
+        - api:
+            device: uut
+            function: apic_rest_get
+            arguments:
+              dn: /api/node/class/fvTenant.json
+            include:
+              - contains('.*%{vars.tenant}.*', regex=True)
+    - delete_tenant:
+        - api:
+            device: uut
+            function: apic_rest_post
+            arguments:
+              dn: "/api/node/mo/uni/tn-%{vars.tenant}.json"
+              payload: |
+                {
+                  "fvTenant": {
+                      "attributes": {
+                        "dn": "uni/tn-%{vars.tenant}",
+                        "status": "deleted"
+                      },
+                      "children": []
+                  }
+                }
+            include:
+              - contains_key_value("totalCount", '0')
+    - check_tenant_was_deleted:
+        - api:
+            device: uut
+            function: apic_rest_get
+            arguments:
+              dn: /api/node/class/fvTenant.json
+            exclude:
+              - contains('.*%{vars.tenant}.*', regex=True)