cvprac 2.0.0__tar.gz → 2.2.0__tar.gz

{cvprac-2.0.0 → cvprac-2.2.0}/PKG-INFO

@@ -1,14 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: cvprac
-Version: 2.0.0
+Version: 2.2.0
 Summary: Arista Cloudvision(R) Portal Rest API Client written in python
 Home-page: https://github.com/aristanetworks/cvprac
+Download-URL: https://github.com/aristanetworks/cvprac/tarball/2.2.0
 Author: Arista Networks, Inc.
 Author-email: eosplus-dev@arista.com
 License: BSD-3
-Download-URL: https://github.com/aristanetworks/cvprac/tarball/2.0.0
 Keywords: networking CloudVision development rest api
-Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
@@ -24,8 +23,29 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
-Provides-Extra: dev
 License-File: LICENSE
+Requires-Dist: requests[socks]>=2.27.0
+Requires-Dist: packaging>=23.2
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+Requires-Dist: pep8; extra == "dev"
+Requires-Dist: pyflakes; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pyyaml; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 # Arista Cloudvision® Portal RESTful API Client
 
@@ -478,5 +498,3 @@ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 THE POSSIBILITY OF SUCH DAMAGE.
-
-

cvprac-2.2.0/VERSION

@@ -0,0 +1 @@
+2.2.0

{cvprac-2.0.0 → cvprac-2.2.0}/cvprac/__init__.py

@@ -32,5 +32,5 @@
 ''' RESTful API Client class for Cloudvision(R) Portal
 '''
 
-__version__ = '2.0.0'
+__version__ = '2.2.0'
 __author__ = 'Arista Networks, Inc.'

{cvprac-2.0.0 → cvprac-2.2.0}/cvprac/cvp_api.py

@@ -471,6 +471,22 @@ class CvpApi():
         return self.clnt.post('/task/cancelTask.do', data=data,
                               timeout=self.request_timeout)
 
+    def get_config_diff_for_task(self, task_id):
+        ''' Get the config diff and validation errors for a specific task.
+            Uses the compliance check API to compare designed vs running config.
+
+            Args:
+                task_id (str): The task ID to check.
+
+            Returns:
+                response (list): A list of dicts containing sources, diff, and
+                    error entries. Error entries have error_code, error_msg,
+                    line_num, configlet_name, and config_line_num fields.
+        '''
+        diff_url = '/api/v3/services/compliancecheck.Compliance/GetConfigDiffForTask'
+        return self.clnt.post(diff_url, data={"task_id": str(task_id)},
+                              timeout=self.request_timeout)
+
     def get_configlets(self, start=0, end=0):
         ''' Returns a list of all defined configlets.
 
@@ -685,6 +701,7 @@ class CvpApi():
         return data
 
     # pylint: disable=too-many-locals
+    # pylint: disable=too-many-branches
     def add_devices_to_inventory(self, device_list, wait=False, move_to_container=True):
         ''' Add list of devices to inventory and optionally move them to specified parent container.
 
@@ -714,6 +731,10 @@ class CvpApi():
                         parent_key: 'container-id-1234'
                     }
                 ]
