Merge pull request #14 from dka-li/snapshot-teanant

Add option to specify tenant when creating snapshot

Author: andreasgraber

README.md

@@ -41,9 +41,10 @@ try:
     aciclient.logout()
 except Exception as e:
     logger.exception("Stack Trace")
-    
 ```
-For automatic authentication token refresh you can set refresh to True
+
+For automatic authentication token refresh you can set variable ```refresh``` to True
+
 ```python
 aciclient = aciClient.ACI(apic_hostname, apic_username, apic_password, refresh=True)    
 ```
@@ -96,8 +97,9 @@ aciclient.deleteMo('uni/tn-XYZ')
 ```
 
 ### create snapshot
+You can specify a tenant in variable ```target_dn``` or not provide any to do a fabric-wide snapshot.
 ```python
-aci.snapshot('test')
+aci.snapshot(description='test', target_dn='/uni/tn-test')
 ```
 
 ## Testing

aciClient/aci.py

@@ -223,7 +223,7 @@ def deleteMo(self, dn) -> int:
     # ==============================================================================
     # snapshot
     # ==============================================================================
-    def snapshot(self, description="snapshot") -> bool:
+    def snapshot(self, description="snapshot", target_dn="") -> bool:
         self.__logger.debug(f'snapshot called {description}')
 
         json_payload = [
@@ -239,7 +239,7 @@ def snapshot(self, description="snapshot") -> bool:
                         "name": "aciclient",
                         "nameAlias": "",
                         "snapshot": "yes",
-                        "targetDn": ""
+                        "targetDn": f"{target_dn}"
                     }
                 }
             }

setup.py

@@ -7,7 +7,7 @@
     long_description = f.read()
 
 setup(name='aciClient',
-      version='1.3',
+      version='1.4',
       description='aci communication helper class',
       url='http://www.netcloud.ch',
       author='mze',

test/test_aci.py

@@ -255,3 +255,28 @@ def test_snapshot_nok(requests_mock):
     aci.login()
     resp = aci.snapshot(description='unit_test')
     assert not resp
+
+def test_snapshot_tenant_ok(requests_mock):
+    requests_mock.post(f'https://{__BASE_URL}/api/mo.json', json={"totalCount": "0", "imdata": []})
+    requests_mock.post(f'https://{__BASE_URL}/api/aaaLogin.json', json={'imdata': [
+        {'aaaLogin': {'attributes': {'token': 'tokenxyz'}}}
+    ]})
+
+    aci = ACI(apicIp=__BASE_URL, apicUser='admin', apicPasword='unkown')
+    aci.login()
+    resp = aci.snapshot(description='unit_test', target_dn='/uni/tn-test')
+    assert resp
+
+
+def test_snapshot_tenant_nok(requests_mock):
+    requests_mock.post(f'https://{__BASE_URL}/api/mo.json',
+                       json={"totalCount": "0", "imdata": [{"error": {"attributes": {"text": "Error UnitTest"}}}]},
+                       status_code=400)
+    requests_mock.post(f'https://{__BASE_URL}/api/aaaLogin.json', json={'imdata': [
+        {'aaaLogin': {'attributes': {'token': 'tokenxyz'}}}
+    ]})
+
+    aci = ACI(apicIp=__BASE_URL, apicUser='admin', apicPasword='unkown')
+    aci.login()
+    resp = aci.snapshot(description='unit_test', target_dn='/uni/tn-test')
+    assert not resp