/*-

 * Copyright (c) 2007 Tim Kientzle

 * 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

 *    in this position and unchanged.

 * 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 AUTHOR(S) ``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 AUTHOR(S) 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 "test.h"

__FBSDID("$FreeBSD: head/lib/libarchive/test/test_write_compress_xz.c 191183 2009-04-17 01:06:31Z kientzle $");

/*

 * A basic exercise of xz reading and writing.

 *

 * TODO: Add a reference file and make sure we can decompress that.

 */

DEFINE_TEST(test_write_filter_xz)

{

	struct archive_entry *ae;

	struct archive* a;

	char *buff, *data;

	size_t buffsize, datasize;

	char path[16];

	size_t used1, used2;

	int i, r;

	buffsize = 2000000;

	assert(NULL != (buff = (char *)malloc(buffsize)));

	if (buff == NULL)

		return;

	datasize = 10000;

	assert(NULL != (data = (char *)malloc(datasize)));

	if (data == NULL) {

		free(buff);

		return;

	}

	memset(data, 0, datasize);

	/*

	 * Write a 100 files and read them all back.

	 */

	assert((a = archive_write_new()) != NULL);

	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));

	r = archive_write_add_filter_xz(a);

	if (r == ARCHIVE_FATAL) {

		skipping("xz writing not supported on this platform");

		assertEqualInt(ARCHIVE_OK, archive_write_free(a));

		free(buff);

		free(data);

		return;

	}

	assertEqualIntA(a, ARCHIVE_OK,

	    archive_write_set_bytes_per_block(a, 10));

	assertEqualInt(ARCHIVE_FILTER_XZ, archive_filter_code(a, 0));

	assertEqualString("xz", archive_filter_name(a, 0));

	assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used1));

	assertEqualInt(ARCHIVE_FILTER_XZ, archive_filter_code(a, 0));

	assertEqualString("xz", archive_filter_name(a, 0));

	assert((ae = archive_entry_new()) != NULL);

	archive_entry_set_filetype(ae, AE_IFREG);

	archive_entry_set_size(ae, datasize);

	for (i = 0; i < 100; i++) {

		sprintf(path, "file%03d", i);

		archive_entry_copy_pathname(ae, path);

		assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));

		assertA(datasize

		    == (size_t)archive_write_data(a, data, datasize));

	}

	archive_entry_free(ae);

	assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));

	assertEqualInt(ARCHIVE_OK, archive_write_free(a));

	assert((a = archive_read_new()) != NULL);

	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));

	r = archive_read_support_filter_xz(a);

	if (r == ARCHIVE_WARN) {

		skipping("Can't verify xz writing by reading back;"

		    " xz reading not fully supported on this platform");

	} else {

		assertEqualIntA(a, ARCHIVE_OK,

		    archive_read_support_filter_all(a));

		assertEqualIntA(a, ARCHIVE_OK,

		    archive_read_open_memory(a, buff, used1));

		for (i = 0; i < 100; i++) {

			sprintf(path, "file%03d", i);

			if (!assertEqualInt(ARCHIVE_OK,

				archive_read_next_header(a, &ae)))

				break;

			assertEqualString(path, archive_entry_pathname(ae));

			assertEqualInt((int)datasize, archive_entry_size(ae));

		}

		assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));

	}

	assertEqualInt(ARCHIVE_OK, archive_read_free(a));

	/*

	 * Repeat the cycle again, this time setting some compression

	 * options.

	 */

	assert((a = archive_write_new()) != NULL);

	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));

	assertEqualIntA(a, ARCHIVE_OK,

	    archive_write_set_bytes_per_block(a, 10));

	assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_xz(a));

	assertEqualIntA(a, ARCHIVE_FAILED,

	    archive_write_set_filter_option(a, NULL, "nonexistent-option", "0"));

	assertEqualIntA(a, ARCHIVE_FAILED,

	    archive_write_set_filter_option(a, NULL, "compression-level", "abc"));

	assertEqualIntA(a, ARCHIVE_FAILED,

	    archive_write_set_filter_option(a, NULL, "compression-level", "99"));

	assertEqualIntA(a, ARCHIVE_OK,

	    archive_write_set_filter_option(a, NULL, "compression-level", "9"));

	assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2));

	for (i = 0; i < 100; i++) {

		sprintf(path, "file%03d", i);

		assert((ae = archive_entry_new()) != NULL);

		archive_entry_copy_pathname(ae, path);

		archive_entry_set_size(ae, datasize);

		archive_entry_set_filetype(ae, AE_IFREG);

		assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));

		assertA(datasize == (size_t)archive_write_data(a, data, datasize));

		archive_entry_free(ae);

	}

	assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));

	assertEqualInt(ARCHIVE_OK, archive_write_free(a));

	/* Curiously, this test fails; the test data above compresses

	 * better at default compression than at level 9. */

	/*

	failure("compression-level=9 wrote %d bytes, default wrote %d bytes",

	    (int)used2, (int)used1);

	assert(used2 < used1);

	*/

	assert((a = archive_read_new()) != NULL);

	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));

	r = archive_read_support_filter_xz(a);

	if (r == ARCHIVE_WARN) {

		skipping("xz reading not fully supported on this platform");

	} else {

		assertEqualIntA(a, ARCHIVE_OK,

		    archive_read_support_filter_all(a));

		assertEqualIntA(a, ARCHIVE_OK,

		    archive_read_open_memory(a, buff, used2));

		for (i = 0; i < 100; i++) {

			sprintf(path, "file%03d", i);

			failure("Trying to read %s", path);

			if (!assertEqualIntA(a, ARCHIVE_OK,

				archive_read_next_header(a, &ae)))

				break;

			assertEqualString(path, archive_entry_pathname(ae));

			assertEqualInt((int)datasize, archive_entry_size(ae));

		}

		assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));

	}

	assertEqualInt(ARCHIVE_OK, archive_read_free(a));

	/*

	 * Repeat again, with much lower compression.

	 */

	assert((a = archive_write_new()) != NULL);

	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));

	assertEqualIntA(a, ARCHIVE_OK,

	    archive_write_set_bytes_per_block(a, 10));

	assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_xz(a));

	assertEqualIntA(a, ARCHIVE_OK,

	    archive_write_set_filter_option(a, NULL, "compression-level", "0"));

	assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2));

	for (i = 0; i < 100; i++) {

		sprintf(path, "file%03d", i);

		assert((ae = archive_entry_new()) != NULL);

		archive_entry_copy_pathname(ae, path);

		archive_entry_set_size(ae, datasize);

		archive_entry_set_filetype(ae, AE_IFREG);

		assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));

		failure("Writing file %s", path);

		assertEqualIntA(a, datasize,

		    (size_t)archive_write_data(a, data, datasize));

		archive_entry_free(ae);

	}

	assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));

	assertEqualInt(ARCHIVE_OK, archive_write_free(a));

	/* I would like to assert that compression-level=0 results in

	 * larger data than the default compression, but that's not true

	 * for all versions of liblzma. */

	/*

	failure("Compression-level=0 wrote %d bytes; default wrote %d bytes",

	    (int)used2, (int)used1);

	assert(used2 > used1);

	*/

	assert((a = archive_read_new()) != NULL);

	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));

	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_filter_all(a));

	r = archive_read_support_filter_xz(a);

	if (r == ARCHIVE_WARN) {

		skipping("xz reading not fully supported on this platform");

	} else {

		assertEqualIntA(a, ARCHIVE_OK,

		    archive_read_open_memory(a, buff, used2));

		for (i = 0; i < 100; i++) {

			sprintf(path, "file%03d", i);

			if (!assertEqualInt(ARCHIVE_OK,

				archive_read_next_header(a, &ae)))

				break;

			assertEqualString(path, archive_entry_pathname(ae));

			assertEqualInt((int)datasize, archive_entry_size(ae));

		}

		assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));

	}

	assertEqualInt(ARCHIVE_OK, archive_read_free(a));

	/*

	 * Test various premature shutdown scenarios to make sure we

	 * don't crash or leak memory.

	 */

	assert((a = archive_write_new()) != NULL);

	assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_xz(a));

	assertEqualInt(ARCHIVE_OK, archive_write_free(a));

	assert((a = archive_write_new()) != NULL);

	assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_xz(a));

	assertEqualInt(ARCHIVE_OK, archive_write_close(a));

	assertEqualInt(ARCHIVE_OK, archive_write_free(a));

	assert((a = archive_write_new()) != NULL);

	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));

	assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_xz(a));

	assertEqualInt(ARCHIVE_OK, archive_write_close(a));

	assertEqualInt(ARCHIVE_OK, archive_write_free(a));

	assert((a = archive_write_new()) != NULL);

	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));

	assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_xz(a));

	assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2));

	assertEqualInt(ARCHIVE_OK, archive_write_close(a));

	assertEqualInt(ARCHIVE_OK, archive_write_free(a));

	/*

	 * Clean up.

	 */

	free(data);

	free(buff);

}