xref: /external/protobuf/java/src/test/java/com/google/protobuf/LazyMessageLiteTest.java

// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package com.google.protobuf;

import protobuf_unittest.LazyFieldsLite.LazyInnerMessageLite;
import protobuf_unittest.LazyFieldsLite.LazyMessageLite;
import protobuf_unittest.LazyFieldsLite.LazyNestedInnerMessageLite;

import junit.framework.TestCase;

import org.easymock.classextension.EasyMock;

import java.util.ArrayList;

/**
 * Unit test for messages with lazy fields.
 *
 * @author niwasaki@google.com (Naoki Iwasaki)
 */
public class LazyMessageLiteTest extends TestCase {

  private Parser<LazyInnerMessageLite> originalLazyInnerMessageLiteParser;

  @Override
  protected void setUp() throws Exception {
    super.setUp();

    originalLazyInnerMessageLiteParser = LazyInnerMessageLite.PARSER;
  }

  @Override
  protected void tearDown() throws Exception {
    LazyInnerMessageLite.PARSER = originalLazyInnerMessageLiteParser;

    super.tearDown();
  }

  public void testSetValues() {
    LazyNestedInnerMessageLite nested = LazyNestedInnerMessageLite.newBuilder()
        .setNum(3)
        .build();
    LazyInnerMessageLite inner = LazyInnerMessageLite.newBuilder()
        .setNum(2)
        .setNested(nested)
        .build();
    LazyMessageLite outer = LazyMessageLite.newBuilder()
        .setNum(1)
        .setInner(inner)
        .setOneofNum(123)
        .setOneofInner(inner)
        .build();

    assertEquals(1, outer.getNum());
    assertEquals(421, outer.getNumWithDefault());

    assertEquals(2, outer.getInner().getNum());
    assertEquals(42, outer.getInner().getNumWithDefault());

    assertEquals(3, outer.getInner().getNested().getNum());
    assertEquals(4, outer.getInner().getNested().getNumWithDefault());

    assertFalse(outer.hasOneofNum());
    assertTrue(outer.hasOneofInner());

    assertEquals(2, outer.getOneofInner().getNum());
    assertEquals(42, outer.getOneofInner().getNumWithDefault());
    assertEquals(3, outer.getOneofInner().getNested().getNum());
    assertEquals(4, outer.getOneofInner().getNested().getNumWithDefault());
  }

  public void testSetRepeatedValues() {
    LazyMessageLite outer = LazyMessageLite.newBuilder()
        .setNum(1)
        .addRepeatedInner(LazyInnerMessageLite.newBuilder().setNum(119))
        .addRepeatedInner(LazyInnerMessageLite.newBuilder().setNum(122))
        .build();

    assertEquals(1, outer.getNum());
    assertEquals(2, outer.getRepeatedInnerCount());
    assertEquals(119, outer.getRepeatedInner(0).getNum());
    assertEquals(122, outer.getRepeatedInner(1).getNum());
  }

  public void testAddAll() {
    ArrayList<LazyInnerMessageLite> inners = new ArrayList<LazyInnerMessageLite>();
    int count = 4;
    for (int i = 0; i < count; i++) {
      LazyInnerMessageLite inner = LazyInnerMessageLite.newBuilder()
          .setNum(i)
          .build();
      inners.add(inner);
    }

    LazyMessageLite outer = LazyMessageLite.newBuilder()
        .addAllRepeatedInner(inners)
        .build();
    assertEquals(count, outer.getRepeatedInnerCount());
    for (int i = 0; i < count; i++) {
      assertEquals(i, outer.getRepeatedInner(i).getNum());
    }
  }

  public void testGetDefaultValues() {
    LazyMessageLite outer = LazyMessageLite.newBuilder()
        .build();

    assertEquals(0, outer.getNum());
    assertEquals(421, outer.getNumWithDefault());

    assertEquals(0, outer.getInner().getNum());
    assertEquals(42, outer.getInner().getNumWithDefault());

    assertEquals(0, outer.getInner().getNested().getNum());
    assertEquals(4, outer.getInner().getNested().getNumWithDefault());

    assertEquals(0, outer.getOneofNum());

    assertEquals(0, outer.getOneofInner().getNum());
    assertEquals(42, outer.getOneofInner().getNumWithDefault());
    assertEquals(0, outer.getOneofInner().getNested().getNum());
    assertEquals(4, outer.getOneofInner().getNested().getNumWithDefault());
  }

