Add aggregate for junos modules and sub spec validation (#27726)

* Add aggregate for junos modules and sub spec validation

*  aggregate support of junos modules
*  aggregate sub spec validation
*  relevant changes to junos integration test
*  junos module boilerplate changes

* Add new boilerplate for junos modules

* Fix CI issues

lib/ansible/modules/network/junos/junos_l3_interface.py

@@ -2,22 +2,11 @@
 # -*- coding: utf-8 -*-
 
 # (c) 2017, Ansible by Red Hat, inc
-#
-# This file is part of Ansible by Red Hat
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
 
 ANSIBLE_METADATA = {'metadata_version': '1.0',
                     'status': ['preview'],
@@ -80,6 +69,25 @@ EXAMPLES = """
   junos_l3_interface:
     name: ge-0/0/1
     state: absent
+
+- name: Set ipv4 address using aggregate
+  junos_l3_interface:
+    aggregate:
+    - name: ge-0/0/1
+      ipv4: 1.1.1.1
+    - name: ge-0/0/2
+      ipv4: 2.2.2.2
+      ipv6: fd5d:12c9:2201:2::2
+
+- name: Delete ipv4 address using aggregate
+  junos_l3_interface:
+    aggregate:
+    - name: ge-0/0/1
+      ipv4: 1.1.1.1
+      state: absent
+    - name: ge-0/0/2
+      ipv4: 2.2.2.2
+      state: absent
 """
 
 RETURN = """
@@ -95,10 +103,12 @@ diff:
 """
 import collections
 
+from copy import copy
+
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.junos import junos_argument_spec, check_args
 from ansible.module_utils.junos import load_config, map_params_to_obj, map_obj_to_ele
-from ansible.module_utils.junos import commit_configuration, discard_changes, locked_config
+from ansible.module_utils.junos import commit_configuration, discard_changes, locked_config, to_param_list
 
 try:
     from lxml.etree import tostring
@@ -111,23 +121,35 @@ USE_PERSISTENT_CONNECTION = True
 def main():
     """ main entry point for module execution
     """
-    argument_spec = dict(
-        name=dict(required=True),
+    element_spec = dict(
+        name=dict(),
         ipv4=dict(),
         ipv6=dict(),
         unit=dict(default=0, type='int'),
-        aggregate=dict(),
-        purge=dict(default=False, type='bool'),
         state=dict(default='present', choices=['present', 'absent']),
         active=dict(default=True, type='bool')
     )
 
+    aggregate_spec = copy(element_spec)
+    aggregate_spec['name'] = dict(required=True)
+
+    argument_spec = dict(
+        aggregate=dict(type='list', elements='dict', options=aggregate_spec),
+        purge=dict(default=False, type='bool')
+    )
+
+    argument_spec.update(element_spec)
     argument_spec.update(junos_argument_spec)
 
-    required_one_of = [['ipv4', 'ipv6']]
+    required_one_of = [['name', 'aggregate']]
+
+    mutually_exclusive = [['name', 'aggregate'],
+                          ['state', 'aggregate'],
+                          ['active', 'aggregate']]
 
     module = AnsibleModule(argument_spec=argument_spec,
                            supports_check_mode=True,
+                           mutually_exclusive=mutually_exclusive,
                            required_one_of=required_one_of)
 
     warnings = list()
@@ -148,11 +170,21 @@ def main():
         ('ipv6', {'xpath': 'inet6/address/name', 'top': 'unit/family', 'is_key': True})
     ])
 
-    want = map_params_to_obj(module, param_to_xpath_map)
-    ele = map_obj_to_ele(module, want, top)
+    params = to_param_list(module)
 
+    requests = list()
+    for param in params:
+        item = copy(param)
+        if not item['ipv4'] and not item['ipv6']:
+            module.fail_json(msg="one of the following is required: ipv4,ipv6")
+
+        want = map_params_to_obj(module, param_to_xpath_map, param=item)
+        requests.append(map_obj_to_ele(module, want, top, param=item))
+
+    diff = None
     with locked_config(module):
-        diff = load_config(module, tostring(ele), warnings, action='replace')
+        for req in requests:
+            diff = load_config(module, tostring(req), warnings, action='replace')
 
         commit = not module.check_mode
         if diff: