test_sch_sheet.cpp File Reference

Test suite for SCH_SHEET. More...

#include <unit_test_utils/unit_test_utils.h>
#include <sch_sheet.h>
#include <schematic.h>
#include "uuid_test_utils.h"
#include <unit_test_utils/wx_assert.h>

Go to the source code of this file.

Classes
class	TEST_SCH_SHEET_FIXTURE
struct	TEST_END_CONN_PIN

Functions
std::ostream &	operator<< (std::ostream &os, DANGLING_END_ITEM const &d)
	Print helper. More...
	BOOST_AUTO_TEST_CASE (Default)
	Declare the test suite. More...
	BOOST_AUTO_TEST_CASE (SchematicParent)
	Test setting parent schematic. More...
	BOOST_AUTO_TEST_CASE (AddPins)
	Test adding pins to a sheet. More...
	BOOST_AUTO_TEST_CASE (PinRenumbering)
	Check that pins are added and renumbered to be unique. More...
	BOOST_AUTO_TEST_CASE (EndconnectionPoints)
	Test the endpoint and connection point collections: we should be able to add pins, then have them appear as endpoints. More...

Detailed Description

Test suite for SCH_SHEET.

Definition in file test_sch_sheet.cpp.

Function Documentation

BOOST_AUTO_TEST_CASE() [1/5]

BOOST_AUTO_TEST_CASE

(

Default

)

Declare the test suite.

Check default properties

Definition at line 79 of file test_sch_sheet.cpp.

{
    BOOST_CHECK_EQUAL( m_csheet.GetPosition(), wxPoint( 0, 0 ) );

    BOOST_CHECK_EQUAL( m_sheet.GetParent(), nullptr );
    BOOST_CHECK_EQUAL( m_sheet.CountSheets(), 1 );

    BOOST_CHECK_EQUAL( m_csheet.GetScreenCount(), 0 );

    BOOST_CHECK_EQUAL( m_sheet.SymbolCount(), 0 );
}

BOOST_AUTO_TEST_CASE() [2/5]

BOOST_AUTO_TEST_CASE

(

SchematicParent

)

Test setting parent schematic.

Definition at line 94 of file test_sch_sheet.cpp.

{
    m_sheet.SetParent( &m_schematic );

    BOOST_CHECK_EQUAL( m_sheet.IsRootSheet(), false );

    m_schematic.SetRoot( &m_sheet );

    BOOST_CHECK_EQUAL( m_sheet.IsRootSheet(), true );
}

BOOST_AUTO_TEST_CASE() [3/5]

BOOST_AUTO_TEST_CASE

(

AddPins

)

Test adding pins to a sheet.

Definition at line 108 of file test_sch_sheet.cpp.

{
    const wxPoint pinPos{ 42, 13 };

    // we should catch null insertions
    CHECK_WX_ASSERT( m_sheet.AddPin( nullptr ) );

    auto newPin = std::make_unique<SCH_SHEET_PIN>( &m_sheet, pinPos, "pinname" );

    // can't be const because of RemovePin (?!)
    SCH_SHEET_PIN& pinRef = *newPin;

    m_sheet.AddPin( newPin.release() );

    // now we can find it in the list
    BOOST_CHECK_EQUAL( m_sheet.HasPins(), true );
    BOOST_CHECK_EQUAL( m_sheet.HasPin( "pinname" ), true );
    BOOST_CHECK_EQUAL( m_sheet.HasPin( "PINname" ), true );

    BOOST_CHECK_EQUAL( m_sheet.GetPin( pinPos ), &pinRef );

    // check the actual list can be retrieved
    std::vector<SCH_SHEET_PIN*>& pins = m_sheet.GetPins();
    BOOST_CHECK_EQUAL( pins[0], &pinRef );

    // catch the bad call
    CHECK_WX_ASSERT( m_sheet.RemovePin( nullptr ) );

    m_sheet.RemovePin( &pinRef );

    // and it's gone
    BOOST_CHECK_EQUAL( m_sheet.HasPins(), false );
    BOOST_CHECK_EQUAL( m_sheet.HasPin( "pinname" ), false );
    BOOST_CHECK_EQUAL( m_sheet.GetPin( pinPos ), nullptr );
}

