chore(release): merge develop into main (#433)

artemrys · web-flow · commit 6a4b06418c12 · 2024-07-10T16:41:29.000+02:00
diff --git a/docs/change_log.md b/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.
+
diff --git a/mkdocs.yml b/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"
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -30,7 +30,7 @@ classifiers = [
 packages = [
         {include = "pytest_splunk_addon_ui_smartx/**/*.py"},
 ]
-version = "4.0.0"
+version = "5.0.0-beta.1"
 
 [tool.poetry.dependencies]
 python = "^3.7"
@@ -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]
diff --git a/pytest_splunk_addon_ui_smartx/__init__.py b/pytest_splunk_addon_ui_smartx/__init__.py
@@ -17,4 +17,4 @@
 from . import components, pages
 from .components import controls
 
-__version__ = "4.0.0"
+__version__ = "5.0.0-beta.1"
diff --git a/pytest_splunk_addon_ui_smartx/alert_actions/components/account_select.py b/pytest_splunk_addon_ui_smartx/alert_actions/components/account_select.py
@@ -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
diff --git a/pytest_splunk_addon_ui_smartx/alert_actions/components/textbox.py b/pytest_splunk_addon_ui_smartx/alert_actions/components/textbox.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
diff --git a/pytest_splunk_addon_ui_smartx/base_test.py b/pytest_splunk_addon_ui_smartx/base_test.py
@@ -154,9 +154,9 @@ def get_local_chrome_opts(headless_run):
         chrome_opts.add_argument("--ignore-ssl-errors=yes")
         chrome_opts.add_argument("--ignore-certificate-errors")
         chrome_opts.add_argument("--disable-dev-shm-usage")
+        chrome_opts.add_argument("--window-size=1280,768")
         if headless_run:
             chrome_opts.add_argument("--headless")
-            chrome_opts.add_argument("--window-size=1280,768")
         return chrome_opts
 
     @staticmethod
diff --git a/pytest_splunk_addon_ui_smartx/components/controls/single_select.py b/pytest_splunk_addon_ui_smartx/components/controls/single_select.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
diff --git a/pytest_splunk_addon_ui_smartx/components/controls/textarea.py b/pytest_splunk_addon_ui_smartx/components/controls/textarea.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.
diff --git a/pytest_splunk_addon_ui_smartx/components/controls/textbox.py b/pytest_splunk_addon_ui_smartx/components/controls/textbox.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
diff --git a/pytest_splunk_addon_ui_smartx/components/input_table.py b/pytest_splunk_addon_ui_smartx/components/input_table.py
@@ -62,32 +62,25 @@ def input_status_toggle(self, name, enable):
             :return: Bool whether or not enabling or disabling the field was successful, If the field was already in the state we wanted it in, then it will return an exception
         """
         _row = self._get_row(name)
-        input_status = _row.find_element(
-            *list(self.elements["input_status"]._asdict().values())
-        )
-        status = (
-            input_status.find_element_by_css_selector('[data-test="status"]')
-            .text.strip()
-            .lower()
-        )
         status_button = _row.find_element(
             *list(self.elements["status_toggle"]._asdict().values())
         )
+        input_enabled = (
+            True
+            if status_button.get_attribute("data-selected").lower().strip() == "true"
+            else False
+        )
         if enable:
-            if status == "enabled":
-                raise Exception(
-                    "The input is already {}".format(self.input_status.text.strip())
-                )
-            elif status == "disabled":
+            if input_enabled:
+                raise Exception("The input is already enabled")
+            else:
                 status_button.click()
                 self.wait_until("switch_button_status")
                 return True
         else:
-            if status == "disabled":
-                raise Exception(
-                    "The input is already {}".format(self.input_status.text.strip())
-                )
-            elif status == "enabled":
+            if not input_enabled:
+                raise Exception("The input is already disabled")
+            else:
                 status_button.click()
                 self.wait_until("switch_button_status")
                 return True
diff --git a/tests/testdata/Splunk_TA_UCCExample/globalConfig.json b/tests/testdata/Splunk_TA_UCCExample/globalConfig.json
@@ -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",
diff --git a/tests/ui/test_splunk_ta_example_addon_account.py b/tests/ui/test_splunk_ta_example_addon_account.py
diff --git a/tests/ui/test_splunk_ta_example_addon_custom.py b/tests/ui/test_splunk_ta_example_addon_custom.py
diff --git a/tests/ui/test_splunk_ta_example_addon_input_1.py b/tests/ui/test_splunk_ta_example_addon_input_1.py
diff --git a/tests/ui/test_splunk_ta_example_addon_input_2.py b/tests/ui/test_splunk_ta_example_addon_input_2.py
diff --git a/tests/ui/test_splunk_ta_example_addon_proxy.py b/tests/ui/test_splunk_ta_example_addon_proxy.py
