feat: Add Polarion status provider and maven resource filtering (#241)

* feat: Add Polarion status provider and maven resource filtering

Author: yurtsevich-sbb

app/src/main/java/ch/sbb/polarion/extension/generic/configuration/GenericPolarionStatusProvider.java

@@ -0,0 +1,25 @@
+package ch.sbb.polarion.extension.generic.configuration;
+
+import ch.sbb.polarion.extension.generic.util.VersionUtils;
+import com.polarion.core.config.Configuration;
+import org.jetbrains.annotations.NotNull;
+
+@SuppressWarnings("unused") // Referenced in extensions which inherits from this project
+public class GenericPolarionStatusProvider extends ConfigurationStatusProvider {
+    public static final String POLARION_ALM = "Polarion ALM";
+
+    @Override
+    public @NotNull ConfigurationStatus getStatus(@NotNull Context context) {
+        String currentCompatiblePolarionVersion = VersionUtils.getCurrentCompatiblePolarionVersion();
+        if (currentCompatiblePolarionVersion == null || currentCompatiblePolarionVersion.trim().isEmpty()) {
+            return new ConfigurationStatus(POLARION_ALM, Status.ERROR, "Officially supported version not specified");
+        }
+
+        String versionName = Configuration.getInstance().getProduct().versionName();
+        if (versionName.startsWith(currentCompatiblePolarionVersion)) {
+            return new ConfigurationStatus(POLARION_ALM, Status.OK, versionName);
+        } else {
+            return new ConfigurationStatus(POLARION_ALM, Status.WARNING, "%s is not officially supported".formatted(versionName));
+        }
+    }
+}

app/src/main/java/ch/sbb/polarion/extension/generic/util/VersionUtils.java

@@ -1,15 +1,21 @@
 package ch.sbb.polarion.extension.generic.util;
 
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Properties;
 import java.util.jar.Attributes;
 
 import org.jetbrains.annotations.NotNull;
 
 import ch.sbb.polarion.extension.generic.rest.model.Version;
 import lombok.experimental.UtilityClass;
+import org.jetbrains.annotations.Nullable;
 
 @UtilityClass
 public class VersionUtils {
 
+    private static final String GENERIC_PROPERTIES_FILE = "generic.properties";
+
     public static final String BUNDLE_NAME = "Bundle-Name";
     public static final String BUNDLE_VENDOR = "Bundle-Vendor";
     public static final String SUPPORT_EMAIL = "Support-Email";
@@ -41,4 +47,25 @@ public static Version getVersion() {
                 .build();
     }
 
+    public static @Nullable String getCurrentCompatiblePolarionVersion() {
+        return getValueFromProperties("polarion.version");
+    }
+
+    public static @Nullable String getValueFromProperties(String key) {
+        return getValueFromProperties(GENERIC_PROPERTIES_FILE, key);
+    }
+
+    public static @Nullable String getValueFromProperties(String propertiesFileName, String key) {
+        try (InputStream input = VersionUtils.class.getClassLoader().getResourceAsStream(propertiesFileName)) {
+            if (input == null) {
+                return null;
+            }
+
+            Properties properties = new Properties();
+            properties.load(input);
+            return properties.getProperty(key);
+        } catch (IOException e) {
+            return null;
+        }
+    }
 }

app/src/main/resources-filtered/generic.properties

@@ -0,0 +1 @@
+polarion.version=${polarion.version}

app/src/test/java/ch/sbb/polarion/extension/generic/configuration/GenericPolarionStatusProviderTest.java

@@ -0,0 +1,53 @@
+package ch.sbb.polarion.extension.generic.configuration;
+
+import ch.sbb.polarion.extension.generic.util.VersionUtils;
+import com.polarion.core.config.Configuration;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.mockito.MockedStatic;
+import org.mockito.Mockito;
+
+import java.util.stream.Stream;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.mockStatic;
+
+public class GenericPolarionStatusProviderTest {
+    public static Stream<Arguments> provideConfigurationStatus() {
+        return Stream.of(
+                Arguments.of("2410", "2410", configurationStatus(Status.OK, "2410")),
+                Arguments.of("2410.1", "2410", configurationStatus(Status.OK, "2410.1")),
+                Arguments.of("2310", "2410", configurationStatus(Status.WARNING, "2310 is not officially supported")),
+                Arguments.of("2310.1", "2410", configurationStatus(Status.WARNING, "2310.1 is not officially supported")),
+                Arguments.of("2410", "", configurationStatus(Status.ERROR, "Officially supported version not specified")),
+                Arguments.of("2410", null, configurationStatus(Status.ERROR, "Officially supported version not specified"))
+        );
+    }
+
+    private static ConfigurationStatus configurationStatus(Status status, String details) {
+        return ConfigurationStatus.builder()
+                .name(GenericPolarionStatusProvider.POLARION_ALM)
+                .status(status)
+                .details(details)
+                .build();
+    }
+
+    @ParameterizedTest
+    @MethodSource("provideConfigurationStatus")
+    void testConfigurationStatus(String polarionVersion, String currentCompatibleVersionPolarion, ConfigurationStatus expectedConfigurationStatus) {
+        GenericPolarionStatusProvider polarionStatusProvider = new GenericPolarionStatusProvider();
+
+        try (
+                MockedStatic<Configuration> configurationMockedStatic = mockStatic(Configuration.class, Mockito.RETURNS_DEEP_STUBS);
+                MockedStatic<VersionUtils> versionUtilsMockedStatic = mockStatic(VersionUtils.class)
+        ) {
+            configurationMockedStatic.when(() -> Configuration.getInstance().getProduct().versionName()).thenReturn(polarionVersion);
+            versionUtilsMockedStatic.when(VersionUtils::getCurrentCompatiblePolarionVersion).thenReturn(currentCompatibleVersionPolarion);
+
+            ConfigurationStatusProvider.Context context = ConfigurationStatusProvider.Context.builder().scope("").build();
+            ConfigurationStatus configurationStatus = polarionStatusProvider.getStatus(context);
+            assertEquals(expectedConfigurationStatus, configurationStatus);
+        }
+    }
+}

pom.xml

@@ -813,6 +813,17 @@
                 </plugin>
             </plugins>
         </pluginManagement>
+
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>false</filtering>
+            </resource>
+            <resource> <!-- Below is a way to replace polarion version in generic.properties by version from a profile -->
+                <directory>src/main/resources-filtered</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
     </build>
 
     <modules>