Merge pull request #43 from ansible-network/bt_prep_for_test_scaffolding

Prep for test scaffolding

Reviewed-by: Bradley A. Thornton
             https://github.com/cidrblock

Author: ansible-zuul[bot]

README.md

@@ -21,21 +21,21 @@ pip install jsonref
 ```
 
 ```
-ansible-playbook -e parent=<parent> \
+ansible-playbook -e rm_dest=<destination for modules and module utils> \
                  -e structure=role \
                  -e model=<model> \
                  site.yml
 ```
 or
 ```
-ansible-playbook -e parent=<parent> \
+ansible-playbook -e rm_dest=<destination for modules and module utils> \
                  -e structure=collection \
                  -e collection_org=<collection_org> \
                  -e collection_name=<collection_name> \
                  -e model=<model> \
                  site.yml
 ```
-- `parent`: The parent directory in which the files and directories should be placed
+- `rm_dest`: The directory in which the files and directories for the resource module and facts modules should be placed
 - `structure`: The directory layout to be generated (role|collection)
   - `role`: Generate a role directory layout
   - `collection`: Generate a collection directory layout
@@ -55,7 +55,7 @@ See the `models` directory for an example.
 - `resource`: interfaces
 
 ```
-ansible-playbook -e parent=~/github/rm_example \
+ansible-playbook -e rm_dest=~/github/rm_example \
                  -e structure=collection \
                  -e collection_org=cidrblock \
                  -e collection_name=my_collection \
@@ -115,7 +115,7 @@ ansible-playbook -e parent=~/github/rm_example \
 - `resource`: interfaces
 
 ```
-ansible-playbook -e parent=~/github/rm_example/roles/my_role \
+ansible-playbook -e rm_dest=~/github/rm_example/roles/my_role \
                  -e structure=role \
                  -e model=models/myos/interfaces/myos_interfaces.yml \
                  site.yml
@@ -262,7 +262,7 @@ def main():
 The tests rely on a role generated by the resource module builder. After changes to the resource module builder, the role should be regenerated and the tests modified and run as needed.  To generate the role after changes:
 
 ```
-ansible-playbook -e parent=./rmb_tests/roles/my_role \
+ansible-playbook -e rm_dest=./rmb_tests/roles/my_role \
                  -e structure=role \
                  -e model=models/myos/interfaces/myos_interfaces.yml \
                  site.yml

roles/init/tasks/main.yml

@@ -1,6 +1,6 @@
-- name: Ensure 'parent' variable is set (see README.md)
+- name: Ensure 'rm_dest' variable is set (see README.md)
   assert:
-    that: parent is defined
+    that: rm_dest is defined
 
 - name: Ensure 'structure' variable is set and one of 'role' or 'collection' (see README.md)
   assert:
@@ -25,14 +25,14 @@
 
 - name: "Create the {{ structure }} directory structure"
   file:
-    path: "{{ parent }}/{{ item }}"
+    path: "{{ rm_dest }}/{{ item }}"
     state: directory
   with_items: "{{ directories[structure] }}"
 
-- name: Copy the license file to the parent directory
+- name: Copy the license file to the resource module destination directory
   copy:
     src: "{{ rm['LICENSE'] | default('gpl-3.0.txt') }}"
-    dest: "{{ parent }}/LICENSE.txt"
+    dest: "{{ rm_dest }}/LICENSE.txt"
 
 - name: Ensure the 'collection_org' is set when 'structure' is set to collection
   assert: