Refactor(pyavd): Adding path attribute to the validation error for removed keys

[Shivani-gslab]

Change Summary

In https://github.com/aristanetworks/avd/blob/devel/python-avd/pyavd/avd_schema_tools.py#L67,
the AvdDeprecationWarning is converted to AvdValidationError for the removed keys.
It does not have path attribute which is needed for highlighting errors in AVD VSCode extension.

Updating the conversion to get the path attribute.

Related Issue(s)

Fixes #https://github.com/aristanetworks/vscode-avd/issues/5

Component(s) name

pyavd

Proposed changes

Adding to_validation_error method to AvdDeprecationWarning for error conversion along with getting the path attribute.
Using this method in schema tools for getting validation error.

How to test

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-4688
# Activate the virtual environment
source test-avd-pr-4688/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/Shivani-gslab/avd.git@fix_pyavd_validation_error#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/Shivani-gslab/avd.git#/ansible_collections/arista/avd/,fix_pyavd_validation_error --force
# Optional: Install AVD examples
cd test-avd-pr-4688
ansible-playbook arista.avd.install_examples

[ClausHolbechArista]

LGTM. Only a minor suggestion to avoid later surprises.

[Vibhu-gslab]

LGTM!

[sonarcloud]

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 SonarCloud