test_stream_flags.c File Reference

Tests Stream Header and Stream Footer coders. More...

#include "tests.h"

Go to the source code of this file.

Functions
static bool	validate (void)
static bool	test_header_decoder (lzma_ret expected_ret)
static void	test_header (void)
static bool	test_footer_decoder (lzma_ret expected_ret)
static void	test_footer (void)
static void	test_encode_invalid (void)
static void	test_decode_invalid (void)
int	main (void)

Variables
static lzma_stream_flags	known_flags
static lzma_stream_flags	decoded_flags
static uint8_t	buffer [LZMA_STREAM_HEADER_SIZE]

Detailed Description

Tests Stream Header and Stream Footer coders.

Definition in file test_stream_flags.c.

Function Documentation

main()

int main

(

void

)

Definition at line 165 of file test_stream_flags.c.

{
    // Valid headers
    known_flags.backward_size = 1024;
    for (lzma_check check = LZMA_CHECK_NONE;
            check <= LZMA_CHECK_ID_MAX; ++check) {
        test_header();
        test_footer();
    }
 
    // Invalid headers
    test_encode_invalid();
    test_decode_invalid();
 
    return 0;
}

References lzma_stream_flags::backward_size, check, known_flags, LZMA_CHECK_ID_MAX, LZMA_CHECK_NONE, test_decode_invalid(), test_encode_invalid(), test_footer(), and test_header().

test_decode_invalid()

static void test_decode_invalid ( void  )

static

Definition at line 122 of file test_stream_flags.c.

{
    known_flags.check = LZMA_CHECK_NONE;
    known_flags.backward_size = 1024;
 
    expect(lzma_stream_header_encode(&known_flags, buffer) == LZMA_OK);
 
    // Test 1 (invalid Magic Bytes)
    buffer[5] ^= 1;
    succeed(test_header_decoder(LZMA_FORMAT_ERROR));
    buffer[5] ^= 1;
 
    // Test 2a (valid CRC32)
    uint32_t crc = lzma_crc32(buffer + 6, 2, 0);
    write32le(buffer + 8, crc);
    succeed(test_header_decoder(LZMA_OK));
 
    // Test 2b (invalid Stream Flags with valid CRC32)
    buffer[6] ^= 0x20;
    crc = lzma_crc32(buffer + 6, 2, 0);
    write32le(buffer + 8, crc);
    succeed(test_header_decoder(LZMA_OPTIONS_ERROR));
 
    // Test 3 (invalid CRC32)
    expect(lzma_stream_header_encode(&known_flags, buffer) == LZMA_OK);
    buffer[9] ^= 1;
    succeed(test_header_decoder(LZMA_DATA_ERROR));
 
    // Test 4 (invalid Stream Flags with valid CRC32)
    expect(lzma_stream_footer_encode(&known_flags, buffer) == LZMA_OK);
    buffer[9] ^= 0x40;
    crc = lzma_crc32(buffer + 4, 6, 0);
    write32le(buffer, crc);
    succeed(test_footer_decoder(LZMA_OPTIONS_ERROR));
 
    // Test 5 (invalid Magic Bytes)
    expect(lzma_stream_footer_encode(&known_flags, buffer) == LZMA_OK);
    buffer[11] ^= 1;
    succeed(test_footer_decoder(LZMA_FORMAT_ERROR));
}

References lzma_stream_flags::backward_size, lzma_stream_flags::check, expect, known_flags, LZMA_CHECK_NONE, LZMA_DATA_ERROR, LZMA_FORMAT_ERROR, LZMA_OK, LZMA_OPTIONS_ERROR, succeed, test_footer_decoder(), test_header_decoder(), and write32le.

Referenced by main().

test_encode_invalid()

static void test_encode_invalid ( void  )

static

Definition at line 84 of file test_stream_flags.c.

