Seth Hillbrand
8c34640520
SQLite ODBC drivers use PRAGMA table_info to implement SQLColumns, which doesn't return generated columns. This caused KiCad to silently ignore any generated column configured in a .kicad_dbl file. Now CacheTableInfo trusts user-configured column names and adds them to the cache even if the ODBC driver doesn't report them. If a column truly doesn't exist, the subsequent query will fail with a clear error rather than silently omitting the data. Also adds a test case with a table containing a virtual generated column. Fixes https://gitlab.com/kicad/code/kicad/-/issues/16952
118 lines
4.2 KiB
C++
118 lines
4.2 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2022 Jon Evans <jon@craftyjon.com>
|
|
* Copyright The 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 <fmt/core.h>
|
|
#include <boost/test/unit_test.hpp>
|
|
|
|
#include <database/database_connection.h>
|
|
|
|
BOOST_AUTO_TEST_SUITE( Database )
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE( Connect )
|
|
{
|
|
std::string cs = fmt::format( "Driver={{SQLite3}};Database={}/database.sqlite",
|
|
QA_DATABASE_FILE_LOCATION );
|
|
|
|
// Construct and connect
|
|
DATABASE_CONNECTION dc( cs, 2, false );
|
|
BOOST_CHECK_NO_THROW( dc.Connect() );
|
|
BOOST_CHECK( dc.IsConnected() );
|
|
|
|
dc.Disconnect();
|
|
BOOST_CHECK( !dc.IsConnected() );
|
|
|
|
dc.Connect();
|
|
BOOST_CHECK( dc.IsConnected() );
|
|
|
|
dc.Disconnect();
|
|
|
|
// Scoped connection should self-disconnect
|
|
{
|
|
DATABASE_CONNECTION dc2( cs, 2 );
|
|
}
|
|
|
|
dc.Connect();
|
|
dc.CacheTableInfo( "Resistors", { "Part ID", "MPN" } );
|
|
dc.CacheTableInfo( "Capacitors", { "Part ID", "Cost" } );
|
|
BOOST_CHECK( dc.IsConnected() );
|
|
|
|
DATABASE_CONNECTION::ROW result;
|
|
|
|
BOOST_CHECK( dc.SelectOne( "Resistors", std::make_pair( "Part ID", "RES-001" ), result ) );
|
|
|
|
BOOST_CHECK( !result.empty() );
|
|
BOOST_CHECK( result.count( "MPN" ) );
|
|
BOOST_CHECK_NO_THROW( std::any_cast<std::string>( result.at( "MPN" ) ) );
|
|
BOOST_CHECK_EQUAL( std::any_cast<std::string>( result.at( "MPN" ) ), "RC0603FR-0710KL" );
|
|
|
|
BOOST_CHECK( dc.SelectOne( "Capacitors", std::make_pair( "Part ID", "CAP-003" ), result ) );
|
|
|
|
BOOST_CHECK( !result.empty() );
|
|
BOOST_CHECK( result.count( "Cost" ) );
|
|
BOOST_CHECK_NO_THROW( std::any_cast<std::string>( result.at( "Cost" ) ) );
|
|
BOOST_CHECK_EQUAL( std::any_cast<std::string>( result.at( "Cost" ) ), "1.95" );
|
|
}
|
|
|
|
|
|
/**
|
|
* Test that generated columns in SQLite are properly handled.
|
|
*
|
|
* SQLite ODBC drivers use PRAGMA table_info to implement SQLColumns, which doesn't
|
|
* return generated columns. This test verifies that KiCad can still query tables
|
|
* with generated columns by trusting user-configured column names.
|
|
*
|
|
* See https://gitlab.com/kicad/code/kicad/-/issues/16952
|
|
*/
|
|
BOOST_AUTO_TEST_CASE( GeneratedColumns )
|
|
{
|
|
std::string cs = fmt::format( "Driver={{SQLite3}};Database={}/database.sqlite",
|
|
QA_DATABASE_FILE_LOCATION );
|
|
|
|
DATABASE_CONNECTION dc( cs, 2 );
|
|
BOOST_CHECK( dc.IsConnected() );
|
|
|
|
// Cache table info including the generated column "FullDesc"
|
|
// The SQLite ODBC driver won't report this column via SQLColumns,
|
|
// but our fix should add it to the cache anyway
|
|
dc.CacheTableInfo( "GeneratedTest", { "part id", "value", "resistance", "fulldesc" } );
|
|
|
|
DATABASE_CONNECTION::ROW result;
|
|
|
|
BOOST_CHECK( dc.SelectOne( "GeneratedTest", std::make_pair( "Part ID", "GEN-001" ), result ) );
|
|
BOOST_CHECK( !result.empty() );
|
|
|
|
// Verify we can read the generated column value
|
|
BOOST_CHECK( result.count( "FullDesc" ) );
|
|
BOOST_CHECK_NO_THROW( std::any_cast<std::string>( result.at( "FullDesc" ) ) );
|
|
BOOST_CHECK_EQUAL( std::any_cast<std::string>( result.at( "FullDesc" ) ), "10K - 10000ohm" );
|
|
|
|
// Also verify regular columns still work
|
|
BOOST_CHECK( result.count( "Value" ) );
|
|
BOOST_CHECK_EQUAL( std::any_cast<std::string>( result.at( "Value" ) ), "10K" );
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_SUITE_END()
|