root/lib/libnv/tests/cnv_tests.cc
/*-
 * Copyright (c) 2016 Adam Starak <starak.adam@gmail.com>
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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 AUTHORS 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 <sys/cdefs.h>
#include <sys/cnv.h>
#include <sys/nv.h>
#include <sys/types.h>

#include <atf-c++.hpp>
#include <fcntl.h>
#include <errno.h>

#define fd_is_valid(fd) (fcntl((fd), F_GETFL) != -1 || errno != EBADF)

/* ATF cnvlist_get tests. */

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_bool);
ATF_TEST_CASE_BODY(cnvlist_get_bool)
{
        nvlist_t *nvl;
        const char *key;
        bool value;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        value = true;

        nvlist_add_bool(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_BOOL);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_bool(nvl, key));

        ATF_REQUIRE_EQ(cnvlist_get_bool(cookie), value);

        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_number);
ATF_TEST_CASE_BODY(cnvlist_get_number)
{
        nvlist_t *nvl;
        const char *key;
        uint64_t value;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        value = 420;

        nvlist_add_number(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NUMBER);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_number(nvl, key));

        ATF_REQUIRE_EQ(cnvlist_get_number(cookie), value);

        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}


ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_string);
ATF_TEST_CASE_BODY(cnvlist_get_string)
{
        nvlist_t *nvl;
        const char *key;
        const char *value;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        value = "text";

        nvlist_add_string(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_STRING);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_string(nvl, key));

        ATF_REQUIRE_EQ(strcmp(cnvlist_get_string(cookie), value), 0);

        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_nvlist);
ATF_TEST_CASE_BODY(cnvlist_get_nvlist)
{
        nvlist_t *nvl, *value;
        const nvlist_t *result;
        const char *key, *subkey;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        value = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        key = "name";
        subkey = "subname";
        cookie = NULL;

        /* Add null to 'value' nvlist. */
        nvlist_add_null(value, subkey);
        ATF_REQUIRE_EQ(strcmp(subkey, nvlist_next(value, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(value), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NULL);
        ATF_REQUIRE(!nvlist_empty(value));
        ATF_REQUIRE(nvlist_exists(value, subkey));
        ATF_REQUIRE(nvlist_exists_null(value, subkey));
        ATF_REQUIRE_EQ(nvlist_next(value, &type, &cookie),
                       static_cast<const char *>(NULL));

        /* Add 'value' nvlist. */
        cookie = NULL;
        nvlist_add_nvlist(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NVLIST);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_nvlist(nvl, key));

        /*
         * Assuming nvlist_get_nvlist() is correct check if cnvlist returns
         * the same pointer.
         */
        result = cnvlist_get_nvlist(cookie);
        ATF_REQUIRE_EQ(result, nvlist_get_nvlist(nvl, key));
        ATF_REQUIRE(result != value);
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
                       static_cast<const char *>(NULL));

        /* Validate data inside nvlist. */
        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(subkey, nvlist_next(result, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(result), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NULL);
        ATF_REQUIRE(!nvlist_empty(result));
        ATF_REQUIRE(nvlist_exists(result, subkey));
        ATF_REQUIRE(nvlist_exists_null(result, subkey));
        ATF_REQUIRE_EQ(nvlist_next(result, &type, &cookie),
                       static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
        nvlist_destroy(value);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_descriptor);
ATF_TEST_CASE_BODY(cnvlist_get_descriptor)
{
        nvlist_t *nvl;
        const char *key;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";

        nvlist_add_descriptor(nvl, key, STDERR_FILENO);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_DESCRIPTOR);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_descriptor(nvl, key));

        ATF_REQUIRE_EQ(fd_is_valid(cnvlist_get_descriptor(cookie)), 1);

        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_binary);
