aboutsummaryrefslogtreecommitdiff
path: root/java/core/src/test/java/com/google/protobuf/ParseExceptionsTest.java
blob: 37fa242d87c676751ba582e1c480176d12bfacdd (plain) (blame)
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
package com.google.protobuf;

import com.google.protobuf.DescriptorProtos.DescriptorProto;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;
import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

/**
 * Tests the exceptions thrown when parsing from a stream. The methods on the {@link Parser}
 * interface are specified to only throw {@link InvalidProtocolBufferException}. But we really want
 * to distinguish between invalid protos vs. actual I/O errors (like failures reading from a
 * socket, etc.). So, when we're not using the parser directly, an {@link IOException} should be
 * thrown where appropriate, instead of always an {@link InvalidProtocolBufferException}.
 *
 * @author jh@squareup.com (Joshua Humphries)
 */
public class ParseExceptionsTest {

  private interface ParseTester {
    DescriptorProto parse(InputStream in) throws IOException;
  }

  private byte serializedProto[];

  private void setup() {
    serializedProto = DescriptorProto.getDescriptor().toProto().toByteArray();
  }

  private void setupDelimited() {
    ByteArrayOutputStream bos = new ByteArrayOutputStream();
    try {
      DescriptorProto.getDescriptor().toProto().writeDelimitedTo(bos);
    } catch (IOException e) {
      fail("Exception not expected: " + e);
    }
    serializedProto = bos.toByteArray();
  }

  @Test public void message_parseFrom_InputStream() {
    setup();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        return DescriptorProto.parseFrom(in);
      }
    });
  }

  @Test public void message_parseFrom_InputStreamAndExtensionRegistry() {
    setup();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        return DescriptorProto.parseFrom(in, ExtensionRegistry.newInstance());
      }
    });
  }

  @Test public void message_parseFrom_CodedInputStream() {
    setup();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        return DescriptorProto.parseFrom(CodedInputStream.newInstance(in));
      }
    });
  }

  @Test public void message_parseFrom_CodedInputStreamAndExtensionRegistry() {
    setup();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        return DescriptorProto.parseFrom(CodedInputStream.newInstance(in),
            ExtensionRegistry.newInstance());
      }
    });
  }

  @Test public void message_parseDelimitedFrom_InputStream() {
    setupDelimited();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        return DescriptorProto.parseDelimitedFrom(in);
      }
    });
  }

  @Test public void message_parseDelimitedFrom_InputStreamAndExtensionRegistry() {
    setupDelimited();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        return DescriptorProto.parseDelimitedFrom(in, ExtensionRegistry.newInstance());
      }
    });
  }

  @Test public void messageBuilder_mergeFrom_InputStream() {
    setup();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        return DescriptorProto.newBuilder().mergeFrom(in).build();
      }
    });
  }

  @Test public void messageBuilder_mergeFrom_InputStreamAndExtensionRegistry() {
    setup();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        return DescriptorProto.newBuilder().mergeFrom(in, ExtensionRegistry.newInstance()).build();
      }
    });
  }

  @Test public void messageBuilder_mergeFrom_CodedInputStream() {
    setup();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        return DescriptorProto.newBuilder().mergeFrom(CodedInputStream.newInstance(in)).build();
      }
    });
  }

  @Test public void messageBuilder_mergeFrom_CodedInputStreamAndExtensionRegistry() {
    setup();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        return DescriptorProto.newBuilder()
            .mergeFrom(CodedInputStream.newInstance(in), ExtensionRegistry.newInstance()).build();
      }
    });
  }

  @Test public void messageBuilder_mergeDelimitedFrom_InputStream() {
    setupDelimited();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        DescriptorProto.Builder builder = DescriptorProto.newBuilder();
        builder.mergeDelimitedFrom(in);
        return builder.build();
      }
    });
  }

  @Test public void messageBuilder_mergeDelimitedFrom_InputStreamAndExtensionRegistry() {
    setupDelimited();
    verifyExceptions(new ParseTester() {
      public DescriptorProto parse(InputStream in) throws IOException {
        DescriptorProto.Builder builder = DescriptorProto.newBuilder();
        builder.mergeDelimitedFrom(in, ExtensionRegistry.newInstance());
        return builder.build();
      }
    });
  }

  private void verifyExceptions(ParseTester parseTester) {
    // No exception
    try {
      assertEquals(DescriptorProto.getDescriptor().toProto(),
          parseTester.parse(new ByteArrayInputStream(serializedProto)));
    } catch (IOException e) {
      fail("No exception expected: " + e);
    }

    // IOException
    try {
      // using a "broken" stream that will throw part-way through reading the message
      parseTester.parse(broken(new ByteArrayInputStream(serializedProto)));
      fail("IOException expected but not thrown");
    } catch (IOException e) {
      assertFalse(e instanceof InvalidProtocolBufferException);
    }

    // InvalidProtocolBufferException
    try {
      // make the serialized proto invalid
      for (int i = 0; i < 50; i++) {
        serializedProto[i] = -1;
      }
      parseTester.parse(new ByteArrayInputStream(serializedProto));
      fail("InvalidProtocolBufferException expected but not thrown");
    } catch (IOException e) {
      assertTrue(e instanceof InvalidProtocolBufferException);
    }
  }

  private InputStream broken(InputStream i) {
    return new FilterInputStream(i) {
      int count = 0;

      @Override public int read() throws IOException {
        if (count++ >= 50) {
          throw new IOException("I'm broken!");
        }
        return super.read();
      }

      @Override public int read(byte b[], int off, int len) throws IOException {
        if ((count += len) >= 50) {
          throw new IOException("I'm broken!");
        }
        return super.read(b, off, len);
      }
    };
  }
}