Merge remote-tracking branch 'origin/main' into feature-update-websection

Author: teo-nikolov

README.md

@@ -29,6 +29,69 @@ For applying filters and other more advanced configuration check the official do
 
 Both TestNG and JUnit are supported.
 
+## Release Strategy
+
+### Versioning
+Our project uses [Semantic Versioning](https://semver.org/) (SemVer) for clear and predictable version management. Each release is tagged with a unique version number that reflects the nature of the changes made.
+### Tags and Releases
+-   **Tags:** We create Git tags for each release to mark specific points in the project's history, making it easier for users to switch between versions.
+-   **Release Notes:** Detailed notes accompany [each release](https://bellatrix.solutions/roadmap/release-3-9-0-0-lyra/), highlighting new features, bug fixes, and any breaking changes.
+### Accessing Releases
+Users can access the specific releases directly from our GitHub repository's Releases page or BELLATRIX website's roadmap section. Each release includes a tag, a summary of changes, and assets (if applicable).
+## Integrating BELLATRIX as a Submodule in Your Project
+### Adding BELLATRIX as a Submodule
+To leverage a specific version of BELLATRIX in your project, you can add it as a Git submodule. This allows you to keep your copy of BELLATRIX up to date or locked to a specific version, depending on your project's needs.
+1.  **Navigate to Your Project Directory:** Open a terminal and change to the directory where your project is located.
+2.  **Add BELLATRIX as a Submodule:** Use the following Git command to add BELLATRIX as a submodule to your project:
+```
+git submodule add https://github.com/BELLATRIX-Library/BELLATRIX.git path/to/submodule
+``` 
+Replace `path/to/submodule` with the relative path within your project where you'd like the BELLATRIX submodule to reside.
+**Initialize and Clone the Submodule:** If you're adding the submodule for the first time, initialize your local configuration file and clone the BELLATRIX repository as follows:
+```
+git submodule update --init --recursive
+```
+### Checking Out a Specific Tag (Release Version)
+After adding BELLATRIX as a submodule, you might want to use a specific release version rather than the latest commit on the main branch.
+1.  **Navigate to the Submodule Directory:** Change into the BELLATRIX submodule directory within your project:
+```
+cd path/to/submodule
+```
+1.  **Fetch All Tags from the BELLATRIX Repository:** To ensure you have a list of all available tags, fetch them:
+```
+git fetch --tags
+```
+2.  **Checkout the Desired Tag:** Check out the specific tag (release version) you want to use by replacing `<tagname>` with the desired version:
+```   
+git checkout tags/<tagname>` 
+```
+For example, if you want to check out version `v3.9.0.0`, you would use:
+```git checkout tags/v3.9.0.0``` 
+
+3.  **Commit the Submodule Change:** Navigate back to your project's root directory, and commit the change to the submodule reference:
+```
+cd ../..
+git add path/to/submodule
+git commit -m "Update BELLATRIX submodule to v3.9.0.0"
+```
+This process ensures that your project uses a specific, fixed version of BELLATRIX, providing stability and consistency across environments or deployments.
+## Contributing to Our Project
+We welcome contributions from the community, whether it's in the form of bug reports, feature requests, documentation improvements, or code contributions.
+### Getting Started
+1.  **Fork the Repository:** Start by forking the repository to your GitHub account. This provides you with a personal workspace for making changes.
+2.  **Clone Your Fork:** Clone your fork to your local machine to start working on the changes.
+### Making Changes
+1.  **Create a Feature Branch:** From your fork, create a new branch for your work. This keeps your changes organized and separate from the main branch.
+2.  **Commit Your Changes:** Make your changes locally, and commit them to your feature branch. Use clear and descriptive commit messages.
+### Submitting Contributions
+1.  **Pull from Upstream:** Before submitting your contribution, pull the latest changes from the upstream main branch into your feature branch to minimize merge conflicts.
+2.  **Push to Your Fork:** Push your changes to your fork on GitHub.
+3.  **Open a Pull Request (PR):** Submit a pull request from your feature branch to the main branch of the original repository. Provide a clear description of your changes and any relevant issue numbers.
+### Code Review
+**Review Process:** Your PR will be reviewed by the project maintainers. They may provide feedback or request changes. Be open to discussion and willing to make adjustments as needed.
+### After Your PR is Merged
+Once your PR is merged, your contributions will become part of the project. You can then safely delete your feature branch.
+
 Supported Code Editors
 ----------------------
 The recommended code editor for writing BELLATRIX tests is IntelliJ

bellatrix.android/src/main/java/solutions/bellatrix/android/components/AndroidComponent.java

@@ -37,6 +37,7 @@
 import solutions.bellatrix.core.utilities.InstanceFactory;
 import solutions.bellatrix.core.utilities.Log;
 
+import java.awt.Dimension;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
@@ -102,12 +103,14 @@ public Class<?> getComponentClass() {
         return getClass();
     }
 
-    public Point getLocation() {
-        return findElement().getLocation();
+    public java.awt.Point getLocation() {
+        var location = findElement().getLocation();
+        return new java.awt.Point(location.getX(), location.getY());
     }
 
     public Dimension getSize() {
-        return findElement().getSize();
+        var size = findElement().getSize();
+        return new java.awt.Dimension(size.getWidth(), size.getHeight());
     }
 
     public String getAttribute(String name) {

bellatrix.android/src/main/java/solutions/bellatrix/android/infrastructure/DriverService.java

@@ -19,7 +19,6 @@
 import io.appium.java_client.remote.MobileCapabilityType;
 import lombok.SneakyThrows;
 import org.openqa.selenium.MutableCapabilities;
-import org.openqa.selenium.Platform;
 import org.openqa.selenium.remote.DesiredCapabilities;
 import solutions.bellatrix.android.configuration.AndroidSettings;
 import solutions.bellatrix.android.configuration.GridSettings;
@@ -30,11 +29,10 @@
 
 import java.io.IOException;
 import java.io.InputStream;
-import java.net.MalformedURLException;
 import java.net.URL;
+import java.time.Duration;
 import java.util.HashMap;
 import java.util.Properties;
-import java.util.concurrent.TimeUnit;
 
 public class DriverService {
     private static final ThreadLocal<Boolean> DISPOSED;
@@ -84,7 +82,7 @@ public static AndroidDriver start(AppConfiguration configuration) {
             driver = initializeDriverGridMode(gridSettings.get(), testName);
         }
 
-        driver.manage().timeouts().implicitlyWait(androidSettings.getTimeoutSettings().getImplicitWaitTimeout(), TimeUnit.SECONDS);
+        driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(androidSettings.getTimeoutSettings().getImplicitWaitTimeout()));
         WRAPPED_ANDROID_DRIVER.set(driver);
         solutions.bellatrix.web.infrastructure.DriverService.setWrappedDriver(driver);
         return driver;

bellatrix.android/src/main/java/solutions/bellatrix/android/infrastructure/MobileScreenshotPlugin.java

@@ -18,11 +18,14 @@
 import org.openqa.selenium.OutputType;
 import org.openqa.selenium.TakesScreenshot;
 import plugins.screenshots.ScreenshotPlugin;
+import plugins.screenshots.ScreenshotPluginEventArgs;
 import solutions.bellatrix.android.configuration.AndroidSettings;
 import solutions.bellatrix.core.configuration.ConfigurationService;
 import solutions.bellatrix.core.utilities.PathNormalizer;
 
 import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
 import java.nio.file.Paths;
 import java.util.UUID;
 
@@ -33,10 +36,43 @@ public MobileScreenshotPlugin() {
 
     @Override
     @SneakyThrows
-    protected void takeScreenshot(String screenshotSaveDir, String filename) {
-        File screenshot = ((TakesScreenshot)DriverService.getWrappedAndroidDriver()).getScreenshotAs(OutputType.FILE);
-        var destFile = new File(Paths.get(screenshotSaveDir, filename) + ".png");
-        FileUtils.copyFile(screenshot, destFile);
+    public String takeScreenshot(String name) {
+        var screenshotSaveDir = getOutputFolder();
+        var filename = getUniqueFileName(name);
+
+        var screenshot = ((TakesScreenshot)DriverService.getWrappedAndroidDriver()).getScreenshotAs(OutputType.BASE64);
+
+        var path = Paths.get(screenshotSaveDir, filename) + ".png";
+
+        var file = new File(path);
+
+        try (FileWriter writer = new FileWriter(file)) {
+            writer.write(screenshot);
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+
+        SCREENSHOT_GENERATED.broadcast(new ScreenshotPluginEventArgs(path.toString(), filename, screenshot));
+        return screenshot;
+    }
+
+    @Override
+    @SneakyThrows
+    public String takeScreenshot(String screenshotSaveDir, String filename) {
+        var screenshot = ((TakesScreenshot)DriverService.getWrappedAndroidDriver()).getScreenshotAs(OutputType.BASE64);
+
+        var path = Paths.get(screenshotSaveDir, filename) + ".png";
+
+        var file = new File(path);
+
+        try (FileWriter writer = new FileWriter(file)) {
+            writer.write(screenshot);
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+
+        SCREENSHOT_GENERATED.broadcast(new ScreenshotPluginEventArgs(path.toString(), filename, screenshot));
+        return screenshot;
     }
 
     @Override

bellatrix.android/src/main/java/solutions/bellatrix/android/services/TouchActionsService.java

@@ -29,15 +29,15 @@ public class TouchActionsService extends MobileService {
     public <TComponent extends AndroidComponent> TouchActionsService tap(TComponent component, int count) {
         TouchAction touchAction = new TouchAction(DriverService.getWrappedAndroidDriver());
         touchAction.tap(TapOptions.tapOptions()
-                .withPosition(PointOption.point(component.getLocation().getX(), component.getLocation().getY())).withTapsCount(count));
+                .withPosition(PointOption.point((int)component.getLocation().getX(), (int)component.getLocation().getY())).withTapsCount(count));
         wrappedMultiAction.add(touchAction);
 
         return this;
     }
 
     public <TComponent extends AndroidComponent> TouchActionsService press(TComponent component) {
         TouchAction touchAction = new TouchAction(DriverService.getWrappedAndroidDriver());
-        touchAction.press(PointOption.point(component.getLocation().getX(), component.getLocation().getY()));
+        touchAction.press(PointOption.point((int)component.getLocation().getX(), (int)component.getLocation().getY()));
         wrappedMultiAction.add(touchAction);
 
         return this;
@@ -53,7 +53,7 @@ public TouchActionsService press(Integer x, Integer y) {
 
     public <TComponent extends AndroidComponent> TouchActionsService longPress(TComponent component) {
         TouchAction touchAction = new TouchAction(DriverService.getWrappedAndroidDriver());
-        touchAction.longPress(PointOption.point(component.getLocation().getX(), component.getLocation().getY()));
+        touchAction.longPress(PointOption.point((int)component.getLocation().getX(), (int)component.getLocation().getY()));
         wrappedMultiAction.add(touchAction);
 
         return this;
@@ -78,7 +78,7 @@ public TouchActionsService wait(Long waitTimeMilliseconds) {
 
     public <TComponent extends AndroidComponent> TouchActionsService moveTo(TComponent component) {
         TouchAction touchAction = new TouchAction(DriverService.getWrappedAndroidDriver());
-        touchAction.moveTo(PointOption.point(component.getLocation().getX(), component.getLocation().getY()));
+        touchAction.moveTo(PointOption.point((int)component.getLocation().getX(), (int)component.getLocation().getY()));
         wrappedMultiAction.add(touchAction);
 
         return this;
@@ -103,9 +103,9 @@ public TouchActionsService release() {
     public <TComponent extends AndroidComponent> TouchActionsService swipe(TComponent firstComponent, TComponent secondComponent, int duration) {
         TouchAction touchAction = new TouchAction(DriverService.getWrappedAndroidDriver());
         touchAction
-                .press(PointOption.point(firstComponent.getLocation().getX(), firstComponent.getLocation().getY()))
+                .press(PointOption.point((int)firstComponent.getLocation().getX(), (int)firstComponent.getLocation().getY()))
                 .waitAction(WaitOptions.waitOptions(Duration.ofMillis(duration)))
-                .moveTo(PointOption.point(secondComponent.getLocation().getX(), secondComponent.getLocation().getY()))
+                .moveTo(PointOption.point((int)secondComponent.getLocation().getX(), (int)secondComponent.getLocation().getY()))
                 .release().perform();
         wrappedMultiAction.add(touchAction);
 

bellatrix.core/pom.xml

@@ -24,7 +24,7 @@
     <version>1.0</version>
 
     <properties>
-        <selenium.version>4.8.1</selenium.version>
+        <selenium.version>4.11.0</selenium.version>
         <appium.version>8.3.0</appium.version>
         <testng.version>7.7.0</testng.version>
         <junit.version>5.9.2</junit.version>
@@ -62,19 +62,16 @@
             <groupId>software.amazon.awssdk</groupId>
             <artifactId>textract</artifactId>
         </dependency>
-
         <dependency>
             <groupId>com.opencsv</groupId>
             <artifactId>opencsv</artifactId>
             <version>5.7.1</version>
         </dependency>
-
         <dependency>
             <groupId>com.mailslurp</groupId>
             <artifactId>mailslurp-client-java</artifactId>
             <version>15.17.1</version>
         </dependency>
-
         <dependency>
             <groupId>commons-io</groupId>
             <artifactId>commons-io</artifactId>
@@ -83,7 +80,7 @@
         <dependency>
             <groupId>com.google.guava</groupId>
             <artifactId>guava</artifactId>
-            <version>31.1-jre</version>
+            <version>33.0.0-jre</version>
         </dependency>
         <dependency>
             <groupId>com.google.code.gson</groupId>
@@ -157,14 +154,9 @@
             <scope>compile</scope>
         </dependency>
         <dependency>
-            <groupId>com.azure</groupId>
-            <artifactId>azure-security-keyvault-secrets</artifactId>
-            <version>4.2.3</version>
-        </dependency>
-        <dependency>
-            <groupId>com.azure</groupId>
-            <artifactId>azure-identity</artifactId>
-            <version>1.2.0</version>
+            <groupId>org.jsoup</groupId>
+            <artifactId>jsoup</artifactId>
+            <version>1.17.2</version>
         </dependency>
     </dependencies>
 </project>

bellatrix.core/src/main/java/solutions/bellatrix/core/assertions/EntitiesAsserter.java

@@ -16,17 +16,15 @@
 
 import java.lang.reflect.Method;
 import java.time.LocalDateTime;
+import java.time.OffsetDateTime;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
 public class EntitiesAsserter {
     public static <TEntity> Boolean areEqual(TEntity expectedObject, TEntity realObject, DateTimeDeltaType deltaType, int deltaQuantity, String... propertiesNotToCompare) {
         List<Exception> failedAssertions = assertAreEqualsInternal(expectedObject, realObject, deltaType, deltaQuantity, propertiesNotToCompare);
-        if (failedAssertions.size() > 1) {
-            return false;
-        }
-        return true;
+        return failedAssertions.size() <= 1;
     }
     public static <TEntity> Boolean areEqual(TEntity expectedObject, TEntity realObject, String... propertiesNotToCompare) {
         return areEqual(expectedObject, realObject, DateTimeDeltaType.MILLISECONDS, 300, propertiesNotToCompare);
@@ -61,25 +59,39 @@ private static <TEntity> List<Exception> assertAreEqualsInternal(TEntity expecte
                 try {
                     currentExpectedProperty = expectedObject.getClass().getMethod(currentRealProperty.getName());
                 } catch (NoSuchMethodException e) {
-                    failedAssertions.add(e);
+                    System.out.println(String.format("Property %s not found.", currentRealProperty));
+//                    failedAssertions.add(e);
                 }
 
                 var exceptionMessage = "The property " + currentRealProperty.getName() + " of class " + realObject.getClass().getSimpleName() + " was not as expected.";
 
                 try {
                     if (currentRealProperty.getReturnType() == LocalDateTime.class) {
+                    assert currentExpectedProperty != null;
+                        LocalDateTimeAssert.areEqual(
+                                (LocalDateTime)currentExpectedProperty.invoke(expectedObject),
+                                (LocalDateTime)currentRealProperty.invoke(realObject),
+                                deltaType, deltaQuantity, exceptionMessage);
+                    } else if (currentRealProperty.getReturnType() == OffsetDateTime.class) {
+                        assert currentExpectedProperty != null;
                         LocalDateTimeAssert.areEqual(
-                                (LocalDateTime) currentExpectedProperty.invoke(expectedObject),
-                                (LocalDateTime) currentRealProperty.invoke(realObject),
+                                ((OffsetDateTime)currentExpectedProperty.invoke(expectedObject)).toLocalDateTime(),
+                                ((OffsetDateTime)currentRealProperty.invoke(realObject)).toLocalDateTime(),
                                 deltaType, deltaQuantity, exceptionMessage);
                     } else {
                         Assertions.assertEquals(
-                                currentExpectedProperty.invoke(expectedObject),
+                                currentExpectedProperty != null ? currentExpectedProperty.invoke(expectedObject) : null,
                                 currentRealProperty.invoke(realObject),
                                 exceptionMessage);
                     }
-
-                } catch (Exception ex) {
+                }
+                catch (NoSuchMethodException nsm){
+                    //ignore this case
+                }
+                catch (NullPointerException nsmex){
+                    //ignore this case
+                }
+                catch (Exception ex) {
                     failedAssertions.add(ex);
                 }
             }

bellatrix.core/src/main/java/solutions/bellatrix/core/assertions/LocalDateTimeAssert.java

@@ -37,7 +37,8 @@ else if (actualDate == null){
         }
 
     }
-    public static void areEqual(LocalDateTime expectedDate, LocalDateTime actualDate, Duration expectedDelta, String exceptionMessage)  throws Exception {
+
+    public static void areEqual(LocalDateTime expectedDate, LocalDateTime actualDate, Duration expectedDelta, String exceptionMessage) {
         if (expectedDate == null && actualDate == null){
             return;
         }
@@ -54,7 +55,7 @@ else if (actualDate == null){
         {
             var message = exceptionMessage+"\nExpected Date: "+expectedDate+", Actual Date: "+actualDate+
                     " \nExpected Delta: "+expectedDelta+", Actual Delta: "+actualDelta;
-            throw new Exception(message);
+            throw new RuntimeException(message);
         }
     }
     private static Duration getTimeSpanDeltaByType(DateTimeDeltaType type, int count)  throws UnsupportedOperationException {

bellatrix.core/src/main/java/solutions/bellatrix/core/configuration/ConfigurationService.java

@@ -30,6 +30,10 @@
 public final class ConfigurationService {
     private static String environment;
 
+    public static String getEnvironment() {
+        return environment;
+    }
+
     public static <T> T get(Class<T> configSection) {
         T mappedObject = (T)new Object();
         if (environment == null) {