  public void testClearValues() {
    LazyInnerMessageLite inner = LazyInnerMessageLite.newBuilder()
        .setNum(115)
        .build();

    LazyMessageLite.Builder outerBuilder = LazyMessageLite.newBuilder();

    assertEquals(0, outerBuilder.build().getNum());


    // Set/Clear num
    outerBuilder.setNum(100);

    assertEquals(100, outerBuilder.build().getNum());
    assertEquals(421, outerBuilder.build().getNumWithDefault());
    assertFalse(outerBuilder.build().hasInner());

    outerBuilder.clearNum();

    assertEquals(0, outerBuilder.build().getNum());
    assertEquals(421, outerBuilder.build().getNumWithDefault());
    assertFalse(outerBuilder.build().hasInner());


    // Set/Clear all
    outerBuilder.setNum(100)
        .setInner(inner)
        .addRepeatedInner(LazyInnerMessageLite.newBuilder().setNum(119))
        .addRepeatedInner(LazyInnerMessageLite.newBuilder().setNum(122))
        .setOneofInner(LazyInnerMessageLite.newBuilder().setNum(123));

    LazyMessageLite outer = outerBuilder.build();
    assertEquals(100, outer.getNum());
    assertEquals(421, outer.getNumWithDefault());
    assertTrue(outer.hasInner());
    assertEquals(115, outer.getInner().getNum());
    assertEquals(2, outer.getRepeatedInnerCount());
    assertEquals(119, outer.getRepeatedInner(0).getNum());
    assertEquals(122, outer.getRepeatedInner(1).getNum());
    assertTrue(outer.hasOneofInner());
    assertEquals(123, outer.getOneofInner().getNum());

    outerBuilder.clear();

    outer = outerBuilder.build();

    assertEquals(0, outer.getNum());
    assertEquals(421, outer.getNumWithDefault());
    assertFalse(outer.hasInner());
    assertEquals(0, outer.getRepeatedInnerCount());
    assertFalse(outer.hasOneofInner());
    assertEquals(0, outer.getOneofInner().getNum());
  }

  public void testMergeValues() {
    LazyMessageLite outerBase = LazyMessageLite.newBuilder()
        .setNumWithDefault(122)
        .build();

    LazyInnerMessageLite innerMerging = LazyInnerMessageLite.newBuilder()
        .setNum(115)
        .build();
    LazyMessageLite outerMerging = LazyMessageLite.newBuilder()
        .setNum(119)
        .setInner(innerMerging)
        .setOneofInner(innerMerging)
        .build();

    LazyMessageLite merged = LazyMessageLite
        .newBuilder(outerBase)
        .mergeFrom(outerMerging)
        .build();
    assertEquals(119, merged.getNum());
    assertEquals(122, merged.getNumWithDefault());
    assertEquals(115, merged.getInner().getNum());
    assertEquals(42, merged.getInner().getNumWithDefault());
    assertEquals(115, merged.getOneofInner().getNum());
    assertEquals(42, merged.getOneofInner().getNumWithDefault());
  }

  public void testMergeDefaultValues() {
    LazyInnerMessageLite innerBase = LazyInnerMessageLite.newBuilder()
        .setNum(115)
        .build();
    LazyMessageLite outerBase = LazyMessageLite.newBuilder()
        .setNum(119)
        .setNumWithDefault(122)
        .setInner(innerBase)
        .setOneofInner(innerBase)
        .build();

    LazyMessageLite outerMerging = LazyMessageLite.newBuilder()
        .build();

    LazyMessageLite merged = LazyMessageLite
        .newBuilder(outerBase)
        .mergeFrom(outerMerging)
        .build();
    // Merging default-instance shouldn't overwrite values in the base message.
    assertEquals(119, merged.getNum());
    assertEquals(122, merged.getNumWithDefault());
    assertEquals(115, merged.getInner().getNum());
    assertEquals(42, merged.getInner().getNumWithDefault());
    assertEquals(115, merged.getOneofInner().getNum());
    assertEquals(42, merged.getOneofInner().getNumWithDefault());
  }

  public void testSerialize() throws InvalidProtocolBufferException {
    LazyNestedInnerMessageLite nested = LazyNestedInnerMessageLite.newBuilder()
        .setNum(3)
        .build();
    LazyInnerMessageLite inner = LazyInnerMessageLite.newBuilder()
        .setNum(2)
        .setNested(nested)
        .build();
    LazyMessageLite outer = LazyMessageLite.newBuilder()
        .setNum(1)
        .setInner(inner)
        .setOneofInner(inner)
        .build();

    ByteString bytes = outer.toByteString();
    assertEquals(bytes.size(), outer.getSerializedSize());

    LazyMessageLite deserialized = LazyMessageLite.parseFrom(bytes);

    assertEquals(1, deserialized.getNum());
    assertEquals(421,  deserialized.getNumWithDefault());

    assertEquals(2,  deserialized.getInner().getNum());
    assertEquals(42,  deserialized.getInner().getNumWithDefault());

    assertEquals(3,  deserialized.getInner().getNested().getNum());
    assertEquals(4,  deserialized.getInner().getNested().getNumWithDefault());

    assertEquals(2,  deserialized.getOneofInner().getNum());
    assertEquals(42,  deserialized.getOneofInner().getNumWithDefault());
    assertEquals(3,  deserialized.getOneofInner().getNested().getNum());
    assertEquals(4,  deserialized.getOneofInner().getNested().getNumWithDefault());

    assertEquals(bytes, deserialized.toByteString());
  }

  public void testLaziness() throws InvalidProtocolBufferException {
    LazyInnerMessageLite inner = LazyInnerMessageLite.newBuilder()
        .setNum(2)
        .build();
    LazyMessageLite outer = LazyMessageLite.newBuilder()
        .setNum(1)
        .setInner(inner)
        .setOneofInner(inner)
        .build();
    ByteString bytes = outer.toByteString();


    // The parser for inner / oneofInner message shouldn't be used if
    // getInner / getOneofInner is not called.
    LazyInnerMessageLite.PARSER = EasyMock.createStrictMock(Parser.class);

    EasyMock.replay(LazyInnerMessageLite.PARSER);

    LazyMessageLite deserialized = LazyMessageLite.parseFrom(bytes);
    assertEquals(1, deserialized.getNum());
    assertEquals(421,  deserialized.getNumWithDefault());

    EasyMock.verify(LazyInnerMessageLite.PARSER);
  }
}