KiCad PCB EDA Suite
Loading...
Searching...
No Matches
test_diff_tree_grouping.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 3
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/gpl-3.0.html
19 * or you may search the http://www.gnu.org website for the version 3 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include <boost/test/unit_test.hpp>
25
27
28
29using namespace KICAD_DIFF;
30
31
32namespace
33{
34
35ITEM_CHANGE MakeChange( const wxString& aType, CHANGE_KIND aKind, std::optional<wxString> aRefdes = std::nullopt )
36{
38 c.id = KIID_PATH( wxS( "/" ) + KIID().AsString() );
39 c.typeName = aType;
40 c.kind = aKind;
41 c.refdes = std::move( aRefdes );
42 return c;
43}
44
45
46std::array<bool, CATEGORY_COUNT> AllVisible()
47{
48 std::array<bool, CATEGORY_COUNT> out{};
49 out.fill( true );
50 return out;
51}
52
53} // namespace
54
55
56BOOST_AUTO_TEST_SUITE( DiffTreeGrouping )
57
58
59// ChangeKindLabel ----------------------------------------------------------
60
61BOOST_AUTO_TEST_CASE( ChangeKindLabel_AllKinds )
62{
63 // Pin that every CHANGE_KIND produces a non-empty label. Locale-dependent
64 // text content can't be asserted strictly but emptiness CAN.
70}
71
72
73// ChangeMatchesSearchFilter ------------------------------------------------
74
75BOOST_AUTO_TEST_CASE( Filter_EmptyMatchesEverything )
76{
77 ITEM_CHANGE c = MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::MODIFIED );
78 BOOST_CHECK( ChangeMatchesSearchFilter( c, wxS( "" ) ) );
79}
80
81
82BOOST_AUTO_TEST_CASE( Filter_TypeNameSubstring )
83{
84 ITEM_CHANGE c = MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::MODIFIED );
85 BOOST_CHECK( ChangeMatchesSearchFilter( c, wxS( "track" ) ) );
86 BOOST_CHECK( ChangeMatchesSearchFilter( c, wxS( "pcb" ) ) );
87 BOOST_CHECK( !ChangeMatchesSearchFilter( c, wxS( "via" ) ) );
88}
89
90
91BOOST_AUTO_TEST_CASE( Filter_RefdesSubstring )
92{
93 ITEM_CHANGE c = MakeChange( wxS( "FOOTPRINT" ), CHANGE_KIND::MODIFIED, wxS( "R12" ) );
94 BOOST_CHECK( ChangeMatchesSearchFilter( c, wxS( "r12" ) ) );
95 BOOST_CHECK( ChangeMatchesSearchFilter( c, wxS( "r" ) ) );
96 BOOST_CHECK( !ChangeMatchesSearchFilter( c, wxS( "c4" ) ) );
97}
98
99
100BOOST_AUTO_TEST_CASE( Filter_AbsentRefdesNoMatch )
101{
102 // No refdes -> only typeName can match. A filter that would match a
103 // hypothetical refdes must not accidentally hit on a missing optional.
104 ITEM_CHANGE c = MakeChange( wxS( "ZONE" ), CHANGE_KIND::ADDED );
105 BOOST_CHECK( !ChangeMatchesSearchFilter( c, wxS( "u1" ) ) );
106}
107
108
109BOOST_AUTO_TEST_CASE( Filter_AssumesLowercaseInput )
110{
111 // The function explicitly requires the caller to pre-lowercase the
112 // filter (otherwise repeated calls would re-lowercase the same string
113 // for every item). Pin that contract: uppercase filter does NOT match.
114 ITEM_CHANGE c = MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::MODIFIED );
115 BOOST_CHECK( !ChangeMatchesSearchFilter( c, wxS( "TRACK" ) ) );
116}
117
118
119// BuildChangeTreeGroups ----------------------------------------------------
120
121BOOST_AUTO_TEST_CASE( Groups_EmptyDiffProducesEmptyResult )
122{
123 DOCUMENT_DIFF diff;
124 auto groups = BuildChangeTreeGroups( diff, wxS( "" ), AllVisible() );
125 BOOST_CHECK( groups.empty() );
126}
127
128
129BOOST_AUTO_TEST_CASE( Groups_BucketsByKind )
130{
131 DOCUMENT_DIFF diff;
132 diff.changes.push_back( MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::ADDED ) );
133 diff.changes.push_back( MakeChange( wxS( "PCB_VIA" ), CHANGE_KIND::ADDED ) );
134 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::REMOVED ) );
135
136 auto groups = BuildChangeTreeGroups( diff, wxS( "" ), AllVisible() );
137 BOOST_REQUIRE_EQUAL( groups.size(), 2u );
138
139 // std::map iterates in key (enum value) order; ADDED < REMOVED.
140 BOOST_CHECK( groups[0].kind == CHANGE_KIND::ADDED );
141 BOOST_CHECK_EQUAL( groups[0].entries.size(), 2u );
142 BOOST_CHECK( groups[1].kind == CHANGE_KIND::REMOVED );
143 BOOST_CHECK_EQUAL( groups[1].entries.size(), 1u );
144}
145
146
147BOOST_AUTO_TEST_CASE( Groups_RecursesIntoChildren )
148{
149 // Footprint with two child pad changes; each child must land in its
150 // own bucket entry so per-pad highlighting works in the dialog.
151 DOCUMENT_DIFF diff;
152 ITEM_CHANGE fp = MakeChange( wxS( "FOOTPRINT" ), CHANGE_KIND::MODIFIED );
153 fp.children.push_back( MakeChange( wxS( "PAD" ), CHANGE_KIND::MODIFIED ) );
154 fp.children.push_back( MakeChange( wxS( "PAD" ), CHANGE_KIND::ADDED ) );
155 diff.changes.push_back( std::move( fp ) );
156
157 auto groups = BuildChangeTreeGroups( diff, wxS( "" ), AllVisible() );
158 BOOST_REQUIRE_EQUAL( groups.size(), 2u );
159
160 // ADDED bucket: the added-pad child.
161 BOOST_CHECK( groups[0].kind == CHANGE_KIND::ADDED );
162 BOOST_CHECK_EQUAL( groups[0].entries.size(), 1u );
163
164 // MODIFIED bucket: the parent footprint + the modified-pad child.
165 BOOST_CHECK( groups[1].kind == CHANGE_KIND::MODIFIED );
166 BOOST_CHECK_EQUAL( groups[1].entries.size(), 2u );
167}
168
169
170BOOST_AUTO_TEST_CASE( Groups_FootprintLibraryKeepsPadsUnderTheirFootprint )
171{
172 DOCUMENT_DIFF diff;
173 diff.docType = wxS( "pretty" );
174
175 ITEM_CHANGE fp = MakeChange( wxS( "FOOTPRINT" ), CHANGE_KIND::MODIFIED, wxS( "R_0402" ) );
176 fp.children.push_back( MakeChange( wxS( "Pad" ), CHANGE_KIND::MODIFIED, wxS( "2" ) ) );
177 diff.changes.push_back( std::move( fp ) );
178
179 auto groups = BuildChangeTreeGroups( diff, wxS( "" ), AllVisible() );
180 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
181 BOOST_REQUIRE_EQUAL( groups[0].entries.size(), 1u );
182 BOOST_CHECK( *groups[0].entries[0].change->refdes == wxS( "R_0402" ) );
183}
184
185
186BOOST_AUTO_TEST_CASE( Groups_CollapsesSameNetRoutingChanges )
187{
188 DOCUMENT_DIFF diff;
189
190 diff.changes.push_back( MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::MODIFIED, wxS( "Net-(U1-Pad1)" ) ) );
191 diff.changes.push_back( MakeChange( wxS( "PCB_VIA" ), CHANGE_KIND::MODIFIED, wxS( "Net-(U1-Pad1)" ) ) );
192 diff.changes.push_back( MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::MODIFIED, wxS( "GND" ) ) );
193
194 auto groups = BuildChangeTreeGroups( diff, wxS( "" ), AllVisible() );
195 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
196 BOOST_REQUIRE_EQUAL( groups[0].entries.size(), 2u );
197 BOOST_CHECK( groups[0].entries[0].itemLabel == wxS( "NET [GND]" ) );
198 BOOST_CHECK( groups[0].entries[1].itemLabel == wxS( "NET [Net-(U1-Pad1)]" ) );
199}
200
201
202BOOST_AUTO_TEST_CASE( Groups_LabelIncludesRefdes )
203{
204 DOCUMENT_DIFF diff;
205 diff.changes.push_back( MakeChange( wxS( "FOOTPRINT" ), CHANGE_KIND::ADDED, wxS( "U7" ) ) );
206
207 auto groups = BuildChangeTreeGroups( diff, wxS( "" ), AllVisible() );
208 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
209 BOOST_REQUIRE_EQUAL( groups[0].entries.size(), 1u );
210 BOOST_CHECK( groups[0].entries[0].itemLabel == wxS( "FOOTPRINT [U7]" ) );
211}
212
213
214BOOST_AUTO_TEST_CASE( Groups_LabelBaseWhenRefdesAbsent )
215{
216 DOCUMENT_DIFF diff;
217 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::ADDED ) );
218
219 auto groups = BuildChangeTreeGroups( diff, wxS( "" ), AllVisible() );
220 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
221 BOOST_CHECK( groups[0].entries[0].itemLabel == wxS( "ZONE" ) );
222}
223
224
225BOOST_AUTO_TEST_CASE( Groups_HiddenCategoryDropsBucket )
226{
227 // ADDED maps to CATEGORY::ADDED. Hide it; the bucket must vanish.
228 DOCUMENT_DIFF diff;
229 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::ADDED ) );
230 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::REMOVED ) );
231
232 std::array<bool, CATEGORY_COUNT> visible{};
233 visible.fill( true );
234 visible[static_cast<std::size_t>( CATEGORY::ADDED )] = false;
235
236 auto groups = BuildChangeTreeGroups( diff, wxS( "" ), visible );
237 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
238 BOOST_CHECK( groups[0].kind == CHANGE_KIND::REMOVED );
239}
240
241
242BOOST_AUTO_TEST_CASE( Groups_CollisionAndDuplicateBothMapToConflictCategory )
243{
244 // Hiding CATEGORY::CONFLICT must drop both kinds at once.
245 DOCUMENT_DIFF diff;
246 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::COLLISION ) );
247 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::DUPLICATE_UUID ) );
248 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::MODIFIED ) );
249
250 std::array<bool, CATEGORY_COUNT> visible{};
251 visible.fill( true );
252 visible[static_cast<std::size_t>( CATEGORY::CONFLICT )] = false;
253
254 auto groups = BuildChangeTreeGroups( diff, wxS( "" ), visible );
255 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
256 BOOST_CHECK( groups[0].kind == CHANGE_KIND::MODIFIED );
257}
258
259
260BOOST_AUTO_TEST_CASE( Groups_SearchFilterDropsNonMatching )
261{
262 DOCUMENT_DIFF diff;
263 diff.changes.push_back( MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::MODIFIED ) );
264 diff.changes.push_back( MakeChange( wxS( "PCB_VIA" ), CHANGE_KIND::MODIFIED ) );
265 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::MODIFIED ) );
266
267 // Filter for "track" — only PCB_TRACK matches.
268 auto groups = BuildChangeTreeGroups( diff, wxS( "track" ), AllVisible() );
269 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
270 BOOST_REQUIRE_EQUAL( groups[0].entries.size(), 1u );
271 BOOST_CHECK( groups[0].entries[0].change->typeName == wxS( "PCB_TRACK" ) );
272}
273
274
275BOOST_AUTO_TEST_CASE( Groups_FilterIsCaseInsensitive )
276{
277 // User input doesn't have to be lowercased — `BuildChangeTreeGroups`
278 // lowercases internally. This is the contract distinguishing the
279 // higher-level function from `ChangeMatchesSearchFilter` (which
280 // requires pre-lowercased input).
281 DOCUMENT_DIFF diff;
282 diff.changes.push_back( MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::ADDED ) );
283
284 auto groups = BuildChangeTreeGroups( diff, wxS( "TRACK" ), AllVisible() );
285 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
286 BOOST_CHECK_EQUAL( groups[0].entries.size(), 1u );
287}
288
289
290BOOST_AUTO_TEST_CASE( Groups_GroupLabelShowsTotal_NoFilter )
291{
292 DOCUMENT_DIFF diff;
293 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::ADDED ) );
294 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::ADDED ) );
295 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::ADDED ) );
296
297 auto groups = BuildChangeTreeGroups( diff, wxS( "" ), AllVisible() );
298 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
299 // "Kind (3)" format when there's no filter.
300 BOOST_CHECK( groups[0].groupLabel.EndsWith( wxS( "(3)" ) ) );
301}
302
303
304BOOST_AUTO_TEST_CASE( Groups_GroupLabelShowsVisibleSlashTotal_WithFilter )
305{
306 DOCUMENT_DIFF diff;
307 diff.changes.push_back( MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::ADDED ) );
308 diff.changes.push_back( MakeChange( wxS( "PCB_VIA" ), CHANGE_KIND::ADDED ) );
309 diff.changes.push_back( MakeChange( wxS( "ZONE" ), CHANGE_KIND::ADDED ) );
310
311 // Filter matches only PCB_TRACK -> 1 of 3 visible.
312 auto groups = BuildChangeTreeGroups( diff, wxS( "track" ), AllVisible() );
313 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
314 BOOST_CHECK( groups[0].groupLabel.EndsWith( wxS( "(1/3)" ) ) );
315}
316
317
318BOOST_AUTO_TEST_CASE( Groups_GroupLabelOmitsSlashWhenFilterMatchesAll )
319{
320 // Filter matches every item in the group — the V/N form would just
321 // be N/N, which is noisy. The function falls back to (N) in that case.
322 DOCUMENT_DIFF diff;
323 diff.changes.push_back( MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::ADDED ) );
324 diff.changes.push_back( MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::ADDED ) );
325
326 auto groups = BuildChangeTreeGroups( diff, wxS( "track" ), AllVisible() );
327 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
328 BOOST_CHECK( groups[0].groupLabel.EndsWith( wxS( "(2)" ) ) );
329}
330
331
332BOOST_AUTO_TEST_CASE( Groups_EmptyBucketAfterFilterIsOmitted )
333{
334 DOCUMENT_DIFF diff;
335 diff.changes.push_back( MakeChange( wxS( "PCB_TRACK" ), CHANGE_KIND::ADDED ) );
336 diff.changes.push_back( MakeChange( wxS( "PCB_VIA" ), CHANGE_KIND::REMOVED ) );
337
338 // Filter matches only the ADDED bucket; the REMOVED bucket must
339 // disappear (UI doesn't show empty groups).
340 auto groups = BuildChangeTreeGroups( diff, wxS( "track" ), AllVisible() );
341 BOOST_REQUIRE_EQUAL( groups.size(), 1u );
342 BOOST_CHECK( groups[0].kind == CHANGE_KIND::ADDED );
343}
344
345
Definition kiid.h:46
CHANGE_KIND
Coarse classification of a single item-level change between two documents.
bool ChangeMatchesSearchFilter(const ITEM_CHANGE &aChange, const wxString &aLowercaseFilter)
Predicate: does this item change match the active search filter?
std::vector< CHANGE_TREE_GROUP > BuildChangeTreeGroups(const DOCUMENT_DIFF &aDiff, const wxString &aSearchFilter, const std::array< bool, CATEGORY_COUNT > &aVisibleCategories)
Group the changes in a DOCUMENT_DIFF by kind, apply category and search filters, and return the resul...
wxString ChangeKindLabel(CHANGE_KIND aKind)
Human-readable label for a CHANGE_KIND (e.g.
_OUT_STRING AsString(const std::string &aString)
Definition sexpr.h:131
The full set of changes between two parsed documents of one type.
std::vector< ITEM_CHANGE > changes
One change record on a single item.
std::optional< wxString > refdes
std::vector< ITEM_CHANGE > children
BOOST_AUTO_TEST_CASE(HorizontalAlignment)
BOOST_AUTO_TEST_SUITE(CadstarPartParser)
BOOST_CHECK(res.column_datatype(0)==SQL_NUMERIC||res.column_datatype(0)==SQL_DECIMAL)
BOOST_REQUIRE_EQUAL(rows.size(), 1)
BOOST_CHECK_EQUAL(std::any_cast< std::string >(rows[0].at("val")), "12345678901234567.89")
BOOST_AUTO_TEST_CASE(ChangeKindLabel_AllKinds)
BOOST_AUTO_TEST_SUITE_END()