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.ext.jmol;
23 import static org.testng.Assert.assertEquals;
24 import static org.testng.Assert.assertTrue;
26 import java.awt.Color;
27 import java.util.HashMap;
28 import java.util.LinkedHashMap;
29 import java.util.List;
32 import org.testng.annotations.BeforeClass;
33 import org.testng.annotations.Test;
35 import jalview.datamodel.Alignment;
36 import jalview.datamodel.AlignmentI;
37 import jalview.datamodel.ColumnSelection;
38 import jalview.datamodel.Sequence;
39 import jalview.datamodel.SequenceI;
40 import jalview.gui.AlignFrame;
41 import jalview.gui.SequenceRenderer;
42 import jalview.schemes.JalviewColourScheme;
43 import jalview.structure.AtomSpecModel;
44 import jalview.structure.StructureCommandI;
45 import jalview.structure.StructureCommandsI.AtomSpecType;
46 import jalview.structure.StructureMapping;
47 import jalview.structure.StructureSelectionManager;
49 public class JmolCommandsTest
51 private JmolCommands testee;
53 @BeforeClass(alwaysRun = true)
56 testee = new JmolCommands();
59 @Test(groups = { "Functional" })
60 public void testGetColourBySequenceCommands_hiddenColumns()
63 * load these sequences, coloured by Strand propensity,
64 * with columns 2-4 hidden
66 SequenceI seq1 = new Sequence("seq1", "MHRSQSSSGG");
67 SequenceI seq2 = new Sequence("seq2", "MVRSNGGSSS");
68 AlignmentI al = new Alignment(new SequenceI[] { seq1, seq2 });
69 AlignFrame af = new AlignFrame(al, 800, 500);
70 af.changeColour_actionPerformed(JalviewColourScheme.Strand.toString());
71 ColumnSelection cs = new ColumnSelection();
75 af.getViewport().setColumnSelection(cs);
76 af.hideSelColumns_actionPerformed(null);
77 SequenceRenderer sr = new SequenceRenderer(af.getViewport());
78 SequenceI[][] seqs = new SequenceI[][] { { seq1 }, { seq2 } };
79 String[] files = new String[] { "seq1.pdb", "seq2.pdb" };
80 StructureSelectionManager ssm = new StructureSelectionManager();
83 * map residues 1-10 to residues 21-30 (atoms 105-150) in structures
85 HashMap<Integer, int[]> map = new HashMap<>();
86 for (int pos = 1; pos <= seq1.getLength(); pos++)
88 map.put(pos, new int[] { 20 + pos, 5 * (20 + pos) });
90 StructureMapping sm1 = new StructureMapping(seq1, "seq1.pdb", "pdb1",
92 ssm.addStructureMapping(sm1);
93 StructureMapping sm2 = new StructureMapping(seq2, "seq2.pdb", "pdb2",
95 ssm.addStructureMapping(sm2);
97 String[] commands = testee.colourBySequence(ssm,
99 seqs, sr, af.alignPanel);
100 assertEquals(commands.length, 2);
102 String chainACommand = commands[0];
103 // M colour is #82827d == (130, 130, 125) (see strand.html help page)
105 chainACommand.contains("select 21:A/1.1;color[130,130,125]")); // first
107 // H colour is #60609f == (96, 96, 159)
108 assertTrue(chainACommand.contains(";select 22:A/1.1;color[96,96,159]"));
109 // hidden columns are Gray (128, 128, 128)
110 assertTrue(chainACommand
111 .contains(";select 23-25:A/1.1;color[128,128,128]"));
112 // S and G are both coloured #4949b6 == (73, 73, 182)
114 chainACommand.contains(";select 26-30:A/1.1;color[73,73,182]"));
116 String chainBCommand = commands[1];
117 // M colour is #82827d == (130, 130, 125)
119 chainBCommand.contains("select 21:B/2.1;color[130,130,125]"));
120 // V colour is #ffff00 == (255, 255, 0)
121 assertTrue(chainBCommand.contains(";select 22:B/2.1;color[255,255,0]"));
122 // hidden columns are Gray (128, 128, 128)
123 assertTrue(chainBCommand
124 .contains(";select 23-25:B/2.1;color[128,128,128]"));
125 // S and G are both coloured #4949b6 == (73, 73, 182)
127 chainBCommand.contains(";select 26-30:B/2.1;color[73,73,182]"));
130 @Test(groups = "Functional")
131 public void testGetAtomSpec()
133 AtomSpecModel model = new AtomSpecModel();
134 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY), "");
135 model.addRange("1", 2, 4, "A");
136 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY), "2-4:A/1.1");
137 model.addRange("1", 8, 8, "A");
138 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY), "2-4:A/1.1|8:A/1.1");
139 model.addRange("1", 5, 7, "B");
140 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY),
141 "2-4:A/1.1|8:A/1.1|5-7:B/1.1");
142 model.addRange("1", 3, 5, "A");
143 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY),
144 "2-5:A/1.1|8:A/1.1|5-7:B/1.1");
145 model.addRange("2", 1, 4, "B");
146 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY),
147 "2-5:A/1.1|8:A/1.1|5-7:B/1.1|1-4:B/2.1");
148 model.addRange("2", 5, 9, "C");
149 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY),
150 "2-5:A/1.1|8:A/1.1|5-7:B/1.1|1-4:B/2.1|5-9:C/2.1");
151 model.addRange("1", 8, 10, "B");
152 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY),
153 "2-5:A/1.1|8:A/1.1|5-10:B/1.1|1-4:B/2.1|5-9:C/2.1");
154 model.addRange("1", 8, 9, "B");
155 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY),
156 "2-5:A/1.1|8:A/1.1|5-10:B/1.1|1-4:B/2.1|5-9:C/2.1");
157 model.addRange("2", 3, 10, "C"); // subsumes 5-9
158 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY),
159 "2-5:A/1.1|8:A/1.1|5-10:B/1.1|1-4:B/2.1|3-10:C/2.1");
160 model.addRange("5", 25, 35, " ");
161 assertEquals(testee.getAtomSpec(model, AtomSpecType.RESIDUE_ONLY),
162 "2-5:A/1.1|8:A/1.1|5-10:B/1.1|1-4:B/2.1|3-10:C/2.1|25-35:/5.1");
166 @Test(groups = { "Functional" })
167 public void testColourBySequence()
169 Map<Object, AtomSpecModel> map = new LinkedHashMap<>();
170 JmolCommands.addAtomSpecRange(map, Color.blue, "1", 2, 5, "A");
171 JmolCommands.addAtomSpecRange(map, Color.blue, "1", 7, 7, "B");
172 JmolCommands.addAtomSpecRange(map, Color.blue, "1", 9, 23, "A");
173 JmolCommands.addAtomSpecRange(map, Color.blue, "2", 1, 1, "A");
174 JmolCommands.addAtomSpecRange(map, Color.blue, "2", 4, 7, "B");
175 JmolCommands.addAtomSpecRange(map, Color.yellow, "2", 8, 8, "A");
176 JmolCommands.addAtomSpecRange(map, Color.yellow, "2", 3, 5, "A");
177 JmolCommands.addAtomSpecRange(map, Color.red, "1", 3, 5, "A");
178 JmolCommands.addAtomSpecRange(map, Color.red, "1", 6, 9, "A");
180 // Colours should appear in the Jmol command in the order in which
181 // they were added; within colour, by model, by chain, ranges in start order
182 List<StructureCommandI> commands = testee.colourBySequence(map);
183 assertEquals(commands.size(), 1);
184 String expected1 = "select 2-5:A/1.1|9-23:A/1.1|7:B/1.1|1:A/2.1|4-7:B/2.1;color[0,0,255]";
185 String expected2 = "select 3-5:A/2.1|8:A/2.1;color[255,255,0]";
186 String expected3 = "select 3-9:A/1.1;color[255,0,0]";
187 assertEquals(commands.get(0).getCommand(),
188 expected1 + ";" + expected2 + ";" + expected3);
191 @Test(groups = { "Functional" })
192 public void testSuperposeStructures()
194 AtomSpecModel ref = new AtomSpecModel();
195 ref.addRange("1", 12, 14, "A");
196 ref.addRange("1", 18, 18, "B");
197 ref.addRange("1", 22, 23, "B");
198 AtomSpecModel toAlign = new AtomSpecModel();
199 toAlign.addRange("2", 15, 17, "B");
200 toAlign.addRange("2", 20, 21, "B");
201 toAlign.addRange("2", 22, 22, "C");
202 List<StructureCommandI> command = testee.superposeStructures(ref,
203 toAlign, AtomSpecType.ALPHA); // doesn't matter for Jmol whether nuc or protein
204 assertEquals(command.size(), 1);
205 String refSpec = "12-14:A/1.1|18:B/1.1|22-23:B/1.1";
206 String toAlignSpec = "15-17:B/2.1|20-21:B/2.1|22:C/2.1";
207 String expected = String.format(
208 "compare {2.1} {1.1} SUBSET {(*.CA | *.P) and conformation=1} ATOMS {%s}{%s} ROTATE TRANSLATE ;select %s|%s;cartoons",
209 toAlignSpec, refSpec, toAlignSpec, refSpec);
210 assertEquals(command.get(0).getCommand(), expected);
213 @Test(groups = "Functional")
214 public void testGetModelStartNo()
216 assertEquals(testee.getModelStartNo(), 1);
219 @Test(groups = "Functional")
220 public void testColourByChain()
222 StructureCommandI cmd = testee.colourByChain();
223 assertEquals(cmd.getCommand(), "select *;color chain");
226 @Test(groups = "Functional")
227 public void testColourByCharge()
229 List<StructureCommandI> cmds = testee.colourByCharge();
230 assertEquals(cmds.size(), 1);
231 assertEquals(cmds.get(0).getCommand(),
232 "select *;color white;select ASP,GLU;color red;"
233 + "select LYS,ARG;color blue;select CYS;color yellow");
236 @Test(groups = "Functional")
237 public void testSetBackgroundColour()
239 StructureCommandI cmd = testee.setBackgroundColour(Color.PINK);
240 assertEquals(cmd.getCommand(), "background [255,175,175]");
243 @Test(groups = "Functional")
244 public void testFocusView()
246 StructureCommandI cmd = testee.focusView();
247 assertEquals(cmd.getCommand(), "zoom 0");
250 @Test(groups = "Functional")
251 public void testSaveSession()
253 StructureCommandI cmd = testee.saveSession("/some/filepath");
254 assertEquals(cmd.getCommand(), "write STATE \"/some/filepath\"");
257 @Test(groups = "Functional")
258 public void testShowBackbone()
260 List<StructureCommandI> cmds = testee.showBackbone();
261 assertEquals(cmds.size(), 1);
262 assertEquals(cmds.get(0).getCommand(),
263 "select *; cartoons off; backbone");
266 @Test(groups = "Functional")
267 public void testLoadFile()
269 StructureCommandI cmd = testee.loadFile("/some/filepath");
270 assertEquals(cmd.getCommand(), "load FILES \"/some/filepath\"");
272 // single backslash gets escaped to double
273 cmd = testee.loadFile("\\some\\filepath");
274 assertEquals(cmd.getCommand(), "load FILES \"\\\\some\\\\filepath\"");
277 @Test(groups = "Functional")
278 public void testOpenSession()
280 StructureCommandI cmd = testee.openSession("/some/filepath");
281 assertEquals(cmd.getCommand(), "load FILES \"/some/filepath\"");
283 // single backslash gets escaped to double
284 cmd = testee.openSession("\\some\\filepath");
285 assertEquals(cmd.getCommand(), "load FILES \"\\\\some\\\\filepath\"");