JAL-3390 unit tests and command and menu refinements
[jalview.git] / test / jalview / ext / rbvi / chimera / ChimeraCommandsTest.java
index f087020..fd4ec69 100644 (file)
@@ -29,19 +29,25 @@ import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 
+import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;
 
 import jalview.structure.AtomSpecModel;
 import jalview.structure.StructureCommandI;
-import jalview.structure.StructureCommandsI;
 
 public class ChimeraCommandsTest
 {
+  private ChimeraCommands testee;
+
+  @BeforeClass(alwaysRun = true)
+  public void setUp()
+  {
+    testee = new ChimeraCommands();
+  }
 
   @Test(groups = { "Functional" })
   public void testColourBySequence()
   {
-
     Map<Object, AtomSpecModel> map = new LinkedHashMap<>();
     ChimeraCommands.addAtomSpecRange(map, Color.blue, "0", 2, 5, "A");
     ChimeraCommands.addAtomSpecRange(map, Color.blue, "0", 7, 7, "B");
@@ -55,8 +61,7 @@ public class ChimeraCommandsTest
 
     // Colours should appear in the Chimera command in the order in which
     // they were added; within colour, by model, by chain, ranges in start order
-    List<StructureCommandI> commands = new ChimeraCommands()
-            .colourBySequence(map);
+    List<StructureCommandI> commands = testee.colourBySequence(map);
     assertEquals(commands.size(), 1);
     assertEquals(commands.get(0).getCommand(),
             "color #0000ff #0:2-5.A,9-23.A,7.B|#1:1.A,4-7.B;color #ffff00 #1:3-5.A,8.A;color #ff0000 #0:3-9.A");
@@ -70,16 +75,14 @@ public class ChimeraCommandsTest
      */
     Map<String, Map<Object, AtomSpecModel>> featuresMap = new LinkedHashMap<>();
     Map<Object, AtomSpecModel> featureValues = new HashMap<>();
-    
+
     /*
      * start with just one feature/value...
      */
     featuresMap.put("chain", featureValues);
     ChimeraCommands.addAtomSpecRange(featureValues, "X", "0", 8, 20, "A");
-  
-    ChimeraCommands commandGenerator = new ChimeraCommands();
-    List<StructureCommandI> commands = commandGenerator
-            .setAttributes(featuresMap);
+
+    List<StructureCommandI> commands = testee.setAttributes(featuresMap);
     assertEquals(1, commands.size());
 
     /*
@@ -93,7 +96,7 @@ public class ChimeraCommandsTest
     ChimeraCommands.addAtomSpecRange(featureValues, "X", "0", 3, 9, "A");
     // same feature value, contiguous range
     ChimeraCommands.addAtomSpecRange(featureValues, "X", "0", 21, 25, "A");
-    commands = commandGenerator.setAttributes(featuresMap);
+    commands = testee.setAttributes(featuresMap);
     assertEquals(1, commands.size());
     assertEquals(commands.get(0).getCommand(),
             "setattr res jv_chain 'X' #0:3-25.A");
@@ -102,14 +105,14 @@ public class ChimeraCommandsTest
     ChimeraCommands.addAtomSpecRange(featureValues, "X", "0", 21, 25, "B");
     // same feature value and chain, different model
     ChimeraCommands.addAtomSpecRange(featureValues, "X", "1", 26, 30, "A");
-    commands = commandGenerator.setAttributes(featuresMap);
+    commands = testee.setAttributes(featuresMap);
     assertEquals(1, commands.size());
     String expected1 = "setattr res jv_chain 'X' #0:3-25.A,21-25.B|#1:26-30.A";
     assertEquals(commands.get(0).getCommand(), expected1);
 
     // same feature, different value
     ChimeraCommands.addAtomSpecRange(featureValues, "Y", "0", 40, 50, "A");
-    commands = commandGenerator.setAttributes(featuresMap);
+    commands = testee.setAttributes(featuresMap);
     assertEquals(2, commands.size());
     // commands are ordered by feature type but not by value
     // so test for the expected command in either order
@@ -123,11 +126,10 @@ public class ChimeraCommandsTest
     featureValues.clear();
     featuresMap.put("side-chain binding!", featureValues);
     ChimeraCommands.addAtomSpecRange(featureValues,
-            "<html>metal <a href=\"http:a.b.c/x\"> 'ion!", "0", 7, 15,
-            "A");
+            "<html>metal <a href=\"http:a.b.c/x\"> 'ion!", "0", 7, 15, "A");
     // feature names are sanitised to change non-alphanumeric to underscore
     // feature values are sanitised to encode single quote characters
-    commands = commandGenerator.setAttributes(featuresMap);
+    commands = testee.setAttributes(featuresMap);
     assertEquals(commands.size(), 1);
     String expected3 = "setattr res jv_side_chain_binding_ '<html>metal <a href=\"http:a.b.c/x\"> &#39;ion!' #0:7-15.A";
     assertTrue(commands.get(0).getCommand().equals(expected3));
@@ -135,28 +137,27 @@ public class ChimeraCommandsTest
 
   /**
    * Tests for the method that prefixes and sanitises a feature name so it can
-   * be used as a valid, namespaced attribute name in Chimera
+   * be used as a valid, namespaced attribute name in Chimera or PyMol
    */
   @Test(groups = { "Functional" })
   public void testMakeAttributeName()
   {
-    assertEquals(ChimeraCommands.makeAttributeName(null), "jv_");
-    assertEquals(ChimeraCommands.makeAttributeName(""), "jv_");
-    assertEquals(ChimeraCommands.makeAttributeName("helix"), "jv_helix");
-    assertEquals(ChimeraCommands.makeAttributeName("Hello World 24"),
+    assertEquals(testee.makeAttributeName(null), "jv_");
+    assertEquals(testee.makeAttributeName(""), "jv_");
+    assertEquals(testee.makeAttributeName("helix"), "jv_helix");
+    assertEquals(testee.makeAttributeName(
+            "Hello World 24"),
             "jv_Hello_World_24");
-    assertEquals(
-            ChimeraCommands.makeAttributeName("!this is-a_very*{odd(name"),
+    assertEquals(testee.makeAttributeName(
+            "!this is-a_very*{odd(name"),
             "jv__this_is_a_very__odd_name");
     // name ending in color gets underscore appended
-    assertEquals(ChimeraCommands.makeAttributeName("helixColor"),
-            "jv_helixColor_");
+    assertEquals(testee.makeAttributeName("helixColor"), "jv_helixColor_");
   }
 
   @Test(groups = "Functional")
   public void testGetAtomSpec()
   {
-    StructureCommandsI testee = new ChimeraCommands();
     AtomSpecModel model = new AtomSpecModel();
     assertEquals(testee.getAtomSpec(model, false), "");
     model.addRange("1", 2, 4, "A");
@@ -191,7 +192,6 @@ public class ChimeraCommandsTest
   @Test(groups = { "Functional" })
   public void testSuperposeStructures()
   {
-    StructureCommandsI testee = new ChimeraCommands();
     AtomSpecModel ref = new AtomSpecModel();
     ref.addRange("1", 12, 14, "A");
     ref.addRange("1", 18, 18, "B");
@@ -206,16 +206,15 @@ public class ChimeraCommandsTest
     String carbonAlphas = "@CA&~@.B-Z&~@.2-9";
     String refSpec = "#1:12-14.A,18.B,22-23.B";
     String toAlignSpec = "#2:15-17.B,20-21.B,22.C";
-    String expected = String.format(
-            "match %s%s %s%s; ribbon %s|%s; focus", toAlignSpec,
-            carbonAlphas, refSpec, carbonAlphas, toAlignSpec, refSpec);
+    String expected = String.format("match %s%s %s%s; ribbon %s|%s; focus",
+            toAlignSpec, carbonAlphas, refSpec, carbonAlphas, toAlignSpec,
+            refSpec);
     assertEquals(command.get(0).getCommand(), expected);
   }
 
   @Test(groups = "Functional")
   public void testGetAtomSpec_alphaOnly()
   {
-    StructureCommandsI testee = new ChimeraCommands();
     AtomSpecModel model = new AtomSpecModel();
     assertEquals(testee.getAtomSpec(model, true), "");
     model.addRange("1", 2, 4, "A");
@@ -248,27 +247,17 @@ public class ChimeraCommandsTest
     model.addRange("5", 25, 35, " "); // empty chain code
     assertEquals(testee.getAtomSpec(model, true),
             "#0:1-4.B,3-10.C@CA&~@.B-Z&~@.2-9|#1:2-5.A,8.A,5-10.B@CA&~@.B-Z&~@.2-9|#5:25-35.@CA&~@.B-Z&~@.2-9");
-  
-  }
-
-  @Test(groups = "Functional")
-  public void testGetModelStartNo()
-  {
-    StructureCommandsI testee = new ChimeraCommands();
-    assertEquals(testee.getModelStartNo(), 0);
   }
 
   @Test(groups = "Functional")
   public void testGetResidueSpec()
   {
-    ChimeraCommands testee = new ChimeraCommands();
     assertEquals(testee.getResidueSpec("ALA"), "::ALA");
   }
 
   @Test(groups = "Functional")
   public void testShowBackbone()
   {
-    ChimeraCommands testee = new ChimeraCommands();
     List<StructureCommandI> cmds = testee.showBackbone();
     assertEquals(cmds.size(), 1);
     assertEquals(cmds.get(0).getCommand(),
@@ -278,7 +267,6 @@ public class ChimeraCommandsTest
   @Test(groups = "Functional")
   public void testOpenCommandFile()
   {
-    ChimeraCommands testee = new ChimeraCommands();
     assertEquals(testee.openCommandFile("nowhere").getCommand(),
             "open cmd:nowhere");
   }
@@ -286,29 +274,104 @@ public class ChimeraCommandsTest
   @Test(groups = "Functional")
   public void testSaveSession()
   {
-    ChimeraCommands testee = new ChimeraCommands();
     assertEquals(testee.saveSession("somewhere").getCommand(),
             "save somewhere");
   }
 
   @Test(groups = "Functional")
+  public void testColourByChain()
+  {
+    assertEquals(testee.colourByChain().getCommand(), "rainbow chain");
+  }
+
+  @Test(groups = { "Functional" })
+  public void testSetBackgroundColour()
+  {
+    StructureCommandI cmd = testee.setBackgroundColour(Color.PINK);
+    assertEquals(cmd.getCommand(), "set bgColor #ffafaf");
+  }
+
+  @Test(groups = { "Functional" })
+  public void testLoadFile()
+  {
+    StructureCommandI cmd = testee.loadFile("/some/filepath");
+    assertEquals(cmd.getCommand(), "open /some/filepath");
+  }
+
+  @Test(groups = { "Functional" })
+  public void testOpenSession()
+  {
+    StructureCommandI cmd = testee.openSession("/some/filepath");
+    assertEquals(cmd.getCommand(), "open chimera:/some/filepath");
+  }
+
+  @Test(groups = "Functional")
+  public void testColourByCharge()
+  {
+    List<StructureCommandI> cmds = testee.colourByCharge();
+    assertEquals(cmds.size(), 1);
+    assertEquals(cmds.get(0)
+            .getCommand(),
+            "color white;color red ::ASP,GLU;color blue ::LYS,ARG;color yellow ::CYS");
+  }
+
+  @Test(groups = "Functional")
   public void testGetColourCommand()
   {
-    ChimeraCommands testee = new ChimeraCommands();
-    assertEquals(testee.getColourCommand("something", Color.MAGENTA)
+    assertEquals(testee.colourResidues("something", Color.MAGENTA)
             .getCommand(),
             "color #ff00ff something");
   }
 
   @Test(groups = "Functional")
+  public void testFocusView()
+  {
+    assertEquals(testee.focusView().getCommand(), "focus");
+  }
+
+  @Test(groups = "Functional")
   public void testSetAttribute()
   {
-    ChimeraCommands testee = new ChimeraCommands();
     AtomSpecModel model = new AtomSpecModel();
     model.addRange("1", 89, 92, "A");
     model.addRange("2", 12, 20, "B");
     model.addRange("2", 8, 9, "B");
-    assertEquals(testee.setAttribute("phi", "27.3", model).getCommand(),
-            "setattr res phi '27.3' #1:89-92.A|#2:8-9.B,12-20.B");
+    assertEquals(testee.setAttribute("jv_kd", "27.3", model).getCommand(),
+            "setattr res jv_kd '27.3' #1:89-92.A|#2:8-9.B,12-20.B");
+  }
+
+  @Test(groups = "Functional")
+  public void testHideAll()
+  {
+    StructureCommandI cmd = testee.hideAll();
+    assertEquals(cmd.getCommand(), "~display all; ~ribbon");
+  }
+
+  @Test(groups = "Functional")
+  public void testHideChain()
+  {
+    StructureCommandI cmd = testee.hideChain("1.1", "B");
+    assertEquals(cmd.getCommand(), "~ribbon #1.1:.B");
+  }
+
+  @Test(groups = "Functional")
+  public void testShowStructures()
+  {
+    /*
+     * with nothing excluded
+     */
+    StructureCommandI cmd = testee.showStructures(null);
+    assertEquals(cmd.getCommand(), "ribbon");
+
+    /*
+     * restricted to specified positions
+     */
+    AtomSpecModel restrictTo = new AtomSpecModel();
+    restrictTo.addRange("1.1", 12, 20, "A");
+    restrictTo.addRange("1.1", 30, 35, "A");
+    restrictTo.addRange("2.1", 11, 30, "B");
+    cmd = testee.showStructures(restrictTo);
+    assertEquals(cmd.getCommand(),
+            "ribbon #1.1:12-20.A,30-35.A|#2.1:11-30.B");
   }
 }