dev: add start of CI section

[davidjpeacock]

New section to encompass definitive documentation of our CI environment for all four repos.

[vyvle]

Since we are explaining what we do here, maybe we can write a bit more info here about the tests, so we arent vague. Hopefully this isnt an overkill, so let me know what you think.

1. Linters: Style, syntax, formatting
2. Sanity Tests (ansible-test sanity) Import tests

• Compilation checks
• Documentation validation
• Argument spec validation
• Code quality checks (pylint, pep8)
• we dont write these, we conform them. they come as standardization for ansible.

3. Unit Tests

• Individual functions/methods tested in isolation

4. Integration Tests

• Module integration tests (test modules against real/fake APIs)
• Role integration tests (test roles in test environments)
• Can use real systems OR mocks (like srv.go fake OpenStack)

5. Functional tests

• For role testing, meaning testing the POV of personas admin and tenant, we are ensuring migration works regardless of which permission level is used. we are testing it via ansible playbooks. in our project, it is categorized as functional, we are testing a lot of stuff from the perspective, but not full workflow as with e2e.

6. E2E Tests

• Full workflow tests from user perspective
• Typically against real systems

then.... i am not sure where to put Module testing as you are describing it now (meaning: separate headers/topics). I would personally categorize module testing under either unit (testing single small targeted feature in module) or integration (stuff is working together/ idempotency).