test_issue23023_http_fields.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 <algorithm>
#include <tuple>
 
#include <wx/arrstr.h> // for MSVC to see std::vector<wxString> is exported from wx
 
#include <json_common.h>
#include <http_lib/http_lib_connection.h>
#include <http_lib/http_lib_settings.h>
 
 
BOOST_AUTO_TEST_SUITE( Issue23023HttpFields )
 
 
static const HTTP_LIB_PART::field_type* findField( const HTTP_LIB_PART& aPart, const std::string& aName )
{
    for( const auto& [name, properties] : aPart.fields )
    {
        if( name == aName )
            return &properties;
    }
 
    return nullptr;
}
 

BOOST_AUTO_TEST_CASE( DetailRecordPopulatesFields )
{
    const nlohmann::json detail = R"({
        "id": "1",
        "name": "RC0603FR-0710KL",
        "symbolIdStr": "Device:R",
        "exclude_from_bom": "False",
        "exclude_from_board": "False",
        "exclude_from_sim": "True",
        "fields": {
            "footprint": { "value": "Resistor_SMD:R_0603_1608Metric", "visible": "False" },
            "datasheet": { "value": "www.kicad.org", "visible": "False" },
            "value": { "value": "10k" },
            "reference": { "value": "R" }
        }
    })"_json;
 
    HTTP_LIB_PART part;
 
    BOOST_CHECK( setPartExtendedData( detail, part ) );
 
    BOOST_CHECK_EQUAL( part.symbolIdStr, "Device:R" );
    BOOST_CHECK_EQUAL( part.exclude_from_sim, true );
    BOOST_CHECK_EQUAL( part.exclude_from_bom, false );
 
    BOOST_REQUIRE_EQUAL( part.fields.size(), 4u );
 
    const HTTP_LIB_PART::field_type* value = findField( part, "value" );
    BOOST_REQUIRE( value );
    BOOST_CHECK_EQUAL( std::get<0>( *value ), "10k" );
 
    // A field with no explicit "visible" key must default to visible.
    BOOST_CHECK_EQUAL( std::get<1>( *value ), true );
 
    const HTTP_LIB_PART::field_type* footprint = findField( part, "footprint" );
    BOOST_REQUIRE( footprint );
    BOOST_CHECK_EQUAL( std::get<0>( *footprint ), "Resistor_SMD:R_0603_1608Metric" );
    BOOST_CHECK_EQUAL( std::get<1>( *footprint ), false );
}
 

BOOST_AUTO_TEST_CASE( ListingRecordReportsNotDetailed )
{
    const nlohmann::json listing = R"({
        "id": "1",
        "name": "RC0603FR-0710KL",
        "description": "10 kOhms resistor"
    })"_json;
 
    HTTP_LIB_PART part;
 
    BOOST_CHECK( !setPartExtendedData( listing, part ) );
    BOOST_CHECK( part.fields.empty() );
}
 

BOOST_AUTO_TEST_CASE( NativeBooleanFlagsAreAccepted )
{
    const nlohmann::json detail = R"({
        "id": "1",
        "symbolIdStr": "Device:R",
        "exclude_from_bom": true,
        "fields": {
            "mpn": { "value": "RC0603FR-0710KL", "visible": false }
        }
    })"_json;
 
    HTTP_LIB_PART part;
 
    BOOST_CHECK_NO_THROW( setPartExtendedData( detail, part ) );
    BOOST_CHECK_EQUAL( part.exclude_from_bom, true );
 
    const HTTP_LIB_PART::field_type* mpn = findField( part, "mpn" );
    BOOST_REQUIRE( mpn );
    BOOST_CHECK_EQUAL( std::get<1>( *mpn ), false );
}
 
 
BOOST_AUTO_TEST_SUITE_END()