SONARPY-2129 Implement VariableDescriptorToPythonTypeConverter (#1973)

Author: maksim-grebeniuk-sonarsource

python-frontend/src/main/java/org/sonar/python/semantic/v2/converter/AnyDescriptorToPythonTypeConverter.java

@@ -35,7 +35,8 @@ public AnyDescriptorToPythonTypeConverter(LazyTypesContext lazyTypesContext) {
     this.lazyTypesContext = lazyTypesContext;
     converters = new EnumMap<>(Map.of(
       Descriptor.Kind.CLASS, new ClassDescriptorToPythonTypeConverter(),
-      Descriptor.Kind.FUNCTION, new FunctionDescriptorToPythonTypeConverter()
+      Descriptor.Kind.FUNCTION, new FunctionDescriptorToPythonTypeConverter(),
+      Descriptor.Kind.VARIABLE, new VariableDescriptorToPythonTypeConverter()
     ));
   }
 
@@ -52,5 +53,4 @@ private DescriptorToPythonTypeConverter converterFor(Descriptor descriptor) {
     return converters.getOrDefault(descriptor.kind(), UNKNOWN_DESCRIPTOR_CONVERTER);
   }
 
-
 }

python-frontend/src/main/java/org/sonar/python/semantic/v2/converter/DescriptorToPythonTypeConverter.java

@@ -26,5 +26,4 @@ public interface DescriptorToPythonTypeConverter {
 
   PythonType convert(ConversionContext ctx, Descriptor from);
 
-
 }

python-frontend/src/main/java/org/sonar/python/semantic/v2/converter/VariableDescriptorToPythonTypeConverter.java

@@ -0,0 +1,45 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.python.semantic.v2.converter;
+
+import java.util.Optional;
+import org.sonar.python.index.Descriptor;
+import org.sonar.python.index.VariableDescriptor;
+import org.sonar.python.types.v2.ObjectType;
+import org.sonar.python.types.v2.PythonType;
+import org.sonar.python.types.v2.TypeWrapper;
+
+public class VariableDescriptorToPythonTypeConverter implements DescriptorToPythonTypeConverter {
+
+  public PythonType convert(ConversionContext ctx, VariableDescriptor from) {
+    var typeWrapper = Optional.ofNullable(from.annotatedType())
+      .map(fqn -> ctx.lazyTypesContext().getOrCreateLazyTypeWrapper(fqn))
+      .orElse(TypeWrapper.UNKNOWN_TYPE_WRAPPER);
+    return new ObjectType(typeWrapper);
+  }
+
+  @Override
+  public PythonType convert(ConversionContext ctx, Descriptor from) {
+    if (from instanceof VariableDescriptor variableDescriptor) {
+      return convert(ctx, variableDescriptor);
+    }
+    throw new IllegalArgumentException("Unsupported Descriptor");
+  }
+}

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

@@ -72,5 +72,4 @@ void convertTest() {
     Assertions.assertSame(expectedType, type);
   }
 
-
 }

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

@@ -28,12 +28,15 @@
 import org.sonar.python.index.ClassDescriptor;
 import org.sonar.python.index.Descriptor;
 import org.sonar.python.index.FunctionDescriptor;
+import org.sonar.python.index.VariableDescriptor;
 import org.sonar.python.semantic.v2.ClassTypeBuilder;
 import org.sonar.python.semantic.v2.LazyTypesContext;
 import org.sonar.python.types.v2.ClassType;
 import org.sonar.python.types.v2.FunctionType;
 import org.sonar.python.types.v2.LazyType;
+import org.sonar.python.types.v2.LazyTypeWrapper;
 import org.sonar.python.types.v2.Member;
+import org.sonar.python.types.v2.ObjectType;
 import org.sonar.python.types.v2.PythonType;
 import org.sonar.python.types.v2.TypeWrapper;
 
@@ -142,5 +145,29 @@ void functionDescriptorConversionTest() {
       .isSameAs(resolvedReturnType);
   }
 
+  @Test
+  void variableDescriptorConversionTest() {
+    var lazyTypesContext = Mockito.mock(LazyTypesContext.class);
+    var converter = new AnyDescriptorToPythonTypeConverter(lazyTypesContext);
+    var descriptor = Mockito.mock(VariableDescriptor.class);
+
+    var variableTypeName = "Returned";
+    var resolvedVariableType = new ClassTypeBuilder().withName(variableTypeName).build();
+
+    Mockito.when(descriptor.kind()).thenReturn(Descriptor.Kind.VARIABLE);
+    Mockito.when(descriptor.name()).thenReturn("variable");
+    Mockito.when(descriptor.annotatedType()).thenReturn(variableTypeName);
+
+    Mockito.when(lazyTypesContext.getOrCreateLazyTypeWrapper(variableTypeName))
+      .thenReturn(new LazyTypeWrapper(new LazyType(variableTypeName, lazyTypesContext)));
+
+    Mockito.when(lazyTypesContext.resolveLazyType(Mockito.argThat(lt -> variableTypeName.equals(lt.fullyQualifiedName()))))
+      .thenReturn(resolvedVariableType);
+
+    var type = (ObjectType) converter.convert(descriptor);
+    Assertions.assertThat(type)
+      .extracting(PythonType::unwrappedType)
+      .isSameAs(resolvedVariableType);
+  }
 
 }

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

@@ -0,0 +1,37 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.python.semantic.v2.converter;
+
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+import org.sonar.python.index.ClassDescriptor;
+
+class VariableDescriptorToPythonTypeConverterTest {
+  @Test
+  void unsupportedClassTest() {
+    var ctx = Mockito.mock(ConversionContext.class);
+    var descriptor = Mockito.mock(ClassDescriptor.class);
+    var converter = new VariableDescriptorToPythonTypeConverter();
+    Assertions.assertThatThrownBy(() -> converter.convert(ctx, descriptor))
+      .isInstanceOf(IllegalArgumentException.class)
+      .hasMessage("Unsupported Descriptor");
+  }
+}