SONARPY-967 Handle Typeshed Python2 modules whose name differ from th… (#1068)

Author: andrea-guarino-sonarsource

python-frontend/src/main/java/org/sonar/python/types/TypeShed.java

@@ -75,6 +75,14 @@ public class TypeShed {
   private static final Set<String> BUILTINS_TO_DISAMBIGUATE = new HashSet<>(
     Arrays.asList(INT, FLOAT, COMPLEX, STR, BuiltinTypes.SET, DICT, LIST, TUPLE, NONE_TYPE, BOOL, "type", "super", "frozenset", "memoryview"));
 
+  // This is needed for some Python 2 modules whose name differ from their Python 3 counterpart by capitalization only.
+  private static final Map<String, String> MODULES_TO_DISAMBIGUATE = new HashMap<>();
+  static {
+    MODULES_TO_DISAMBIGUATE.put("ConfigParser", "2@ConfigParser");
+    MODULES_TO_DISAMBIGUATE.put("Queue", "2@Queue");
+    MODULES_TO_DISAMBIGUATE.put("SocketServer", "2@SocketServer");
+  }
+
   static {
     BUILTINS_TO_DISAMBIGUATE.addAll(BuiltinSymbols.EXCEPTIONS);
   }
@@ -305,7 +313,8 @@ private static boolean isAmbiguousSymbolOfClasses(Symbol symbol) {
   }
 
   private static Map<String, Symbol> getSymbolsFromProtobufModule(String moduleName, String dirName) {
-    InputStream resource = TypeShed.class.getResourceAsStream(dirName + moduleName + ".protobuf");
+    String fileName = MODULES_TO_DISAMBIGUATE.getOrDefault(moduleName, moduleName);
+    InputStream resource = TypeShed.class.getResourceAsStream(dirName + fileName + ".protobuf");
     if (resource == null) {
       return Collections.emptyMap();
     }

python-frontend/src/test/java/org/sonar/python/types/TypeShedTest.java

@@ -534,4 +534,44 @@ public void stubFilesSymbols_third_party_symbols_should_not_be_null() {
     symbolsForModule("six");
     assertThat(TypeShed.stubFilesSymbols()).doesNotContainNull();
   }
+
+  @Test
+  public void modules_whose_name_differ_by_capitalization_only() {
+    // Python 2, import SocketServer
+    setPythonVersions(PythonVersionUtils.fromString("2.7"));
+    Map<String, Symbol> socketServer = symbolsForModule("SocketServer");
+    assertThat(socketServer).isNotEmpty();
+    SymbolImpl baseServer = (SymbolImpl) socketServer.get("BaseServer");
+    assertThat(baseServer.validForPythonVersions()).containsExactlyInAnyOrder("27");
+
+    // Python 2, import socketserver
+    socketServer = symbolsForModule("socketserver");
+    assertThat(socketServer).isEmpty();
+
+    // Python 3, import SocketServer
+    setPythonVersions(PythonVersionUtils.fromString("3.10"));
+    socketServer = symbolsForModule("SocketServer");
+    assertThat(socketServer).isEmpty();
+
+    // Python 3, import socketserver
+    socketServer = symbolsForModule("socketserver");
+    assertThat(socketServer).isNotEmpty();
+    baseServer = (SymbolImpl) socketServer.get("BaseServer");
+    assertThat(baseServer.validForPythonVersions()).containsExactlyInAnyOrder("35", "36", "37", "38", "39", "310");
+
+    // Unknown Python version, import SocketServer
+    // in this case we assume Python2 module is imported
+    setPythonVersions();
+    socketServer = symbolsForModule("SocketServer");
+    assertThat(socketServer).isNotEmpty();
+    baseServer = (SymbolImpl) socketServer.get("BaseServer");
+    assertThat(baseServer.validForPythonVersions()).containsExactlyInAnyOrder("27");
+
+    // Unknown Python version, import socketserver
+    // in this case we assume Python3 module is imported
+    socketServer = symbolsForModule("socketserver");
+    assertThat(socketServer).isNotEmpty();
+    baseServer = (SymbolImpl) socketServer.get("BaseServer");
+    assertThat(baseServer.validForPythonVersions()).containsExactlyInAnyOrder("35", "36", "37", "38", "39", "310");
+  }
 }