Feat(cv_deploy): Verify streaming status and raise before trying to submit Workspace

[alexeygorbunov]

Change Summary

Verify streaming status of all devices targeted by cv_deploy and raise (and update Errors) or update Warnings (depending on the force parameter of the Workspace) if any of those inactive devices are targeted by configuration update.

Related Issue(s)

Fixes #4038

Component(s) name

arista.avd.cv_deploy

Proposed changes

• cv_client.get_inventory_devices in verify_devices_in_cloudvision_inventory already fetches actual state of all targeted devices including their streaming status. Add additional attribute _streaming to describe streaming state of CVDevices.
• If Workspace submission is not forced and inactive devices are targeted for configuration update - raise without wasting compute and time cycles trying to submit Workspace which will 100% fail. Expose details regarding discovered inactive devices via result (errors)
• If Workspace submission is forced and inactive devices are targeted for configuration update - proceed with Workspace submission but still expose details regarding discovered inactive devices via result (warnings)
• Ingore any devices not targeted for configuration update (like TAGs, etc as submission will not fail in this case)

How to test

• Initiate cv_deploy molecule tests targeting CI environment
• Observe the following under cv_deploy with cv_submit_workspace_force = true test:

TASK [arista.avd.cv_deploy : Deploy device configurations and tags to CloudVision] ***
[WARNING]: [pyavd] - verify_devices_streaming: Inactive devices present.
[CVDevice(hostname='avd-ci-core1',
serial_number='20C292B489214DF32F9506C242A722FF',
system_mac_address='50:00:00:a1:33:1a', _exists_on_cv=True, _streaming=False)]
[WARNING]: ('Inactive devices present.', [CVDevice(hostname='avd-ci-core1',
serial_number='20C292B489214DF32F9506C242A722FF',
system_mac_address='50:00:00:a1:33:1a', _exists_on_cv=True, _streaming=False)])

        "errors": [],
        "failed": false,
        "warnings": [
            "('Inactive devices present.', [CVDevice(hostname='avd-ci-core1', serial_number='20C292B489214DF32F9506C242A722FF', system_mac_address='50:00:00:a1:33:1a', _exists_on_cv=True, _streaming=False)])"
        ],

• Observe the following under cv_deploy with cv_submit_workspace_force = false test:

TASK [arista.avd.cv_deploy : Deploy device configurations and tags to CloudVision] ***
fatal: [avd-ci-spine1 -> localhost]: FAILED! => {"change_control": {"..."}

        "errors": [
            "('Unable to submit Workspace due to the presence of inactive devices. Use force to override.', [CVDevice(hostname='avd-ci-core1', serial_number='20C292B489214DF32F9506C242A722FF', system_mac_address='50:00:00:a1:33:1a', _exists_on_cv=True, _streaming=False)])"
        ],
        "failed": true,
        "warnings": []

Checklist

User Checklist

• N/A

Repository Checklist

• My code has been rebased from devel before I start
• I have read the CONTRIBUTING document.
• My change requires a change to the documentation and documentation have been updated accordingly.
• I have updated molecule CI testing accordingly. (check the box if not applicable)

[github-actions]

Review docs on Read the Docs

To test this pull request:

# Create virtual environment for this testing below the current directory
python -m venv test-avd-pr-4990
# Activate the virtual environment
source test-avd-pr-4990/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/alexeygorbunov/avd.git@issue_4038_improve_inact_devs_err#subdirectory=python-avd" --force
# Point Ansible collections path to the Python virtual environment
export ANSIBLE_COLLECTIONS_PATH=$VIRTUAL_ENV/ansible_collections
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/alexeygorbunov/avd.git#/ansible_collections/arista/avd/,issue_4038_improve_inact_devs_err --force
# Optional: Install AVD examples
cd test-avd-pr-4990
ansible-playbook arista.avd.install_examples

[ClausHolbechArista]

We should only warn if requested state for the workspace will not need to submit it. It can be useful to do builds and preview the changes even if devices are not streaming.

[alexeygorbunov]

We should only warn if requested state for the workspace will not need to submit it. It can be useful to do builds and preview the changes even if devices are not streaming.

fixed

    existing_devices = await verify_devices_in_cloudvision_inventory(
        ....
        raise_if_inactive=((not workspace.force) and workspace.requested_state == "submitted"),

[ClausHolbechArista]

If feels like we are building more lists and iterating over everything again and again.

Could be just set the streaming flag during the inspection above?

[alexeygorbunov]

You mean to extend CVDevice class to add streaming attribute?

[ClausHolbechArista]

Yeah that would be my suggestion. But if we decide to just submit no matter what, we don't even need to record this, but just set the force flag or not as given.

[ClausHolbechArista]

I don't think we need all these extra options on this function. If you just gather the streaming state in here, you could move the invocation of the verify to the workspace submission logic where everything would make more sense. It would also mean we would not raise early (before even trying to build the workspace).

[alexeygorbunov]

Just to confirm, after moving this streaming check over to submission phase - should we still raise (and avoid initiating submission) is we discover inactive devices targeted to configuration update when WS submission is not forced? Or should we just let submission to be initiated and let if fail (although we know in advance that it will fail)?

[ClausHolbechArista]

I know I said let's not try, but what if the device started streaming meanwhile. I think we should just submit and catch the error and provide a nice message suggesting the force option.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud