Adding changes for dyndns tests

[danlavu]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @danlavu, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the SSSD test framework by introducing new network utility functions and refining existing ones. It provides a dedicated method for managing hostnames, improves the nslookup utility for more straightforward test assertions, and adds a convenient way to configure SSSD's dynamic DNS features. These changes aim to streamline network-related test setups and improve the robustness of DNS-related test cases.

Highlights

• New hostname utility: Introduced a new hostname method in NetworkUtils to allow getting or setting the hostname of a host, with automatic rollback capabilities for testing.
• nslookup return type change: The nslookup method in NetworkUtils has been updated to return the integer exit code of the command, making it more direct and suitable for assertion checks in tests.
• Dynamic DNS configuration: Added a dyndns method to SSSDUtils to simplify the configuration of SSSD for dynamic DNS updates, including setting update flags, refresh intervals, and the DNS server.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new utility for managing the hostname, adds a common configuration for dynamic DNS, and adjusts the nslookup helper for easier use in test assertions. My review includes suggestions to improve the efficiency and correctness of the new hostname utility and to enhance the flexibility of the dyndns configuration helper by making its parameters configurable.

[danlavu]

Writing the tests now, but they do seem to work.

def test_dynamic_dns__updates_forward_records(client: Client, provider: GenericProvider):
    """
    :title: SSSD updates DNS A records
    :setup:
        1. Check for existing records
        2. Configure and start SSSD
    :steps:
        1. Lookup the hostname
    :expectedresults:
        1. Hostname is found
    :customerscenario: False
    """
    assert client.net.nslookup(f"{client.host.hostname} {provider.server}") != 0, f"Host {client.host.hostname} not found!"
    client.sssd.common.dyndns(provider, f"client.{provider.domain}")
    client.sssd.start()

    assert client.net.nslookup(f"{client.host.hostname} {provider.server}"), f"Host {client.host.hostname} was not found!"

collected 18 items / 15 deselected / 3 selected

tests/test_dynamic_dns.py::test_dynamic_dns__updates_forward_records (ad) 
tests/test_dynamic_dns.py::test_dynamic_dns__updates_forward_records (ipa) 
tests/test_dynamic_dns.py::test_dynamic_dns__updates_forward_records (samba) 

================= 3 passed, 15 deselected in 65.76s (0:01:05) ==================

UPDATE: There was a problem changing the hostname during the test. The teardown did not always work leaving the domain. Updated sssd.conf to contain *_hostname.

[spoore1]

Just one question about the nslookup return value. Running the provided test passes currently:

PASSED tests/test_dynamic_dns.py::test_dynamic_dns__updates_forward_records (ad)                                                                                                                                    
PASSED tests/test_dynamic_dns.py::test_dynamic_dns__updates_forward_records (ipa)                                                                                                                                   
PASSED tests/test_dynamic_dns.py::test_dynamic_dns__updates_forward_records (samba)                                                                                                                                 

[danlavu]

Just one question about the nslookup return value. Running the provided test passes currently:

PASSED tests/test_dynamic_dns.py::test_dynamic_dns__updates_forward_records (ad)                                                                                                                                    
PASSED tests/test_dynamic_dns.py::test_dynamic_dns__updates_forward_records (ipa)                                                                                                                                   
PASSED tests/test_dynamic_dns.py::test_dynamic_dns__updates_forward_records (samba)                                                                                                                                 

Actually, it wasn't working correctly. things like if there were two A records but resolved to the wrong ip. Having the return code be 0, but the wrong IP is found, was just messy and complicated.

[danlavu]

This test works.

from __future__ import annotations

import time

import pytest

from sssd_test_framework.misc import ip_to_ptr
from sssd_test_framework.roles.client import Client
from sssd_test_framework.roles.generic import GenericProvider
from sssd_test_framework.topology import KnownTopologyGroup


def create_ptr_zones(client: Client, provider: GenericProvider, device: str = "dummy0") -> None:
    """
    Create PTR zones.
    :param client: Client object.
    :type client: Client.
    :param provider: Provider object.
    :type provider: GenericProvider
    :param device: Network device name.
    :type device: str
    """
    provider.dns().clear_forwarders()
    ip_address = client.net.ip(device).address
    if ip_to_ptr(ip_address) not in provider.dns().list_zones():
        provider.dns().zone(ip_to_ptr(ip_address)).create()


def create_dummy_interface(
    client: Client, provider: GenericProvider, device: str | None = "dummy0"
) -> tuple[str, str | None]:
    """
    Create a dummy network interface on the client.
    :param client: Client object.
    :type client: Client.
    :param provider: GenericProvider object.
    :type provider: GenericProvider
    :param device: Name of the dummy network interface.
    :type device: str | None
    :return: IP and device name.
    :rtype: tuple[str, str | None]
    """
    if provider.server == "dc.ad.test":
        ip = "10.255.250.40"
        client.net.ip(device).add_device("10.255.250.40", "255.255.255.0")
    elif provider.server == "master.ipa.test":
        ip = "10.255.251.40"
        client.net.ip("dummy0").add_device("10.255.251.40", "255.255.255.0")
    elif provider.server == "dc.samba.test":
        ip = "10.255.252.40"
        client.net.ip("dummy0").add_device("10.255.252.40", "255.255.255.0")
    else:
        raise ValueError("Invalid provider server!")

    return ip, device

def check_records(client: Client, provider: GenericProvider, hostname: str) -> None:
    """
    Clean hostname records.
    :param client: Client object.
    :type client: Client.
    :param provider: GenericProvider object.
    :type provider: GenericProvider
    :param hostname: Hostname to clean A records for.
    :type hostname: str
    """
    records = client.net.dig(hostname, provider.server)
    if records is not None:
        for record in records:
            provider.dns().zone(provider.domain).delete_record(hostname.split(".")[0], record["data"])


@pytest.mark.topology(KnownTopologyGroup.AnyDC)
@pytest.mark.importance("critical")
def test_dyndns__enabled(client: Client, provider: GenericProvider):
    """
    :title: Dynamic DNS updates all records
    :setup:
        1. Create dummy interface
        2. Create reverse zones
        3. Check for existing records
        4. Configure and start SSSD
    :steps:
        1. Lookup hostname
        2. Lookup ipv4 address
    :expectedresults:
        1. Hostname is found
        2. IP address is found
    customerscenario: True
    """
    short_hostname = client.net.hostname(short=True)
    hostname = f"{short_hostname}.{provider.domain}"
    ip, device = create_dummy_interface(client, provider)
    create_ptr_zones(client, provider)
    check_records(client, provider, hostname)
    client.sssd.common.dyndns()
    client.sssd.start()

    time.sleep(15)

    assert client.net.dig(hostname, provider.server), f"Host {hostname} was not found!"
    assert any(r["data"] == ip for r in client.net.dig(hostname, provider.server)), f"Host {hostname} found with invalid ip!"
    assert client.net.dig(ip, provider.server), f"PTR record for {ip} was not found!"
    assert any(r["data"] == hostname for r in client.net.dig(ip, provider.server)), f"Host {hostname} found with invalid ip!"