SONARPY-1819 Improve testing to compare types

Author: guillaume-dequenne

python-frontend/src/main/java/org/sonar/python/types/v2/ObjectType.java

@@ -41,6 +41,11 @@ public boolean isCompatibleWith(PythonType another) {
     return this.type.isCompatibleWith(another);
   }
 
+  @Override
+  public PythonType unwrappedType() {
+    return this.type;
+  }
+
   @Override
   public Optional<PythonType> resolveMember(String memberName) {
     return members().stream()

python-frontend/src/main/java/org/sonar/python/types/v2/PythonType.java

@@ -59,4 +59,8 @@ default TriBool hasMember(String memberName) {
   default Optional<LocationInFile> definitionLocation() {
     return Optional.empty();
   }
+
+  default PythonType unwrappedType() {
+    return this;
+  }
 }

python-frontend/src/test/java/org/sonar/python/semantic/v2/TypeInferenceV2Test.java

@@ -58,14 +58,15 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.sonar.python.PythonTestUtils.parseWithoutSymbols;
+import static org.sonar.python.types.v2.TypesTestUtils.INT_TYPE;
+import static org.sonar.python.types.v2.TypesTestUtils.LIST_TYPE;
+import static org.sonar.python.types.v2.TypesTestUtils.STR_TYPE;
 
 class TypeInferenceV2Test {
   private static FileInput fileInput;
 
   static PythonFile pythonFile = PythonTestUtils.pythonFile("");
 
-  static ModuleType BUILTINS = new ProjectLevelTypeTable(ProjectLevelSymbolTable.empty()).getModule();
-
   @BeforeAll
   static void init() {
     var context = TestPythonVisitorRunner.createContext(new File("src/test/resources/semantic/v2/script.py"));
@@ -299,20 +300,17 @@ void inferTypeForReassignedVariables() {
     var aSymbol = aName.symbolV2();
     Assertions.assertThat(aSymbol.usages()).hasSize(6);
 
-    var typeNames = aSymbol.usages()
+    var types = aSymbol.usages()
       .stream()
       .map(UsageV2::tree)
       .map(Name.class::cast)
       .sorted(Comparator.comparing(n -> n.firstToken().line()))
       .map(Expression::typeV2)
-      .filter(ObjectType.class::isInstance)
-      .map(ObjectType.class::cast)
-      .map(ObjectType::type)
-      .map(PythonType::name)
+      .map(PythonType::unwrappedType)
       .toList();
 
-    Assertions.assertThat(typeNames).hasSize(6)
-      .containsExactly("int", "int", "str", "str", "str", "str");
+    Assertions.assertThat(types).hasSize(6)
+      .containsExactly(INT_TYPE, INT_TYPE, STR_TYPE, STR_TYPE, STR_TYPE, STR_TYPE);
   }
 
   @Test
@@ -408,7 +406,7 @@ void compoundAssignmentStr() {
       a = 42
       a += 1
       a
-      """).typeV2().displayName()).contains("int");
+      """).typeV2().unwrappedType()).isEqualTo(INT_TYPE);
   }
 
   @Test
@@ -418,7 +416,7 @@ void compoundAssignmentList() {
         b = 'world'
         a += b
         a
-        """).typeV2().displayName()).contains("list");
+        """).typeV2().unwrappedType()).isEqualTo(LIST_TYPE);
   }
 
   @Test
@@ -427,7 +425,7 @@ void annotation_with_reassignment() {
         a = "foo"
         b: int = a
         b
-        """).typeV2().displayName()).contains("str");
+        """).typeV2().unwrappedType()).isEqualTo(STR_TYPE);
   }
 
   @Test
@@ -450,7 +448,7 @@ class A: pass
 
   @Test
   void variable_outside_function() {
-    assertThat(lastExpression("a = 42; a").typeV2().displayName()).contains("int");
+    assertThat(lastExpression("a = 42; a").typeV2().unwrappedType()).isEqualTo(INT_TYPE);
   }
 
   @Test
