test/jalview/commands/EditCommandTest.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21 package jalview.commands;
  22
  23 import static org.testng.AssertJUnit.assertEquals;
  24 import static org.testng.AssertJUnit.assertSame;
  25 import static org.testng.AssertJUnit.assertTrue;
  26
  27 import jalview.commands.EditCommand.Action;
  28 import jalview.commands.EditCommand.Edit;
  29 import jalview.datamodel.Alignment;
  30 import jalview.datamodel.AlignmentI;
  31 import jalview.datamodel.Sequence;
  32 import jalview.datamodel.SequenceFeature;
  33 import jalview.datamodel.SequenceI;
  34 import jalview.datamodel.features.SequenceFeatures;
  35 import jalview.gui.JvOptionPane;
  36
  37 import java.util.Collections;
  38 import java.util.Comparator;
  39 import java.util.List;
  40 import java.util.Map;
  41
  42 import org.testng.Assert;
  43 import org.testng.annotations.BeforeClass;
  44 import org.testng.annotations.BeforeMethod;
  45 import org.testng.annotations.Test;
  46
  47 /**
  48  * Unit tests for EditCommand
  49  *
  50  * @author gmcarstairs
  51  *
  52  */
  53 public class EditCommandTest
  54 {
  55   private static Comparator<SequenceFeature> BY_DESCRIPTION = new Comparator<SequenceFeature>()
  56   {
  57
  58     @Override
  59     public int compare(SequenceFeature o1, SequenceFeature o2)
  60     {
  61       return o1.getDescription().compareTo(o2.getDescription());
  62     }
  63   };
  64
  65   private EditCommand testee;
  66
  67   private SequenceI[] seqs;
  68
  69   private Alignment al;
  70
  71   /*
  72    * compute n(n+1)/2 e.g.
  73    * func(5) = 5 + 4 + 3 + 2 + 1 = 15
  74    */
  75   private static int func(int i)
  76   {
  77     return i * (i + 1) / 2;
  78   }
  79
  80   @BeforeClass(alwaysRun = true)
  81   public void setUpJvOptionPane()
  82   {
  83     JvOptionPane.setInteractiveMode(false);
  84     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  85   }
  86
  87   @BeforeMethod(alwaysRun = true)
  88   public void setUp()
  89   {
  90     testee = new EditCommand();
  91     seqs = new SequenceI[4];
  92     seqs[0] = new Sequence("seq0", "abcdefghjk");
  93     seqs[0].setDatasetSequence(new Sequence("seq0ds", "abcdefghjk"));
  94     seqs[1] = new Sequence("seq1", "fghjklmnopq");
  95     seqs[1].setDatasetSequence(new Sequence("seq1ds", "fghjklmnopq"));
  96     seqs[2] = new Sequence("seq2", "qrstuvwxyz");
  97     seqs[2].setDatasetSequence(new Sequence("seq2ds", "qrstuvwxyz"));
  98     seqs[3] = new Sequence("seq3", "1234567890");
  99     seqs[3].setDatasetSequence(new Sequence("seq3ds", "1234567890"));
 100     al = new Alignment(seqs);
 101     al.setGapCharacter('?');
 102   }
 103
 104   /**
 105    * Test inserting gap characters
 106    */
 107   @Test(groups = { "Functional" })
 108   public void testAppendEdit_insertGap()
 109   {
 110     // set a non-standard gap character to prove it is actually used
 111     testee.appendEdit(Action.INSERT_GAP, seqs, 4, 3, al, true);
 112     assertEquals("abcd???efghjk", seqs[0].getSequenceAsString());
 113     assertEquals("fghj???klmnopq", seqs[1].getSequenceAsString());
 114     assertEquals("qrst???uvwxyz", seqs[2].getSequenceAsString());
 115     assertEquals("1234???567890", seqs[3].getSequenceAsString());
 116
 117     // todo: test for handling out of range positions?
 118   }
 119
 120   /**
 121    * Test deleting characters from sequences. Note the deleteGap() action does
 122    * not check that only gap characters are being removed.
 123    */
 124   @Test(groups = { "Functional" })
 125   public void testAppendEdit_deleteGap()
 126   {
 127     testee.appendEdit(Action.DELETE_GAP, seqs, 4, 3, al, true);
 128     assertEquals("abcdhjk", seqs[0].getSequenceAsString());
 129     assertEquals("fghjnopq", seqs[1].getSequenceAsString());
 130     assertEquals("qrstxyz", seqs[2].getSequenceAsString());
 131     assertEquals("1234890", seqs[3].getSequenceAsString());
 132   }
 133
 134   /**
 135    * Test a cut action. The command should store the cut characters to support
 136    * undo.
 137    */
 138   @Test(groups = { "Functional" })
 139   public void testCut()
 140   {
 141     Edit ec = testee.new Edit(Action.CUT, seqs, 4, 3, al);
 142     EditCommand.cut(ec, new AlignmentI[] { al });
 143     assertEquals("abcdhjk", seqs[0].getSequenceAsString());
 144     assertEquals("fghjnopq", seqs[1].getSequenceAsString());
 145     assertEquals("qrstxyz", seqs[2].getSequenceAsString());
 146     assertEquals("1234890", seqs[3].getSequenceAsString());
 147
 148     assertEquals("efg", new String(ec.string[0]));
 149     assertEquals("klm", new String(ec.string[1]));
 150     assertEquals("uvw", new String(ec.string[2]));
 151     assertEquals("567", new String(ec.string[3]));
 152     // TODO: case where whole sequence is deleted as nothing left; etc
 153   }
 154
 155   /**
 156    * Test a Paste action, where this adds sequences to an alignment.
 157    */
 158   @Test(groups = { "Functional" }, enabled = false)
 159   // TODO fix so it works
 160   public void testPaste_addToAlignment()
 161   {
 162     SequenceI[] newSeqs = new SequenceI[2];
 163     newSeqs[0] = new Sequence("newseq0", "ACEFKL");
 164     newSeqs[1] = new Sequence("newseq1", "JWMPDH");
 165
 166     Edit ec = testee.new Edit(Action.PASTE, newSeqs, 0, al.getWidth(), al);
 167     EditCommand.paste(ec, new AlignmentI[] { al });
 168     assertEquals(6, al.getSequences().size());
 169     assertEquals("1234567890", seqs[3].getSequenceAsString());
 170     assertEquals("ACEFKL", seqs[4].getSequenceAsString());
 171     assertEquals("JWMPDH", seqs[5].getSequenceAsString());
 172   }
 173
 174   /**
 175    * Test insertGap followed by undo command
 176    */
 177   @Test(groups = { "Functional" })
 178   public void testUndo_insertGap()
 179   {
 180     // Edit ec = testee.new Edit(Action.INSERT_GAP, seqs, 4, 3, '?');
 181     testee.appendEdit(Action.INSERT_GAP, seqs, 4, 3, al, true);
 182     // check something changed
 183     assertEquals("abcd???efghjk", seqs[0].getSequenceAsString());
 184     testee.undoCommand(new AlignmentI[] { al });
 185     assertEquals("abcdefghjk", seqs[0].getSequenceAsString());
 186     assertEquals("fghjklmnopq", seqs[1].getSequenceAsString());
 187     assertEquals("qrstuvwxyz", seqs[2].getSequenceAsString());
 188     assertEquals("1234567890", seqs[3].getSequenceAsString());
 189   }
 190
 191   /**
 192    * Test deleteGap followed by undo command
 193    */
 194   @Test(groups = { "Functional" })
 195   public void testUndo_deleteGap()
 196   {
 197     testee.appendEdit(Action.DELETE_GAP, seqs, 4, 3, al, true);
 198     // check something changed
 199     assertEquals("abcdhjk", seqs[0].getSequenceAsString());
 200     testee.undoCommand(new AlignmentI[] { al });
 201     // deleteGap doesn't 'remember' deleted characters, only gaps get put back
 202     assertEquals("abcd???hjk", seqs[0].getSequenceAsString());
 203     assertEquals("fghj???nopq", seqs[1].getSequenceAsString());
 204     assertEquals("qrst???xyz", seqs[2].getSequenceAsString());
 205     assertEquals("1234???890", seqs[3].getSequenceAsString());
 206   }
 207
 208   /**
 209    * Test several commands followed by an undo command
 210    */
 211   @Test(groups = { "Functional" })
 212   public void testUndo_multipleCommands()
 213   {
 214     // delete positions 3/4/5 (counting from 1)
 215     testee.appendEdit(Action.DELETE_GAP, seqs, 2, 3, al, true);
 216     assertEquals("abfghjk", seqs[0].getSequenceAsString());
 217     assertEquals("1267890", seqs[3].getSequenceAsString());
 218
 219     // insert 2 gaps after the second residue
 220     testee.appendEdit(Action.INSERT_GAP, seqs, 2, 2, al, true);
 221     assertEquals("ab??fghjk", seqs[0].getSequenceAsString());
 222     assertEquals("12??67890", seqs[3].getSequenceAsString());
 223
 224     // delete positions 4/5/6
 225     testee.appendEdit(Action.DELETE_GAP, seqs, 3, 3, al, true);
 226     assertEquals("ab?hjk", seqs[0].getSequenceAsString());
 227     assertEquals("12?890", seqs[3].getSequenceAsString());
 228
 229     // undo edit commands
 230     testee.undoCommand(new AlignmentI[] { al });
 231     assertEquals("ab?????hjk", seqs[0].getSequenceAsString());
 232     assertEquals("12?????890", seqs[3].getSequenceAsString());
 233   }
 234
 235   /**
 236    * Unit test for JAL-1594 bug: click and drag sequence right to insert gaps -
 237    * undo did not remove them all.
 238    */
 239   @Test(groups = { "Functional" })
 240   public void testUndo_multipleInsertGaps()
 241   {
 242     testee.appendEdit(Action.INSERT_GAP, seqs, 4, 1, al, true);
 243     testee.appendEdit(Action.INSERT_GAP, seqs, 5, 1, al, true);
 244     testee.appendEdit(Action.INSERT_GAP, seqs, 6, 1, al, true);
 245
 246     // undo edit commands
 247     testee.undoCommand(new AlignmentI[] { al });
 248     assertEquals("abcdefghjk", seqs[0].getSequenceAsString());
 249     assertEquals("1234567890", seqs[3].getSequenceAsString());
 250
 251   }
 252
 253   /**
 254    * Test cut followed by undo command
 255    */
 256   @Test(groups = { "Functional" })
 257   public void testUndo_cut()
 258   {
 259     testee.appendEdit(Action.CUT, seqs, 4, 3, al, true);
 260     // check something changed
 261     assertEquals("abcdhjk", seqs[0].getSequenceAsString());
 262     testee.undoCommand(new AlignmentI[] { al });
 263     assertEquals("abcdefghjk", seqs[0].getSequenceAsString());
 264     assertEquals("fghjklmnopq", seqs[1].getSequenceAsString());
 265     assertEquals("qrstuvwxyz", seqs[2].getSequenceAsString());
 266     assertEquals("1234567890", seqs[3].getSequenceAsString());
 267   }
 268
 269   /**
 270    * Test the replace command (used to manually edit a sequence)
 271    */
 272   @Test(groups = { "Functional" })
 273   public void testReplace()
 274   {
 275     // seem to need a dataset sequence on the edited sequence here
 276     seqs[1].createDatasetSequence();
 277     new EditCommand("", Action.REPLACE, "ZXY", new SequenceI[] { seqs[1] },
 278             4, 8, al);
 279     assertEquals("abcdefghjk", seqs[0].getSequenceAsString());
 280     assertEquals("qrstuvwxyz", seqs[2].getSequenceAsString());
 281     assertEquals("1234567890", seqs[3].getSequenceAsString());
 282     seqs[1] = new Sequence("seq1", "fghjZXYnopq");
 283   }
 284
 285   /**
 286    * Test that the addEdit command correctly merges insert gap commands when
 287    * possible.
 288    */
 289   @Test(groups = { "Functional" })
 290   public void testAddEdit_multipleInsertGap()
 291   {
 292     /*
 293      * 3 insert gap in a row (aka mouse drag right):
 294      */
 295     Edit e = new EditCommand().new Edit(Action.INSERT_GAP,
 296             new SequenceI[] { seqs[0] }, 1, 1, al);
 297     testee.addEdit(e);
 298     SequenceI edited = new Sequence("seq0", "a?bcdefghjk");
 299     edited.setDatasetSequence(seqs[0].getDatasetSequence());
 300     e = new EditCommand().new Edit(Action.INSERT_GAP,
 301             new SequenceI[] { edited }, 2, 1, al);
 302     testee.addEdit(e);
 303     edited = new Sequence("seq0", "a??bcdefghjk");
 304     edited.setDatasetSequence(seqs[0].getDatasetSequence());
 305     e = new EditCommand().new Edit(Action.INSERT_GAP,
 306             new SequenceI[] { edited }, 3, 1, al);
 307     testee.addEdit(e);
 308     assertEquals(1, testee.getSize());
 309     assertEquals(Action.INSERT_GAP, testee.getEdit(0).getAction());
 310     assertEquals(1, testee.getEdit(0).getPosition());
 311     assertEquals(3, testee.getEdit(0).getNumber());
 312
 313     /*
 314      * Add a non-contiguous edit - should not be merged.
 315      */
 316     e = new EditCommand().new Edit(Action.INSERT_GAP,
 317             new SequenceI[] { edited }, 5, 2, al);
 318     testee.addEdit(e);
 319     assertEquals(2, testee.getSize());
 320     assertEquals(5, testee.getEdit(1).getPosition());
 321     assertEquals(2, testee.getEdit(1).getNumber());
 322
 323     /*
 324      * Add a Delete after the Insert - should not be merged.
 325      */
 326     e = new EditCommand().new Edit(Action.DELETE_GAP,
 327             new SequenceI[] { edited }, 6, 2, al);
 328     testee.addEdit(e);
 329     assertEquals(3, testee.getSize());
 330     assertEquals(Action.DELETE_GAP, testee.getEdit(2).getAction());
 331     assertEquals(6, testee.getEdit(2).getPosition());
 332     assertEquals(2, testee.getEdit(2).getNumber());
 333   }
 334
 335   /**
 336    * Test that the addEdit command correctly merges delete gap commands when
 337    * possible.
 338    */
 339   @Test(groups = { "Functional" })
 340   public void testAddEdit_multipleDeleteGap()
 341   {
 342     /*
 343      * 3 delete gap in a row (aka mouse drag left):
 344      */
 345     seqs[0].setSequence("a???bcdefghjk");
 346     Edit e = new EditCommand().new Edit(Action.DELETE_GAP,
 347             new SequenceI[] { seqs[0] }, 4, 1, al);
 348     testee.addEdit(e);
 349     assertEquals(1, testee.getSize());
 350
 351     SequenceI edited = new Sequence("seq0", "a??bcdefghjk");
 352     edited.setDatasetSequence(seqs[0].getDatasetSequence());
 353     e = new EditCommand().new Edit(Action.DELETE_GAP,
 354             new SequenceI[] { edited }, 3, 1, al);
 355     testee.addEdit(e);
 356     assertEquals(1, testee.getSize());
 357
 358     edited = new Sequence("seq0", "a?bcdefghjk");
 359     edited.setDatasetSequence(seqs[0].getDatasetSequence());
 360     e = new EditCommand().new Edit(Action.DELETE_GAP,
 361             new SequenceI[] { edited }, 2, 1, al);
 362     testee.addEdit(e);
 363     assertEquals(1, testee.getSize());
 364     assertEquals(Action.DELETE_GAP, testee.getEdit(0).getAction());
 365     assertEquals(2, testee.getEdit(0).getPosition());
 366     assertEquals(3, testee.getEdit(0).getNumber());
 367
 368     /*
 369      * Add a non-contiguous edit - should not be merged.
 370      */
 371     e = new EditCommand().new Edit(Action.DELETE_GAP,
 372             new SequenceI[] { edited }, 2, 1, al);
 373     testee.addEdit(e);
 374     assertEquals(2, testee.getSize());
 375     assertEquals(Action.DELETE_GAP, testee.getEdit(0).getAction());
 376     assertEquals(2, testee.getEdit(1).getPosition());
 377     assertEquals(1, testee.getEdit(1).getNumber());
 378
 379     /*
 380      * Add an Insert after the Delete - should not be merged.
 381      */
 382     e = new EditCommand().new Edit(Action.INSERT_GAP,
 383             new SequenceI[] { edited }, 1, 1, al);
 384     testee.addEdit(e);
 385     assertEquals(3, testee.getSize());
 386     assertEquals(Action.INSERT_GAP, testee.getEdit(2).getAction());
 387     assertEquals(1, testee.getEdit(2).getPosition());
 388     assertEquals(1, testee.getEdit(2).getNumber());
 389   }
 390
 391   /**
 392    * Test that the addEdit command correctly handles 'remove gaps' edits for the
 393    * case when they appear contiguous but are acting on different sequences.
 394    * They should not be merged.
 395    */
 396   @Test(groups = { "Functional" })
 397   public void testAddEdit_removeAllGaps()
 398   {
 399     seqs[0].setSequence("a???bcdefghjk");
 400     Edit e = new EditCommand().new Edit(Action.DELETE_GAP,
 401             new SequenceI[] { seqs[0] }, 4, 1, al);
 402     testee.addEdit(e);
 403
 404     seqs[1].setSequence("f??ghjklmnopq");
 405     Edit e2 = new EditCommand().new Edit(Action.DELETE_GAP, new SequenceI[]
 406     { seqs[1] }, 3, 1, al);
 407     testee.addEdit(e2);
 408     assertEquals(2, testee.getSize());
 409     assertSame(e, testee.getEdit(0));
 410     assertSame(e2, testee.getEdit(1));
 411   }
 412
 413   /**
 414    * Test that the addEdit command correctly merges insert gap commands acting
 415    * on a multi-sequence selection.
 416    */
 417   @Test(groups = { "Functional" })
 418   public void testAddEdit_groupInsertGaps()
 419   {
 420     /*
 421      * 2 insert gap in a row (aka mouse drag right), on two sequences:
 422      */
 423     Edit e = new EditCommand().new Edit(Action.INSERT_GAP, new SequenceI[] {
 424         seqs[0], seqs[1] }, 1, 1, al);
 425     testee.addEdit(e);
 426     SequenceI seq1edited = new Sequence("seq0", "a?bcdefghjk");
 427     seq1edited.setDatasetSequence(seqs[0].getDatasetSequence());
 428     SequenceI seq2edited = new Sequence("seq1", "f?ghjklmnopq");
 429     seq2edited.setDatasetSequence(seqs[1].getDatasetSequence());
 430     e = new EditCommand().new Edit(Action.INSERT_GAP, new SequenceI[] {
 431         seq1edited, seq2edited }, 2, 1, al);
 432     testee.addEdit(e);
 433
 434     assertEquals(1, testee.getSize());
 435     assertEquals(Action.INSERT_GAP, testee.getEdit(0).getAction());
 436     assertEquals(1, testee.getEdit(0).getPosition());
 437     assertEquals(2, testee.getEdit(0).getNumber());
 438     assertEquals(seqs[0].getDatasetSequence(), testee.getEdit(0)
 439             .getSequences()[0].getDatasetSequence());
 440     assertEquals(seqs[1].getDatasetSequence(), testee.getEdit(0)
 441             .getSequences()[1].getDatasetSequence());
 442   }
 443
 444   /**
 445    * Test for 'undoing' a series of gap insertions.
 446    * <ul>
 447    * <li>Start: ABCDEF insert 2 at pos 1</li>
 448    * <li>next: A--BCDEF insert 1 at pos 4</li>
 449    * <li>next: A--B-CDEF insert 2 at pos 0</li>
 450    * <li>last: --A--B-CDEF</li>
 451    * </ul>
 452    */
 453   @Test(groups = { "Functional" })
 454   public void testPriorState_multipleInserts()
 455   {
 456     EditCommand command = new EditCommand();
 457     SequenceI seq = new Sequence("", "--A--B-CDEF");
 458     SequenceI ds = new Sequence("", "ABCDEF");
 459     seq.setDatasetSequence(ds);
 460     SequenceI[] sqs = new SequenceI[] { seq };
 461     Edit e = command.new Edit(Action.INSERT_GAP, sqs, 1, 2, '-');
 462     command.addEdit(e);
 463     e = command.new Edit(Action.INSERT_GAP, sqs, 4, 1, '-');
 464     command.addEdit(e);
 465     e = command.new Edit(Action.INSERT_GAP, sqs, 0, 2, '-');
 466     command.addEdit(e);
 467
 468     Map<SequenceI, SequenceI> unwound = command.priorState(false);
 469     assertEquals("ABCDEF", unwound.get(ds).getSequenceAsString());
 470   }
 471
 472   /**
 473    * Test for 'undoing' a series of gap deletions.
 474    * <ul>
 475    * <li>Start: A-B-C delete 1 at pos 1</li>
 476    * <li>Next: AB-C delete 1 at pos 2</li>
 477    * <li>End: ABC</li>
 478    * </ul>
 479    */
 480   @Test(groups = { "Functional" })
 481   public void testPriorState_removeAllGaps()
 482   {
 483     EditCommand command = new EditCommand();
 484     SequenceI seq = new Sequence("", "ABC");
 485     SequenceI ds = new Sequence("", "ABC");
 486     seq.setDatasetSequence(ds);
 487     SequenceI[] sqs = new SequenceI[] { seq };
 488     Edit e = command.new Edit(Action.DELETE_GAP, sqs, 1, 1, '-');
 489     command.addEdit(e);
 490     e = command.new Edit(Action.DELETE_GAP, sqs, 2, 1, '-');
 491     command.addEdit(e);
 492
 493     Map<SequenceI, SequenceI> unwound = command.priorState(false);
 494     assertEquals("A-B-C", unwound.get(ds).getSequenceAsString());
 495   }
 496
 497   /**
 498    * Test for 'undoing' a single delete edit.
 499    */
 500   @Test(groups = { "Functional" })
 501   public void testPriorState_singleDelete()
 502   {
 503     EditCommand command = new EditCommand();
 504     SequenceI seq = new Sequence("", "ABCDEF");
 505     SequenceI ds = new Sequence("", "ABCDEF");
 506     seq.setDatasetSequence(ds);
 507     SequenceI[] sqs = new SequenceI[] { seq };
 508     Edit e = command.new Edit(Action.DELETE_GAP, sqs, 2, 2, '-');
 509     command.addEdit(e);
 510
 511     Map<SequenceI, SequenceI> unwound = command.priorState(false);
 512     assertEquals("AB--CDEF", unwound.get(ds).getSequenceAsString());
 513   }
 514
 515   /**
 516    * Test 'undoing' a single gap insertion edit command.
 517    */
 518   @Test(groups = { "Functional" })
 519   public void testPriorState_singleInsert()
 520   {
 521     EditCommand command = new EditCommand();
 522     SequenceI seq = new Sequence("", "AB---CDEF");
 523     SequenceI ds = new Sequence("", "ABCDEF");
 524     seq.setDatasetSequence(ds);
 525     SequenceI[] sqs = new SequenceI[] { seq };
 526     Edit e = command.new Edit(Action.INSERT_GAP, sqs, 2, 3, '-');
 527     command.addEdit(e);
 528
 529     Map<SequenceI, SequenceI> unwound = command.priorState(false);
 530     SequenceI prior = unwound.get(ds);
 531     assertEquals("ABCDEF", prior.getSequenceAsString());
 532     assertEquals(1, prior.getStart());
 533     assertEquals(6, prior.getEnd());
 534   }
 535
 536   /**
 537    * Test 'undoing' a single gap insertion edit command, on a sequence whose
 538    * start residue is other than 1
 539    */
 540   @Test(groups = { "Functional" })
 541   public void testPriorState_singleInsertWithOffset()
 542   {
 543     EditCommand command = new EditCommand();
 544     SequenceI seq = new Sequence("", "AB---CDEF", 8, 13);
 545     // SequenceI ds = new Sequence("", "ABCDEF", 8, 13);
 546     // seq.setDatasetSequence(ds);
 547     seq.createDatasetSequence();
 548     SequenceI[] sqs = new SequenceI[] { seq };
 549     Edit e = command.new Edit(Action.INSERT_GAP, sqs, 2, 3, '-');
 550     command.addEdit(e);
 551
 552     Map<SequenceI, SequenceI> unwound = command.priorState(false);
 553     SequenceI prior = unwound.get(seq.getDatasetSequence());
 554     assertEquals("ABCDEF", prior.getSequenceAsString());
 555     assertEquals(8, prior.getStart());
 556     assertEquals(13, prior.getEnd());
 557   }
 558
 559   /**
 560    * Test that mimics 'remove all gaps' action. This generates delete gap edits
 561    * for contiguous gaps in each sequence separately.
 562    */
 563   @Test(groups = { "Functional" })
 564   public void testPriorState_removeGapsMultipleSeqs()
 565   {
 566     EditCommand command = new EditCommand();
 567     String original1 = "--ABC-DEF";
 568     String original2 = "FG-HI--J";
 569     String original3 = "M-NOPQ";
 570
 571     /*
 572      * Two edits for the first sequence
 573      */
 574     SequenceI seq = new Sequence("", "ABC-DEF");
 575     SequenceI ds1 = new Sequence("", "ABCDEF");
 576     seq.setDatasetSequence(ds1);
 577     SequenceI[] sqs = new SequenceI[] { seq };
 578     Edit e = command.new Edit(Action.DELETE_GAP, sqs, 0, 2, '-');
 579     command.addEdit(e);
 580     seq = new Sequence("", "ABCDEF");
 581     seq.setDatasetSequence(ds1);
 582     sqs = new SequenceI[] { seq };
 583     e = command.new Edit(Action.DELETE_GAP, sqs, 3, 1, '-');
 584     command.addEdit(e);
 585
 586     /*
 587      * Two edits for the second sequence
 588      */
 589     seq = new Sequence("", "FGHI--J");
 590     SequenceI ds2 = new Sequence("", "FGHIJ");
 591     seq.setDatasetSequence(ds2);
 592     sqs = new SequenceI[] { seq };
 593     e = command.new Edit(Action.DELETE_GAP, sqs, 2, 1, '-');
 594     command.addEdit(e);
 595     seq = new Sequence("", "FGHIJ");
 596     seq.setDatasetSequence(ds2);
 597     sqs = new SequenceI[] { seq };
 598     e = command.new Edit(Action.DELETE_GAP, sqs, 4, 2, '-');
 599     command.addEdit(e);
 600
 601     /*
 602      * One edit for the third sequence.
 603      */
 604     seq = new Sequence("", "MNOPQ");
 605     SequenceI ds3 = new Sequence("", "MNOPQ");
 606     seq.setDatasetSequence(ds3);
 607     sqs = new SequenceI[] { seq };
 608     e = command.new Edit(Action.DELETE_GAP, sqs, 1, 1, '-');
 609     command.addEdit(e);
 610
 611     Map<SequenceI, SequenceI> unwound = command.priorState(false);
 612     assertEquals(original1, unwound.get(ds1).getSequenceAsString());
 613     assertEquals(original2, unwound.get(ds2).getSequenceAsString());
 614     assertEquals(original3, unwound.get(ds3).getSequenceAsString());
 615   }
 616
 617   /**
 618    * Test that mimics 'remove all gapped columns' action. This generates a
 619    * series Delete Gap edits that each act on all sequences that share a gapped
 620    * column region.
 621    */
 622   @Test(groups = { "Functional" })
 623   public void testPriorState_removeGappedCols()
 624   {
 625     EditCommand command = new EditCommand();
 626     String original1 = "--ABC--DEF";
 627     String original2 = "-G-HI--J";
 628     String original3 = "-M-NO--PQ";
 629
 630     /*
 631      * First edit deletes the first column.
 632      */
 633     SequenceI seq1 = new Sequence("", "-ABC--DEF");
 634     SequenceI ds1 = new Sequence("", "ABCDEF");
 635     seq1.setDatasetSequence(ds1);
 636     SequenceI seq2 = new Sequence("", "G-HI--J");
 637     SequenceI ds2 = new Sequence("", "GHIJ");
 638     seq2.setDatasetSequence(ds2);
 639     SequenceI seq3 = new Sequence("", "M-NO--PQ");
 640     SequenceI ds3 = new Sequence("", "MNOPQ");
 641     seq3.setDatasetSequence(ds3);
 642     SequenceI[] sqs = new SequenceI[] { seq1, seq2, seq3 };
 643     Edit e = command.new Edit(Action.DELETE_GAP, sqs, 0, 1, '-');
 644     command.addEdit(e);
 645
 646     /*
 647      * Second edit deletes what is now columns 4 and 5.
 648      */
 649     seq1 = new Sequence("", "-ABCDEF");
 650     seq1.setDatasetSequence(ds1);
 651     seq2 = new Sequence("", "G-HIJ");
 652     seq2.setDatasetSequence(ds2);
 653     seq3 = new Sequence("", "M-NOPQ");
 654     seq3.setDatasetSequence(ds3);
 655     sqs = new SequenceI[] { seq1, seq2, seq3 };
 656     e = command.new Edit(Action.DELETE_GAP, sqs, 4, 2, '-');
 657     command.addEdit(e);
 658
 659     Map<SequenceI, SequenceI> unwound = command.priorState(false);
 660     assertEquals(original1, unwound.get(ds1).getSequenceAsString());
 661     assertEquals(original2, unwound.get(ds2).getSequenceAsString());
 662     assertEquals(original3, unwound.get(ds3).getSequenceAsString());
 663     assertEquals(ds1, unwound.get(ds1).getDatasetSequence());
 664     assertEquals(ds2, unwound.get(ds2).getDatasetSequence());
 665     assertEquals(ds3, unwound.get(ds3).getDatasetSequence());
 666   }
 667
 668   /**
 669    * Test a cut action's relocation of sequence features
 670    */
 671   @Test(groups = { "Functional" })
 672   public void testCut_withFeatures()
 673   {
 674     /*
 675      * create sequence features before, after and overlapping
 676      * a cut of columns/residues 4-7
 677      */
 678     SequenceI seq0 = seqs[0]; // abcdefghjk/1-10
 679     seq0.addSequenceFeature(new SequenceFeature("before", "", 1, 3, 0f,
 680             null));
 681     seq0.addSequenceFeature(new SequenceFeature("overlap left", "", 2, 6,
 682             0f, null));
 683     seq0.addSequenceFeature(new SequenceFeature("internal", "", 5, 6, 0f,
 684             null));
 685     seq0.addSequenceFeature(new SequenceFeature("overlap right", "", 7, 8,
 686             0f, null));
 687     seq0.addSequenceFeature(new SequenceFeature("after", "", 8, 10, 0f,
 688             null));
 689
 690     /*
 691      * add some contact features
 692      */
 693     SequenceFeature internalContact = new SequenceFeature("disulphide bond", "", 5,
 694             6, 0f, null);
 695     seq0.addSequenceFeature(internalContact); // should get deleted
 696     SequenceFeature overlapLeftContact = new SequenceFeature(
 697             "disulphide bond", "", 2, 6, 0f, null);
 698     seq0.addSequenceFeature(overlapLeftContact); // should get deleted
 699     SequenceFeature overlapRightContact = new SequenceFeature(
 700             "disulphide bond", "", 5, 8, 0f, null);
 701     seq0.addSequenceFeature(overlapRightContact); // should get deleted
 702     SequenceFeature spanningContact = new SequenceFeature(
 703             "disulphide bond", "", 2, 9, 0f, null);
 704     seq0.addSequenceFeature(spanningContact); // should get shortened 3'
 705
 706     /*
 707      * cut columns 3-6 (base 0), residues d-g 4-7
 708      */
 709     Edit ec = testee.new Edit(Action.CUT, seqs, 3, 4, al); // cols 3-6 base 0
 710     EditCommand.cut(ec, new AlignmentI[] { al });
 711
 712     List<SequenceFeature> sfs = seq0.getSequenceFeatures();
 713     SequenceFeatures.sortFeatures(sfs, true);
 714
 715     assertEquals(5, sfs.size()); // features internal to cut were deleted
 716     SequenceFeature sf = sfs.get(0);
 717     assertEquals("before", sf.getType());
 718     assertEquals(1, sf.getBegin());
 719     assertEquals(3, sf.getEnd());
 720     sf = sfs.get(1);
 721     assertEquals("disulphide bond", sf.getType());
 722     assertEquals(2, sf.getBegin());
 723     assertEquals(5, sf.getEnd()); // truncated by cut
 724     sf = sfs.get(2);
 725     assertEquals("overlap left", sf.getType());
 726     assertEquals(2, sf.getBegin());
 727     assertEquals(3, sf.getEnd()); // truncated by cut
 728     sf = sfs.get(3);
 729     assertEquals("after", sf.getType());
 730     assertEquals(4, sf.getBegin()); // shifted left by cut
 731     assertEquals(6, sf.getEnd()); // shifted left by cut
 732     sf = sfs.get(4);
 733     assertEquals("overlap right", sf.getType());
 734     assertEquals(4, sf.getBegin()); // shifted left by cut
 735     assertEquals(4, sf.getEnd()); // truncated by cut
 736   }
 737
 738   /**
 739    * Test a cut action's relocation of sequence features, with full coverage of
 740    * all possible feature and cut locations for a 5-position ungapped sequence
 741    */
 742   @Test(groups = { "Functional" })
 743   public void testCut_withFeatures_exhaustive()
 744   {
 745     /*
 746      * create a sequence features on each subrange of 1-5
 747      */
 748     SequenceI seq0 = new Sequence("seq", "ABCDE");
 749     int start = 8;
 750     int end = 12;
 751     seq0.setStart(start);
 752     seq0.setEnd(end);
 753     AlignmentI alignment = new Alignment(new SequenceI[] { seq0 });
 754     alignment.setDataset(null);
 755     /*
 756      * create a new alignment with shared dataset sequence
 757      */
 758     AlignmentI copy = new Alignment(
 759             new SequenceI[]
 760             { alignment.getDataset().getSequenceAt(0).deriveSequence() });
 761     SequenceI copySeq0 = copy.getSequenceAt(0);
 762
 763     for (int from = start; from <= end; from++)
 764     {
 765       for (int to = from; to <= end; to++)
 766       {
 767         String desc = String.format("%d-%d", from, to);
 768         SequenceFeature sf = new SequenceFeature("test", desc, from, to,
 769                 0f, null);
 770         sf.setValue("from", Integer.valueOf(from));
 771         sf.setValue("to", Integer.valueOf(to));
 772         seq0.addSequenceFeature(sf);
 773       }
 774     }
 775     // sanity check
 776     List<SequenceFeature> sfs = seq0.getSequenceFeatures();
 777     assertEquals(func(5), sfs.size());
 778     assertEquals(sfs, copySeq0.getSequenceFeatures());
 779     String copySequenceFeatures = copySeq0.getSequenceFeatures().toString();
 780     /*
 781      * now perform all possible cuts of subranges of columns 1-5
 782      * and validate the resulting remaining sequence features!
 783      */
 784     SequenceI[] sqs = new SequenceI[] { seq0 };
 785
 786     for (int from = 0; from < seq0.getLength(); from++)
 787     {
 788       for (int to = from; to < seq0.getLength(); to++)
 789       {
 790         EditCommand ec = new EditCommand("Cut", Action.CUT, sqs, from, (to
 791                 - from + 1), alignment);
 792         final String msg = String.format("Cut %d-%d ", from + 1, to + 1);
 793
 794         verifyCut(seq0, from, to, msg, start);
 795
 796         /*
 797          * verify copy alignment dataset sequence unaffected
 798          */
 799         assertEquals("Original dataset sequence was modified",
 800                 copySequenceFeatures,
 801                 copySeq0.getSequenceFeatures().toString());
 802         /*
 803          * verify a new dataset sequence has appeared
 804          */
 805         assertEquals("Wrong Dataset size after cut", 2,
 806                 alignment.getDataset().getHeight());
 807
 808         /*
 809          * undo and verify all restored
 810          */
 811         AlignmentI[] views = new AlignmentI[] { alignment };
 812         ec.undoCommand(views);
 813         sfs = seq0.getSequenceFeatures();
 814         assertEquals("After undo of " + msg, func(5), sfs.size());
 815         verifyUndo(from, to, sfs);
 816
 817         /*
 818          * verify copy alignment dataset sequence still unaffected
 819          */
 820         assertEquals("Original dataset sequence was modified",
 821                 copySequenceFeatures,
 822                 copySeq0.getSequenceFeatures().toString());
 823
 824         /*
 825          * verify dataset sequence has shrunk
 826          */
 827         assertEquals("Wrong Dataset size after cut", 1,
 828                 alignment.getDataset().getHeight());
 829
 830         /*
 831          * redo and verify
 832          */
 833         ec.doCommand(views);
 834         verifyCut(seq0, from, to, msg, start);
 835
 836         /*
 837          * verify copy alignment dataset sequence unaffected
 838          */
 839         assertEquals("Original dataset sequence was modified",
 840                 copySequenceFeatures,
 841                 copySeq0.getSequenceFeatures().toString());
 842
 843         /*
 844          * verify a new dataset sequence has appeared again
 845          */
 846         assertEquals("Wrong Dataset size after cut", 2,
 847                 alignment.getDataset().getHeight());
 848
 849         /*
 850          * undo ready for next cut
 851          */
 852         ec.undoCommand(views);
 853
 854         /*
 855          * final verify that copy alignment dataset sequence is still unaffected
 856          */
 857         assertEquals("Original dataset sequence was modified",
 858                 copySequenceFeatures,
 859                 copySeq0.getSequenceFeatures().toString());
 860         /*
 861          * and that dataset sequence has shrunk
 862          */
 863         assertEquals("Wrong Dataset size after cut", 1,
 864                 alignment.getDataset().getHeight());
 865
 866       }
 867     }
 868   }
 869
 870   /**
 871    * Verify by inspection that the sequence features left on the sequence after
 872    * a cut match the expected results. The trick to this is that we can parse
 873    * each feature's original start-end positions from its description.
 874    *
 875    * @param seq0
 876    * @param from
 877    * @param to
 878    * @param msg
 879    * @param seqStart
 880    */
 881   protected void verifyCut(SequenceI seq0, int from, int to,
 882           final String msg, int seqStart)
 883   {
 884     List<SequenceFeature> sfs;
 885     sfs = seq0.getSequenceFeatures();
 886
 887     Collections.sort(sfs, BY_DESCRIPTION);
 888
 889     /*
 890      * confirm the number of features has reduced by the
 891      * number of features within the cut region i.e. by
 892      * func(length of cut); exception is a cut at start or end of sequence,
 893      * which retains the original coordinates, dataset sequence
 894      * and all its features
 895      */
 896     boolean datasetRetained = from == 0 || to == 4;
 897     if (datasetRetained)
 898     {
 899       // dataset and all features retained
 900       assertEquals(msg, func(5), sfs.size());
 901     }
 902     else if (to - from == 4)
 903     {
 904       // all columns were cut
 905       assertTrue(sfs.isEmpty());
 906     }
 907     else
 908     {
 909       // failure in checkFeatureRelocation is more informative!
 910       assertEquals(msg + "wrong number of features left", func(5)
 911               - func(to - from + 1), sfs.size());
 912     }
 913
 914     /*
 915      * inspect individual features
 916      */
 917     for (SequenceFeature sf : sfs)
 918     {
 919       verifyFeatureRelocation(sf, from + 1, to + 1, !datasetRetained,
 920               seqStart);
 921     }
 922   }
 923
 924   /**
 925    * Check that after Undo, every feature has start/end that match its original
 926    * "start" and "end" properties
 927    *
 928    * @param from
 929    * @param to
 930    * @param sfs
 931    */
 932   protected void verifyUndo(int from, int to, List<SequenceFeature> sfs)
 933   {
 934     for (SequenceFeature sf : sfs)
 935     {
 936       final int oldFrom = ((Integer) sf.getValue("from")).intValue();
 937       final int oldTo = ((Integer) sf.getValue("to")).intValue();
 938       String msg = String.format(
 939               "Undo cut of [%d-%d], feature at [%d-%d] ", from + 1, to + 1,
 940               oldFrom, oldTo);
 941       assertEquals(msg + "start", oldFrom, sf.getBegin());
 942       assertEquals(msg + "end", oldTo, sf.getEnd());
 943     }
 944   }
 945
 946   /**
 947    * Helper method to check a feature has been correctly relocated after a cut
 948    *
 949    * @param sf
 950    * @param from
 951    *          start of cut (first residue cut 1..)
 952    * @param to
 953    *          end of cut (last residue cut 1..)
 954    * @param newDataset
 955    * @param seqStart
 956    */
 957   private void verifyFeatureRelocation(SequenceFeature sf, int from, int to,
 958  boolean newDataset, int seqStart)
 959   {
 960     // TODO handle the gapped sequence case as well
 961     int cutSize = to - from + 1;
 962     final int oldFrom = ((Integer) sf.getValue("from")).intValue();
 963     final int oldTo = ((Integer) sf.getValue("to")).intValue();
 964     final int oldFromPosition = oldFrom - seqStart + 1; // 1..
 965     final int oldToPosition = oldTo - seqStart + 1; // 1..
 966
 967     String msg = String.format(
 968             "Feature %s relocated to %d-%d after cut of %d-%d",
 969             sf.getDescription(), sf.getBegin(), sf.getEnd(), from, to);
 970     if (!newDataset)
 971     {
 972       // dataset retained with all features unchanged
 973       assertEquals("0: " + msg, oldFrom, sf.getBegin());
 974       assertEquals("0: " + msg, oldTo, sf.getEnd());
 975     }
 976     else if (oldToPosition < from)
 977     {
 978       // before cut region so unchanged
 979       assertEquals("1: " + msg, oldFrom, sf.getBegin());
 980       assertEquals("2: " + msg, oldTo, sf.getEnd());
 981     }
 982     else if (oldFromPosition > to)
 983     {
 984       // follows cut region - shift by size of cut
 985       assertEquals("3: " + msg, newDataset ? oldFrom - cutSize : oldFrom,
 986               sf.getBegin());
 987       assertEquals("4: " + msg, newDataset ? oldTo - cutSize : oldTo,
 988               sf.getEnd());
 989     }
 990     else if (oldFromPosition < from && oldToPosition > to)
 991     {
 992       // feature encloses cut region - shrink it right
 993       assertEquals("5: " + msg, oldFrom, sf.getBegin());
 994       assertEquals("6: " + msg, oldTo - cutSize, sf.getEnd());
 995     }
 996     else if (oldFromPosition < from)
 997     {
 998       // feature overlaps left side of cut region - truncated right
 999       assertEquals("7: " + msg, from - 1 + seqStart - 1, sf.getEnd());
1000     }
1001     else if (oldToPosition > to)
1002     {
1003       // feature overlaps right side of cut region - truncated left
1004       assertEquals("8: " + msg, newDataset ? from + seqStart - 1 : to + 1,
1005               sf.getBegin());
1006       assertEquals("9: " + msg, newDataset ? from + oldTo - to - 1 : oldTo,
1007               sf.getEnd());
1008     }
1009     else
1010     {
1011       // feature internal to cut - should have been deleted!
1012       Assert.fail(msg + " - should have been deleted");
1013     }
1014   }
1015
1016   /**
1017    * Test a cut action's relocation of sequence features
1018    */
1019   @Test(groups = { "Functional" })
1020   public void testCut_withFeatures5prime()
1021   {
1022     SequenceI seq0 = new Sequence("seq/8-11", "A-BCC");
1023     seq0.createDatasetSequence();
1024     assertEquals(8, seq0.getStart());
1025     seq0.addSequenceFeature(new SequenceFeature("", "", 10, 11, 0f,
1026             null));
1027     SequenceI[] seqsArray = new SequenceI[] { seq0 };
1028     AlignmentI alignment = new Alignment(seqsArray);
1029
1030     /*
1031      * cut columns of A-B; same dataset sequence is retained, aligned sequence
1032      * start becomes 10
1033      */
1034     Edit ec = testee.new Edit(Action.CUT, seqsArray, 0, 3, alignment);
1035     EditCommand.cut(ec, new AlignmentI[] { alignment });
1036
1037     /*
1038      * feature on CC(10-11) should still be on CC(10-11)
1039      */
1040     assertSame(seq0, alignment.getSequenceAt(0));
1041     assertEquals(10, seq0.getStart());
1042     List<SequenceFeature> sfs = seq0.getSequenceFeatures();
1043     assertEquals(1, sfs.size());
1044     SequenceFeature sf = sfs.get(0);
1045     assertEquals(10, sf.getBegin());
1046     assertEquals(11, sf.getEnd());
1047   }
1048 }