Version 2023.03.20: Detect and fail on static Page/Endpoint object cr…

…eation
devonfw-forge · Mar 20, 2023 · 1aabfe0 · 1aabfe0
1 parent 73e7f01
commit 1aabfe0
Show file tree

Hide file tree

Showing 25 changed files with 109 additions and 68 deletions.
diff --git a/mrchecker-framework-modules/mrchecker-cli-module/pom.xml b/mrchecker-framework-modules/mrchecker-cli-module/pom.xml
@@ -6,11 +6,11 @@
     <parent>
         <artifactId>mrchecker-test-framework</artifactId>
         <groupId>com.capgemini.mrchecker</groupId>
-        <version>2023.03.16</version>
+        <version>2023.03.20</version>
     </parent>
 
     <artifactId>mrchecker-cli-module</artifactId>
-    <version>2023.03.16</version>
+    <version>2023.03.20</version>
     <packaging>jar</packaging>
     <name>MrChecker - CLI - Module</name>
     <description>MrChecker CLI Module supports:
@@ -60,7 +60,7 @@
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>mrchecker-core-module</artifactId>
-            <version>2023.03.16</version>
+            <version>2023.03.20</version>
         </dependency>
     </dependencies>
 

diff --git a/mrchecker-framework-modules/mrchecker-core-module/pom.xml b/mrchecker-framework-modules/mrchecker-core-module/pom.xml
@@ -7,11 +7,11 @@
     <parent>
         <artifactId>mrchecker-test-framework</artifactId>
         <groupId>com.capgemini.mrchecker</groupId>
-        <version>2023.03.16</version>
+        <version>2023.03.20</version>
     </parent>
 
     <artifactId>mrchecker-core-module</artifactId>
-    <version>2023.03.16</version>
+    <version>2023.03.20</version>
     <packaging>jar</packaging>
     <name>MrChecker - Test core - Module</name>
     <description>MrChecker Test Framework Core is responsible for:

diff --git a/...k-modules/mrchecker-core-module/src/main/java/com/capgemini/mrchecker/test/core/Page.java b/...k-modules/mrchecker-core-module/src/main/java/com/capgemini/mrchecker/test/core/Page.java
@@ -1,5 +1,6 @@
 package com.capgemini.mrchecker.test.core;
 
