test_issue24477_http_network_loss.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, you may find one here:
 * https://www.gnu.org/licenses/gpl-3.0.en.html
 */

 
#include <boost/test/unit_test.hpp>
 
#include <cstring>
 
#include <wx/filename.h>
#include <wx/wfstream.h>
 
#include <http_lib/http_lib_connection.h>
#include <libraries/library_manager.h>
#include <libraries/symbol_library_adapter.h>
#include <lib_symbol.h>
#include <sch_io/http_lib/sch_io_http_lib.h>
#include <ki_exception.h>
 
 
BOOST_AUTO_TEST_SUITE( Issue24477HttpNetworkLoss )
 
 

static wxFileName writeUnreachableHttpLib()
{
    wxFileName settings( wxFileName::CreateTempFileName( "kicad_qa_issue24477_" ) );
    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\": \"Unreachable 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 ) );
    out.Close();
 
    return settings;
}
 

BOOST_AUTO_TEST_CASE( SubLibraryQueriesSurviveNetworkLoss )
{
    wxFileName settings = writeUnreachableHttpLib();
 
    LIBRARY_MANAGER        manager;
    SYMBOL_LIBRARY_ADAPTER adapter( manager );
 
    SCH_IO_HTTP_LIB plugin;
    plugin.SetLibraryManagerAdapter( &adapter );
 
    // Opening the library caches its settings and then fails to connect, exactly as it does
    // while a schematic referencing the library is opened with the network down.  This leaves
    // the plugin with valid settings but a null connection, the state the tree build hit.
    std::vector<LIB_SYMBOL*> symbols;
    BOOST_CHECK_THROW( plugin.EnumerateSymbolLib( symbols, settings.GetFullPath() ), IO_ERROR );
 
    // GetSubLibraryNames previously dereferenced the null connection.  It must now fail
    // gracefully and leave the result empty.
    std::vector<wxString> names = { wxS( "stale" ) };
    BOOST_REQUIRE_NO_THROW( plugin.GetSubLibraryNames( names ) );
    BOOST_CHECK( names.empty() );
 
    // GetSubLibraryDescription dereferenced the connection with no settings/connection
    // guard at all.  It must now return empty rather than crash.
    wxString desc;
    BOOST_REQUIRE_NO_THROW( desc = plugin.GetSubLibraryDescription( wxS( "anything" ) ) );
    BOOST_CHECK( desc.IsEmpty() );
 
    wxRemoveFile( settings.GetFullPath() );
}
 

BOOST_AUTO_TEST_CASE( ConnectionReportsInvalidEndpointOnNetworkLoss )
{
    HTTP_LIB_SOURCE source;
    source.root_url = "http://localhost:1/v1/";
    source.token = "";
    source.api_version = "v1";
 
    HTTP_LIB_CONNECTION conn( source, true );
 
    BOOST_CHECK( !conn.IsValidEndpoint() );
    BOOST_CHECK( !conn.GetLastError().empty() );
}
 
 
BOOST_AUTO_TEST_SUITE_END()