From 330927503326fb3a831f59c38ca1fbad88311612 Mon Sep 17 00:00:00 2001
From: Lawrence Qiu <lawrenceqiu@google.com>
Date: Fri, 13 Sep 2024 16:16:23 +0000
Subject: [PATCH] chore: Add Clirr exemptions for Protobuf 4.27.4 runtime
 (#3188)

Clirr is flagging a bunch of 7006 Method Return Type changed errors. The
Protoc generated changes are source code compatible and should ignore
these errors in our generated code.

See [this
doc](https://docs.google.com/spreadsheets/d/1qEzUWLougtiqh0ocRaG4e8w12pr89o0T_tQvB6YDStE/edit?pli=1&gid=0#gid=0)
for more information. After adding all the Clirr checks exemptions in
this PR to the downstream handwritten libraries, we are no longer seeing
an Clirr failures.
---
 .../clirr/clirr-ignored-differences.xml.j2    | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/library_generation/owlbot/templates/clirr/clirr-ignored-differences.xml.j2 b/library_generation/owlbot/templates/clirr/clirr-ignored-differences.xml.j2
index 6528981704..3fc907802f 100644
--- a/library_generation/owlbot/templates/clirr/clirr-ignored-differences.xml.j2
+++ b/library_generation/owlbot/templates/clirr/clirr-ignored-differences.xml.j2
@@ -15,5 +15,66 @@
     <differenceType>7012</differenceType>
     <className>{{proto_path}}/*OrBuilder</className>
     <method>boolean has*(*)</method>
+  </difference>
+  <!-- The following 7006 exemptions are related to Protobuf 4.27.4 upgrade -->
+  <difference>
+    <differenceType>7006</differenceType>
+    <className>{{proto_path}}/**</className>
+    <method>* getDefaultInstanceForType()</method>
+    <to>**</to>
+  </difference>
+  <difference>
+    <differenceType>7006</differenceType>
+    <className>{{proto_path}}/**</className>
+    <method>* addRepeatedField(*)</method>
+    <to>**</to>
+  </difference>
+  <difference>
+    <differenceType>7006</differenceType>
+    <className>{{proto_path}}/**</className>
+    <method>* clear()</method>
+    <to>**</to>
+  </difference>
+  <difference>
+    <differenceType>7006</differenceType>
+    <className>{{proto_path}}/**</className>
+    <method>* clearField(*)</method>
+    <to>**</to>
+  </difference>
+  <difference>
+    <differenceType>7006</differenceType>
+    <className>{{proto_path}}/**</className>
+    <method>* clearOneof(*)</method>
+    <to>**</to>
+  </difference>
+  <difference>
+    <differenceType>7006</differenceType>
+    <className>{{proto_path}}/**</className>
+    <method>* clone()</method>
+    <to>**</to>
+  </difference>
+  <difference>
+    <differenceType>7006</differenceType>
+    <className>{{proto_path}}/**</className>
+    <method>* mergeUnknownFields(*)</method>
+    <to>**</to>
+  </difference>
+  <difference>
+    <differenceType>7006</differenceType>
+    <className>{{proto_path}}/**</className>
+    <method>* setField(*)</method>
+    <to>**</to>
+  </difference>
+  <difference>
+    <differenceType>7006</differenceType>
+    <className>{{proto_path}}/**</className>
+    <method>* setRepeatedField(*)</method>
+    <to>**</to>
+  </difference>
+  <difference>
+    <differenceType>7006</differenceType>
+    <className>{{proto_path}}/**</className>
+    <method>* setUnknownFields(*)</method>
+    <to>**</to>
   </difference>{% endfor %}
 </differences>