+            Returns: Dict of devices that failed to onboard in below format. None if all devices
+                     onboarded successfully.
+
+                     {'192.168.0.11': "ERROR"}
         '''
 
         self.log.debug('add_devices_to_inventory: called')
@@ -735,17 +756,27 @@ class CvpApi():
             self.clnt.post('/inventory/add/addToInventory.do?'
                            'startIndex=0&endIndex=0', data=data,
                            timeout=self.request_timeout)
-        else:
-            self.log.debug('v2 Inventory API Call')
-
-            # Create a list of device IPs
-            device_ips = [dev['device_ip'] for dev in device_list]
-
-            # First add the devices to the inventory in a single call
-            data = {'hosts': device_ips}
-            self.clnt.post('/inventory/devices', data=data,
-                           timeout=self.request_timeout)
+            return None
+        self.log.debug('v2 Inventory API Call')
 
+        # Create a list of device IPs
+        device_ips = [dev['device_ip'] for dev in device_list]
+
+        # First add the devices to the inventory in a single call
+        data = {'hosts': device_ips}
+        failed_onboard = None
+        resp = self.clnt.post('/inventory/devices', data=data, timeout=self.request_timeout)
+        if resp and 'failed' in resp['data']:
+            failed_onboard = resp['data']['failed']
+            for failed_dev_ip in failed_onboard:
+                self.log.warning(
+                    'Found error onboarding device %s - %s',
+                    failed_dev_ip,
+                    failed_onboard[failed_dev_ip]
+                )
+                device_ips.remove(failed_dev_ip)
+
+        if device_ips:
             # Get the inventory list
             inv = self.get_inventory()
 
@@ -771,11 +802,14 @@ class CvpApi():
                 for device in device_list:
                     devs = [dev for dev in inv if 'ipAddress' in dev and
                             device['device_ip'] in dev['ipAddress']]
-                    dev = devs[0]
-                    container = {'key': device['parent_key'],
-                                 'name': device['parent_name']}
-                    self.move_device_to_container('add_devices_to_inventory API v2',
-                                                  dev, container, False)
+                    # Only attempt to move device to another container if it is in inventory
+                    if devs:
+                        dev = devs[0]
+                        container = {'key': device['parent_key'],
+                                     'name': device['parent_name']}
+                        self.move_device_to_container('add_devices_to_inventory API v2',
+                                                      dev, container, False)
+        return failed_onboard
 
     def add_device_to_inventory(self, device_ip, parent_name,
                                 parent_key, wait=False, move_to_container=True):
@@ -3040,6 +3074,24 @@ class CvpApi():
             return self.clnt.get(cc_url, timeout=self.request_timeout)
         return None
 
+    def change_control_get_task_errors(self, cc_id):
+        ''' Get task configuration errors for a change control.
+            Supported versions: CVP 2021.2.0 or newer and CVaaS.
+
+            Args:
+               cc_id (str): The ID of the change control.
+
+            Returns:
+                errors (list): A list of (task_id, error_dict) tuples for any tasks
+                    with DEVICEERROR entries. Empty list if no errors found.
+                    Returns None if the change control does not exist or the API
+                    is unsupported.
+        '''
+        cc_status = self.change_control_get_one(cc_id)
+        if cc_status is None:
+            return None
+        return self._parse_task_errors_from_cc_data(cc_status)
+
     def change_control_approval_get_one(self, cc_id, cc_time=None):
         ''' Get the state of a specific Change Control's approve config using Resource APIs.
             Supported versions: CVP 2021.2.0 or newer and CVaaS.
@@ -3093,6 +3145,10 @@ class CvpApi():
         ''' Approve/Unapprove a change control using Resource APIs.
             Supported versions: CVP 2021.2.0 or newer and CVaaS.
 
+            When approving (approve=True), validates that no tasks in the
+            change control have configuration errors. Raises CvpApiError
+            if any task has DEVICEERROR entries from the compliance check.
+
             Args:
               cc_id (str): The ID of the change control.
               notes (str): An optional approval note.
@@ -3111,6 +3167,19 @@ class CvpApi():
         else:
             self.log.error('The version timestamp was not found in the CC status.')
             return None
+
+        if approve:
+            task_errors = self._parse_task_errors_from_cc_data(cc_status)
+            if task_errors:
+                error_details = "; ".join(
+                    f"Task {tid}: {err['error_msg']}"
+                    for tid, err in task_errors
+                )
+                raise CvpApiError(
+                    f"Cannot approve change control {cc_id}. "
+                    f"Tasks have configuration errors: {error_details}"
+                )
+
         payload = {
             "key": {
                 "id": cc_id
@@ -3123,6 +3192,46 @@ class CvpApi():
         }
         return self.clnt.post(cc_url, data=payload, timeout=self.request_timeout)
 
+    def _parse_task_errors_from_cc_data(self, cc_data):
+        ''' Extract task IDs from a change control data and check each for config errors.
+            Make an API call on each task and parse the config diff for errors.
+
+            Args:
+                cc_data (dict): The change control dict from change_control_get_one.
+
+            Returns:
+                errors (list): A list of (task_id, error_dict) tuples for any tasks
+                    with DEVICEERROR entries. Empty list if no errors found.
+                    error_dict example: {
+                            "error_code": "DEVICEERROR",
+                            "error_msg": "> typocommand test % Invalid input (at token 0: 'typocommand')",
+                            "line_num": 50,
+                            "configlet_name": "device-name",
+                            "config_line_num": 54
+                        }
+        '''
+        errors = []
+        stages = (cc_data.get('value', {}).get('change', {})
+                  .get('stages', {}).get('values', {}))
+        for stage in stages.values():
+            action = stage.get('action', {})
+            if action.get('name') == 'task':
+                task_id = (action.get('args', {}).get('values', {})
+                           .get('TaskID'))
+                if task_id:
+                    try:
+                        resp = self.get_config_diff_for_task(task_id)
+                    except Exception as error:
+                        self.log.error(
+                            f"Failed to get config diff for task {task_id}: {error}")
+                        continue
+                    if isinstance(resp, list):
+                        for entry in resp:
+                            err = entry.get('error') if isinstance(entry, dict) else None
+                            if err and err.get('error_code') == 'DEVICEERROR':
+                                errors.append((task_id, err))
+        return errors
+
     def change_control_delete(self, cc_id):
         ''' Delete a pending Change Control using Resource APIs.
             Supported versions: CVP 2021.2.0 or newer and CVaaS.

