Skip to content

Commit cda2b69

Browse files
authored
Remove bwc_tests_enabled flag (#115456)
In the past, making bwc changes across major version branches required temporarily disabling bwc tests. This was due to timing of adding the change in the old branch, so that bwc tests on the newer branch would pass. In particular there could be discrepancies in transport messages between the two versions. TransportVersion now handles this problem since a new transport version is added along with the bwc change. Unfortunately the gradle flag is used for another purpose now, but developers should no longer manually set it. This commit removes the documentation suggesting the flag be changed for backports.
1 parent c8f2703 commit cda2b69

File tree

1 file changed

+4
-18
lines changed

1 file changed

+4
-18
lines changed

build.gradle

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -221,25 +221,11 @@ tasks.register("verifyVersions") {
221221
}
222222
}
223223

224-
/*
225-
* When adding backcompat behavior that spans major versions, temporarily
226-
* disabling the backcompat tests is necessary. This flag controls
227-
* the enabled state of every bwc task. It should be set back to true
228-
* after the backport of the backcompat code is complete.
229-
*/
230-
224+
// TODO: This flag existed as a mechanism to disable bwc tests during a backport. It is no
225+
// longer used for that purpose, but instead a way to run only functional tests. We should
226+
// rework the functionalTests task to be more explicit about which tasks it wants to run
227+
// so that that this flag is no longer needed.
231228
boolean bwc_tests_enabled = true
232-
// place a PR link here when committing bwc changes:
233-
String bwc_tests_disabled_issue = ""
234-
if (bwc_tests_enabled == false) {
235-
if (bwc_tests_disabled_issue.isEmpty()) {
236-
throw new GradleException("bwc_tests_disabled_issue must be set when bwc_tests_enabled == false")
237-
}
238-
println "========================= WARNING ========================="
239-
println " Backwards compatibility tests are disabled!"
240-
println "See ${bwc_tests_disabled_issue}"
241-
println "==========================================================="
242-
}
243229
if (project.gradle.startParameter.taskNames.any { it.startsWith("checkPart") || it == 'functionalTests' }) {
244230
// Disable BWC tests for checkPart* tasks and platform support tests as it's expected that this will run on it's own check
245231
bwc_tests_enabled = false

0 commit comments

Comments
 (0)