1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2025 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle;
21
22 import static org.junit.jupiter.api.Assumptions.assumeFalse;
23
24 import java.awt.Component;
25 import java.awt.Container;
26 import java.awt.GraphicsEnvironment;
27
28 import org.junit.jupiter.api.BeforeEach;
29 import org.junit.jupiter.api.extension.ExtendWith;
30
31 import com.github.caciocavallosilano.cacio.ctc.junit.CacioExtension;
32 import com.github.caciocavallosilano.cacio.ctc.junit.CacioTest;
33
34 /**
35 * Abstract base class for testing GUI components.
36 *
37 * @noinspection NewClassNamingConvention
38 * @noinspectionreason Abstract base class for GUI tests
39 */
40 @ExtendWith(CacioExtension.class)
41 @CacioTest
42 public abstract class AbstractGuiTestSupport extends AbstractPathTestSupport {
43
44 /**
45 * Validates the graphics environment.
46 */
47 @BeforeEach
48 public void validateGraphicsEnvironment() {
49 final boolean isHeadless = GraphicsEnvironment.isHeadless();
50 assumeFalse(isHeadless, "This test is incompatible with headless environment");
51 }
52
53 /**
54 * Helper method to find a component by its name.
55 *
56 * @param root the root component to start search
57 * @param name the name of component to find
58 * @param <T> the type of component to find
59 * @return the component if found, {@code null} otherwise
60 * @noinspection unchecked
61 * @noinspectionreason unchecked - we know that any component is OK to typecast to T
62 */
63 protected static <T extends Component> T findComponentByName(Component root, String name) {
64 Component result = null;
65 if (name.equals(root.getName())) {
66 result = root;
67 }
68 else if (root instanceof Container) {
69 final Component[] children = ((Container) root).getComponents();
70 for (Component component : children) {
71 result = findComponentByName(component, name);
72 if (result != null) {
73 break;
74 }
75 }
76 }
77 return (T) result;
78 }
79 }