ATF_TEST_CASE_BODY(cnvlist_get_binary)
{
        nvlist_t *nvl;
        const char *key;
        void *in_binary;
        const void *out_binary;
        void *cookie;
        int type;
        size_t in_size, out_size;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        in_size = 13;

        in_binary = malloc(in_size);
        ATF_REQUIRE(in_binary != NULL);
        memset(in_binary, 0xa5, in_size);

        nvlist_add_binary(nvl, key, in_binary, in_size);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_BINARY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_binary(nvl, key));

        out_binary = cnvlist_get_binary(cookie, &out_size);
        ATF_REQUIRE_EQ(out_size, in_size);
        ATF_REQUIRE_EQ(memcmp(in_binary, out_binary, out_size), 0);

        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

/* ATF cnvlist_get array tests. */

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_bool_array);
ATF_TEST_CASE_BODY(cnvlist_get_bool_array)
{
        nvlist_t *nvl;
        bool in_array[16];
        const bool *out_array;
        const char *key;
        void *cookie;
        int type, i;
        size_t nitems;

        for (i = 0; i < 16; i++)
                in_array[i] = (i % 2 == 0);

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";

        nvlist_add_bool_array(nvl, key, in_array, 16);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_BOOL_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_bool_array(nvl, key));

        out_array = cnvlist_get_bool_array(cookie, &nitems);
        ATF_REQUIRE_EQ(nitems, 16);
        ATF_REQUIRE(out_array != NULL);
        for (i = 0; i < 16; i++)
                ATF_REQUIRE_EQ(out_array[i], in_array[i]);

        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_number_array);
ATF_TEST_CASE_BODY(cnvlist_get_number_array)
{
        nvlist_t *nvl;
        uint64_t in_array[16];
        const uint64_t *out_array;
        const char *key;
        void *cookie;
        int type, i;
        size_t nitems;

        for (i = 0; i < 16; i++)
                in_array[i] = i;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";

        nvlist_add_number_array(nvl, key, in_array, 16);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NUMBER_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_number_array(nvl, key));

        out_array = cnvlist_get_number_array(cookie, &nitems);
        ATF_REQUIRE(out_array != NULL);
        ATF_REQUIRE_EQ(nitems, 16);
        for (i = 0; i < 16; i++)
                ATF_REQUIRE_EQ(out_array[i], in_array[i]);

        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_string_array);
ATF_TEST_CASE_BODY(cnvlist_get_string_array)
{
        nvlist_t *nvl;
        const char *in_array[4] = {"inequality", "sucks", ".", ""};
        const char * const *out_array;
        const char *key;
        void *cookie;
        int type, i;
        size_t nitems;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";

        nvlist_add_string_array(nvl, key, in_array, 4);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_STRING_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_string_array(nvl, key));

        out_array = cnvlist_get_string_array(cookie, &nitems);
        ATF_REQUIRE_EQ(nitems, 4);
        ATF_REQUIRE(out_array != NULL);
        for (i = 0; i < 4; i++) {
                ATF_REQUIRE(out_array[i] != NULL);
                ATF_REQUIRE_EQ(strcmp(out_array[i], in_array[i]), 0);
        }

        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_nvlist_array);
