2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
21 package jalview.viewmodel.styles;
23 import static org.testng.AssertJUnit.assertEquals;
24 import static org.testng.AssertJUnit.assertFalse;
25 import static org.testng.AssertJUnit.assertTrue;
27 import jalview.gui.JvOptionPane;
29 import java.awt.Color;
30 import java.lang.reflect.Field;
31 import java.util.Random;
33 import org.testng.AssertJUnit;
34 import org.testng.annotations.BeforeClass;
35 import org.testng.annotations.Test;
37 public class ViewStyleTest
40 @BeforeClass(alwaysRun = true)
41 public void setUpJvOptionPane()
43 JvOptionPane.setInteractiveMode(false);
44 JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
47 Random r = new Random();
50 * This test uses reflection to set all fields on a ViewStyle, make a copy of
51 * it, and verify all fields match. This test should fail if a getter/setter
52 * pair are added to the class but missing in the copy constructor. Using
53 * reflection in the copy constructor itself is broken by obfuscation when the
56 * To prove this test works, simply comment out a line in the ViewStyle copy
57 * constructor, or add a new member field to ViewStyle.
59 * @throws IllegalAccessException
60 * @throws IllegalArgumentException
62 @Test(groups = { "Functional" })
63 public void testCopyConstructor() throws IllegalArgumentException,
64 IllegalAccessException
66 ViewStyle vs1 = new ViewStyle();
67 Field[] fields = ViewStyle.class.getDeclaredFields();
68 for (Field field : fields)
70 field.setAccessible(true);
71 if (!copyConstructorIgnores(field.getName()))
73 changeValue(vs1, field);
77 ViewStyle vs2 = new ViewStyle(vs1);
79 for (Field field1 : fields)
81 final Object value1 = field1.get(vs1);
82 final Object value2 = field1.get(vs2);
83 String msg = "Mismatch in " + field1.getName() + "(" + value1 + "/"
84 + value2 + ") - not set in copy constructor?";
85 assertEquals(msg, value1, value2);
87 assertEquals("Hashcode not equals", vs1.hashCode(), vs2.hashCode());
91 * Add any field names in here that we expect to be ignored by the copy
97 private boolean copyConstructorIgnores(String name)
106 * Change the value of one field in a ViewStyle object
110 * @throws IllegalAccessException
112 protected void changeValue(ViewStyle vs, Field field)
113 throws IllegalAccessException
115 Class<?> type = field.getType();
117 if (type.toString().contains("com_atlassian_clover"))
119 // instrumentation added for test coverage - ignore
122 if (type.equals(boolean.class) || type.equals(Boolean.class))
124 boolean value = (Boolean) field.get(vs);
125 // System.out.println("Setting " + field.getName() + " to " + !value);
126 field.set(vs, !value);
128 else if (type.equals(short.class) || type.equals(int.class)
129 || type.equals(long.class) || type.equals(float.class)
130 || type.equals(double.class))
132 final int value = (int) (1 + field.getDouble(vs));
133 // System.out.println("Setting " + field.getName() + " to " + value);
134 field.set(vs, value);
136 else if (type.equals(Integer.class))
138 field.set(vs, (int) (1 + getNumberValue(field, vs)));
140 else if (type.equals(Float.class))
142 field.set(vs, (float) (1f + getNumberValue(field, vs)));
144 else if (type.equals(Long.class))
146 field.set(vs, (long) (1L + getNumberValue(field, vs)));
148 else if (type.equals(Double.class))
150 field.set(vs, 1d + getNumberValue(field, vs));
152 else if (type.equals(Short.class))
154 field.set(vs, (short) (1 + getNumberValue(field, vs)));
156 else if (type.equals(Byte.class))
158 field.set(vs, (byte) (1 + getNumberValue(field, vs)));
160 else if (type.equals(Character.class))
162 field.set(vs, (char) (1 + getNumberValue(field, vs)));
164 else if (type.equals(String.class))
166 field.set(vs, "Joe" + field.get(vs));
168 else if (type.equals(Color.class))
170 field.set(vs, Color.RED.equals(field.get(vs)) ? Color.BLACK
175 AssertJUnit.fail("Unhandled field type (add to test): "
176 + field.getName() + ":" + type);
180 private double getNumberValue(Field field, ViewStyle vs)
181 throws IllegalArgumentException, IllegalAccessException
183 if (field.get(vs) == null)
187 return ((Number) field.get(vs)).doubleValue();
191 * Test that the equals method compares every field by changing them one by
192 * one in a cloned ViewStyle.
194 * This test will fail if a new field is added to ViewStyle but not to the
195 * comparisons in ViewStyle.equals().
197 * To confirm that this test works, temporarily comment out one of the field
198 * comparisons in ViewStyle.equals()
200 * @throws IllegalAccessException
201 * @throws IllegalArgumentException
203 @Test(groups = { "Functional" })
204 public void testEquals() throws IllegalArgumentException,
205 IllegalAccessException
207 ViewStyle vs1 = new ViewStyle();
208 ViewStyle vs2 = new ViewStyle(vs1);
210 assertFalse(vs1.equals(null));
211 assertFalse(vs1.equals(this));
212 assertTrue(vs1.equals(vs2));
213 assertTrue(vs2.equals(vs1));
215 Field[] fields = ViewStyle.class.getDeclaredFields();
216 for (Field field : fields)
218 field.setAccessible(true);
219 Object oldValue = field.get(vs2);
220 changeValue(vs2, field);
221 assertFalse("equals method ignores " + field.getName(),
224 if (vs1.hashCode() == vs2.hashCode())
226 // uncomment next line to see which fields hashCode ignores
227 // System.out.println("hashCode ignores " + field.getName());
229 // restore original value before testing the next field
230 field.set(vs2, oldValue);