litespeed-quic/tests/test_hcsi_reader.c

/* Copyright (c) 2017 - 2022 LiteSpeed Technologies Inc.  See LICENSE. */
#include <assert.h>
#include <inttypes.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <sys/queue.h>

#include "lsquic.h"
#include "lsquic_int_types.h"
#include "lsquic_varint.h"
#include "lsquic_hq.h"
#include "lsquic_hcsi_reader.h"
#include "lsquic_hash.h"
#include "lsquic_conn.h"

struct test
{
    int             lineno;

    enum {
        TEST_NO_FLAGS           = 0,
        TEST_NUL_OUT_LEST_FULL  = 1 << 0,
    }               flags;

    unsigned char   input[0x100];
    size_t          input_sz;

    int             retval;
    char            output[0x1000];
};


static const struct test tests[] =
{
    {
        __LINE__,
        TEST_NO_FLAGS,
        {
            0x03,
            0x04,
            0x80, 0x12, 0x34, 0x45,
        },
        6,
        0,
        "on_cancel_push: 1193029\n",
    },

    {
        __LINE__,
        TEST_NO_FLAGS,
        {
            HQFT_MAX_PUSH_ID,
            0x02,
            0x41, 0x23,
        },
        4,
        0,
        "on_max_push_id: 291\n",
    },

    {
        __LINE__,
        TEST_NO_FLAGS,
        {
            HQFT_SETTINGS,
            0x00,
        },
        2,
        0,
        "have SETTINGS frame\n",
    },

    {   /* Frame contents do not match frame length */
        __LINE__,
        TEST_NO_FLAGS,
        {
            HQFT_MAX_PUSH_ID,
            0x03,
            0x41, 0x23,
        },
        4,
        -1,
        "",
    },

    {
        __LINE__,
        TEST_NO_FLAGS,
        {
            HQFT_SETTINGS,
            13,
            0x52, 0x34,
            0xC0, 0x12, 0x23, 0x34, 0x45, 0x56, 0x67, 0x78,
            0x52, 0x35,
            0x00,
        },
        15,
        0,
        "on_setting: 0x1234=0x12233445566778\n"
        "on_setting: 0x1235=0x0\n"
        "have SETTINGS frame\n"
        ,
    },

    {
        __LINE__,
        TEST_NO_FLAGS,
        {
            0x80, 0x0F, 0x07, 0x00, /* HQFT_PRIORITY_UPDATE_STREAM */
            7,
            0x52, 0x34,
            0x41, 0x42, 0x43, 0x44, 0x45,   /* ABCDE */
            HQFT_MAX_PUSH_ID,
            0x02,
            0x41, 0x23,
        },
        16,
        0,
        "on_priority_update: stream=0x1234, [ABCDE]\n"
        "on_max_push_id: 291\n"
        ,
    },

    {
        __LINE__,
        TEST_NO_FLAGS,
        {
            0x80, 0x0F, 0x07, 0x01, /* HQFT_PRIORITY_UPDATE_PUSH */
            6,
            0x08,
            0x50, 0x51, 0x52, 0x53, 0x54,   /* PQRST */
        },
        11,
        0,
        "on_priority_update: push=0x8, [PQRST]\n"
        ,
    },

    {
        __LINE__,
        TEST_NUL_OUT_LEST_FULL,
        {
            0x80, 0x0F, 0x07, 0x01, /* HQFT_PRIORITY_UPDATE_PUSH */
            21,
            0x08,
            0x50, 0x51, 0x52, 0x53, 0x54,   /* PQRST */
            0x50, 0x51, 0x52, 0x53, 0x54,   /* PQRST */
            0x50, 0x51, 0x52, 0x53, 0x54,   /* PQRST */
            0x50, 0x51, 0x52, 0x53, 0x54,   /* PQRST */
        },
        26,
        0,
        "on_priority_update: push=0x8, [PQRSTPQRSTPQRSTPQRST]\n"
        ,
    },

};


static void
on_cancel_push (void *ctx, uint64_t push_id)
{
    fprintf(ctx, "%s: %"PRIu64"\n", __func__, push_id);
}