ATF_TEST_CASE_BODY(cnvlist_get_nvlist_array)
{
        nvlist_t *nvl;
        nvlist_t *in_array[6];
        const nvlist_t * const *out_array;
        const nvlist_t * const *out_result;
        void *cookie;
        const char *key;
        const char *subkeys;
        int type, i;
        size_t nitems;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        subkeys = "123456";
        for (i = 0; i < 6; i++) {
                in_array[i] = nvlist_create(0);
                ATF_REQUIRE(in_array[i] != NULL);
                ATF_REQUIRE_EQ(nvlist_error(in_array[i]), 0);
                ATF_REQUIRE(nvlist_empty(in_array[i]));

                cookie = NULL;

                nvlist_add_null(in_array[i], subkeys+i);
                ATF_REQUIRE_EQ(strcmp(subkeys+i, nvlist_next(in_array[i],
                    &type, &cookie)),0);
                ATF_REQUIRE_EQ(nvlist_error(in_array[i]), 0);
                ATF_REQUIRE_EQ(type, NV_TYPE_NULL);
                ATF_REQUIRE(!nvlist_empty(in_array[i]));
                ATF_REQUIRE(nvlist_exists(in_array[i], subkeys+i));
                ATF_REQUIRE(nvlist_exists_null(in_array[i], subkeys+i));
                ATF_REQUIRE_EQ(nvlist_next(in_array[i], &type, &cookie),
                    static_cast<const char *>(NULL));
        }

        cookie = NULL;
        key = "name";

        nvlist_add_nvlist_array(nvl, key, in_array, 6);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NVLIST_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_nvlist_array(nvl, key));

        /* Get nvlist array by cnvlist function. */
        out_array = cnvlist_get_nvlist_array(cookie, &nitems);
        ATF_REQUIRE(out_array != NULL);
        ATF_REQUIRE_EQ(nitems, 6);
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        /* Get nvlist array by nvlist function. */
        out_result = nvlist_get_nvlist_array(nvl, key, &nitems);
        ATF_REQUIRE(out_result != NULL);
        ATF_REQUIRE_EQ(nitems, 6);

        /* Validate assuming that nvlist returned a proper pointer */
        for (i = 0; i < 6; i++) {
                ATF_REQUIRE_EQ(out_result[i], out_array[i]);
                ATF_REQUIRE(out_array[i] != in_array[i]);

                /* Validate data inside nvlist. */
                cookie = NULL;
                ATF_REQUIRE_EQ(strcmp(subkeys+i, nvlist_next(out_array[i],
                    &type, &cookie)), 0);
                ATF_REQUIRE_EQ(nvlist_error(out_array[i]), 0);
                ATF_REQUIRE_EQ(type, NV_TYPE_NULL);
                ATF_REQUIRE(!nvlist_empty(out_array[i]));
                ATF_REQUIRE(nvlist_exists(out_array[i], subkeys+i));
                ATF_REQUIRE(nvlist_exists_null(out_array[i], subkeys+i));
                ATF_REQUIRE_EQ(nvlist_next(out_array[i], &type, &cookie),
                    static_cast<const char *>(NULL));
        }

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_get_descriptor_array);
ATF_TEST_CASE_BODY(cnvlist_get_descriptor_array)
{
        nvlist_t *nvl;
        size_t count, i, nitems;
        const int *out_array;
        int *in_array, type;
        const char *key;
        void *cookie;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        count = 50;

        in_array = static_cast<int *>(malloc(sizeof(*in_array)*count));
        ATF_REQUIRE(in_array != NULL);
        for (i = 0; i < count; i++) {
                in_array[i] = dup(STDERR_FILENO);
                ATF_REQUIRE(fd_is_valid(in_array[i]));
        }

        nvlist_add_descriptor_array(nvl, key, in_array, count);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_DESCRIPTOR_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_descriptor_array(nvl, key));

        out_array = cnvlist_get_descriptor_array(cookie, &nitems);
        ATF_REQUIRE_EQ(nitems, count);
        ATF_REQUIRE(out_array != NULL);
        for (i = 0; i < count; i++)
                ATF_REQUIRE_EQ(fd_is_valid(out_array[i]), 1);

        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

