Fix(eos_validate_state): Sanitize markdown output on markdown validation report

[nathanmusser]

Change Summary

Borrowed the safe_markdown method from the ANTA project to fix a bug where some tests (LLDP Neighbors) inserted newlines in the message field which would break markdown formatting.

Related Issue(s)

aristanetworks/anta#752

Component(s) name

arista.avd.eos_validate_state

Proposed changes

Implemented safe_markdown as part of MDReportBase and added it to sanitize the message output in the markdown table of failed tests and all tests. safe_markdown replaces backticks with single quotes and replaces newlines with a single space.

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-4212
# Activate the virtual environment
source test-avd-pr-4212/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/nathanmusser/avd.git@md-newline-sanitize#subdirectory=python-avd" --force
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/nathanmusser/avd.git#/ansible_collections/arista/avd/,md-newline-sanitize --force
# Optional: Install AVD examples
cd test-avd-pr-4212
ansible-playbook arista.avd.install_examples

[carl-baillargeon]

LGTM. Thanks Nathan