aboutsummaryrefslogtreecommitdiffhomepage
path: root/java/util/src/test/java/com/google/protobuf/util/FieldMaskUtilTest.java
blob: 194f7b9c737b85e21030a2a7884ba7c0941668b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
// 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.util;

import com.google.protobuf.FieldMask;
import protobuf_unittest.UnittestProto.NestedTestAllTypes;
import protobuf_unittest.UnittestProto.TestAllTypes;

import junit.framework.TestCase;

/** Unit tests for {@link FieldMaskUtil}. */
public class FieldMaskUtilTest extends TestCase {
  public void testIsValid() throws Exception {
    assertTrue(FieldMaskUtil.isValid(NestedTestAllTypes.class, "payload"));
    assertFalse(FieldMaskUtil.isValid(NestedTestAllTypes.class, "nonexist"));
    assertTrue(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, "payload.optional_int32"));
    assertTrue(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, "payload.repeated_int32"));
    assertTrue(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, "payload.optional_nested_message"));
    assertTrue(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, "payload.repeated_nested_message"));
    assertFalse(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, "payload.nonexist"));
    
    assertTrue(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, FieldMaskUtil.fromString("payload")));
    assertFalse(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, FieldMaskUtil.fromString("nonexist")));
    assertFalse(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, FieldMaskUtil.fromString("payload,nonexist")));
    
    assertTrue(FieldMaskUtil.isValid(NestedTestAllTypes.getDescriptor(), "payload"));
    assertFalse(FieldMaskUtil.isValid(NestedTestAllTypes.getDescriptor(), "nonexist"));
    
    assertTrue(FieldMaskUtil.isValid(
        NestedTestAllTypes.getDescriptor(), FieldMaskUtil.fromString("payload")));
    assertFalse(FieldMaskUtil.isValid(
        NestedTestAllTypes.getDescriptor(), FieldMaskUtil.fromString("nonexist")));
    
    assertTrue(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, "payload.optional_nested_message.bb"));
    // Repeated fields cannot have sub-paths.
    assertFalse(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, "payload.repeated_nested_message.bb"));
    // Non-message fields cannot have sub-paths.
    assertFalse(FieldMaskUtil.isValid(
        NestedTestAllTypes.class, "payload.optional_int32.bb"));
  }
  
  public void testToString() throws Exception {
    assertEquals("", FieldMaskUtil.toString(FieldMask.getDefaultInstance()));
    FieldMask mask = FieldMask.newBuilder().addPaths("foo").build();
    assertEquals("foo", FieldMaskUtil.toString(mask));
    mask = FieldMask.newBuilder().addPaths("foo").addPaths("bar").build();
    assertEquals("foo,bar", FieldMaskUtil.toString(mask));
    
    // Empty field paths are ignored.
    mask = FieldMask.newBuilder().addPaths("").addPaths("foo").addPaths("").
      addPaths("bar").addPaths("").build();
    assertEquals("foo,bar", FieldMaskUtil.toString(mask));
  }

  public void testFromString() throws Exception {
    FieldMask mask = FieldMaskUtil.fromString("");
    assertEquals(0, mask.getPathsCount());
    mask = FieldMaskUtil.fromString("foo");
    assertEquals(1, mask.getPathsCount());
    assertEquals("foo", mask.getPaths(0));
    mask = FieldMaskUtil.fromString("foo,bar.baz");
    assertEquals(2, mask.getPathsCount());
    assertEquals("foo", mask.getPaths(0));
    assertEquals("bar.baz", mask.getPaths(1));

    // Empty field paths are ignore.
    mask = FieldMaskUtil.fromString(",foo,,bar,");
    assertEquals(2, mask.getPathsCount());
    assertEquals("foo", mask.getPaths(0));
    assertEquals("bar", mask.getPaths(1));

    // Check whether the field paths are valid if a class parameter is provided.
    mask = FieldMaskUtil.fromString(NestedTestAllTypes.class, ",payload");

    try {
      mask = FieldMaskUtil.fromString(
          NestedTestAllTypes.class, "payload,nonexist");
      fail("Exception is expected.");
    } catch (IllegalArgumentException e) {
      // Expected.
    }
  }

  public void testFromFieldNumbers() throws Exception {
    FieldMask mask = FieldMaskUtil.fromFieldNumbers(TestAllTypes.class);
    assertEquals(0, mask.getPathsCount());
    mask =
        FieldMaskUtil.fromFieldNumbers(
            TestAllTypes.class, TestAllTypes.OPTIONAL_INT32_FIELD_NUMBER);
    assertEquals(1, mask.getPathsCount());
    assertEquals("optional_int32", mask.getPaths(0));
    mask =
        FieldMaskUtil.fromFieldNumbers(
            TestAllTypes.class,
            TestAllTypes.OPTIONAL_INT32_FIELD_NUMBER,
            TestAllTypes.OPTIONAL_INT64_FIELD_NUMBER);
    assertEquals(2, mask.getPathsCount());
    assertEquals("optional_int32", mask.getPaths(0));
    assertEquals("optional_int64", mask.getPaths(1));

    try {
      int invalidFieldNumber = 1000;
      mask = FieldMaskUtil.fromFieldNumbers(TestAllTypes.class, invalidFieldNumber);
      fail("Exception is expected.");
    } catch (IllegalArgumentException expected) {
    }
  }
  
  public void testUnion() throws Exception {
    // Only test a simple case here and expect
    // {@link FieldMaskTreeTest#testAddFieldPath} to cover all scenarios.
    FieldMask mask1 = FieldMaskUtil.fromString("foo,bar.baz,bar.quz");
    FieldMask mask2 = FieldMaskUtil.fromString("foo.bar,bar");
    FieldMask result = FieldMaskUtil.union(mask1, mask2);
    assertEquals("bar,foo", FieldMaskUtil.toString(result));
  }

  public void testUnion_usingVarArgs() throws Exception {
    FieldMask mask1 = FieldMaskUtil.fromString("foo");
    FieldMask mask2 = FieldMaskUtil.fromString("foo.bar,bar.quz");
    FieldMask mask3 = FieldMaskUtil.fromString("bar.quz");
    FieldMask mask4 = FieldMaskUtil.fromString("bar");
    FieldMask result = FieldMaskUtil.union(mask1, mask2, mask3, mask4);
    assertEquals("bar,foo", FieldMaskUtil.toString(result));
  }
  
  public void testIntersection() throws Exception {
    // Only test a simple case here and expect
    // {@link FieldMaskTreeTest#testIntersectFieldPath} to cover all scenarios.
    FieldMask mask1 = FieldMaskUtil.fromString("foo,bar.baz,bar.quz");
    FieldMask mask2 = FieldMaskUtil.fromString("foo.bar,bar");
    FieldMask result = FieldMaskUtil.intersection(mask1, mask2);
    assertEquals("bar.baz,bar.quz,foo.bar", FieldMaskUtil.toString(result));
  }
  
  public void testMerge() throws Exception {
    // Only test a simple case here and expect
    // {@link FieldMaskTreeTest#testMerge} to cover all scenarios.
    NestedTestAllTypes source = NestedTestAllTypes.newBuilder()
        .setPayload(TestAllTypes.newBuilder().setOptionalInt32(1234))
        .build();
    NestedTestAllTypes.Builder builder = NestedTestAllTypes.newBuilder();
    FieldMaskUtil.merge(FieldMaskUtil.fromString("payload"), source, builder);
    assertEquals(1234, builder.getPayload().getOptionalInt32());
  }
}