Merge pull request #39 from ansible-network/bt_add_network_dir_in_role

Add network dir in module utils, update import statements

Reviewed-by: https://github.com/ansible-zuul[bot]

Author: ansible-zuul[bot]

README.md

@@ -76,33 +76,37 @@ ansible-playbook -e parent=~/github/rm_example \
 │   │   └── myos_interfaces.py
 │   └── module_utils
 │       ├── __init__.py
-│       └── myos
-│           ├── argspec
-│           │   ├── facts
-│           │   │   ├── facts.py
-│           │   │   └── __init__.py
-│           │   ├── __init__.py
-│           │   └── interfaces
-│           │       ├── __init__.py
-│           │       └── interfaces.py
-│           ├── config
-│           │   ├── base.py
-│           │   ├── __init__.py
-│           │   └── interfaces
-│           │       ├── __init__.py
-│           │       └── interfaces.py
-│           ├── facts
-│           │   ├── base.py
-│           │   ├── facts.py
-│           │   ├── __init__.py
-│           │   └── interfaces
-│           │       ├── __init__.py
-│           │       └── interfaces.py
+│       └── network
 │           ├── __init__.py
-│           └── utils
+│           └── myos
+│               ├── argspec
+│               │   ├── facts
+│               │   │   ├── facts.py
+│               │   │   └── __init__.py
+│               │   ├── __init__.py
+│               │   └── interfaces
+│               │       ├── __init__.py
+│               │       └── interfaces.py
+│               ├── config
+│               │   ├── base.py
+│               │   ├── __init__.py
+│               │   └── interfaces
+│               │       ├── __init__.py
+│               │       └── interfaces.py
+│               ├── facts
+│               │   ├── base.py
+│               │   ├── facts.py
+│               │   ├── __init__.py
+│               │   └── interfaces
+│               │       ├── __init__.py
+│               │       └── interfaces.py
 │               ├── __init__.py
-│               └── utils.py
-└── roles
+│               └── utils
+│                   ├── __init__.py
+│                   └── utils.py
+├── README.md
+├── roles
+
  
 ```
 **Role directory layout**
@@ -118,40 +122,44 @@ ansible-playbook -e parent=~/github/rm_example/roles/my_role \
 ```
 
 ```
-└── roles
-    └── my_role
-        ├── library
-        │   ├── __init__.py
-        │   ├── myos_facts.py
-        │   └── myos_interfaces.py
-        └── module_utils
-            ├── __init__.py
-            └── myos
-                ├── argspec
-                │   ├── facts
-                │   │   ├── facts.py
-                │   │   └── __init__.py
-                │   ├── __init__.py
-                │   └── interfaces
-                │       ├── __init__.py
-                │       └── interfaces.py
-                ├── config
-                │   ├── base.py
-                │   ├── __init__.py
-                │   └── interfaces
-                │       ├── __init__.py
-                │       └── interfaces.py
-                ├── facts
-                │   ├── base.py
-                │   ├── facts.py
-                │   ├── __init__.py
-                │   └── interfaces
-                │       ├── __init__.py
-                │       └── interfaces.py
-                ├── __init__.py
-                └── utils
-                    ├── __init__.py
-                    └── utils.py
+roles
+└── my_role
+    ├── library
+    │   ├── __init__.py
+    │   ├── myos_facts.py
+    │   └── myos_interfaces.py
+    ├── LICENSE.txt
+    ├── module_utils
+    │   ├── __init__.py
+    │   └── network
+    │       ├── __init__.py
+    │       └── myos
+    │           ├── argspec
+    │           │   ├── facts
+    │           │   │   ├── facts.py
+    │           │   │   └── __init__.py
+    │           │   ├── __init__.py
+    │           │   └── interfaces
+    │           │       ├── __init__.py
+    │           │       └── interfaces.py
+    │           ├── config
+    │           │   ├── base.py
+    │           │   ├── __init__.py
+    │           │   └── interfaces
+    │           │       ├── __init__.py
+    │           │       └── interfaces.py
+    │           ├── facts
+    │           │   ├── base.py
+    │           │   ├── facts.py
+    │           │   ├── __init__.py
+    │           │   └── interfaces
+    │           │       ├── __init__.py
+    │           │       └── interfaces.py
+    │           ├── __init__.py
+    │           └── utils
+    │               ├── __init__.py
+    │               └── utils.py
+    └── README.md
 ```
 
 **Using the collection layout**

roles/resource_module/vars/main.yml

@@ -21,21 +21,22 @@ import_paths:
   role: ansible.module_utils
   collection: "ansible_collections.{{ collection_org|default('') }}.{{ collection_name|default('') }}.plugins.module_utils"
 
