updates to ansible-maintained collections guidelines (#70178)

This commit is contained in:
Sandra McCann 2020-06-19 15:04:19 -04:00 committed by GitHub
parent 86606d3ca7
commit 647c6cd289
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 62 additions and 37 deletions

View file

@ -120,7 +120,7 @@ The following table shows:
</tr> </tr>
<tr> <tr>
<td><a href="https://galaxy.ansible.com/cisco/asa">cisco.asa</a></td> <td><a href="https://galaxy.ansible.com/cisco/asa">cisco.asa</a></td>
<td>community.asa</td> <td><a href="https://github.com/ansible-collections/community.asa">community.asa</a></td>
<td><a href="https://github.com/ansible/community/wiki/Security-Automation">Security</a></td> <td><a href="https://github.com/ansible/community/wiki/Security-Automation">Security</a></td>
<td>✓</td> <td>✓</td>
<td>✓</td> <td>✓</td>
@ -164,7 +164,7 @@ The following table shows:
</tr> </tr>
<tr> <tr>
<td><a href="https://galaxy.ansible.com/ibm/qradar">ibm.qradar</a></td> <td><a href="https://galaxy.ansible.com/ibm/qradar">ibm.qradar</a></td>
<td>community.qradar</td> <td><a href="https://github.com/ansible-collections/community.qradar">community.qradar</a></td>
<td><a href="https://github.com/ansible/community/wiki/Security-Automation">Security</a></td> <td><a href="https://github.com/ansible/community/wiki/Security-Automation">Security</a></td>
<td>✓</td> <td>✓</td>
<td></td> <td></td>
@ -197,7 +197,7 @@ The following table shows:
</tr> </tr>
<tr> <tr>
<td><a href="https://github.com/ansible-collections/splunk.es">splunk.es</a></td> <td><a href="https://github.com/ansible-collections/splunk.es">splunk.es</a></td>
<td>community.es</td> <td><a href="https://github.com/ansible-collections/community.es">community.es</a></td>
<td><a href="https://github.com/ansible/community/wiki/Security-Automation">Security</a></td> <td><a href="https://github.com/ansible/community/wiki/Security-Automation">Security</a></td>
<td>✓</td> <td>✓</td>
<td></td> <td></td>
@ -250,7 +250,7 @@ The following scenarios use the ``arista.eos`` to help explain when to contribut
* Propose a new module in the ``community.network`` collection (requires network community approval). * Propose a new module in the ``community.network`` collection (requires network community approval).
* Place your new module in a collection in your own namespace (no approvals required). * Place your new module in a collection in your own namespace (no approvals required).
Most new content should go into either a related community collection or your own collection first so that is well established in the community before you can propose adding it to the ``arista`` namespace, where inclusion and maintenance criteria are much higher. Most new content should go into either a related community collection or your own collection first so that is well established in the community before you can propose adding it to the ``arista`` namespace, where inclusion and maintenance criteria are much higher.

View file

@ -511,9 +511,9 @@ For platforms that support ``connection: local`` *and* ``connection: network_cli
* Name the :file:`targets/` directories after the module name. * Name the :file:`targets/` directories after the module name.
* The :file:`main.yaml` file should just reference the transport. * The :file:`main.yaml` file should just reference the transport.
The following example walks through the integration tests for the ``vyos.vyos.vyos_banner`` module in the `vyos.vyos <https://github.com/ansible-collections/vyos.vyos/tree/master/tests/integration>`_ collection: The following example walks through the integration tests for the ``vyos.vyos.vyos_l3_interfaces`` module in the `vyos.vyos <https://github.com/ansible-collections/vyos.vyos/tree/master/tests/integration>`_ collection:
``test/integration/targets/vyos_banner/tasks/main.yaml`` ``test/integration/targets/vyos_l3_interfaces/tasks/main.yaml``
.. code-block:: yaml .. code-block:: yaml
@ -522,7 +522,7 @@ The following example walks through the integration tests for the ``vyos.vyos.vy
tags: tags:
- cli - cli
``test/integration/targets/vyos_banner/tasks/cli.yaml`` ``test/integration/targets/vyos_l3_interfaces/tasks/cli.yaml``
.. code-block:: yaml .. code-block:: yaml
@ -549,46 +549,71 @@ The following example walks through the integration tests for the ``vyos.vyos.vy
loop_control: loop_control:
loop_var: test_case_to_run loop_var: test_case_to_run
``test/integration/targets/vyos_banner/tests/cli/basic-no-login.yaml`` ``test/integration/targets/vyos_l3_interfaces/tests/cli/overridden.yaml``
.. code-block:: yaml .. code-block:: yaml
--- ---
- debug: - debug:
msg: "cli/basic-no-login.yaml on connection={{ ansible_connection }}" msg: START vyos_l3_interfaces merged integration tests on connection={{ ansible_connection
}}
- name: Setup - include_tasks: _remove_config.yaml
vyos_banner:
banner: pre-login
text: |
Junk pre-login banner
over multiple lines
state: present
- name: remove pre-login - block:
vyos_banner:
banner: pre-login - include_tasks: _populate.yaml
state: absent
- name: Overrides all device configuration with provided configuration
register: result register: result
vyos.vyos.vyos_l3_interfaces: &id001
config:
- debug: - name: eth0
msg: "{{ result }}" ipv4:
- assert: - address: dhcp
- name: eth1
ipv4:
- address: 192.0.2.15/24
state: overridden
- name: Assert that before dicts were correctly generated
assert:
that: that:
- "result.changed == true" - "{{ populate | symmetric_difference(result['before']) |length == 0 }}"
- "'delete system login banner pre-login' in result.commands"
- name: remove pre-login (idempotent) - name: Assert that correct commands were generated
vyos_banner: assert:
banner: pre-login that:
state: absent - "{{ overridden['commands'] | symmetric_difference(result['commands'])\
\ |length == 0 }}"
- name: Assert that after dicts were correctly generated
assert:
that:
- "{{ overridden['after'] | symmetric_difference(result['after']) |length\
\ == 0 }}"
- name: Overrides all device configuration with provided configurations (IDEMPOTENT)
register: result register: result
vyos.vyos.vyos_l3_interfaces: *id001
- assert: - name: Assert that the previous task was idempotent
assert:
that: that:
- "result.changed == false" - result['changed'] == false
- "result.commands | length == 0"
- name: Assert that before dicts were correctly generated
assert:
that:
- "{{ overridden['after'] | symmetric_difference(result['before']) |length\
\ == 0 }}"
always:
- include_tasks: _remove_config.yaml
Detecting test resources at runtime Detecting test resources at runtime
@ -659,14 +684,14 @@ To run integration tests for a specific module:
.. code-block:: bash .. code-block:: bash
ansible-test network-integration --inventory /path/to-collection-module/test/integration/inventory.networking vyos_vlan ansible-test network-integration --inventory /path/to-collection-module/test/integration/inventory.networking vyos_l3_interfaces
To run a single test case on a specific module: To run a single test case on a specific module:
.. code-block:: bash .. code-block:: bash
# Only run vyos_vlan/tests/cli/basic.yaml # Only run vyos_l3_interfaces/tests/cli/gathered.yaml
ansible-test network-integration --inventory /path/to-collection-module/test/integration/inventory.networking vyos_vlan --testcase basic ansible-test network-integration --inventory /path/to-collection-module/test/integration/inventory.networking vyos_l3_interfaces --testcase gathered
To run integration tests for a specific transport: To run integration tests for a specific transport: