Test(cv_deploy): Add support for offline testing of CVClient

ClausHolbechArista commented 3 days ago

Change Summary

Add support for offline testing of CVClient

Proposed changes

Create a recorder for API requests coming from CVClient.
Create a mock class to play back the recorded responses.
Various mockery to make cvclient happy in offline state.

How to test

Added a pytest fixture which automatically serves the relevant type of CVClient:

@pytest_asyncio.fixture
async def cv_client() -> AsyncGenerator[CVClient, None]:
    """
    Instance of CVClient.

    If CVAAS_AAWG_CI environment variable is set, but RECORDING environment variable is not set,
    this will return a proper instance of CVClient connected to cv-staging with the token.

    If CVAAS_AAWG_CI environment variable is set, but RECORDING environment variable is set,
    this will return an instance of CVClient connected to cv-staging with the token where all API calls will be recorded.

    Otherwise this will return an instance of CVClient where API calls are mocked using previously recorded API messages.
    """

Checklist

User Checklist

N/A

Repository Checklist

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

github-actions[bot] commented 3 days ago

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