Fixing flaky test when Typshed builtins are poisoned with an incomplete Python Version Set (#1111)

joke1196 · sonartech · commit ac96e16fd080 · 2026-05-11T15:01:53.000Z
GitOrigin-RevId: 28935d3d2f89344d3d68d5064fc21343e8a6d639
diff --git a/python-checks/src/test/java/org/sonar/python/checks/CompressionModulesFromNamespaceCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/CompressionModulesFromNamespaceCheckTest.java
@@ -17,15 +17,23 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 class CompressionModulesFromNamespaceCheckTest {
 
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_314));
diff --git a/python-checks/src/test/java/org/sonar/python/checks/FStringNestingLevelCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/FStringNestingLevelCheckTest.java
@@ -20,13 +20,21 @@
 
 import java.util.EnumSet;
 
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 class FStringNestingLevelCheckTest {
 
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test_1() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_312));
diff --git a/python-checks/src/test/java/org/sonar/python/checks/GenericClassTypeParameterCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/GenericClassTypeParameterCheckTest.java
@@ -17,14 +17,23 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 class GenericClassTypeParameterCheckTest {
+
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test_python_3_12_only() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_312));
diff --git a/python-checks/src/test/java/org/sonar/python/checks/GenericFunctionTypeParameterCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/GenericFunctionTypeParameterCheckTest.java
@@ -17,15 +17,23 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 class GenericFunctionTypeParameterCheckTest {
 
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test_1() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_312));
diff --git a/python-checks/src/test/java/org/sonar/python/checks/GenericTypeStatementCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/GenericTypeStatementCheckTest.java
@@ -17,17 +17,25 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 class GenericTypeStatementCheckTest {
 
   private static final GenericTypeStatementCheck check = new GenericTypeStatementCheck();
 
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test_1() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_312));
diff --git a/python-checks/src/test/java/org/sonar/python/checks/NotImplementedBooleanContextCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/NotImplementedBooleanContextCheckTest.java
@@ -17,15 +17,23 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 class NotImplementedBooleanContextCheckTest {
 
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_314));
diff --git a/python-checks/src/test/java/org/sonar/python/checks/PytzUsageCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/PytzUsageCheckTest.java
@@ -17,12 +17,21 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 class PytzUsageCheckTest {
+
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test_39_310_311_312() {
     ProjectPythonVersion
diff --git a/python-checks/src/test/java/org/sonar/python/checks/TemplateAndStrConcatenationCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/TemplateAndStrConcatenationCheckTest.java
@@ -17,15 +17,23 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 class TemplateAndStrConcatenationCheckTest {
 
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_314));
@@ -39,4 +47,3 @@ void test_older_python_version() {
     assertThat(issues).isEmpty();
   }
 }
-
diff --git a/python-checks/src/test/java/org/sonar/python/checks/TemplateStringStructuralPatternMatchingCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/TemplateStringStructuralPatternMatchingCheckTest.java
@@ -17,15 +17,23 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 class TemplateStringStructuralPatternMatchingCheckTest {
 
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_314));
diff --git a/python-checks/src/test/java/org/sonar/python/checks/TypeAliasAnnotationCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/TypeAliasAnnotationCheckTest.java
@@ -17,15 +17,23 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 class TypeAliasAnnotationCheckTest {
 
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void verify_python_312_issues() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_312));
diff --git a/python-checks/src/test/java/org/sonar/python/checks/UnionTypeExpressionCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/UnionTypeExpressionCheckTest.java
@@ -22,6 +22,7 @@
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -30,6 +31,7 @@ class UnionTypeExpressionCheckTest {
   @AfterEach
   void reset_python_version() {
     ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
   }
 
   @Test
diff --git a/python-checks/src/test/java/org/sonar/python/checks/UnprocessedTemplateStringCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/UnprocessedTemplateStringCheckTest.java
@@ -17,15 +17,23 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 class UnprocessedTemplateStringCheckTest {
 
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_314));
diff --git a/python-checks/src/test/java/org/sonar/python/checks/UselessParenthesisCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/UselessParenthesisCheckTest.java
@@ -17,16 +17,24 @@
 package org.sonar.python.checks;
 
 import java.util.EnumSet;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
-import org.sonar.python.checks.quickfix.PythonQuickFixVerifier;
 import org.sonar.plugins.python.api.PythonVersionUtils;
+import org.sonar.python.checks.quickfix.PythonQuickFixVerifier;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 import static org.junit.Assert.assertEquals;
 
 class UselessParenthesisCheckTest {
 
+  @AfterEach
+  void reset_python_version() {
+    ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
+  }
+
   @Test
   void test() {
     ProjectPythonVersion.setCurrentVersions(EnumSet.of(PythonVersionUtils.Version.V_314));
diff --git a/python-checks/src/test/java/org/sonar/python/checks/WeakSSLProtocolCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/WeakSSLProtocolCheckTest.java
@@ -22,12 +22,14 @@
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
+import org.sonar.python.types.TypeShed;
 
 class WeakSSLProtocolCheckTest {
 
   @AfterEach
   void reset_python_version() {
     ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.allVersions());
+    TypeShed.resetBuiltinSymbols();
   }
 
   @Test
diff --git a/python-frontend/src/test/java/org/sonar/python/types/TypeShedTest.java b/python-frontend/src/test/java/org/sonar/python/types/TypeShedTest.java
@@ -615,4 +615,16 @@ void customDbStubs() {
     var pymysql = symbolsForModule("pymysql");
     assertThat(pymysql.get("connect")).isInstanceOf(FunctionSymbol.class);
   }
+
+  @Test
+  void resets_typeshed_after_python_version_change() {
+    setPythonVersions(Set.of(PythonVersionUtils.Version.V_310));
+
+    assertThat(TypeShed.typeShedClass("object").canHaveMember("__getstate__")).isFalse();
+
+    setPythonVersions(PythonVersionUtils.allVersions());
+
+    assertThat(TypeShed.typeShedClass("object").canHaveMember("__getstate__")).isTrue();
+  }
+
 }