-import_path: "{{ import_paths[structure] }}"
+import_path: "{{ import_paths[structure] }}.network"
 
 # all the directories that need to be built
 resource_module_directories:
 - "{{ module_directory }}"
 - module_utils
-- module_utils/{{ network_os }}
-- module_utils/{{ network_os }}/argspec
-- module_utils/{{ network_os }}/argspec/facts
-- module_utils/{{ network_os }}/argspec/{{ resource }}
-- module_utils/{{ network_os }}/config
-- module_utils/{{ network_os }}/config/{{ resource }}
-- module_utils/{{ network_os }}/facts
-- module_utils/{{ network_os }}/facts/{{ resource }}
-- module_utils/{{ network_os }}/utils
+- module_utils/network
+- module_utils/network/{{ network_os }}
+- module_utils/network/{{ network_os }}/argspec
+- module_utils/network/{{ network_os }}/argspec/facts
+- module_utils/network/{{ network_os }}/argspec/{{ resource }}
+- module_utils/network/{{ network_os }}/config
+- module_utils/network/{{ network_os }}/config/{{ resource }}
+- module_utils/network/{{ network_os }}/facts
+- module_utils/network/{{ network_os }}/facts/{{ resource }}
+- module_utils/network/{{ network_os }}/utils
 
 # each of the files to be templated
 resource_module_templates:
@@ -49,26 +50,26 @@ resource_module_templates:
   destination: "{{ parent_directory }}/{{ module_directory }}/{{ network_os }}_facts.py"
   overwrite: False
 - source: module_utils/network_os/argspec/facts/facts.py.j2
-  destination: "{{ parent_directory}}/module_utils/{{ network_os }}/argspec/facts/facts.py"
+  destination: "{{ parent_directory}}/module_utils/network/{{ network_os }}/argspec/facts/facts.py"
   overwrite: False
 - source: module_utils/network_os/argspec/resource/resource.py.j2
-  destination: "{{ parent_directory }}/module_utils/{{ network_os }}/argspec/{{ resource }}/{{ resource }}.py"
+  destination: "{{ parent_directory }}/module_utils/network/{{ network_os }}/argspec/{{ resource }}/{{ resource }}.py"
   overwrite: True
 - source: module_utils/network_os/config/base.py.j2
-  destination: "{{ parent_directory }}/module_utils/{{ network_os }}/config/base.py"
+  destination: "{{ parent_directory }}/module_utils/network/{{ network_os }}/config/base.py"
   overwrite: False
 - source: module_utils/network_os/config/resource/resource.py.j2
-  destination: "{{ parent_directory }}/module_utils/{{ network_os }}/config/{{ resource }}/{{ resource }}.py"
+  destination: "{{ parent_directory }}/module_utils/network/{{ network_os }}/config/{{ resource }}/{{ resource }}.py"
   overwrite: False
 - source: module_utils/network_os/facts/base.py.j2
-  destination: "{{ parent_directory }}/module_utils/{{ network_os }}/facts/base.py"
+  destination: "{{ parent_directory }}/module_utils/network/{{ network_os }}/facts/base.py"
   overwrite: False
 - source: module_utils/network_os/facts/facts.py.j2
-  destination: "{{ parent_directory}}/module_utils/{{ network_os }}/facts/facts.py"
+  destination: "{{ parent_directory}}/module_utils/network/{{ network_os }}/facts/facts.py"
   overwrite: False
 - source: module_utils/network_os/facts/resource/resource.py.j2
-  destination: "{{ parent_directory}}/module_utils/{{ network_os }}/facts/{{ resource }}/{{ resource }}.py"
+  destination: "{{ parent_directory}}/module_utils/network/{{ network_os }}/facts/{{ resource }}/{{ resource }}.py"
   overwrite: False
 - source: module_utils/network_os/utils/utils.py.j2
-  destination: "{{ parent_directory}}/module_utils/{{ network_os }}/utils/utils.py"
+  destination: "{{ parent_directory}}/module_utils/network/{{ network_os }}/utils/utils.py"
   overwrite: False

tests/roles/my_role/library/myos_facts.py

@@ -10,7 +10,7 @@
 from __future__ import absolute_import, division, print_function
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.connection import Connection
-from ansible.module_utils. \
+from ansible.module_utils.network. \
     myos.facts.facts import Facts
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',

tests/roles/my_role/library/myos_interfaces.py

@@ -181,7 +181,7 @@
 
 # pylint: disable=C0413
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils. \
+from ansible.module_utils.network. \
     myos.config.interfaces.interfaces import Interfaces
 # pylint: enable=C0413