<filename>venv/lib/python3.6/site-packages/ansible_collections/ansible/utils/plugins/test/subnet_of.py
# -*- 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: subnet_of
"""

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

__metaclass__ = type

DOCUMENTATION = """
    name: subnet_of
    author: <NAME> (@priyamsahoo)
    version_added: "2.2.0"
    short_description: Test if a network is a subnet of another network
    description:
        - This plugin checks if the first network is a subnet of the second network amongst the provided network addresses
    options:
        network_a:
            description:
            - A string that represents the first network address
            - For example:
                - "10.1.1.0/24"
            type: str
            required: True
        network_b:
            description:
            - A string that represents the second network address
            - For example:
                - "10.0.0.0/8"
            type: str
            required: True
    notes:
"""

EXAMPLES = r"""

- name: Check if 10.1.1.0/24 is a subnet of 10.0.0.0/8
  ansible.builtin.set_fact:
    data: "{{ '10.1.1.0/24' is ansible.utils.subnet_of '10.0.0.0/8' }}"

# TASK [Check if 10.1.1.0/24 is a subnet of 10.0.0.0/8] **************************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

- name: Check if 192.168.1.0/24 is not a subnet of 10.0.0.0/8
  ansible.builtin.set_fact:
    data: "{{ '192.168.1.0/24' is not ansible.utils.subnet_of '10.0.0.0/8' }}"

# TASK [Check if 192.168.1.0/24 is not a subnet of 10.0.0.0/8] *******************
# 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 _subnet_of(network_a, network_b):
    """ Test if a network is a subnet of another network """

    params = {"network_a": network_a, "network_b": network_b}
    _validate_args("subnet_of", DOCUMENTATION, params)

    try:
        return _is_subnet_of(ip_network(network_a), ip_network(network_b))
    except Exception:
        return False


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

    test_map = {"subnet_of": _subnet_of}

    def tests(self):
        return self.test_map

<filename>venv/lib/python3.6/site-packages/ansible_collections/ansible/utils/plugins/test/subnet_of.py
# -*- 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: subnet_of
"""

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

__metaclass__ = type

DOCUMENTATION = """
    name: subnet_of
    author: <NAME> (@priyamsahoo)
    version_added: "2.2.0"
    short_description: Test if a network is a subnet of another network
    description:
        - This plugin checks if the first network is a subnet of the second network amongst the provided network addresses
    options:
        network_a:
            description:
            - A string that represents the first network address
            - For example:
                - "10.1.1.0/24"
            type: str
            required: True
        network_b:
            description:
            - A string that represents the second network address
            - For example:
                - "10.0.0.0/8"
            type: str
            required: True
    notes:
"""

EXAMPLES = r"""

- name: Check if 10.1.1.0/24 is a subnet of 10.0.0.0/8
  ansible.builtin.set_fact:
    data: "{{ '10.1.1.0/24' is ansible.utils.subnet_of '10.0.0.0/8' }}"

# TASK [Check if 10.1.1.0/24 is a subnet of 10.0.0.0/8] **************************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

- name: Check if 192.168.1.0/24 is not a subnet of 10.0.0.0/8
  ansible.builtin.set_fact:
    data: "{{ '192.168.1.0/24' is not ansible.utils.subnet_of '10.0.0.0/8' }}"

# TASK [Check if 192.168.1.0/24 is not a subnet of 10.0.0.0/8] *******************
# 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 _subnet_of(network_a, network_b):
    """ Test if a network is a subnet of another network """

    params = {"network_a": network_a, "network_b": network_b}
    _validate_args("subnet_of", DOCUMENTATION, params)

    try:
        return _is_subnet_of(ip_network(network_a), ip_network(network_b))
    except Exception:
        return False


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

    test_map = {"subnet_of": _subnet_of}

    def tests(self):
        return self.test_map

# -*- 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: subnet_of name: subnet_of     author: <NAME> (@priyamsahoo)     version_added: "2.2.0"     short_description: Test if a network is a subnet of another network     description:         - This plugin checks if the first network is a subnet of the second network amongst the provided network addresses     options:         network_a:             description:             - A string that represents the first network address             - For example:                 - "10.1.1.0/24"             type: str             required: True         network_b:             description:             - A string that represents the second network address             - For example:                 - "10.0.0.0/8"             type: str             required: True     notes: - name: Check if 10.1.1.0/24 is a subnet of 10.0.0.0/8   ansible.builtin.set_fact:     data: "{{ '10.1.1.0/24' is ansible.utils.subnet_of '10.0.0.0/8' }}"  # TASK [Check if 10.1.1.0/24 is a subnet of 10.0.0.0/8] ************************** # ok: [localhost] => { #     "ansible_facts": { #         "data": true #     }, #     "changed": false # }  - name: Check if 192.168.1.0/24 is not a subnet of 10.0.0.0/8   ansible.builtin.set_fact:     data: "{{ '192.168.1.0/24' is not ansible.utils.subnet_of '10.0.0.0/8' }}"  # TASK [Check if 192.168.1.0/24 is not a subnet of 10.0.0.0/8] ******************* # ok: [localhost] => { #     "ansible_facts": { #         "data": true #     }, #     "changed": false # } data:     description:       - If jinja test satisfies plugin expression C(true)       - If jinja test does not satisfy plugin expression C(false) Test if a network is a subnet of another network network jinja test