feat(java): ✨ added android specific critical actions

BoykaFramework · Jan 22, 2025 · 3295f25 · 3295f25
1 parent 02e0c60
commit 3295f25
Show file tree

Hide file tree

Showing 220 changed files with 641 additions and 267 deletions.
diff --git a/core-java/checkstyles/checkstyle-suppressions.xml b/core-java/checkstyles/checkstyle-suppressions.xml
@@ -2,7 +2,7 @@
 <!--
   ~ MIT License
   ~
-  ~ Copyright (c) 2022 Wasiq Bhamla
+  ~ Copyright (c) 2022 Boyka Framework
   ~
   ~ Permission is hereby granted, free of charge, to any person obtaining a copy
   ~ of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/checkstyles/checkstyle.xml b/core-java/checkstyles/checkstyle.xml
@@ -2,7 +2,7 @@
 <!--
   ~ MIT License
   ~
-  ~ Copyright (c) 2022 Wasiq Bhamla
+  ~ Copyright (c) 2022 Boyka Framework
   ~
   ~ Permission is hereby granted, free of charge, to any person obtaining a copy
   ~ of this software and associated documentation files (the "Software"), to deal
@@ -145,7 +145,7 @@
         </module>
         <!-- Validate whitespace around Generics (angle brackets) per typical conventions
             http://checkstyle.sourceforge.net/config_whitespace.html#GenericWhitespace -->
-<!--        <module name="GenericWhitespace"/>-->
+        <!--        <module name="GenericWhitespace"/>-->
 
         <!-- ##### Blank line requirements ##### -->
         <module name="EmptyLineSeparator">

diff --git a/core-java/code-formatter/boyka-formatter.xml b/core-java/code-formatter/boyka-formatter.xml
@@ -1,7 +1,7 @@
 <!--
   ~ MIT License
   ~
-  ~ Copyright (c) 2023, Wasiq Bhamla
+  ~ Copyright (c) 2024, Boyka Framework
   ~
   ~ Permission is hereby granted, free of charge, to any person obtaining a copy
   ~ of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/pom.xml b/core-java/pom.xml
@@ -2,7 +2,7 @@
 <!--
   ~ MIT License
   ~
-  ~ Copyright (c) 2022 Wasiq Bhamla
+  ~ Copyright (c) 2022 Boyka Framework
   ~
   ~ Permission is hereby granted, free of charge, to any person obtaining a copy
   ~ of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/setting/settings.xml b/core-java/setting/settings.xml
@@ -1,7 +1,7 @@
 <!--
   ~ MIT License
   ~
-  ~ Copyright (c) 2022 Wasiq Bhamla
+  ~ Copyright (c) 2022 Boyka Framework
   ~
   ~ Permission is hereby granted, free of charge, to any person obtaining a copy
   ~ of this software and associated documentation files (the "Software"), to deal
@@ -15,8 +15,8 @@
   -->
 
 <settings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xmlns="http://maven.apache.org/SETTINGS/1.0.0"
-    xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
+          xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
     <profiles>
         <profile>
             <id>central</id>

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/CommonActions.java b/core-java/src/main/java/io/github/boykaframework/actions/CommonActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/api/ApiActions.java b/core-java/src/main/java/io/github/boykaframework/actions/api/ApiActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/data/DataRow.java b/core-java/src/main/java/io/github/boykaframework/actions/data/DataRow.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/data/TestDataAction.java b/core-java/src/main/java/io/github/boykaframework/actions/data/TestDataAction.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/device/AndroidDeviceActions.java b/core-java/src/main/java/io/github/boykaframework/actions/device/AndroidDeviceActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -16,6 +16,8 @@
 
 package io.github.boykaframework.actions.device;
 
+import static com.google.common.truth.Truth.assertWithMessage;
+import static io.github.boykaframework.actions.CommonActions.getDriverAttribute;
 import static io.github.boykaframework.actions.CommonActions.performDriverAction;
 import static io.github.boykaframework.enums.ListenerType.ANDROID_DEVICE_ACTION;
 import static io.github.boykaframework.enums.Message.ACTION_NOT_SUPPORTED_ON_PLATFORM;
@@ -25,9 +27,15 @@
 import static java.util.Optional.ofNullable;
 import static org.apache.logging.log4j.LogManager.getLogger;
 
+import java.io.File;
+import java.io.IOException;
+
+import com.google.common.truth.StringSubject;
 import io.appium.java_client.android.AndroidDriver;
+import io.appium.java_client.android.HasNotifications;
 import io.appium.java_client.android.nativekey.AndroidKey;
 import io.appium.java_client.android.nativekey.KeyEvent;
+import io.appium.java_client.clipboard.HasClipboard;
 import io.github.boykaframework.actions.interfaces.device.IAndroidDeviceActions;
 import io.github.boykaframework.actions.interfaces.listeners.device.IAndroidDeviceActionsListener;
 import org.apache.logging.log4j.Logger;
@@ -57,16 +65,87 @@ private AndroidDeviceActions () {
         this.listener = getSession ().getListener (ANDROID_DEVICE_ACTION);
     }
 