@@ -482,7 +480,7 @@ void variable_outside_function_4() {
       def foo():
         a = 'hello'
       a
-      """).typeV2().displayName()).contains("int");
+      """).typeV2().unwrappedType()).isEqualTo(INT_TYPE);
   }
 
   private static FileInput inferTypes(String lines) {

python-frontend/src/test/java/org/sonar/python/types/v2/ClassTypeTest.java

@@ -65,6 +65,7 @@ void no_parents() {
 
     assertThat(classType.displayName()).contains("type");
     assertThat(classType.instanceDisplayName()).contains("C");
+    assertThat(classType.unwrappedType()).isEqualTo(classType);
 
     String fileId = SymbolUtils.pathOf(pythonFile).toString();
     assertThat(classType.definitionLocation()).contains(new LocationInFile(fileId, 1, 6, 1, 7));

python-frontend/src/test/java/org/sonar/python/types/v2/FunctionTypeTest.java

@@ -46,6 +46,7 @@ void arity() {
     assertThat(functionType.isAsynchronous()).isFalse();
     assertThat(functionType.parameters()).isEmpty();
     assertThat(functionType.displayName()).contains("Callable");
+    assertThat(functionType.unwrappedType()).isEqualTo(functionType);
     assertThat(functionType.instanceDisplayName()).isEmpty();
     String fileId = SymbolUtils.pathOf(pythonFile).toString();
     assertThat(functionType.definitionLocation()).contains(new LocationInFile(fileId, 1, 4, 1, 6));

python-frontend/src/test/java/org/sonar/python/types/v2/ModuleTypeTest.java

@@ -33,6 +33,7 @@ void resolveMemberTest() {
 
     Assertions.assertThat(b.resolveMember("a")).containsSame(a);
     Assertions.assertThat(b.resolveMember("b")).isNotPresent();
+    Assertions.assertThat(b.unwrappedType()).isEqualTo(b);
   }
 
   @Test

python-frontend/src/test/java/org/sonar/python/types/v2/ObjectTypeTest.java

@@ -56,6 +56,7 @@ class A: ...
     );
     ClassType classType = (ClassType) ((ClassDef) fileInput.statements().statements().get(0)).name().typeV2();
     ObjectType objectType = (ObjectType) ((ExpressionStatement) fileInput.statements().statements().get(2)).expressions().get(0).typeV2();
+    assertThat(objectType.unwrappedType()).isEqualTo(classType);
 
     assertThat(objectType.displayName()).contains("A");
     assertThat(objectType.isCompatibleWith(classType)).isTrue();

python-frontend/src/test/java/org/sonar/python/types/v2/TypesTestUtils.java

@@ -30,9 +30,11 @@
 public class TypesTestUtils {
 
   public static final ModuleType BUILTINS = new ProjectLevelTypeTable(ProjectLevelSymbolTable.empty()).getModule();
+
   public static final PythonType INT_TYPE = BUILTINS.resolveMember("int").get();
   public static final PythonType BOOL_TYPE = BUILTINS.resolveMember("bool").get();
   public static final PythonType STR_TYPE = BUILTINS.resolveMember("str").get();
+  public static final PythonType LIST_TYPE = BUILTINS.resolveMember("list").get();
 
   public static FileInput parseAndInferTypes(String... code) {
     return parseAndInferTypes(PythonTestUtils.pythonFile(""), code);

python-frontend/src/test/java/org/sonar/python/types/v2/UnionTypeTest.java

@@ -45,6 +45,7 @@ void basicUnion() {
     assertThat(unionType.isCompatibleWith(strType)).isTrue();
 
     assertThat(unionType.displayName()).contains("Union[int, str]");
+    assertThat(unionType.unwrappedType()).isEqualTo(unionType);
     assertThat(unionType.instanceDisplayName()).isEmpty();
     assertThat(unionType.definitionLocation()).isEmpty();
   }