7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2024-11-22 05:35:05 +00:00
kicad/qa/tests/common/test_embedded_file_compress.cpp
Seth Hillbrand 5ba50c26a9 Update embedded files hash to use Murmur3
SHA256 is fine for one-offs but for large libraries where we might be
running the hash on hundreds of files, the speed difference is
appreciable.  We don't require crytographic hashing, just a check that
the original file hasn't been corrupted so Murmur3 satisfies our basic
requirement.
2024-09-06 09:57:23 -07:00

140 lines
4.5 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <magic_enum.hpp>
#include <boost/test/unit_test.hpp>
#include <mmh3_hash.h>
#include <embedded_files.h>
#include <random>
using magic_enum::iostream_operators::operator<<;
BOOST_AUTO_TEST_SUITE( EmbeddedFiles )
BOOST_AUTO_TEST_CASE( CompressAndEncode_OK )
{
EMBEDDED_FILES::EMBEDDED_FILE file;
file.name = "test_file";
std::string data = "Hello, World!";
file.decompressedData.assign(data.begin(), data.end());
MMH3_HASH hash( EMBEDDED_FILES::Seed() );
hash.add( file.decompressedData );
file.data_hash = hash.digest().ToString();
EMBEDDED_FILES::RETURN_CODE result = EMBEDDED_FILES::CompressAndEncode(file);
BOOST_CHECK_EQUAL(result, EMBEDDED_FILES::RETURN_CODE::OK);
}
BOOST_AUTO_TEST_CASE( DecompressAndDecode_OK )
{
EMBEDDED_FILES::EMBEDDED_FILE file;
file.name = "test_file";
std::string data = "Hello, World!";
file.decompressedData.assign( data.begin(), data.end() );
MMH3_HASH hash( EMBEDDED_FILES::Seed() );
hash.add( file.decompressedData );
file.data_hash = hash.digest().ToString();
EMBEDDED_FILES::RETURN_CODE result = EMBEDDED_FILES::CompressAndEncode( file );
BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
result = EMBEDDED_FILES::DecompressAndDecode( file );
BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
// Create a large test data
data.clear();
data.reserve( 13 * 100000 + 1 );
for( int i = 0; i < 100000; ++i )
data += "Hello, World!";
file.decompressedData.assign( data.begin(), data.end() );
hash.reset();
hash.add( file.decompressedData );
file.data_hash = hash.digest().ToString();
result = EMBEDDED_FILES::CompressAndEncode( file );
BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
result = EMBEDDED_FILES::DecompressAndDecode( file );
BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
// Create a sequential test dataset
data.clear();
data.reserve( 100000 );
for( int i = 0; i < 100000; ++i )
data += static_cast<char>( i % 256 );
file.decompressedData.assign( data.begin(), data.end() );
hash.reset();
hash.add( file.decompressedData );
file.data_hash = hash.digest().ToString();
result = EMBEDDED_FILES::CompressAndEncode( file );
BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
result = EMBEDDED_FILES::DecompressAndDecode( file );
BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
// Create a random test dataset with a known seed
data.clear();
data.reserve( 100000 );
std::mt19937 rng;
rng.seed( 0 );
for( int i = 0; i < 100000; ++i )
data += static_cast<char>( rng() % 256 );
file.decompressedData.assign( data.begin(), data.end() );
hash.reset();
hash.add( file.decompressedData );
file.data_hash = hash.digest().ToString();
result = EMBEDDED_FILES::CompressAndEncode( file );
BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
result = EMBEDDED_FILES::DecompressAndDecode( file );
BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
}
BOOST_AUTO_TEST_CASE( DecompressAndDecode_ChecksumError )
{
EMBEDDED_FILES::EMBEDDED_FILE file;
file.name = "test_file";
std::string data = "Hello, World!";
file.decompressedData.assign(data.begin(), data.end());
EMBEDDED_FILES::RETURN_CODE result = EMBEDDED_FILES::CompressAndEncode(file);
BOOST_CHECK_EQUAL(result, EMBEDDED_FILES::RETURN_CODE::OK);
// Modify the checksum
file.data_hash[0] = 'x';
result = EMBEDDED_FILES::DecompressAndDecode(file);
BOOST_CHECK_EQUAL(result, EMBEDDED_FILES::RETURN_CODE::CHECKSUM_ERROR);
}
BOOST_AUTO_TEST_SUITE_END()