feat: OBS-417 end to end tests for happy paths

[Julio-Oliveira-Encora]

No description provided.

[linear]

OBS-417 End-to-end tests for happy paths

Define:

• payloads
• expected results
• how to send ingestion data and retrieve results from NetBox - diode-sdk-python (when finished, early next week) or buf curl for time being?

Test cases https://docs.google.com/document/d/1J8wIARn_BtsyYCu0L3904U2QHalfVqPcr4Eej5nW_zo/edit

BDD with behave (python)?

1. (ensure NetBox resources are torn down after previous test runs)
2. create resources in NetBox expected to exist for update operations
3. ingest data utilising diode-sdk-python (development to be completed)
4. call NetBox REST API endpoints (per object type) to check resources exist as expected (either after creation of update)
5. assert resources in NetBox are as expected
6. tear down resources (on but successful and failed test runs)

As we don't have fully functional diode-sdk-python yet, for this week to keep moving on, our end-to-end tests could be sending requests to /api/diode/apply-change-set plugin's endpoint (as it would be produces by reconciler) and verify resources are created/updates as expected. For today (Tuesday, 12 March 2024) we could focus on simple - non-nested models - test cases and expand with complex ones once we have it working later this week 🤞