test_altium_parser.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#include <qa_utils/wx_utils/unit_test_utils.h>
#include <boost/test/data/test_case.hpp>
 
#include <common/io/altium/altium_binary_parser.h>
 
struct ALTIUM_BINARY_PARSER_FIXTURE
{
 ALTIUM_BINARY_PARSER_FIXTURE() {}
};
 
 
BOOST_FIXTURE_TEST_SUITE( AltiumParser, ALTIUM_BINARY_PARSER_FIXTURE )
 
 
static const std::vector<std::tuple<int, int>> altium_to_kicad_unit = {
 // Some simple values
 { 0, 0 },
 { 1, 0 },
 { 2, 10 },
 { 3, 10 },
 { 10, 30 },
 { 20, 50 },
 { 30, 80 },
 // Edge Cases
 { 845466002, 2147483640 },
 { -845466002, -2147483640 },
 // Clamp bigger values
 { 845466003, 2147483640 },
 { -845466003, -2147483640 },
 { 1000000000, 2147483640 },
 { -1000000000, -2147483640 },
 // imperial rounded units as input (rounded to the near 10 nm value)
 { 100, 250 },
 { 200, 510 },
 { 300, 760 },
 { 400, 1020 },
 { 500, 1270 },
 { 600, 1520 },
 { 700, 1780 },
 { 800, 2030 },
 { 900, 2290 },
 { 1000, 2540 },
 // metric rounded units as input
 { 394, 1000 },
 { 787, 2000 },
 { 1181, 3000 },
 { 1575, 4000 },
 { 1969, 5000 },
 { 2362, 6000 },
 { 2756, 7000 },
 { 3150, 8000 },
 { 3543, 9000 },
 { 3937, 10000 },
 { 39370, 100000 },
 { 78740, 200000 },
 { 118110, 300000 },
 { 157480, 400000 },
 { 196850, 500000 },
 { 236220, 600000 },
 { 275591, 700000 },
 { 314961, 800000 },
 { 354331, 900000 },
 { 393701, 1000000 },
 { -394, -1000 },
 { -787, -2000 },
 { -1181, -3000 },
 { -1575, -4000 },
 { -1969, -5000 },
 { -2362, -6000 },
 { -2756, -7000 },
 { -3150, -8000 },
 { -3543, -9000 },
 { -3937, -10000 },
 { -39370, -100000 },
 { -78740, -200000 },
 { -118110, -300000 },
 { -157480, -400000 },
 { -196850, -500000 },
 { -236220, -600000 },
 { -275591, -700000 },
 { -314961, -800000 },
 { -354331, -900000 },
 { -393701, -1000000 },
};
 
BOOST_DATA_TEST_CASE( ConvertToKicadUnit,
 boost::unit_test::data::make(altium_to_kicad_unit),
 input_value,
 expected_result )
{
 int result = ALTIUM_PROPS_UTILS::ConvertToKicadUnit( input_value );
 
 // These are all valid
 BOOST_CHECK_EQUAL( result, expected_result );
}
 