+    @Override
+    public String getClipboardText () {
+        LOGGER.traceEntry ();
+        isActionSupported ();
+        LOGGER.info ("Getting the Clipboard text from Android device...");
+        ofNullable (this.listener).ifPresent (IAndroidDeviceActionsListener::onGetClipboardText);
+        return getClipboard ();
+    }
+
+    @Override
+    public void openNotification () {
+        LOGGER.traceEntry ();
+        isActionSupported ();
+        LOGGER.info ("Opening Notification panel on the Android device...");
+        ofNullable (this.listener).ifPresent (IAndroidDeviceActionsListener::onOpenNotification);
+        performDriverAction (HasNotifications::openNotifications);
+        LOGGER.traceExit ();
+    }
+
     @Override
     public void pressKey (final AndroidKey key) {
         LOGGER.traceEntry ();
-        final var platform = getSession ().getPlatformType ();
-        if (platform != ANDROID) {
-            throwError (ACTION_NOT_SUPPORTED_ON_PLATFORM, "Press key", platform);
-        }
+        isActionSupported ();
         LOGGER.info ("Pressing key [{}] on Android device...", key);
         ofNullable (this.listener).ifPresent (l -> l.onPressKey (key));
         performDriverAction ((AndroidDriver d) -> d.pressKey (new KeyEvent ().withKey (key)));
         LOGGER.traceExit ();
     }
+
+    @Override
+    public byte[] pullFile (final String targetFile) {
+        LOGGER.traceEntry ();
+        isActionSupported ();
+        LOGGER.info ("Pulling file [{}] from Android device...", targetFile);
+        ofNullable (this.listener).ifPresent (l -> l.onPullFile (targetFile));
+        return getDriverAttribute ((final AndroidDriver d) -> d.pullFile (targetFile), null);
+    }
+
+    @Override
+    public boolean putFile (final File sourceFile, final String destinationPath) {
+        LOGGER.traceEntry ();
+        isActionSupported ();
+        LOGGER.info ("Putting file [{}] on Android device path [{}]...", sourceFile.getName (), destinationPath);
+        ofNullable (this.listener).ifPresent (l -> l.onPutFile (sourceFile, destinationPath));
+        return getDriverAttribute ((final AndroidDriver d) -> {
+            try {
+                d.pushFile (destinationPath, sourceFile);
+                return true;
+            } catch (final IOException e) {
+                return false;
+            }
+        }, false);
+    }
+
+    @Override
+    public void setClipboardText (final String text) {
+        LOGGER.traceEntry ();
+        isActionSupported ();
+        LOGGER.info ("Setting the Clipboard text [{}] on the Android device...", text);
+        ofNullable (this.listener).ifPresent (l -> l.onSetClipboardText (text));
+        performDriverAction ((AndroidDriver d) -> d.setClipboardText (text));
+        LOGGER.traceExit ();
+    }
+
+    @Override
+    public StringSubject verifyClipboardText () {
+        LOGGER.traceEntry ();
+        isActionSupported ();
+        LOGGER.info ("Verifying the Clipboard text from Android device...");
+        ofNullable (this.listener).ifPresent (IAndroidDeviceActionsListener::onVerifyClipboardText);
+        return assertWithMessage ("Clipboard Text").that (getClipboard ());
+    }
+
+    private String getClipboard () {
+        return getDriverAttribute (HasClipboard::getClipboardText, null);
+    }
+
+    private void isActionSupported () {
+        final var platform = getSession ().getPlatformType ();
+        if (platform != ANDROID) {
+            throwError (ACTION_NOT_SUPPORTED_ON_PLATFORM, "Press key", platform);
+        }
+    }
 }
diff --git a/core-java/src/main/java/io/github/boykaframework/actions/device/DeviceActions.java b/core-java/src/main/java/io/github/boykaframework/actions/device/DeviceActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/drivers/AlertActions.java b/core-java/src/main/java/io/github/boykaframework/actions/drivers/AlertActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/drivers/ContextActions.java b/core-java/src/main/java/io/github/boykaframework/actions/drivers/ContextActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/drivers/CookieActions.java b/core-java/src/main/java/io/github/boykaframework/actions/drivers/CookieActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/drivers/DriverActions.java b/core-java/src/main/java/io/github/boykaframework/actions/drivers/DriverActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/drivers/FrameActions.java b/core-java/src/main/java/io/github/boykaframework/actions/drivers/FrameActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/drivers/NavigateActions.java b/core-java/src/main/java/io/github/boykaframework/actions/drivers/NavigateActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/drivers/WindowActions.java b/core-java/src/main/java/io/github/boykaframework/actions/drivers/WindowActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/elements/ClickableActions.java b/core-java/src/main/java/io/github/boykaframework/actions/elements/ClickableActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/elements/DropDownActions.java b/core-java/src/main/java/io/github/boykaframework/actions/elements/DropDownActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/elements/ElementActions.java b/core-java/src/main/java/io/github/boykaframework/actions/elements/ElementActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/elements/ElementFinder.java b/core-java/src/main/java/io/github/boykaframework/actions/elements/ElementFinder.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/elements/FingerActions.java b/core-java/src/main/java/io/github/boykaframework/actions/elements/FingerActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/elements/FingerGestureBuilder.java b/core-java/src/main/java/io/github/boykaframework/actions/elements/FingerGestureBuilder.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/elements/FingersActions.java b/core-java/src/main/java/io/github/boykaframework/actions/elements/FingersActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/elements/TextBoxActions.java b/core-java/src/main/java/io/github/boykaframework/actions/elements/TextBoxActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/interfaces/api/IApiActions.java b/core-java/src/main/java/io/github/boykaframework/actions/interfaces/api/IApiActions.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/core-java/src/main/java/io/github/boykaframework/actions/interfaces/data/IDataRow.java b/core-java/src/main/java/io/github/boykaframework/actions/interfaces/data/IDataRow.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/...-java/src/main/java/io/github/boykaframework/actions/interfaces/data/ITestDataAction.java b/...-java/src/main/java/io/github/boykaframework/actions/interfaces/data/ITestDataAction.java
@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024, Wasiq Bhamla
+ * Copyright (c) 2024, Boyka Framework
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal