feat: remove placeholder functionality from framework (#430)

ADDON-71391
Removes the placeholder related functionalities and the test cases
present.
Users would no longer be able to use the `get_placeholder_value`
property for their test cases.

**NOTE:** This PR can be merged once UCC 5.48.0 is released and updating
the same version for this repo.

BREAKING CHANGE: remove placeholder functionality

---------

Co-authored-by: Artem Rys <rysartem@gmail.com>

Author: hetangmodi-crest

docs/change_log.md

@@ -0,0 +1,8 @@
+# v5.0.0
+
+The `get_placeholder_value` method has been removed in this version. The value present in placeholder will no longer be accessible starting SmartX v5.0.0.
+To ensure smooth upgrade of the SmartX from v4.x to v5.0 in your environment, ensure that your add-on doesn't use `placeholder` property defined in your add-on's globalConfig file.
+The `placeholder` property for an entity of an input has been deprecated as of September 2023 and has been removed as of UCC framework v5.48.0. You can use `help` property instead. Refer [this documentation](https://splunk.github.io/addonfactory-ucc-generator/entity/) of UCC framework for more details.
+
+Refer the [deprecation notice](https://github.com/splunk/addonfactory-ucc-generator/issues/831) for more details.
+

mkdocs.yml

@@ -98,3 +98,4 @@ nav:
         - single_select: "api_reference/components/controls/single_select.md"
         - textbox: "api_reference/components/controls/textbox.md"
         - toggle: "api_reference/components/controls/toggle.md"
+  - Changelog: "change_log.md"

poetry.lock

@@ -48,7 +48,7 @@ pytest11 = { "ucc-smartx" = "pytest_splunk_addon_ui_smartx.plugin" }
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=5.4, <7.3"
-splunk-add-on-ucc-framework = "5.28.5"
+splunk-add-on-ucc-framework = "5.48.0"
 pytest-rerunfailures = "^12.0"
 
 [build-system]

pyproject.toml

@@ -154,12 +154,6 @@ def get_value(self):
         except:
             return False
 
-    def get_placeholder_value(self):
-        """
-        get placeholder value from the single select
-        """
-        return self.input.get_attribute("placeholder").strip()
-
     def cancel_selected_value(self):
         """
         Cancels the currently selected value in the SingleSelect

pytest_splunk_addon_ui_smartx/alert_actions/components/account_select.py

@@ -48,12 +48,6 @@ def get_value(self):
         """
         return self.input.get_attribute("value").strip()
 
-    def get_placeholder_value(self):
-        """
-        get placeholder value from the textbox
-        """
-        return self.input.get_attribute("placeholder").strip()
-
     def is_editable(self):
         """
         Returns True if the Textbox is editable, False otherwise

pytest_splunk_addon_ui_smartx/alert_actions/components/textbox.py

@@ -202,29 +202,6 @@ def get_value(self):
             else:
                 return False
 
-    def get_placeholder_value(self):
-        """
-        get placeholder value from the single select
-        """
-        if self.searchable:
-            if self.allow_new_values:
-                self.elements.update(
-                    {
-                        "input": Selector(
-                            select=self.container.select + ' [data-test="textbox"]'
-                        )
-                    }
-                )
-            else:
-                self.wait_to_be_clickable("root")
-                self.root.click()
-                popover_id = "#" + self.root.get_attribute("data-test-popover-id")
-                self.elements.update(
-                    {"input": Selector(select=popover_id + ' [data-test="textbox"]')}
-                )
-
-        return self.input.get_attribute("placeholder").strip()
-
     def cancel_selected_value(self):
         """
         Cancels the currently selected value in the SingleSelect

pytest_splunk_addon_ui_smartx/components/controls/single_select.py

@@ -49,13 +49,6 @@ def get_value(self):
         """
         return self.input.get_attribute("value")
 
-    def get_placeholder_value(self):
-        """
-        get placeholder value from the textbox
-            :return: Str Value of the placeholder
-        """
-        return self.input.get_attribute("placeholder")
-
     def get_textarea_height(self) -> int:
         """
         Get the height of the displayed textarea.

pytest_splunk_addon_ui_smartx/components/controls/textarea.py

@@ -62,12 +62,6 @@ def get_value(self):
         """
         return self.input.get_attribute("value").strip()
 
-    def get_placeholder_value(self):
-        """
-        get placeholder value from the textbox
-        """
-        return self.input.get_attribute("placeholder").strip()
-
     def is_editable(self):
         """
         Returns True if the Textbox is editable, False otherwise

pytest_splunk_addon_ui_smartx/components/controls/textbox.py

@@ -38,9 +38,6 @@
                                     "pattern": "^[a-zA-Z]\\w*$"
                                 }
                             ],
-                            "options": {
-                                "placeholder": "Required"
-                            },
                             "field": "name",
                             "help": "Enter a unique name for this account.",
                             "required": true
@@ -349,10 +346,7 @@
                                     "minLength": 5
                                 }
                             ],
-                            "required": true,
-                            "options": {
-                                "placeholder": "Required"
-                            }
+                            "required": true
                         },
                         {
                             "field": "test_number",
@@ -367,10 +361,7 @@
                                     ]
                                 }
                             ],
-                            "required": true,
-                            "options": {
-                                "placeholder": "Required"
-                            }
+                            "required": true
                         },
                         {
                             "field": "test_regex",