static const std::vector<std::tuple<wxString, int>> read_kicad_unit_property = {
 // Empty (use default)
 { "", 0 },
 // Some simple cases
 { "0mil", 0 },
 { "1mil", 25400 },
 { "+1mil", 25400 },
 { "-1mil", -25400 },
 // Decimal Places
 { "0.1mil", 2540 },
 { "-0.1mil", -2540 },
 { "0.01mil", 250 },
 { "-0.01mil", -250 },
 { "0.001mil", 30 },
 { "-0.001mil", -30 },
 { "0.0001mil", 0 },
 { "-0.0001mil", 0 },
 { "0.00001mil", 0 },
 { "-0.00001mil", -0 },
 // Big Numbers
 { "10mil", 254000 },
 { "-10mil", -254000 },
 { "100mil", 2540000 },
 { "-100mil", -2540000 },
 { "1000mil", 25400000 },
 { "-1000mil", -25400000 },
 { "10000mil", 254000000 },
 { "-10000mil", -254000000 },
 // Edge Cases, values are rounded to the near available 10nm
 { "84546.6002mil", 2147483640 },
 { "-84546.6002mil", -2147483640 },
 // Clamp bigger values, values are rounded to the near available 10nm
 { "84546.6003mil", 2147483640 },
 { "-84546.6003mil", -2147483640 },
 { "100000mil", 2147483640 },
 { "-100000mil", -2147483640 },
 { "1000000mil", 2147483640 },
 { "-1000000mil", -2147483640 },
 { "10000000mil", 2147483640 },
 { "-10000000mil", -2147483640 },
 // Incorrect suffix
 { "100", 0 },
 { "100mils", 0 },
 // Incorrect prefix
 { "a100mil", 0 },
};
 
 
BOOST_DATA_TEST_CASE( PropertiesReadKicadUnit,
 boost::unit_test::data::make(read_kicad_unit_property),
 input_value,
 expected_result )
{
 std::map<wxString, wxString> properties = { { "TEST", input_value } };
 
 int result = ALTIUM_PROPS_UTILS::ReadKicadUnit( properties, "TEST", "0mil" );
 
 // These are all valid
 BOOST_CHECK_EQUAL( result, expected_result );
}
 
 
static const std::vector<std::tuple<std::string, std::map<wxString, wxString>>> read_properties = {
 // Empty
 { "", {} },
 { "\0", {} },
 { "|", {} },
 { "|\0", {} },
 { "||", {} },
 { "||\0", {} },
 // Empty key-value pair
 { "|=", { { "", "" } } },
 { "|=\0", { { "", "" } } },
 { "| = ", { { "", "" } } },
 { "| = \0", { { "", "" } } },
 // Single key-value pair
 { "|A=\0", { { "A", "" } } },
 { "|A=B", { { "A", "B" } } },
 { "|A=B\0", { { "A", "B" } } },
 { "|A=B|", { { "A", "B" } } },
 { "|A=B|\0", { { "A", "B" } } },
 { "A=\0", { { "A", "" } } },
 { "A=B", { { "A", "B" } } },
 { "A=B\0", { { "A", "B" } } },
 { "A=B|", { { "A", "B" } } },
 { "A=B|\0", { { "A", "B" } } },
 // Multiple key-value pairs
 { "|A=B|C=D|\0", { { "A", "B" }, { "C", "D" } } },
 { "A=B|C=D|\0", { { "A", "B" }, { "C", "D" } } },
 // Same key multiple times
 { "|A=B|A=C\0", { { "A", "B" } } },
 { "|A=B|A=C|A=D|A=E|A=F\0", { { "A", "B" } } },
 // Always upper case key
 { "|a=b\0", { { "A", "b" } } },
 { "|abc123=b\0", { { "ABC123", "b" } } },
 // Trim whitespaces, TODO: correct?
 { "|A= B\0", { { "A", " B" } } },
 { "|A=B \0", { { "A", "B" } } },
 { "| A=B\0", { { "A", "B" } } },
 { "|A =B\0", { { "A", "B" } } },
 { "|A=\nB\n\0", { { "A", "\nB" } } },
 { "A= B\0", { { "A", " B" } } },
 { "A=B \0", { { "A", "B" } } },
 { " A=B\0", { { "A", "B" } } },
 { "A =B\0", { { "A", "B" } } },
 { "A=\nB\n\0", { { "A", "\nB" } } },
 // Escaping and other special cases, TODO: extend
 //{ "|A=||\0", {{"A", "|"}} },
 { "|A==\0", { { "A", "=" } } },
 { "|A=a\na\0", { { "A", "a\na" } } },
 { "|A=a\ta\0", { { "A", "a\ta" } } },
 // Encoding, TODO: extend
 { "|%UTF8%A=abc\0", { { "%UTF8%A", "abc" } } },
 { "|%UTF8%A=\xc2\xa6\0", { { "%UTF8%A", { "\xc2\xa6", wxConvUTF8 } } } }, // Convert to '|' ?
 // Correct reading errors
 { "|A|B=C\0", { { "B", "C" } } },
 { "|A=B|C\0", { { "A", "B" } } },
};
 
BOOST_DATA_TEST_CASE( ReadProperties,
 boost::unit_test::data::make(read_properties),
 input_value,
 expected_result )
{
 size_t size = 4 + input_value.size();
 std::unique_ptr<char[]> content = std::make_unique<char[]>( size );
 
 *content.get() = input_value.size();
 std::memcpy( content.get() + 4, input_value.c_str(), input_value.size() );
 
 ALTIUM_BINARY_PARSER parser( content, size );
 
 std::map<wxString, wxString> result = parser.ReadProperties();
 
 BOOST_CHECK_EQUAL( parser.HasParsingError(), false );
 BOOST_CHECK_EQUAL( parser.GetRemainingBytes(), 0 );
 
 BOOST_CHECK_EQUAL_COLLECTIONS( result.begin(), result.end(),
 expected_result.begin(), expected_result.end() );
}
 
 
BOOST_AUTO_TEST_SUITE_END()