SONARPY-2094: Refactor Python version comparison to PythonVersionsUtils (#2049)

Author: joke1196

python-checks/src/main/java/org/sonar/python/checks/FStringNestingLevelCheck.java

@@ -104,10 +104,6 @@ private static boolean isTheNestingTooDeepInFormatSpecifier(@Nullable FormatSpec
   }
 
   private static boolean supportsTypeParameterSyntax(SubscriptionContext ctx) {
-    PythonVersionUtils.Version required = PythonVersionUtils.Version.V_312;
-
-    // All versions must be greater than or equal to the required version.
-    return ctx.sourcePythonVersions().stream()
-      .allMatch(version -> version.compare(required.major(), required.minor()) >= 0);
+    return PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(ctx.sourcePythonVersions(), PythonVersionUtils.Version.V_312);
   }
 }

python-checks/src/main/java/org/sonar/python/checks/GenericClassTypeParameterCheck.java

@@ -106,10 +106,6 @@ private static boolean isTypingGeneric(Expression expression) {
   }
 
   private static boolean supportsTypeParameterSyntax(SubscriptionContext ctx) {
-    PythonVersionUtils.Version required = PythonVersionUtils.Version.V_312;
-
-    // All versions must be greater than or equal to the required version.
-    return ctx.sourcePythonVersions().stream()
-      .allMatch(version -> version.compare(required.major(), required.minor()) >= 0);
+    return PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(ctx.sourcePythonVersions(), PythonVersionUtils.Version.V_312);
   }
 }

python-checks/src/main/java/org/sonar/python/checks/GenericFunctionTypeParameterCheck.java

@@ -82,10 +82,6 @@ private static Set<Tree> getAssignmentLocations(Set<Tree> secondaryLocations) {
   }
 
   private static boolean supportsTypeParameterSyntax(SubscriptionContext ctx) {
-    PythonVersionUtils.Version required = PythonVersionUtils.Version.V_312;
-
-    // All versions must be greater than or equal to the required version.
-    return ctx.sourcePythonVersions().stream()
-      .allMatch(version -> version.compare(required.major(), required.minor()) >= 0);
+    return PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(ctx.sourcePythonVersions(), PythonVersionUtils.Version.V_312);
   }
 }

python-checks/src/main/java/org/sonar/python/checks/GenericTypeStatementCheck.java

@@ -72,7 +72,6 @@ private static void checkUseOfGenerics(SubscriptionContext ctx) {
       return;
     }
     TypeAliasStatement typeStatement = (TypeAliasStatement) ctx.syntaxNode();
-    
     Set<Tree> typeVarAsTypeParameter = Optional.ofNullable(typeStatement.expression())
       .flatMap(TreeUtils.toOptionalInstanceOfMapper(SubscriptionExpression.class))
       .map(SubscriptionExpression::subscripts)
@@ -96,12 +95,7 @@ private static Set<Tree> getAssignmentLocations(Set<Tree> secondaryLocations) {
       .collect(Collectors.toSet());
   }
 
-
   private static boolean supportsTypeParameterSyntax(SubscriptionContext ctx) {
-    PythonVersionUtils.Version required = PythonVersionUtils.Version.V_312;
-
-    // All versions must be greater than or equal to the required version.
-    return ctx.sourcePythonVersions().stream()
-      .allMatch(version -> version.compare(required.major(), required.minor()) >= 0);
+    return PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(ctx.sourcePythonVersions(), PythonVersionUtils.Version.V_312);
   }
 }

python-checks/src/main/java/org/sonar/python/checks/PytzUsageCheck.java

