tests/unit/test_netif.cpp

/*
 *  Copyright (c) 2019, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#include <stdarg.h>

#include "test_platform.h"

#include <openthread/config.h>

#include "common/debug.hpp"
#include "common/instance.hpp"
#include "net/netif.hpp"

#include "test_util.h"

namespace ot {

class TestNetif : public Ip6::Netif
{
public:
    TestNetif(Instance &aInstance)
        : Ip6::Netif(aInstance)
    {
    }

    // Provide `protected` methods in `Netif` as `public` from `TestNetif`
    // so that we can verify their behavior in this test
    otError SubscribeAllNodesMulticast(void) { return Ip6::Netif::SubscribeAllNodesMulticast(); }
    otError UnsubscribeAllNodesMulticast(void) { return Ip6::Netif::UnsubscribeAllNodesMulticast(); }
};

// This function verifies the multicast addresses on Netif matches the list of given addresses.
void VerifyMulticastAddressList(const Ip6::Netif &aNetif, Ip6::Address aAddresses[], uint8_t aLength)
{
    uint8_t count = 0;

    for (uint8_t i = 0; i < aLength; i++)
    {
        VerifyOrQuit(aNetif.IsMulticastSubscribed(aAddresses[i]), "IsMulticastSubscribed() failed");
    }

    for (const Ip6::NetifMulticastAddress *addr = aNetif.GetMulticastAddresses(); addr; addr = addr->GetNext())
    {
        bool didFind = false;

        for (uint8_t i = 0; i < aLength; i++)
        {
            if (addr->GetAddress() == aAddresses[i])
            {
                didFind = true;
                break;
            }
        }

        VerifyOrQuit(didFind, "Netif multicast address is missing from expected address list");
        count++;
    }

    VerifyOrQuit(count == aLength, "Expected address is missing from Netif address list");
}

void TestNetifMulticastAddresses(void)
{
    const uint8_t kMaxAddresses = 8;

    Instance *   instance = testInitInstance();
    TestNetif    netif(*instance);
    Ip6::Address addresses[kMaxAddresses];

    Ip6::Address               address;
    Ip6::NetifMulticastAddress netifAddress;

    const char *kLinkLocalAllNodes    = "ff02::01";
    const char *kRealmLocalAllNodes   = "ff03::01";
    const char *kRealmLocalAllMpl     = "ff03::fc";
    const char *kLinkLocalAllRouters  = "ff02::02";
    const char *kRealmLocalAllRouters = "ff03::02";
    const char *kTestAddress1         = "ff02::114";
    const char *kTestAddress2         = "ff03::114";
    const char *kTestAddress3         = "ff04::114";

    addresses[0].FromString(kLinkLocalAllRouters);
    addresses[1].FromString(kRealmLocalAllRouters);
    addresses[2].FromString(kLinkLocalAllNodes);
    addresses[3].FromString(kRealmLocalAllNodes);
    addresses[4].FromString(kRealmLocalAllMpl);
    addresses[5].FromString(kTestAddress1);
    addresses[6].FromString(kTestAddress2);
    addresses[7].FromString(kTestAddress3);

    VerifyMulticastAddressList(netif, addresses, 0);

    SuccessOrQuit(netif.SubscribeAllNodesMulticast(), "SubscribeAllNodesMulticast() failed");

    VerifyMulticastAddressList(netif, &addresses[2], 3);

    VerifyOrQuit(netif.SubscribeAllNodesMulticast() == OT_ERROR_ALREADY,
                 "SubscribeAllNodesMulticast() did not fail when already subscribed");

    SuccessOrQuit(netif.SubscribeAllRoutersMulticast(), "SubscribeAllRoutersMulticast() failed");
    VerifyMulticastAddressList(netif, &addresses[0], 5);

    VerifyOrQuit(netif.SubscribeAllRoutersMulticast() == OT_ERROR_ALREADY,
                 "SubscribeAllRoutersMulticast() did not fail when already subscribed");

    SuccessOrQuit(netif.UnsubscribeAllRoutersMulticast(), "UnsubscribeAllRoutersMulticast() failed");
    VerifyMulticastAddressList(netif, &addresses[2], 3);

    VerifyOrQuit(netif.UnsubscribeAllRoutersMulticast() == OT_ERROR_NOT_FOUND,
                 "UnsubscribeAllRoutersMulticast() did not fail when not subscribed");

    netifAddress.GetAddress().FromString(kTestAddress1);
    SuccessOrQuit(netif.SubscribeMulticast(netifAddress), "SubscribeMulticast() failed");
    VerifyMulticastAddressList(netif, &addresses[2], 4);

    VerifyOrQuit(netif.SubscribeMulticast(netifAddress) == OT_ERROR_ALREADY,
                 "SubscribeMulticast() did not fail when address was already subscribed");

    SuccessOrQuit(netif.UnsubscribeAllNodesMulticast(), "UnsubscribeAllNodesMulticast() failed");
    VerifyMulticastAddressList(netif, &addresses[5], 1);

    VerifyOrQuit(netif.UnsubscribeAllNodesMulticast() == OT_ERROR_NOT_FOUND,
                 "UnsubscribeAllNodesMulticast() did not fail when not subscribed");

    address.FromString(kTestAddress2);
    SuccessOrQuit(netif.SubscribeExternalMulticast(address), "SubscribeExternalMulticast() failed");
    VerifyMulticastAddressList(netif, &addresses[5], 2);

    SuccessOrQuit(netif.SubscribeAllNodesMulticast(), "SubscribeAllNodesMulticast() failed");
    VerifyMulticastAddressList(netif, &addresses[2], 5);

    VerifyOrQuit(netif.SubscribeExternalMulticast(address) == OT_ERROR_ALREADY,
                 "SubscribeExternalMulticast() did not fail when address was already subscribed");

    SuccessOrQuit(netif.SubscribeAllRoutersMulticast(), "SubscribeAllRoutersMulticast() failed");
    VerifyMulticastAddressList(netif, &addresses[0], 7);

    VerifyOrQuit(netif.SubscribeAllRoutersMulticast() == OT_ERROR_ALREADY,
                 "SubscribeAllRoutersMulticast() did not fail when already subscribed");

    address.FromString(kTestAddress3);
    SuccessOrQuit(netif.SubscribeExternalMulticast(address), "SubscribeExternalMulticast() failed");
    VerifyMulticastAddressList(netif, &addresses[0], 8);

    address.FromString(kTestAddress1); // same as netifAddress (internal)
    VerifyOrQuit(netif.UnsubscribeExternalMulticast(address) == OT_ERROR_INVALID_ARGS,
                 "UnsubscribeExternalMulticast() did not fail when address was not external");

    address.FromString(kRealmLocalAllMpl);
    VerifyOrQuit(netif.UnsubscribeExternalMulticast(address) == OT_ERROR_INVALID_ARGS,
                 "UnsubscribeExternalMulticast() did not fail when address was fixed address");

    SuccessOrQuit(netif.UnsubscribeAllRoutersMulticast(), "UnsubscribeAllRoutersMulticast() failed");
    VerifyMulticastAddressList(netif, &addresses[2], 6);

    VerifyOrQuit(netif.UnsubscribeAllRoutersMulticast() == OT_ERROR_NOT_FOUND,
                 "UnsubscribeAllRoutersMulticast() did not fail when not subscribed");

    netif.UnsubscribeAllExternalMulticastAddresses();
    VerifyMulticastAddressList(netif, &addresses[2], 4);

    SuccessOrQuit(netif.UnsubscribeMulticast(netifAddress), "UnsubscribeMulticast() failed");
    VerifyMulticastAddressList(netif, &addresses[2], 3);

    VerifyOrQuit(netif.UnsubscribeMulticast(netifAddress) == OT_ERROR_NOT_FOUND,
                 "UnsubscribeMulticast() did not fail when address was not subscribed");

    SuccessOrQuit(netif.UnsubscribeAllNodesMulticast(), "UnsubscribeAllNodesMulticast() failed");
    VerifyMulticastAddressList(netif, NULL, 0);

    // The first five elements in `addresses[]` are the default/fixed addresses:
    // kLinkLocalAllRouters, kRealmLocalAllRouters, kLinkLocalAllNodes,
    // kRealmLocalAllNodes, and kRealmLocalAllMpl. Verify that we cannot add
    // any of them as an external multicast address.

    for (uint8_t i = 0; i < 5; i++)
    {
        VerifyOrQuit(netif.SubscribeExternalMulticast(addresses[i]) == OT_ERROR_INVALID_ARGS,
                     "SubscribeExternalMulticast() did not fail when address was a default/fixed address");
    }
}

} // namespace ot

int main(void)
{
    ot::TestNetifMulticastAddresses();
    printf("All tests passed\n");
    return 0;
}