static void
on_max_push_id (void *ctx, uint64_t push_id)
{
    fprintf(ctx, "%s: %"PRIu64"\n", __func__, push_id);
}

static void
on_settings_frame (void *ctx)
{
    fprintf(ctx, "have SETTINGS frame\n");
}

static void
on_setting (void *ctx, uint64_t setting_id, uint64_t value)
{
    fprintf(ctx, "%s: 0x%"PRIX64"=0x%"PRIX64"\n", __func__, setting_id, value);
}

static void
on_goaway (void *ctx, uint64_t stream_id)
{
    fprintf(ctx, "%s: %"PRIu64"\n", __func__, stream_id);
}

static void
on_frame_error (void *ctx, unsigned code, uint64_t frame_type)
{
    fprintf(ctx, "%s: %"PRIu64"\n", __func__, frame_type);
}

static void
on_priority_update (void *ctx, enum hq_frame_type frame_type,
                            /* PFV: Priority Field Value */
                            uint64_t id, const char *pfv, size_t pfv_sz)
{
    const char *type;

    switch (frame_type)
    {
    case HQFT_PRIORITY_UPDATE_STREAM:  type = "stream"; break;
    case HQFT_PRIORITY_UPDATE_PUSH:    type = "push"; break;
    default:                    assert(0); return;
    }

    fprintf(ctx, "%s: %s=0x%"PRIX64", [%.*s]\n", __func__, type, id,
                                                        (int) pfv_sz, pfv);
}

static const struct hcsi_callbacks callbacks =
{
    .on_cancel_push         = on_cancel_push,
    .on_max_push_id         = on_max_push_id,
    .on_settings_frame      = on_settings_frame,
    .on_setting             = on_setting,
    .on_goaway              = on_goaway,
    .on_frame_error         = on_frame_error,
    .on_priority_update     = on_priority_update,
};


static void
abort_error (struct lsquic_conn *conn, int is_app, unsigned error_code,
                                                    const char *format, ...)
{
}


static const struct conn_iface conn_iface = {
    .ci_abort_error     = abort_error,
};


static void
run_test (const struct test *test)
{
    struct hcsi_reader reader;
    size_t read_sz, out_sz, toread;
    FILE *out_f;
    char *output;
    const unsigned char *p;
    int s;
    struct lsquic_conn lconn = LSCONN_INITIALIZER_CIDLEN(lconn, 0);
    lconn.cn_if = &conn_iface;

    for (read_sz = 1; read_sz <= test->input_sz; ++read_sz)
    {
        out_f = open_memstream(&output, &out_sz);
        lsquic_hcsi_reader_init(&reader, &lconn, &callbacks, out_f);
        reader.hr_flag |= HR_FLAG_RCVD_SETTING;

        p = test->input;
        do
        {
            toread = test->input + test->input_sz - p;
            if (toread > read_sz)
                toread = read_sz;
            s = lsquic_hcsi_reader_feed(&reader, p, toread);
            if (s != 0)
                break;
            p += toread;
        }
        while (p < test->input + test->input_sz);

        assert(s == test->retval);

        fclose(out_f);
        if (test->retval == 0 && read_sz < test->input_sz
                                    && (test->flags & TEST_NUL_OUT_LEST_FULL))
            assert(0 == strcmp(output, ""));
        else
            assert(0 == strcmp(test->output, output));
        free(output);
    }
}

int
main (void)
{
    const struct test *test;
    struct test coalesced_test;

    for (test = tests; test < tests + sizeof(tests) / sizeof(tests[0]); ++test)
        run_test(test);

    memset(&coalesced_test, 0, sizeof(coalesced_test));
    for (test = tests; test < tests + sizeof(tests) / sizeof(tests[0]); ++test)
        if (test->retval == 0 && !(test->flags & TEST_NUL_OUT_LEST_FULL))
        {
            memcpy(coalesced_test.input + coalesced_test.input_sz,
                    test->input, test->input_sz);
            coalesced_test.input_sz += test->input_sz;
            strcat(coalesced_test.output, test->output);
        }
    run_test(&coalesced_test);

    return 0;
}