@@ -36,7 +36,6 @@
 
 @Rule(key = "S6890")
 public class PytzUsageCheck extends PythonSubscriptionCheck {
-  private static final PythonVersionUtils.Version REQUIRED_VERSION = PythonVersionUtils.Version.V_39;
   private static final String MESSAGE = "Don't use `pytz` module with Python 3.9 and later.";
 
   @Override
@@ -46,8 +45,7 @@ public void initialize(Context context) {
   }
 
   private static boolean isRelevantPythonVersion(SubscriptionContext context) {
-    return context.sourcePythonVersions().stream()
-      .allMatch(version -> version.compare(REQUIRED_VERSION.major(), REQUIRED_VERSION.minor()) >= 0);
+    return PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(context.sourcePythonVersions(), PythonVersionUtils.Version.V_39);
   }
 
   private static void checkImport(SubscriptionContext context) {

python-checks/src/main/java/org/sonar/python/checks/TypeAliasAnnotationCheck.java

@@ -54,10 +54,6 @@ public static void checkTypeAliasVariableAnnotation(SubscriptionContext ctx) {
   }
 
   private static boolean supportsTypeParameterSyntax(SubscriptionContext ctx) {
-    PythonVersionUtils.Version required = PythonVersionUtils.Version.V_312;
-
-    // All versions must be greater than or equal to the required version.
-    return ctx.sourcePythonVersions().stream()
-      .allMatch(version -> version.compare(required.major(), required.minor()) >= 0);
+    return PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(ctx.sourcePythonVersions(), PythonVersionUtils.Version.V_312);
   }
 }

python-checks/src/main/java/org/sonar/python/checks/UnionTypeExpressionCheck.java

@@ -60,10 +60,6 @@ private static void checkTypeAnnotation(SubscriptionContext ctx) {
   }
 
   private static boolean supportsUnionTypeExpressions(SubscriptionContext ctx) {
-    PythonVersionUtils.Version required = PythonVersionUtils.Version.V_310;
-
-    // All versions must be greater than or equal to the required version.
-    return ctx.sourcePythonVersions().stream()
-      .allMatch(version -> version.compare(required.major(), required.minor()) >= 0);
+    return PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(ctx.sourcePythonVersions(), PythonVersionUtils.Version.V_310);
   }
 }

python-frontend/src/main/java/org/sonar/plugins/python/api/PythonVersionUtils.java

@@ -108,6 +108,7 @@ private PythonVersionUtils() {
   public static Set<Version> fromString(String propertyValue) {
     return fromStringArray(propertyValue.split(","));
   }
+
   public static Set<Version> fromStringArray(String[] versions) {
     if (versions.length == 0) {
       return allVersions();
@@ -168,6 +169,12 @@ private static boolean guessPythonVersion(Set<Version> pythonVersions, String ve
     return true;
   }
 
+  public static boolean areSourcePythonVersionsGreaterOrEqualThan(Set<Version> sourcePythonVersions, Version required) {
+    // All versions must be greater than or equal to the required version.
+    return !sourcePythonVersions.isEmpty() && sourcePythonVersions.stream()
+      .allMatch(version -> version.compare(required.major(), required.minor()) >= 0);
+  }
+
   private static void logErrorMessage(String propertyValue) {
     LOG.warn(
       "Error while parsing value of parameter '{}' ({}). Versions must be specified as MAJOR_VERSION.MINOR_VERSION (e.g. \"3.7, 3.8\")",

python-frontend/src/test/java/org/sonar/plugins/python/api/PythonVersionUtilsTest.java

@@ -19,12 +19,15 @@
  */
 package org.sonar.plugins.python.api;
 
+import java.util.Set;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.slf4j.event.Level;
 import org.sonar.api.testfixtures.log.LogTesterJUnit5;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
 import static org.sonar.plugins.python.api.PythonVersionUtils.Version.V_310;
 import static org.sonar.plugins.python.api.PythonVersionUtils.Version.V_311;
 import static org.sonar.plugins.python.api.PythonVersionUtils.Version.V_312;
@@ -75,4 +78,15 @@ void error_while_parsing_version() {
     assertThat(logTester.logs(Level.WARN))
       .contains("Error while parsing value of parameter 'sonar.python.version' (foo). Versions must be specified as MAJOR_VERSION.MINOR_VERSION (e.g. \"3.7, 3.8\")");
   }
+
+  @Test
+  void isPythonVersionGreaterOrEqualThan() {
+    assertFalse(PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(Set.of(), V_39));
+    assertFalse(PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(Set.of(V_36, V_38), V_39));
+    assertFalse(PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(Set.of(V_36, V_310), V_39));
+    assertTrue(PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(Set.of(V_39), V_39));
+    assertTrue(PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(Set.of(V_39, V_310), V_39));
+    assertTrue(PythonVersionUtils.areSourcePythonVersionsGreaterOrEqualThan(Set.of(V_312, V_310), V_39));
+  }
+  
 }