WaveletDataTestBase.java example

Explorer
WaveInCloud-master
/**
 * Copyright 2008 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package org.waveprotocol.wave.model.wave;

import junit.framework.TestCase;

import org.waveprotocol.wave.model.testing.ExtraAsserts;
import org.waveprotocol.wave.model.testing.ModelTestUtils;
import org.waveprotocol.wave.model.util.CollectionUtils;
import org.waveprotocol.wave.model.wave.data.BlipData;
import org.waveprotocol.wave.model.wave.data.WaveletData;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Set;

/**
 * Black-box test of the {@link WaveletData} interface.
 *
 * To create a concrete test case, subclass this with an appropriate factory
 * for creating an {@link WaveletData}.
 *
 * NOTE(user): These tests should not be too complex, because the intent
 * of the {@link WaveletData} interface is that a basic implementation be
 * Too Trivial To Test.  Any non-trivial aspects of a {@link WaveletData}
 * implementation (e.g., sending events, managing locks, ...) are
 * implementation aspects for which implementation-specific tests should be
 * written.
 *
 * @author zdwang@google.com (David Wang)
 * @author anorth@google.com (Alex North)
 */
public abstract class WaveletDataTestBase extends TestCase {

  private WaveletData target;

  /**
   * Creates a wavelet data instance for testing.
   */
  protected abstract WaveletData createWaveletData();

  @Override
  protected void setUp() throws Exception {
    super.setUp();
    target = createWaveletData();
  }

  public void testNewWaveHasCreator() {
    assertNotNull(target.getCreator());
  }

  public void testNewWaveHasNoParticipants() {
    // The creator is NOT automatically a participant.
    assertTrue(target.getParticipants().isEmpty());
  }

  public void testNewWaveHasNoDocuments() {
    assertTrue(target.getDocumentIds().isEmpty());
  }

  public void testCreateBlip() {
    target.createDocument("root", target.getCreator(), Collections.singletonList(target.getCreator()),
        ModelTestUtils.createContent("test"), 42L, 42L);

    BlipData blip = target.getDocument("root");
    assertNotNull(blip);

    // The root blip is retrievable by id.
    assertNotNull(target.getDocument("root"));
    Set<String> docIds = target.getDocumentIds();
    assertEquals(Collections.singleton("root"), docIds);

    assertEquals("root", blip.getId());
    assertEquals(target.getCreator(), blip.getAuthor());
    ExtraAsserts.checkContent("<body><line/>test</body>", blip);
    assertEquals(42L, blip.getLastModifiedTime());
    // Initial value for lastModifiedVersion is not defined.
  }

  public void testCanNotCreateMultipleBlipsWithSameId() {
    target.createDocument("DOCUMENT_NAME", target.getCreator(),
        Collections.singletonList(target.getCreator()), ModelTestUtils.createContent("test"),
        42L, 42L);
    try {
      target.createDocument("DOCUMENT_NAME", target.getCreator(),
          Collections.singletonList(target.getCreator()), ModelTestUtils.createContent("test"),
          42L, 42L);
      fail("Should not be able to create document 2nd time.");
    } catch (IllegalArgumentException ex) {
      // Test is fine.
    }
  }

  public void testGetNonExistentBlipFails() {
    assertNull(target.getDocument("not a real blip id"));
  }

  public void testAddParticipant() {
    ParticipantId fred = new ParticipantId("fred@gwave.com");
    ParticipantId jane = new ParticipantId("jane@gwave.com");
    assertTrue(target.addParticipant(fred));
    assertTrue(target.addParticipant(jane));
  }

  public void testAddParticipantAtPosition() {
    ParticipantId fred = new ParticipantId("fred@gwave.com");
    ParticipantId jane = new ParticipantId("jane@gwave.com");
    assertTrue(target.addParticipant(fred, 0));
    assertEquals(Collections.singleton(fred), target.getParticipants());
    assertFalse(target.addParticipant(fred, 0));
    assertTrue(target.addParticipant(jane, 0));
    assertEquals(
        CollectionUtils.newArrayList(jane, fred),
        CollectionUtils.newArrayList(target.getParticipants()));
    assertFalse(target.addParticipant(jane, 0));
  }

  public void testAddParticipantAtPositionPastEnd() {
    ParticipantId fred = new ParticipantId("fred@gwave.com");
    ParticipantId jane = new ParticipantId("jane@gwave.com");
    try {
      target.addParticipant(fred, 1);
      fail("Should not accept position beyond the end of the participant list");
    } catch (IndexOutOfBoundsException expected) {
      // Test is fine.
    }
    assertTrue(target.addParticipant(fred, 0));
    try {
      target.addParticipant(jane, 2);
      fail("Should not accept position beyond the end of the participant list");
    } catch (IndexOutOfBoundsException expected) {
      // Test is fine.
    }
    assertEquals(Collections.singleton(fred), target.getParticipants());
  }

  public void testRemoveParticipant() {
    ParticipantId fred = new ParticipantId("fred@gwave.com");
    ParticipantId jane = new ParticipantId("jane@gwave.com");
    target.addParticipant(fred);
    target.addParticipant(jane);
    assertTrue(target.removeParticipant(fred));
    assertEquals(Collections.singleton(jane), target.getParticipants());
  }

  public void testAddDuplicateParticipantReturnsFalse() {
    ParticipantId fred = new ParticipantId("fred@gwave.com");
    target.addParticipant(fred);
    assertFalse(target.addParticipant(fred));
    assertEquals(Collections.singleton(fred), target.getParticipants());
  }

  public void testRemoveInvalidParticipantReturnsFalse() {
    ParticipantId fred = new ParticipantId("fred@gwave.com");
    ParticipantId jane = new ParticipantId("jane@gwave.com");
    target.addParticipant(fred);
    assertFalse(target.removeParticipant(jane));
    assertEquals(Collections.singleton(fred), target.getParticipants());
  }

  public void testAddParticipantsRetrievedInOrder() {
    ParticipantId fred = new ParticipantId("fred@gwave.com");
    ParticipantId jane = new ParticipantId("jane@gwave.com");
    target.addParticipant(fred);
    target.addParticipant(jane);
    List<ParticipantId> result = new ArrayList<ParticipantId>();
    for (ParticipantId p : target.getParticipants()) {
      result.add(p);
    }
    assertEquals(Arrays.asList(fred, jane), result);
  }

  public void testRemovalOfMultiplyAddedParticipant() {
    ParticipantId fred = new ParticipantId("fred@gwave.com");
    ParticipantId jane = new ParticipantId("jane@gwave.com");
    target.addParticipant(fred);
    target.addParticipant(fred);
    target.addParticipant(jane);
    assertTrue(target.removeParticipant(fred));
    assertEquals(Collections.singleton(jane), target.getParticipants());
  }

  public void testSetTitle() {
    // TODO(anorth): re-enable this test when the title representation
    // has been confirmed
    //target.setTitle("A wavelet title");
    //assertEquals("A wavelet title", target.getTitle());
  }

  public void testSetVersion() {
    target.setVersion(1234L);
    assertEquals(1234L, target.getVersion());
  }

  public void testSetLastModifiedTime() {
    target.setLastModifiedTime(4321L);
    assertEquals(4321L, target.getLastModifiedTime());
  }
}