/* ATF cnvlist_take tests. */

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_take_bool);
ATF_TEST_CASE_BODY(cnvlist_take_bool)
{
        nvlist_t *nvl;
        const char *key;
        bool value;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        value = true;

        nvlist_add_bool(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_BOOL);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_bool(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(cnvlist_take_bool(cookie), value);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_bool(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_take_number);
ATF_TEST_CASE_BODY(cnvlist_take_number)
{
        nvlist_t *nvl;
        const char *key;
        uint64_t value;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        value = 69;

        nvlist_add_number(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NUMBER);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_number(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(cnvlist_take_number(cookie), value);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_number(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_take_string);
ATF_TEST_CASE_BODY(cnvlist_take_string)
{
        nvlist_t *nvl;
        const char *key;
        const char *value;
        char *out_string;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        value = "text";

        nvlist_add_string(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_STRING);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_string(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        out_string = cnvlist_take_string(cookie);
        ATF_REQUIRE(out_string != NULL);
        ATF_REQUIRE_EQ(strcmp(out_string, value), 0);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_string(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        free(out_string);
        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_take_nvlist);
ATF_TEST_CASE_BODY(cnvlist_take_nvlist)
{
        nvlist_t *nvl, *value, *result;
        const char *key, *subkey;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        value = nvlist_create(0);
        ATF_REQUIRE(value != NULL);
        ATF_REQUIRE_EQ(nvlist_error(value), 0);
        ATF_REQUIRE(nvlist_empty(value));

        key = "name";
        subkey = "subname";
        cookie = NULL;

        /* Add null to 'value' nvlist. */
        nvlist_add_null(value, subkey);
        ATF_REQUIRE_EQ(strcmp(subkey, nvlist_next(value, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(value), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NULL);
        ATF_REQUIRE(!nvlist_empty(value));
        ATF_REQUIRE(nvlist_exists(value, subkey));
        ATF_REQUIRE(nvlist_exists_null(value, subkey));
        ATF_REQUIRE_EQ(nvlist_next(value, &type, &cookie),
            static_cast<const char *>(NULL));

        /* Add 'value' nvlist. */
        cookie = NULL;
        nvlist_move_nvlist(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NVLIST);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_nvlist(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        result = cnvlist_take_nvlist(cookie);
        ATF_REQUIRE(!nvlist_exists_nvlist(nvl, key));
        ATF_REQUIRE(result == value);

        /* Validate data inside nvlist. */
        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(subkey, nvlist_next(result, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(value), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NULL);
        ATF_REQUIRE(!nvlist_empty(value));
        ATF_REQUIRE(nvlist_exists(value, subkey));
        ATF_REQUIRE(nvlist_exists_null(value, subkey));
        ATF_REQUIRE_EQ(nvlist_next(value, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
        nvlist_destroy(value);
}

/* ATF cnvlist_take array tests */

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_take_bool_array);
ATF_TEST_CASE_BODY(cnvlist_take_bool_array)
{
        nvlist_t *nvl;
        bool in_array[16];
        const bool *out_array;
        const char *key;
        void *cookie;
        int type, i;
        size_t nitems;

        for (i = 0; i < 16; i++)
                in_array[i] = (i % 2 == 0);

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";

        nvlist_add_bool_array(nvl, key, in_array, 16);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_BOOL_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_bool_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        out_array = cnvlist_take_bool_array(cookie, &nitems);
        ATF_REQUIRE_EQ(nitems, 16);
        ATF_REQUIRE(out_array != NULL);
        for (i = 0; i < 16; i++)
                ATF_REQUIRE_EQ(out_array[i], in_array[i]);

        cookie = NULL;
        ATF_REQUIRE(!nvlist_exists_bool_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));


        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_take_number_array);
ATF_TEST_CASE_BODY(cnvlist_take_number_array)
{
        nvlist_t *nvl;
        uint64_t in_array[16];
        const uint64_t *out_array;
        const char *key;
        void *cookie;
        int type, i;
        size_t nitems;

        for (i = 0; i < 16; i++)
                in_array[i] = i;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";

        nvlist_add_number_array(nvl, key, in_array, 16);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NUMBER_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_number_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        out_array = cnvlist_take_number_array(cookie, &nitems);

        ATF_REQUIRE(out_array != NULL);
        ATF_REQUIRE_EQ(nitems, 16);
        for (i = 0; i < 16; i++)
                ATF_REQUIRE_EQ(out_array[i], in_array[i]);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_number_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_take_string_array);
ATF_TEST_CASE_BODY(cnvlist_take_string_array)
{
        nvlist_t *nvl;
        const char *in_array[4] = {"inequality", "sks", ".", ""};
        char **out_array;
        const char *key;
        void *cookie;
        int type, i;
        size_t nitems;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";

        nvlist_add_string_array(nvl, key, in_array, 4);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_STRING_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_string_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        out_array = cnvlist_take_string_array(cookie, &nitems);
        ATF_REQUIRE_EQ(nitems, 4);
        for (i = 0; i < 4; i++) {
                ATF_REQUIRE(out_array[i] != NULL);
                ATF_REQUIRE_EQ(strcmp(out_array[i], in_array[i]), 0);
        }
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_number_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        free(out_array);
        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_take_nvlist_array);
ATF_TEST_CASE_BODY(cnvlist_take_nvlist_array)
{
        nvlist_t *testnvl[8];
        nvlist_t **result;
        nvlist_t *nvl;
        void *cookie;
        size_t num_items;
        unsigned int i;
        int type;
        const char *somestr[8] = { "a", "b", "c", "d", "e", "f", "g", "h" };
        const char *key;

        for (i = 0; i < 8; i++) {
                testnvl[i] = nvlist_create(0);
                ATF_REQUIRE(testnvl[i] != NULL);
                ATF_REQUIRE_EQ(nvlist_error(testnvl[i]), 0);
                ATF_REQUIRE(nvlist_empty(testnvl[i]));
                nvlist_add_string(testnvl[i], "nvl/string", somestr[i]);

                cookie = NULL;
                ATF_REQUIRE_EQ(strcmp("nvl/string", nvlist_next(testnvl[i],
                    &type, &cookie)), 0);
                ATF_REQUIRE_EQ(nvlist_error(testnvl[i]), 0);
                ATF_REQUIRE_EQ(type, NV_TYPE_STRING);
                ATF_REQUIRE(!nvlist_empty(testnvl[i]));
                ATF_REQUIRE(nvlist_exists(testnvl[i], "nvl/string"));
                ATF_REQUIRE(nvlist_exists_string(testnvl[i], "nvl/string"));
                ATF_REQUIRE_EQ(nvlist_next(testnvl[i], &type, &cookie),
                    static_cast<const char *>(NULL));
        }

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        key = "nvl/nvlist";
        cookie = NULL;

        nvlist_add_nvlist_array(nvl, key, (const nvlist_t * const *)testnvl, 8);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NVLIST_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_nvlist_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        result = cnvlist_take_nvlist_array(cookie, &num_items);

        ATF_REQUIRE(result != NULL);
        ATF_REQUIRE_EQ(num_items, 8);
        for (i = 0; i < num_items; i++) {
                ATF_REQUIRE_EQ(nvlist_error(result[i]), 0);
                ATF_REQUIRE(nvlist_get_array_next(result[i]) == NULL);
        }

        ATF_REQUIRE(!nvlist_exists_string_array(nvl, key));
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_nvlist_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        for (i = 0; i < 8; i++) {
                nvlist_destroy(result[i]);
                nvlist_destroy(testnvl[i]);
        }

        free(result);
        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_take_binary);
ATF_TEST_CASE_BODY(cnvlist_take_binary)
{
        nvlist_t *nvl;
        const char *key;
        void *in_binary;
        const void *out_binary;
        void *cookie;
        int type;
        size_t in_size, out_size;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        in_size = 13;
        in_binary = malloc(in_size);
        ATF_REQUIRE(in_binary != NULL);
        memset(in_binary, 0xa5, in_size);

        nvlist_add_binary(nvl, key, in_binary, in_size);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_BINARY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_binary(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        out_binary = cnvlist_take_binary(cookie, &out_size);
        ATF_REQUIRE_EQ(out_size, in_size);
        ATF_REQUIRE_EQ(memcmp(in_binary, out_binary, out_size), 0);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_binary(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

/* ATF cnvlist_free tests. */

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_free_bool);
ATF_TEST_CASE_BODY(cnvlist_free_bool)
{
        nvlist_t *nvl;
        const char *key;
        bool value;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        value = true;

        nvlist_add_bool(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_BOOL);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_bool(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        cnvlist_free_bool(cookie);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_bool(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_free_number);
ATF_TEST_CASE_BODY(cnvlist_free_number)
{
        nvlist_t *nvl;
        const char *key;
        uint64_t value;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        value = 69;

        nvlist_add_number(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NUMBER);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_number(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        cnvlist_free_number(cookie);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_number(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_free_string);
ATF_TEST_CASE_BODY(cnvlist_free_string)
{
        nvlist_t *nvl;
        const char *key;
        const char *value;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        value = "text";

        nvlist_add_string(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_STRING);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_string(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        cnvlist_free_string(cookie);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_string(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_free_nvlist);
ATF_TEST_CASE_BODY(cnvlist_free_nvlist)
{
        nvlist_t *nvl, *value;
        const char *key, *subkey;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        value = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        key = "name";
        subkey = "subname";
        cookie = NULL;

        /* Add null to 'value' nvlist. */
        nvlist_add_null(value, subkey);
        ATF_REQUIRE_EQ(strcmp(subkey, nvlist_next(value, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(value), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NULL);
        ATF_REQUIRE(!nvlist_empty(value));
        ATF_REQUIRE(nvlist_exists(value, subkey));
        ATF_REQUIRE(nvlist_exists_null(value, subkey));
        ATF_REQUIRE_EQ(nvlist_next(value, &type, &cookie),
            static_cast<const char *>(NULL));

        /* Add 'value' nvlist. */
        cookie = NULL;
        nvlist_move_nvlist(nvl, key, value);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NVLIST);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_nvlist(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        cnvlist_free_nvlist(cookie);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_nvlist(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_free_binary);
ATF_TEST_CASE_BODY(cnvlist_free_binary)
{
        nvlist_t *nvl;
        const char *key;
        void *in_binary;
        void *cookie;
        int type;
        size_t in_size;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";
        in_size = 13;
        in_binary = malloc(in_size);
        ATF_REQUIRE(in_binary != NULL);
        memset(in_binary, 0xa5, in_size);

        nvlist_add_binary(nvl, key, in_binary, in_size);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_BINARY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_binary(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        cnvlist_free_binary(cookie);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_nvlist(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

/* ATF cnvlist_free array tests. */

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_free_bool_array);
ATF_TEST_CASE_BODY(cnvlist_free_bool_array)
{
        nvlist_t *nvl;
        bool in_array[16];
        const char *key;
        void *cookie;
        int type, i;

        for (i = 0; i < 16; i++)
                in_array[i] = (i % 2 == 0);

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";

        nvlist_add_bool_array(nvl, key, in_array, 16);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_BOOL_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_bool_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        cnvlist_free_bool_array(cookie);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_bool(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_free_number_array);
ATF_TEST_CASE_BODY(cnvlist_free_number_array)
{
        nvlist_t *nvl;
        uint64_t in_array[16];
        const char *key;
        void *cookie;
        int type, i;

        for (i = 0; i < 16; i++)
                in_array[i] = i;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";

        nvlist_add_number_array(nvl, key, in_array, 16);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NUMBER_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_number_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        cnvlist_free_number_array(cookie);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_number_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_free_string_array);
ATF_TEST_CASE_BODY(cnvlist_free_string_array)
{
        nvlist_t *nvl;
        const char *in_array[4] = {"inequality", "sucks", ".", ""};
        const char *key;
        void *cookie;
        int type;

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        cookie = NULL;
        key = "name";

        nvlist_add_string_array(nvl, key, in_array, 4);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_STRING_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_string_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        cnvlist_free_string_array(cookie);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_string_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        nvlist_destroy(nvl);
}

ATF_TEST_CASE_WITHOUT_HEAD(cnvlist_free_nvlist_array);
ATF_TEST_CASE_BODY(cnvlist_free_nvlist_array)
{
        nvlist_t *testnvl[8];
        nvlist_t *nvl;
        void *cookie;
        unsigned int i;
        int type;
        const char *somestr[8] = { "a", "b", "c", "d", "e", "f", "g", "h" };
        const char *key;

        for (i = 0; i < 8; i++) {
                testnvl[i] = nvlist_create(0);
                ATF_REQUIRE(testnvl[i] != NULL);
                ATF_REQUIRE_EQ(nvlist_error(testnvl[i]), 0);
                ATF_REQUIRE(nvlist_empty(testnvl[i]));
                nvlist_add_string(testnvl[i], "nvl/string", somestr[i]);

                cookie = NULL;
                ATF_REQUIRE_EQ(strcmp("nvl/string", nvlist_next(testnvl[i],
                    &type, &cookie)), 0);
                ATF_REQUIRE_EQ(nvlist_error(testnvl[i]), 0);
                ATF_REQUIRE_EQ(type, NV_TYPE_STRING);
                ATF_REQUIRE(!nvlist_empty(testnvl[i]));
                ATF_REQUIRE(nvlist_exists(testnvl[i], "nvl/string"));
                ATF_REQUIRE(nvlist_exists_string(testnvl[i], "nvl/string"));
                ATF_REQUIRE_EQ(nvlist_next(testnvl[i], &type, &cookie),
                    static_cast<const char *>(NULL));
        }

        nvl = nvlist_create(0);
        ATF_REQUIRE(nvl != NULL);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));

        key = "nvl/nvlist";
        cookie = NULL;

        nvlist_add_nvlist_array(nvl, key, (const nvlist_t * const *)testnvl, 8);
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE_EQ(type, NV_TYPE_NVLIST_ARRAY);
        ATF_REQUIRE(!nvlist_empty(nvl));
        ATF_REQUIRE(nvlist_exists(nvl, key));
        ATF_REQUIRE(nvlist_exists_nvlist_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        cookie = NULL;
        ATF_REQUIRE_EQ(strcmp(key, nvlist_next(nvl, &type, &cookie)), 0);
        cnvlist_free_nvlist_array(cookie);

        cookie = NULL;
        ATF_REQUIRE_EQ(nvlist_error(nvl), 0);
        ATF_REQUIRE(nvlist_empty(nvl));
        ATF_REQUIRE(!nvlist_exists(nvl, key));
        ATF_REQUIRE(!nvlist_exists_nvlist_array(nvl, key));
        ATF_REQUIRE_EQ(nvlist_next(nvl, &type, &cookie),
            static_cast<const char *>(NULL));

        for (i = 0; i < 8; i++)
                nvlist_destroy(testnvl[i]);
        nvlist_destroy(nvl);
}

ATF_INIT_TEST_CASES(tp)
{
        ATF_ADD_TEST_CASE(tp, cnvlist_get_bool);
        ATF_ADD_TEST_CASE(tp, cnvlist_get_bool_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_get_number);
        ATF_ADD_TEST_CASE(tp, cnvlist_get_string);
        ATF_ADD_TEST_CASE(tp, cnvlist_get_nvlist);
        ATF_ADD_TEST_CASE(tp, cnvlist_get_descriptor);
        ATF_ADD_TEST_CASE(tp, cnvlist_get_binary);
        ATF_ADD_TEST_CASE(tp, cnvlist_get_number_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_get_string_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_get_nvlist_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_get_descriptor_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_take_bool);
        ATF_ADD_TEST_CASE(tp, cnvlist_take_number);
        ATF_ADD_TEST_CASE(tp, cnvlist_take_string);
        ATF_ADD_TEST_CASE(tp, cnvlist_take_nvlist);
        ATF_ADD_TEST_CASE(tp, cnvlist_take_binary);
        ATF_ADD_TEST_CASE(tp, cnvlist_take_bool_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_take_number_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_take_string_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_take_nvlist_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_free_bool);
        ATF_ADD_TEST_CASE(tp, cnvlist_free_number);
        ATF_ADD_TEST_CASE(tp, cnvlist_free_string);
        ATF_ADD_TEST_CASE(tp, cnvlist_free_nvlist);
        ATF_ADD_TEST_CASE(tp, cnvlist_free_binary);
        ATF_ADD_TEST_CASE(tp, cnvlist_free_bool_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_free_number_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_free_string_array);
        ATF_ADD_TEST_CASE(tp, cnvlist_free_nvlist_array);
}