+import com.capgemini.mrchecker.test.core.exceptions.BFStaticVariableException;
 import com.capgemini.mrchecker.test.core.logger.BFLogger;
 
 public abstract class Page implements ITestObserver {
@@ -79,4 +80,15 @@ public void onTestExecutionException() {
     public final void addToTestExecutionObserver() {
         TEST_EXECUTION_OBSERVER.addObserver(this);
     }
+
+    protected void verifyStaticObject(boolean allowStaticObject, String objectName) {
+        if (!allowStaticObject) {
+            StackTraceElement[] stackTrace = new Exception().getStackTrace();
+            for (StackTraceElement stackTraceElement : stackTrace) {
+                if (stackTraceElement.getMethodName().equalsIgnoreCase("<clinit>")) {
+                    throw new BFStaticVariableException(objectName);
+                }
+            }
+        }
+    }
 }
diff --git a/...src/main/java/com/capgemini/mrchecker/test/core/exceptions/BFStaticVariableException.java b/...src/main/java/com/capgemini/mrchecker/test/core/exceptions/BFStaticVariableException.java
@@ -0,0 +1,9 @@
+package com.capgemini.mrchecker.test.core.exceptions;
+
+public class BFStaticVariableException extends RuntimeException {
+    private static final String MESSAGE_FORMAT = "Mr Checker does not support static %s variables";
+
+    public BFStaticVariableException(String objectName) {
+        super(String.format(MESSAGE_FORMAT, objectName));
+    }
+}
diff --git a/mrchecker-framework-modules/mrchecker-database-module/pom.xml b/mrchecker-framework-modules/mrchecker-database-module/pom.xml
@@ -6,11 +6,11 @@
     <parent>
         <artifactId>mrchecker-test-framework</artifactId>
         <groupId>com.capgemini.mrchecker</groupId>
-        <version>2023.03.16</version>
+        <version>2023.03.20</version>
     </parent>
 
     <artifactId>mrchecker-database-module</artifactId>
-    <version>2023.03.16</version>
+    <version>2023.03.20</version>
     <packaging>jar</packaging>
     <name>MrChecker - Database - Module</name>
     <description>MrChecker Database Module:
@@ -80,7 +80,7 @@
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>mrchecker-core-module</artifactId>
-            <version>2023.03.16</version>
+            <version>2023.03.20</version>
         </dependency>
 
         <!-- JPA dependencies -->

diff --git a/mrchecker-framework-modules/mrchecker-mobile-module/pom.xml b/mrchecker-framework-modules/mrchecker-mobile-module/pom.xml
@@ -7,11 +7,11 @@
     <parent>
         <artifactId>mrchecker-test-framework</artifactId>
         <groupId>com.capgemini.mrchecker</groupId>
-        <version>2023.03.16</version>
+        <version>2023.03.20</version>
     </parent>
 
     <artifactId>mrchecker-mobile-module</artifactId>
-    <version>2023.03.16</version>
+    <version>2023.03.20</version>
     <packaging>jar</packaging>
     <name>MrChecker - Mobile - Module</name>
     <description>MrChecker Test Framework name supports:
@@ -52,12 +52,12 @@
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>mrchecker-core-module</artifactId>
-            <version>2023.03.16</version>
+            <version>2023.03.20</version>
         </dependency>
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>mrchecker-selenium-module</artifactId>
-            <version>2023.03.16</version>
+            <version>2023.03.20</version>
         </dependency>
 
         <!--This dependency is necessary for Appium plugin. -->

diff --git a/mrchecker-framework-modules/mrchecker-playwright-module/pom.xml b/mrchecker-framework-modules/mrchecker-playwright-module/pom.xml
@@ -7,11 +7,11 @@
     <parent>
         <artifactId>mrchecker-test-framework</artifactId>
         <groupId>com.capgemini.mrchecker</groupId>
-        <version>2023.03.16</version>
+        <version>2023.03.20</version>
     </parent>
 
     <artifactId>mrchecker-playwright-module</artifactId>
-    <version>2023.03.16</version>
+    <version>2023.03.20</version>
     <packaging>jar</packaging>
     <name>MrChecker - Playwright - Module</name>
     <description>MrChecker Test Framework Playwright</description>
@@ -68,7 +68,7 @@
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>mrchecker-core-module</artifactId>
-            <version>2023.03.16</version>
+            <version>2023.03.20</version>
         </dependency>
 
         <!--This dependency is necessary for Playwright plugin. -->

diff --git a/...ker-playwright-module/src/main/java/com/capgemini/mrchecker/playwright/core/BasePage.java b/...ker-playwright-module/src/main/java/com/capgemini/mrchecker/playwright/core/BasePage.java
@@ -65,6 +65,7 @@ public BasePage(com.microsoft.playwright.Page page) {
     }
 
     public BasePage(com.microsoft.playwright.Page page, BasePage parent) {
+        verifyStaticObject(PROPERTIES_PLAYWRIGHT.getAllowStaticPage(), "Page");
         setParent(parent);
         setPage(page);
 

diff --git a/...in/java/com/capgemini/mrchecker/playwright/core/base/properties/PropertiesPlaywright.java b/...in/java/com/capgemini/mrchecker/playwright/core/base/properties/PropertiesPlaywright.java
@@ -9,6 +9,7 @@ public class PropertiesPlaywright {
     private String channel;
     private String browsersPath = "./lib/playwright";
     private int skipBrowserDownload = 0;
+    private boolean allowStaticPage = false;
 
     @Inject(optional = true)
     @SuppressWarnings("unused")
@@ -49,4 +50,14 @@ private void setSkipBrowserDownload(@Named("playwright.browser.skipDownload") in
     public int getSkipBrowserDownload() {
         return skipBrowserDownload;
     }
+
+    @Inject(optional = true)
+    @SuppressWarnings("unused")
+    private void setAllowStaticPage(@Named("playwright.allowStaticPage") boolean value) {
+        this.allowStaticPage = value;
+    }
+
+    public boolean getAllowStaticPage() {
+        return allowStaticPage;
+    }
 }
diff --git a/mrchecker-framework-modules/mrchecker-playwright-module/src/resources/settings.properties b/mrchecker-framework-modules/mrchecker-playwright-module/src/resources/settings.properties
@@ -1,4 +1,5 @@
 playwright.browser.proxy=
 playwright.browser.channel=
 playwright.browser.downloadPath=./lib/playwright
-playwright.browser.skipDownload=0
+playwright.browser.skipDownload=0
+playwright.allowStaticPage=false
diff --git a/mrchecker-framework-modules/mrchecker-security-module/pom.xml b/mrchecker-framework-modules/mrchecker-security-module/pom.xml
@@ -7,11 +7,11 @@
     <parent>
         <artifactId>mrchecker-test-framework</artifactId>
         <groupId>com.capgemini.mrchecker</groupId>
-        <version>2023.03.16</version>
+        <version>2023.03.20</version>
     </parent>
 
     <artifactId>mrchecker-security-module</artifactId>
-    <version>2023.03.16</version>
+    <version>2023.03.20</version>
     <packaging>jar</packaging>
     <name>MrChecker - Security - Module</name>
     <description>MrChecker Test Framework Security supports:
@@ -63,7 +63,7 @@
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>mrchecker-core-module</artifactId>
-            <version>2023.03.16</version>
+            <version>2023.03.20</version>
         </dependency>
 
         <!-- Needed to perform all API calls -->

diff --git a/mrchecker-framework-modules/mrchecker-selenium-module/pom.xml b/mrchecker-framework-modules/mrchecker-selenium-module/pom.xml
@@ -7,11 +7,11 @@
     <parent>
         <artifactId>mrchecker-test-framework</artifactId>
         <groupId>com.capgemini.mrchecker</groupId>
-        <version>2023.03.16</version>
+        <version>2023.03.20</version>
     </parent>
 
     <artifactId>mrchecker-selenium-module</artifactId>
-    <version>2023.03.16</version>
+    <version>2023.03.20</version>
     <packaging>jar</packaging>
     <name>MrChecker - Selenium - Module</name>
     <description>MrChecker Test Framework Selenium supports:
@@ -101,7 +101,7 @@
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>mrchecker-core-module</artifactId>
-            <version>2023.03.16</version>
+            <version>2023.03.20</version>
         </dependency>
 
         <!--This dependency is necessary for Selenium plugin. -->

diff --git a/...checker-selenium-module/src/main/java/com/capgemini/mrchecker/selenium/core/BasePage.java b/...checker-selenium-module/src/main/java/com/capgemini/mrchecker/selenium/core/BasePage.java
@@ -64,6 +64,7 @@ public BasePage() {
     }
 
     public BasePage(BasePage parent) {
+        verifyStaticObject(PROPERTIES_SELENIUM.getAllowStaticPage(), "Page");
         setParent(parent);
 
         // If the page is not yet loaded, then load it

diff --git a/...c/main/java/com/capgemini/mrchecker/selenium/core/base/properties/PropertiesSelenium.java b/...c/main/java/com/capgemini/mrchecker/selenium/core/base/properties/PropertiesSelenium.java
@@ -14,6 +14,7 @@ public class PropertiesSelenium {
     private String seleniumIE = webDrivers + "/internetexplorer/IEDriverServer.exe";
     private String driverVersionIE = "";
     private boolean driverAutoUpdateFlag = true;
+    private boolean allowStaticPage = false;
 
     @Inject(optional = true)
     @SuppressWarnings("unused")
@@ -104,4 +105,14 @@ private void setEdgeDriverVersion(@Named("wdm.edgeVersion") String version) {
     public String getEdgeDriverVersion() {
         return driverVersionEdge;
     }
+
+    @Inject(optional = true)
+    @SuppressWarnings("unused")
+    private void setAllowStaticPage(@Named("selenium.allowStaticPage") boolean value) {
+        this.allowStaticPage = value;
+    }
+
+    public boolean getAllowStaticPage() {
+        return allowStaticPage;
+    }
 }
diff --git a/mrchecker-framework-modules/mrchecker-selenium-module/src/resources/settings.properties b/mrchecker-framework-modules/mrchecker-selenium-module/src/resources/settings.properties
@@ -3,7 +3,4 @@ selenium.firefox=./lib/webdrivers/firefox/geckodriver.exe
 selenium.ie=./lib/webdrivers/internetexplorer/IEDriverServer.exe
 selenium.edge=./lib/webdrivers/edge/msedgedriver.exe
 selenium.driverAutoUpdate=true
-wdm.chromeDriverVersion=83.0.4103.39
-wdm.internetExplorerDriverVersion=
-wdm.geckoDriverVersion=
-wdm.edgeVersion=
+selenium.allowStaticPage=false
diff --git a/mrchecker-framework-modules/mrchecker-webapi-module/pom.xml b/mrchecker-framework-modules/mrchecker-webapi-module/pom.xml
@@ -7,11 +7,11 @@
     <parent>
         <artifactId>mrchecker-test-framework</artifactId>
         <groupId>com.capgemini.mrchecker</groupId>
-        <version>2023.03.16</version>
+        <version>2023.03.20</version>
     </parent>
 
     <artifactId>mrchecker-webapi-module</artifactId>
-    <version>2023.03.16</version>
+    <version>2023.03.20</version>
     <packaging>jar</packaging>
     <name>MrChecker - WebApi - Module</name>
     <description>
@@ -80,7 +80,7 @@
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>mrchecker-core-module</artifactId>
-            <version>2023.03.16</version>
+            <version>2023.03.20</version>
         </dependency>
 
         <!-- Dependency to REST and SOAP lib -->

diff --git a/...checker-webapi-module/src/main/java/com/capgemini/mrchecker/webapi/core/BaseEndpoint.java b/...checker-webapi-module/src/main/java/com/capgemini/mrchecker/webapi/core/BaseEndpoint.java
@@ -7,7 +7,7 @@
 import com.capgemini.mrchecker.test.core.base.properties.PropertiesSettingsModule;
 import com.capgemini.mrchecker.test.core.logger.BFLogger;
 import com.capgemini.mrchecker.webapi.core.base.driver.DriverManager;
-import com.capgemini.mrchecker.webapi.core.base.properties.PropertiesFileSettings;
+import com.capgemini.mrchecker.webapi.core.base.properties.PropertiesWebAPI;
 import com.capgemini.mrchecker.webapi.core.base.runtime.RuntimeParameters;
 import com.google.inject.Guice;
 import io.restassured.config.RestAssuredConfig;
@@ -17,7 +17,7 @@
 
 public abstract class BaseEndpoint extends Page implements IWebAPI {
     private static DriverManager driver = null;
-    private final static PropertiesFileSettings propertiesFileSettings;
+    private final static PropertiesWebAPI PROPERTIES_WEB_API;
     private final static IAnalytics ANALYTICS;
     public final static String ANALYTICS_CATEGORY_NAME = "WebAPI-Module";
 
@@ -26,7 +26,7 @@ public abstract class BaseEndpoint extends Page implements IWebAPI {
         ANALYTICS = BaseTest.getAnalytics();
 
         // Get and then set properties information from selenium.settings file
-        propertiesFileSettings = setPropertiesSettings();
+        PROPERTIES_WEB_API = setPropertiesSettings();
 
         // Read System or maven parameters
         setRuntimeParametersWebApi();
@@ -35,6 +35,10 @@ public abstract class BaseEndpoint extends Page implements IWebAPI {
         setEnvironmentInstance();
     }
 
+    public BaseEndpoint() {
+        verifyStaticObject(PROPERTIES_WEB_API.getAllowStaticEndpoint(), "Endpoint");
+    }
+
     public static IAnalytics getAnalytics() {
         return ANALYTICS;
     }
@@ -47,23 +51,23 @@ public ModuleType getModuleType() {
     public static RequestSpecification getDriver() {
         if (Objects.isNull(driver)) {
             // Create module driver
-            driver = new DriverManager(propertiesFileSettings);
+            driver = new DriverManager(PROPERTIES_WEB_API);
         }
         return driver.getDriverWebAPI();
     }
 
     public static RequestSpecification getDriver(RestAssuredConfig config) {
         if (Objects.isNull(driver)) {
             // Create module driver
-            driver = new DriverManager(propertiesFileSettings);
+            driver = new DriverManager(PROPERTIES_WEB_API);
         }
         return driver.getDriverWebAPI(config);
     }
 
-    private static PropertiesFileSettings setPropertiesSettings() {
+    private static PropertiesWebAPI setPropertiesSettings() {
         // Get and then set properties information from settings.properties file
         return Guice.createInjector(PropertiesSettingsModule.init())
-                .getInstance(PropertiesFileSettings.class);
+                .getInstance(PropertiesWebAPI.class);
     }
 
     private static void setRuntimeParametersWebApi() {

diff --git a/...i-module/src/main/java/com/capgemini/mrchecker/webapi/core/base/driver/DriverManager.java b/...i-module/src/main/java/com/capgemini/mrchecker/webapi/core/base/driver/DriverManager.java
@@ -1,7 +1,7 @@
 package com.capgemini.mrchecker.webapi.core.base.driver;
 
 import com.capgemini.mrchecker.test.core.logger.BFLogger;
-import com.capgemini.mrchecker.webapi.core.base.properties.PropertiesFileSettings;
+import com.capgemini.mrchecker.webapi.core.base.properties.PropertiesWebAPI;
 import com.capgemini.mrchecker.webapi.core.base.runtime.RuntimeParameters;
 import com.github.tomakehurst.wiremock.WireMockServer;
 import com.github.tomakehurst.wiremock.client.WireMock;
@@ -24,10 +24,10 @@
 
 public class DriverManager {
     private static final ThreadLocal<VirtualizedService> driverVirtualizedService = new ThreadLocal<>();
-    private static PropertiesFileSettings propertiesFileSettings;
+    private static PropertiesWebAPI propertiesFileSettings;
 
     @Inject
-    public DriverManager(@Named("properties") PropertiesFileSettings propertiesFileSettings) {
+    public DriverManager(@Named("properties") PropertiesWebAPI propertiesFileSettings) {
         if (Objects.isNull(DriverManager.propertiesFileSettings)) {
             DriverManager.propertiesFileSettings = propertiesFileSettings;
         }