Correctly parse the skip field for compatibility tests (#7573)

* chore: correctly parse the skip field * chore: update release tracker md
cosmos · Nov 19, 2024 · 7100971 · 7100971
1 parent 0240148
commit 7100971
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/.github/ISSUE_TEMPLATE/release-tracker.md b/.github/ISSUE_TEMPLATE/release-tracker.md
@@ -66,7 +66,7 @@ versions of ibc-go to guarantee that no regression is introduced -->
       - [ ] In `docs/versions.json`.
       - [ ] Rename `docs/versioned_sidebars/version-vx.y.z-sidebars.json`
       - [ ] Rename `docs/versioned_docs/version-vx.y.z`
-- [ ] Update the [compatibility test matrices](https://github.com/cosmos/ibc-go/tree/main/.github/compatibility-test-matrices):
+- [ ] Ensure annotations on tests are correct as per the [compatibility test tool](../../scripts/compatibility.md):
   - Add the new release.
   - Remove any tags that might not be recommended anymore.
 - [ ] Update the manual [e2e `simd`](https://github.com/cosmos/ibc-go/blob/main/.github/workflows/e2e-manual-simd.yaml) test workflow:

diff --git a/e2e/tests/interchain_accounts/base_test.go b/e2e/tests/interchain_accounts/base_test.go
@@ -430,12 +430,12 @@ func (s *InterchainAccountsTestSuite) TestMsgSendTx_SuccessfulTransfer_AfterReop
 	})
 }
 
-// compatibility:TestMsgSendTx_SuccessfulSubmitGovProposal:skip
+// compatibility:TestMsgSendTx_SuccessfulSubmitGovProposal:skip:true
 func (s *InterchainAccountsTestSuite) TestMsgSendTx_SuccessfulSubmitGovProposal() {
 	s.testMsgSendTxSuccessfulGovProposal(channeltypes.ORDERED)
 }
 
-// compatibility:TestMsgSendTx_SuccessfulSubmitGovProposal_UnorderedChannel:skip
+// compatibility:TestMsgSendTx_SuccessfulSubmitGovProposal_UnorderedChannel:skip:true
 func (s *InterchainAccountsTestSuite) TestMsgSendTx_SuccessfulSubmitGovProposal_UnorderedChannel() {
 	s.testMsgSendTxSuccessfulGovProposal(channeltypes.UNORDERED)
 }

diff --git a/scripts/compatibility.md b/scripts/compatibility.md
@@ -35,6 +35,6 @@ The following annotations are supported:
 |-------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
 | from_version            | v7.4.0               | Tests should only run if a semver comparison is greater than or equal to this version. Generally this will just be the minimum supported version of ibc-go                                                                                                                                                          | // compatibility:from_version:v7.4.0                                                 |
 | TEST_NAME:from_versions | v8.4.0,v8.5.0,v9.0.0 | For some tests, they should only be run against a specific release line. This annotation is test case specific, and ensures the test case is run based on the major and minor versions specified. If a version is provided to the tool, and a matching major minor version is not listed, the test will be skipped. | // compatibility:TestScheduleIBCUpgrade_Succeeds:from_versions: v8.4.0,v8.5.0,v9.0.0 |
-| TEST_NAME:skip          | skip                 | A flag to ensure that this test is not included in the compatibility tests at all.                                                                                                                                                                                                                                  | // compatibility:TestMsgSendTx_SuccessfulSubmitGovProposal:skip                      |
+| TEST_NAME:skip          | true                 | A flag to ensure that this test is not included in the compatibility tests at all.                                                                                                                                                                                                                                  | // compatibility:TestMsgSendTx_SuccessfulSubmitGovProposal:skip:true                 |
 
 > Note: if additional control is required, the script can be modified to support additional annotations.
diff --git a/scripts/generate-compatibility-json.py b/scripts/generate-compatibility-json.py
@@ -206,7 +206,7 @@ def _test_should_be_run(test_name: str, version: str, file_fields: Dict) -> bool
     """
 
     # the test has been explicitly marked to be skipped for compatibility tests.
-    if file_fields.get(f"{test_name}:{SKIP}") is not None:
+    if file_fields.get(f"{test_name}:{SKIP}") == "true":
         return False
 
     test_semver_version = parse_version(version)