06a561e36ccc4578bb07af2ac184a19fe74bbc2f
[controller.git] / opendaylight / md-sal / sal-protocolbuffer-encoding / src / test / resources / version-compatibility-serialized-data / readme.txt
1 This directory contains one serialized test data file for one of the messages in each .proto file.
2 These files are utilized as part of the  test cases, mostly to fail the test cases in case some engineer has used
3 a different version of protocol buffer than what we ship with (Protocol Buffer 2.5.0) to generate the messages source f
4 file.
5
6 1. If you see protocolbuffer version/invalid message exception in the test case
7   1. ensure you are using the right version of protocol buffer/protoc compiler i.e protocol
8
9 2. If you have knowingly updated an existing .proto message than please update the corresponding version-compatibility-serialized-data
10 file. You can get the file by commenting out the test file deletion in AbstractMessagesTest look for comments
11
12  /* we will delete only the test file -- comment below if you want to capture the
13        version-compatibility-serialized-data test data file.The file will be generated at root of the sal-protocolbuffer-encoding
14        and you need to move it to version-compatbility-serialized-data folder renaming the file to include suffix <TestFileName>"Data"
15   */
16
17 3. If you are creating a new .proto file -- Follow an existing test case e.g. ThreePhaseCommitCohortMessagesTest to
18    check how the test case is created and create the corresponding serialized test data file in version-compatibility-serialized-data