{
    known_flags.check = (lzma_check)(LZMA_CHECK_ID_MAX + 1);
    known_flags.backward_size = 1024;
 
    expect(lzma_stream_header_encode(&known_flags, buffer)
            == LZMA_PROG_ERROR);
 
    expect(lzma_stream_footer_encode(&known_flags, buffer)
            == LZMA_PROG_ERROR);
 
    known_flags.check = (lzma_check)(-1);
 
    expect(lzma_stream_header_encode(&known_flags, buffer)
            == LZMA_PROG_ERROR);
 
    expect(lzma_stream_footer_encode(&known_flags, buffer)
            == LZMA_PROG_ERROR);
 
    known_flags.check = LZMA_CHECK_NONE;
    known_flags.backward_size = 0;
 
    // Header encoder ignores backward_size.
    expect(lzma_stream_header_encode(&known_flags, buffer) == LZMA_OK);
 
    expect(lzma_stream_footer_encode(&known_flags, buffer)
            == LZMA_PROG_ERROR);
 
    known_flags.backward_size = LZMA_VLI_MAX;
 
    expect(lzma_stream_header_encode(&known_flags, buffer) == LZMA_OK);
 
    expect(lzma_stream_footer_encode(&known_flags, buffer)
            == LZMA_PROG_ERROR);
}

References lzma_stream_flags::backward_size, lzma_stream_flags::check, expect, known_flags, LZMA_CHECK_ID_MAX, LZMA_CHECK_NONE, LZMA_OK, LZMA_PROG_ERROR, and LZMA_VLI_MAX.

Referenced by main().

test_footer()

static void test_footer ( void  )

static

Definition at line 75 of file test_stream_flags.c.

{
    memcrap(buffer, sizeof(buffer));
    expect(lzma_stream_footer_encode(&known_flags, buffer) == LZMA_OK);
    succeed(test_footer_decoder(LZMA_OK));
}

References expect, known_flags, LZMA_OK, memcrap, succeed, and test_footer_decoder().

Referenced by main().

test_footer_decoder()

static bool test_footer_decoder ( lzma_ret  expected_ret )

static

Definition at line 60 of file test_stream_flags.c.

{
    memcrap(&decoded_flags, sizeof(decoded_flags));
 
    if (lzma_stream_footer_decode(&decoded_flags, buffer) != expected_ret)
        return true;
 
    if (expected_ret != LZMA_OK)
        return false;
 
    return validate();
}

References decoded_flags, LZMA_OK, memcrap, and validate().

Referenced by test_decode_invalid(), and test_footer().

test_header()

static void test_header ( void  )

static

Definition at line 51 of file test_stream_flags.c.

{
    memcrap(buffer, sizeof(buffer));
    expect(lzma_stream_header_encode(&known_flags, buffer) == LZMA_OK);
    succeed(test_header_decoder(LZMA_OK));
}

References expect, known_flags, LZMA_OK, memcrap, succeed, and test_header_decoder().

Referenced by main().

test_header_decoder()

static bool test_header_decoder ( lzma_ret  expected_ret )

static

Definition at line 33 of file test_stream_flags.c.

{
    memcrap(&decoded_flags, sizeof(decoded_flags));
 
    if (lzma_stream_header_decode(&decoded_flags, buffer) != expected_ret)
        return true;
 
    if (expected_ret != LZMA_OK)
        return false;
 
    // Header doesn't have Backward Size, so make
    // lzma_stream_flags_compare() ignore it.
    decoded_flags.backward_size = LZMA_VLI_UNKNOWN;
    return validate();
}

References lzma_stream_flags::backward_size, decoded_flags, LZMA_OK, LZMA_VLI_UNKNOWN, memcrap, and validate().

Referenced by test_decode_invalid(), and test_header().

validate()

static bool validate ( void  )

static

Definition at line 22 of file test_stream_flags.c.

{
    // TODO: This could require the specific error type as an argument.
    // We could also test that lzma_stream_flags_compare() gives
    // the correct return values in different situations.
    return lzma_stream_flags_compare(&known_flags, &decoded_flags)
            != LZMA_OK;
}

References decoded_flags, known_flags, and LZMA_OK.

Referenced by test_footer_decoder(), and test_header_decoder().

Variable Documentation

buffer

uint8_t buffer[LZMA_STREAM_HEADER_SIZE]

static

Definition at line 18 of file test_stream_flags.c.

decoded_flags

lzma_stream_flags decoded_flags

static

Definition at line 17 of file test_stream_flags.c.

Referenced by test_footer_decoder(), test_header_decoder(), and validate().

known_flags

lzma_stream_flags known_flags

static

Definition at line 16 of file test_stream_flags.c.

Referenced by main(), test_decode_invalid(), test_encode_invalid(), test_footer(), test_header(), and validate().