# -*- coding: utf-8 -*-
# Copyright 2021 Red Hat
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

"""
Test plugin file for netaddr tests: multicast
"""

from __future__ import absolute_import, division, print_function
from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
    ip_address,
    _need_ipaddress,
)
from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
    _validate_args,
)


__metaclass__ = type

DOCUMENTATION = """
    name: multicast
    author: Priyam Sahoo (@priyamsahoo)
    version_added: "2.2.0"
    short_description: Test for a multicast IP address
    description:
        - This plugin checks if the provided value is a valid multicast IP address
    options:
        ip:
            description:
            - A string that represents the value against which the test is going to be performed
            - For example:
                - "224.0.0.1"
                - "127.0.0.1"
            type: str
            required: True
    notes:
"""

EXAMPLES = r"""

- name: Check if 224.0.0.1 is a valid multicast IP address
  ansible.builtin.set_fact:
    data: "{{ '224.0.0.1' is ansible.utils.multicast }}"

# TASK [Check if 224.0.0.1 is a valid multicast IP address] **********************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

- name: Check if ff02::1 is a valid multicast IP address
  ansible.builtin.set_fact:
    data: "{{ 'ff02::1' is ansible.utils.multicast }}"

# TASK [Check if ff02::1 is a valid multicast IP address] ***************************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

- name: Check if 127.0.0.1 is not a valid multicast IP address
  ansible.builtin.set_fact:
    data: "{{ '127.0.0.1' is not ansible.utils.multicast }}"

# TASK [Check if 127.0.0.1 is not a valid multicast IP address] *********************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

- name: Check if helloworld is not a valid multicast IP address
  ansible.builtin.set_fact:
    data: "{{ 'helloworld' is not ansible.utils.multicast }}"

# TASK [Check if helloworld is not a valid multicast IP address] ********************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

"""

RETURN = """
  data:
    description:
      - If jinja test satisfies plugin expression C(true)
      - If jinja test does not satisfy plugin expression C(false)
"""


@_need_ipaddress
def _multicast(ip):
    """Test for a multicast IP address"""

    params = {"ip": ip}
    _validate_args("multicast", DOCUMENTATION, params)

    try:
        return ip_address(ip).is_multicast
    except Exception:
        return False


class TestModule(object):
    """network jinja test"""

    test_map = {"multicast": _multicast}

    def tests(self):
        return self.test_map