test_issue24297_http_migrate.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 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 <https://www.gnu.org/licenses/>.
 */

 
#include <boost/test/unit_test.hpp>
 
#include <cstring>
 
#include <wx/filename.h>
#include <wx/wfstream.h>
 
#include <sch_io/sch_io_mgr.h>
 
 
namespace
{
 
void removeIfPresent( const wxFileName& aFile )
{
    if( aFile.FileExists() )
        wxRemoveFile( aFile.GetFullPath() );
}
 
} // namespace
 
 
BOOST_AUTO_TEST_SUITE( Issue24297HttpMigrate )
 
 

BOOST_AUTO_TEST_CASE( HttpLibraryRejectedByConvertLibrary )
{
    wxFileName settings( wxFileName::CreateTempFileName( "kicad_qa_issue24297_" ) );
    wxRemoveFile( settings.GetFullPath() );
    settings.SetExt( "kicad_httplib" );
 
    {
        wxFFileOutputStream out( settings.GetFullPath() );
        BOOST_REQUIRE( out.IsOk() );
        const char* json =
                "{\n"
                "    \"meta\": { \"version\": 1.0 },\n"
                "    \"name\": \"Test HTTP Library\",\n"
                "    \"source\": {\n"
                "        \"type\": \"REST_API\",\n"
                "        \"api_version\": \"v1\",\n"
                "        \"root_url\": \"http://localhost:1/\",\n"
                "        \"token\": \"\"\n"
                "    }\n"
                "}\n";
        out.WriteAll( json, std::strlen( json ) );
    }
 
    BOOST_REQUIRE_EQUAL( SCH_IO_MGR::GuessPluginTypeFromLibPath( settings.GetFullPath() ),
                         SCH_IO_MGR::SCH_HTTP );
 
    wxFileName outLib( settings );
    outLib.SetExt( "kicad_sym" );
    removeIfPresent( outLib );
 
    // Previously this returned true and wrote an empty .kicad_sym, clobbering the table entry.
    BOOST_CHECK( !SCH_IO_MGR::ConvertLibrary( nullptr, settings.GetFullPath(),
                                              outLib.GetFullPath() ) );
 
    // And must not have produced an empty replacement file.
    BOOST_CHECK( !outLib.Exists() );
 
    wxRemoveFile( settings.GetFullPath() );
    removeIfPresent( outLib );
}
 

BOOST_AUTO_TEST_CASE( DatabaseLibraryRejectedByConvertLibrary )
{
    wxFileName settings( wxFileName::CreateTempFileName( "kicad_qa_issue24297_db_" ) );
    wxRemoveFile( settings.GetFullPath() );
    settings.SetExt( "kicad_dbl" );
 
    {
        wxFFileOutputStream out( settings.GetFullPath() );
        BOOST_REQUIRE( out.IsOk() );
        const char* json =
                "{\n"
                "    \"meta\": { \"version\": 0 },\n"
                "    \"name\": \"Test DB\",\n"
                "    \"source\": { \"type\": \"odbc\", \"dsn\": \"\", \"username\": \"\","
                " \"password\": \"\", \"connection_string\": \"\" },\n"
                "    \"libraries\": []\n"
                "}\n";
        out.WriteAll( json, std::strlen( json ) );
    }
 
    BOOST_REQUIRE_EQUAL( SCH_IO_MGR::GuessPluginTypeFromLibPath( settings.GetFullPath() ),
                         SCH_IO_MGR::SCH_DATABASE );
 
    wxFileName outLib( settings );
    outLib.SetExt( "kicad_sym" );
    removeIfPresent( outLib );
 
    BOOST_CHECK( !SCH_IO_MGR::ConvertLibrary( nullptr, settings.GetFullPath(),
                                              outLib.GetFullPath() ) );
    BOOST_CHECK( !outLib.Exists() );
 
    wxRemoveFile( settings.GetFullPath() );
    removeIfPresent( outLib );
}
 

BOOST_AUTO_TEST_CASE( NestedTableRejectedByConvertLibrary )
{
    wxFileName table( wxFileName::CreateTempFileName( "kicad_qa_issue23291_sym_" ) );
 
    {
        wxFFileOutputStream out( table.GetFullPath() );
        BOOST_REQUIRE( out.IsOk() );
        const char* contents =
                "(sym_lib_table\n"
                "  (version 7)\n"
                "  (lib (name \"Device\") (type \"KiCad\")"
                " (uri \"${KICAD9_SYMBOL_DIR}/Device.kicad_sym\") (options \"\") (descr \"\"))\n"
                ")\n";
        out.WriteAll( contents, std::strlen( contents ) );
    }
 
    BOOST_REQUIRE_EQUAL( SCH_IO_MGR::GuessPluginTypeFromLibPath( table.GetFullPath() ),
                         SCH_IO_MGR::SCH_NESTED_TABLE );
 
    wxFileName outLib( table );
    outLib.SetExt( "kicad_sym" );
    removeIfPresent( outLib );
 
    BOOST_CHECK( !SCH_IO_MGR::ConvertLibrary( nullptr, table.GetFullPath(), outLib.GetFullPath() ) );
    BOOST_CHECK( !outLib.Exists() );
 
    wxRemoveFile( table.GetFullPath() );
    removeIfPresent( outLib );
}
 
 
BOOST_AUTO_TEST_SUITE_END()