nautobot / nautobot-app-design-builder

https://docs.nautobot.com/projects/design-builder/en/latest/
Other
8 stars 2 forks source link

Provide design testing capabilities #26

Open mzbroch opened 1 year ago

mzbroch commented 1 year ago

As ... Austin, Network Automation Engineer

I want ... Develop and test my designs quickly and efficiently

So that ... I can quickly render and destroy my network design

I know this is done when... I need only single cli command to test a design

mzbroch commented 1 year ago

Workaround used so far by me: For each design set , provide a management command that does the following:

abates commented 1 year ago

Related to #14

abates commented 1 year ago

To some degree this is already available with the DesignTestCase for unit tests. We could definitely document design testing better. What is not available, out of the box, is bootstrapping a development environment with test data. Rolling back, when launching from the UI, is already supported with the commit option when launching the job and unit tests are wrapped in transactions to reset the database as well.

abates commented 8 months ago

We've added unit tests for design builder that make it easier to test the internal workings of the plugin. These tests are constructed using yaml files that include the design as well as a list of "checks". I think we can extend and adapt the concept to be able to test standalone designs.

See examples here

@mzbroch any thoughts?

Also, please chime in @nkallergis and @housepbass

nkallergis commented 8 months ago

This is brilliant and would indeed make the whole dev process so much streamlined.