text: #
  # -*- coding: utf-8 -*-
  # Copyright 2019 Red Hat
  # GNU General Public License v3.0+
  # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
  """
  The junos_lacp_interfaces class
  It is in this file where the current configuration (as dict)
  is compared to the provided configuration (as dict) and the command set
  necessary to bring the current configuration to it's desired end-state is
  created
  """
  from __future__ import absolute_import, division, print_function
  
  __metaclass__ = type
  
  from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
      ConfigBase,
  )
  from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
      to_list,
  )
  from ansible_collections.junipernetworks.junos.plugins.module_utils.network.junos.facts.facts import (
      Facts,
  )
  from ansible_collections.junipernetworks.junos.plugins.module_utils.network.junos.junos import (
      locked_config,
      load_config,
      commit_configuration,
      discard_changes,
      tostring,
  )
  from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.netconf import (
      build_root_xml_node,
      build_child_xml_node,
      build_subtree,
  )
  
  
  class Lacp_interfaces(ConfigBase):
      """
      The junos_lacp_interfaces class
      """
  
      gather_subset = ["!all", "!min"]
  
      gather_network_resources = ["lacp_interfaces"]
  
      def __init__(self, module):
          super(Lacp_interfaces, self).__init__(module)
  
      def get_lacp_interfaces_facts(self, data=None):
          """ Get the 'facts' (the current configuration)
          :rtype: A dictionary
          :returns: The current configuration as a dictionary
          """
          facts, _warnings = Facts(self._module).get_facts(
              self.gather_subset, self.gather_network_resources, data=data
          )
          lacp_interfaces_facts = facts["ansible_network_resources"].get(
              "lacp_interfaces"
          )
          if not lacp_interfaces_facts:
              return []
          return lacp_interfaces_facts
  
      def execute_module(self):
          """ Execute the module
          :rtype: A dictionary
          :returns: The result from module execution
          """
          result = {"changed": False}
          state = self._module.params["state"]
  
          if self.state in self.ACTION_STATES:
              existing_lacp_interfaces_facts = self.get_lacp_interfaces_facts()
          else:
              existing_lacp_interfaces_facts = []
  
          if state == "gathered":
              existing_lacp_interfaces_facts = self.get_lacp_interfaces_facts()
              result["gathered"] = existing_lacp_interfaces_facts
          elif self.state == "parsed":
              running_config = self._module.params["running_config"]
              if not running_config:
                  self._module.fail_json(
                      msg="value of running_config parameter must not be empty for state parsed"
                  )
              result["parsed"] = self.get_lacp_interfaces_facts(
                  data=running_config
              )
          elif self.state == "rendered":
              config_xmls = self.set_config(existing_lacp_interfaces_facts)
              if config_xmls:
                  result["rendered"] = config_xmls[0]
              else:
                  result["rendered"] = ""
  
          else:
              config_xmls = self.set_config(existing_lacp_interfaces_facts)
              with locked_config(self._module):
                  for config_xml in to_list(config_xmls):
                      diff = load_config(self._module, config_xml, [])
  
                  commit = not self._module.check_mode
                  if diff:
                      if commit:
                          commit_configuration(self._module)
                      else:
                          discard_changes(self._module)
                      result["changed"] = True
  
                      if self._module._diff:
                          result["diff"] = {"prepared": diff}
  
              result["commands"] = config_xmls
  
              changed_interfaces_facts = self.get_lacp_interfaces_facts()
  
              result["before"] = existing_lacp_interfaces_facts
              if result["changed"]:
                  result["after"] = changed_interfaces_facts
          return result
  
      def set_config(self, existing_lacp_interfaces_facts):
          """ Collect the configuration from the args passed to the module,
              collect the current configuration (as a dict from facts)
          :rtype: A list
          :returns: the commands necessary to migrate the current configuration
                    to the desired configuration
          """
          want = self._module.params["config"]
          have = existing_lacp_interfaces_facts
          resp = self.set_state(want, have)
          return to_list(resp)
  
      def set_state(self, want, have):
          """ Select the appropriate function based on the state provided
          :param want: the desired configuration as a dictionary
          :param have: the current configuration as a dictionary
          :rtype: A list
          :returns: the commands necessary to migrate the current configuration
                    to the desired configuration
          """
          root = build_root_xml_node("interfaces")
          state = self._module.params["state"]
          if (
              state in ("merged", "replaced", "overridden", "rendered")
              and not want
          ):
              self._module.fail_json(
                  msg="value of config parameter must not be empty for state {0}".format(
                      state
                  )
              )
          if state == "overridden":
              config_xmls = self._state_overridden(want, have)
          elif state == "deleted":
              config_xmls = self._state_deleted(want, have)
          elif state in ("merged", "rendered"):
              config_xmls = self._state_merged(want, have)
          elif state == "replaced":
              config_xmls = self._state_replaced(want, have)
  
          for xml in config_xmls:
              root.append(xml)
  
          return tostring(root)
  
      def _state_replaced(self, want, have):
          """ The xml configuration generator when state is replaced
          :rtype: A list
          :returns: the xml configuration necessary to migrate the current configuration
                    to the desired configuration
          """
          intf_xml = []
          intf_xml.extend(self._state_deleted(want, have))
          intf_xml.extend(self._state_merged(want, have))
  
          return intf_xml
  
      def _state_overridden(self, want, have):
          """ The xml configuration generator when state is overridden
          :rtype: A list
          :returns: the xml configuration necessary to migrate the current configuration
                    to the desired configuration
          """
          interface_xmls_obj = []
          # replace interface config with data in want
          interface_xmls_obj.extend(self._state_replaced(want, have))
  
          # delete interface config if interface in have not present in want
          delete_obj = []
          for have_obj in have:
              for want_obj in want:
                  if have_obj["name"] == want_obj["name"]:
                      break
              else:
                  delete_obj.append(have_obj)
  
          if delete_obj:
              interface_xmls_obj.extend(self._state_deleted(delete_obj, have))
          return interface_xmls_obj
  
      def _state_merged(self, want, have):
          """ The xml configuration generator when state is merged
           :rtype: A list
           :returns: the xml configuration necessary to merge the provided into
                     the current configuration
           """
          intf_xml = []
  
          for config in want:
              lacp_intf_name = config["name"]
              lacp_intf_root = build_root_xml_node("interface")
  
              build_child_xml_node(lacp_intf_root, "name", lacp_intf_name)
              if lacp_intf_name.startswith("ae"):
                  element = build_subtree(
                      lacp_intf_root, "aggregated-ether-options/lacp"
                  )
                  if config["period"]:
                      build_child_xml_node(element, "periodic", config["period"])
                  if config["sync_reset"]:
                      build_child_xml_node(
                          element, "sync-reset", config["sync_reset"]
                      )
  
                  system = config["system"]
                  if system:
                      mac = system.get("mac")
                      if mac:
                          if mac.get("address"):
                              build_child_xml_node(
                                  element, "system-id", mac["address"]
                              )
                      if system.get("priority"):
                          build_child_xml_node(
                              element, "system-priority", system["priority"]
                          )
                  intf_xml.append(lacp_intf_root)
              elif config["port_priority"] or config["force_up"] is not None:
                  element = build_subtree(
                      lacp_intf_root, "ether-options/ieee-802.3ad/lacp"
                  )
                  if config["port_priority"] is not None:
                      build_child_xml_node(
                          element, "port-priority", config["port_priority"]
                      )
                  else:
                      build_child_xml_node(
                          element, "port-priority", None, {"delete": "delete"}
                      )
                  if config["force_up"]:
                      build_child_xml_node(element, "force-up")
                  else:
                      build_child_xml_node(
                          element, "force-up", None, {"delete": "delete"}
                      )
                  intf_xml.append(lacp_intf_root)
  
          return intf_xml
  
      def _state_deleted(self, want, have):
          """ The xml configuration generator when state is deleted
          :rtype: A list
          :returns: the xml configuration necessary to remove the current configuration
                    of the provided objects
          """
          intf_xml = []
          intf_obj = want
  
          if not intf_obj:
              # delete lag interfaces attribute for all the interface
              intf_obj = have
  
          for config in intf_obj:
              lacp_intf_name = config["name"]
              lacp_intf_root = build_root_xml_node("interface")
              build_child_xml_node(lacp_intf_root, "name", lacp_intf_name)
              if lacp_intf_name.startswith("ae"):
                  element = build_subtree(
                      lacp_intf_root, "aggregated-ether-options/lacp"
                  )
                  build_child_xml_node(
                      element, "periodic", None, {"delete": "delete"}
                  )
                  build_child_xml_node(
                      element, "sync-reset", None, {"delete": "delete"}
                  )
                  build_child_xml_node(
                      element, "system-id", None, {"delete": "delete"}
                  )
                  build_child_xml_node(
                      element, "system-priority", None, {"delete": "delete"}
                  )
              else:
                  element = build_subtree(
                      lacp_intf_root, "ether-options/ieee-802.3ad/lacp"
                  )
                  build_child_xml_node(
                      element, "port-priority", None, {"delete": "delete"}
                  )
                  build_child_xml_node(
                      element, "force-up", None, {"delete": "delete"}
                  )
  
              intf_xml.append(lacp_intf_root)
  
          return intf_xml
  