{cvprac-2.0.0 → cvprac-2.2.0}/cvprac.egg-info/PKG-INFO

@@ -1,14 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: cvprac
-Version: 2.0.0
+Version: 2.2.0
 Summary: Arista Cloudvision(R) Portal Rest API Client written in python
 Home-page: https://github.com/aristanetworks/cvprac
+Download-URL: https://github.com/aristanetworks/cvprac/tarball/2.2.0
 Author: Arista Networks, Inc.
 Author-email: eosplus-dev@arista.com
 License: BSD-3
-Download-URL: https://github.com/aristanetworks/cvprac/tarball/2.0.0
 Keywords: networking CloudVision development rest api
-Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
@@ -24,8 +23,29 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
-Provides-Extra: dev
 License-File: LICENSE
+Requires-Dist: requests[socks]>=2.27.0
+Requires-Dist: packaging>=23.2
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+Requires-Dist: pep8; extra == "dev"
+Requires-Dist: pyflakes; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pyyaml; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 # Arista Cloudvision® Portal RESTful API Client
 
@@ -478,5 +498,3 @@ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 THE POSSIBILITY OF SUCH DAMAGE.
-
-

{cvprac-2.0.0 → cvprac-2.2.0}/cvprac.egg-info/SOURCES.txt

@@ -37,6 +37,8 @@ docs/release-notes-1.4.0.rst
 docs/release-notes-1.4.1.rst
 docs/release-notes-1.4.2.rst
 docs/release-notes-2.0.0.rst
+docs/release-notes-2.1.0.rst
+docs/release-notes-2.2.0.rst
 docs/labs/README.md
 docs/labs/lab01-cvp-info/get_cvp_info.py
 docs/labs/lab02-inventory-operations/compliance_check.py

cvprac-2.2.0/docs/release-notes-2.1.0.rst

@@ -0,0 +1,10 @@
+######
+v2.1.0
+######
+
+2026-5-26
+
+Enhancements
+^^^^^^^^^^^^
+
+* Handle devices that fail to onboard in add_devices_to_inventory. (`311 <https://github.com/aristanetworks/cvprac/pull/311>`_) [`mharista <https://github.com/mharista>`_]

cvprac-2.2.0/docs/release-notes-2.2.0.rst

@@ -0,0 +1,10 @@
+######
+v2.2.0
+######
+
+2026-6-24
+
+Enhancements
+^^^^^^^^^^^^
+
+* Add check for Validation Errors on Tasks before CC Approval. (`317 <https://github.com/aristanetworks/cvprac/pull/317>`_) [`chetryan <https://github.com/chetryan>`_]

{cvprac-2.0.0 → cvprac-2.2.0}/test/fixtures/cvp_nodes.yaml

@@ -1,4 +1,4 @@
-- node: 10.255.0.159
+- node: 10.18.134.138
   username: cvpadmin
   password: cvp123!
   device: veos1

{cvprac-2.0.0 → cvprac-2.2.0}/test/system/test_cvp_base.py

@@ -13,6 +13,7 @@ import urllib3
 sys.path.append(os.path.join(os.path.dirname(__file__), '../lib'))
 from systestlib import DutSystemTest
 from cvprac.cvp_client import CvpClient
+from cvprac.cvp_client_errors import CvpApiError
 
 
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
@@ -101,7 +102,6 @@ class TestCvpClientBase(DutSystemTest):
         '''
         self.task_id = None
         self.cc_id = str(uuid.uuid4())
-        # self.cc_name = 'test_api_%d %s' % time.time()
         self.cc_name = f'test_api_{time.time()}'
 
     def tearDown(self):
@@ -113,11 +113,25 @@ class TestCvpClientBase(DutSystemTest):
         if chg_ctrl_get_one:
             # Delete CC
             self.delete_change_control(self.cc_id)
-            # Cancel task
-            if self.task_id:
-                task = self.api.get_task_by_id(self.task_id)
-                if task and task['currentTaskName'] != "Cancelled":
-                    self.cancel_task(self.task_id)
+            self.cc_id = None
+        # Cancel task
+        if self.task_id:
+            # Do not attempt to cancel tasks with taskStatus
+            # in following list.
+            ignore_task_status = ["COMPLETED"]
+            # Do not attempt to cancel tasks with currentTaskName
+            # in following list.
+            ignore_current_task_name = ["Cancelled"]
+            task = self.api.get_task_by_id(self.task_id)
+            if task:
+                if task["currentTaskName"] not in ignore_current_task_name:
+                    if task["taskStatus"] not in ignore_task_status:
+                        try:
+                            self.cancel_task(self.task_id)
+                        except CvpApiError as err:
+                            print(f"Error while trying to cancel task {self.task_id} - {err}")
+                            print(f"Task info - {task}")
+            self.task_id = None
 
     def _get_next_task_id(self):
         ''' Return the next task id.
@@ -146,10 +160,10 @@ class TestCvpClientBase(DutSystemTest):
         configlet = None
         for conf in self.dev_configlets:
             if conf['netElementCount'] == 1:
-                configlet = conf
+                configlet = conf.copy()
                 break
         if configlet is None:
-            configlet = self.dev_configlets[0]
+            configlet = self.dev_configlets[0].copy()
 
         config = configlet['config']
         org_config = config
@@ -184,7 +198,50 @@ class TestCvpClientBase(DutSystemTest):
         err_msg = f'Timeout waiting for task id {task_id} to be created'
         self.assertGreater(cnt, 0, msg=err_msg)
         self.task_id = task_id
-        return task_id, org_config
+        return task_id, org_config, configlet
+
+    def _create_task_with_invalid_config(self):
+        ''' Create a task by adding an invalid EOS command to a configlet.
+            The invalid command will cause a DEVICEERROR in the config diff
+            compliance check, which is used to test the task error validation
+            in change_control_approve.
+
+            Returns:
+                (task_id, org_config, configlet)
+                task_id (str): Task ID
+                org_config (str): Original configlet contents for cleanup
+                configlet (dict): The configlet dict for cleanup
+        '''
+        task_id = self._get_next_task_id()
+        configlet = None
+        for conf in self.dev_configlets:
+            if conf['netElementCount'] == 1:
+                configlet = conf.copy()
+                break
+        if configlet is None:
+            configlet = self.dev_configlets[0].copy()
+
+        org_config = configlet['config']
+        config = org_config + '\ntypocommand test\n'
+        configlet['config'] = config
+
+        self.api.update_configlet(config, configlet['key'], configlet['name'])
+
+        cnt = 30
+        if self.clnt.apiversion is None:
+            self.api.get_cvp_info()
+        if self.clnt.apiversion >= 2.0:
+            cnt += 30
+        while cnt > 0:
+            time.sleep(1)
+            result = self.api.get_task_by_id(task_id)
+            if result is not None:
+                break
+            cnt -= 1
+        err_msg = f'Timeout waiting for task id {task_id} to be created'
+        self.assertGreater(cnt, 0, msg=err_msg)
+        self.task_id = task_id
+        return task_id, org_config, configlet
 
     def delete_change_control(self, cc_id):
         """ Delete change control