References CHECK_WX_ASSERT.

BOOST_AUTO_TEST_CASE() [4/5]

BOOST_AUTO_TEST_CASE

(

PinRenumbering

)

Check that pins are added and renumbered to be unique.

Definition at line 147 of file test_sch_sheet.cpp.

{
    for( int i = 0; i < 5; ++i )
    {
        SCH_SHEET_PIN* pin = new SCH_SHEET_PIN( &m_sheet, wxPoint{ i, i }, "name" );

        // set the pins to have the same number going in
        pin->SetNumber( 2 );

        m_sheet.AddPin( pin );
    }

    std::vector<SCH_SHEET_PIN*>& pins = m_sheet.GetPins();

    std::vector<int> numbers;

    for( SCH_SHEET_PIN* pin : pins )
        numbers.push_back( pin->GetNumber() );

    // and now...they are all unique
    BOOST_CHECK_PREDICATE( KI_TEST::CollectionHasNoDuplicates<decltype( numbers )>, ( numbers ) );
}

References KI_TEST::CollectionHasNoDuplicates(), and SCH_SHEET_PIN::SetNumber().

BOOST_AUTO_TEST_CASE() [5/5]

BOOST_AUTO_TEST_CASE

(

EndconnectionPoints

)

Test the endpoint and connection point collections: we should be able to add pins, then have them appear as endpoints.

Definition at line 182 of file test_sch_sheet.cpp.

{
    // x = zero because the pin is clamped to the left side by default
    const std::vector<TEST_END_CONN_PIN> pin_defs = {
        {
            "1name",
            { 0, 13 },
        },
        {
            "2name",
            { 0, 130 },
        },
    };

    // Insert the pins into the sheet
    for( const auto& pin : pin_defs )
        m_sheet.AddPin( new SCH_SHEET_PIN( &m_sheet, pin.m_pos, pin.m_pin_name ) );

    std::vector<SCH_SHEET_PIN*>& pins = m_sheet.GetPins();

    // make sure the pins made it in
    BOOST_CHECK_EQUAL( pins.size(), pin_defs.size() );

    // Check that the EndPoint getter gets the right things
    {
        std::vector<DANGLING_END_ITEM> expectedDangling;

        // Construct expected from the pin, not defs, as we need the pin address
        for( SCH_SHEET_PIN* pin : pins )
        {
            expectedDangling.emplace_back( DANGLING_END_T::SHEET_LABEL_END, pin,
                                           pin->GetPosition(), pin );
        }

        std::vector<DANGLING_END_ITEM> dangling;
        m_sheet.GetEndPoints( dangling );

        BOOST_CHECK_EQUAL_COLLECTIONS( dangling.begin(), dangling.end(),
                                       expectedDangling.begin(), expectedDangling.end() );
    }

    // And check the connection getter
    {
        std::vector<wxPoint> expectedConnections;

        // we want to see every pin that we just added
        for( const auto& pin : pin_defs )
        {
            expectedConnections.push_back( pin.m_pos );
        }

        std::vector<wxPoint> connections = m_sheet.GetConnectionPoints();

        BOOST_CHECK_EQUAL_COLLECTIONS( connections.begin(), connections.end(),
                                       expectedConnections.begin(), expectedConnections.end() );
    }
}

References SHEET_LABEL_END.

operator<<()

std::ostream& operator<<	(	std::ostream &	os,
		DANGLING_END_ITEM const &	d
	)

Print helper.

Not a print_log_value because old Boosts don't like that in BOOST_CHECK_EQUAL_COLLECTIONS

Definition at line 63 of file test_sch_sheet.cpp.

{
    os << "DANGLING_END_ITEM[ type " << d.GetType() << " @(" << d.GetPosition().x << ", "
       << d.GetPosition().y << "), item " << d.GetItem() << ", parent " << d.GetParent() << " ]";
    return os;
}

References DANGLING_END_ITEM::GetItem(), DANGLING_END_ITEM::GetParent(), DANGLING_END_ITEM::GetPosition(), and DANGLING_END_ITEM::GetType().