From d9a2b02f0f062d1ecc32ad99e179973e2b743d8c Mon Sep 17 00:00:00 2001 From: gschatz Date: Fri, 26 Jul 2024 14:47:36 -0700 Subject: [PATCH 1/3] add table --- .../browser-test/set-up-browser-test.rst | 248 ++---------------- 1 file changed, 22 insertions(+), 226 deletions(-) diff --git a/synthetics/browser-test/set-up-browser-test.rst b/synthetics/browser-test/set-up-browser-test.rst index 05ffd700e..ade8c03ee 100644 --- a/synthetics/browser-test/set-up-browser-test.rst +++ b/synthetics/browser-test/set-up-browser-test.rst @@ -335,232 +335,7 @@ If your recording contains unsupported steps, you need to edit the step to refor "wait_for_nav": false } - - -.. - .. list-table:: - :header-rows: 1 - :widths: 50 50 - :class: fix-width - - * - :strong:`Google Chrome Recorder snippet` - - :strong:`Synthetic snippet` - - * - ``navigate``: - - .. code-block:: javascript - - { - "type": "navigate", - "url": "www.buttercupgames.com", - "assertedEvents": [ - { - "type": "navigation", - "url": "www.buttercupgames.com", - "title": "Buttercup Games" - } - ] - } - - - ``go_to_url`` : - - .. code-block:: javascript - - { - "name": "Go to URL", - "type": "go_to_url", - "url": "www.buttercupgames.com", - "wait_for_nav": true - } - - * - ``click`` with resulting navigation: - - .. code-block:: javascript - - { - "type": "click", - "target": "main", - "selectors": [ - [ - "div:nth-of-type(2) > div:nth-of-type(2) a > div" - ], - [ - "xpath//html/body/main/div/div/div[2]/div[2]/div/a/div" - ] - ], - "offsetY": 211, - "offsetX": 164, - "assertedEvents": [ - { - "type": "navigation", - "url": "www.buttercupgames.com/product/example", - "title": "Buttercup Games" - } - ] - - - ``click_element`` with resulting navigation: - - .. code-block:: javascript - - { - "name": "", - "type": "click_element", - "selector_type": "css", - "selector": "div:nth-of-type(2) > div:nth-of-type(2) a > div", - "wait_for_nav": true - } - - * - ``click`` without resulting navigation: - - .. code-block:: javascript - - { - "type": "click", - "target": "main", - "selectors": [ - [ - "div:nth-of-type(2) > div:nth-of-type(2) a > div" - ], - [ - "xpath//html/body/main/div/div/div[2]/div[2]/div/a/div" - ] - ], - "offsetY": 211, - "offsetX": 164, - "assertedEvents": [] - } - - - - - ``click_element`` without resulting navigation: - - .. code-block:: javascript - - { - "name": "", - "type": "click_element", - "selector_type": "css", - "selector": "div:nth-of-type(2) > div:nth-of-type(2) a > div", - "wait_for_nav": false - } - - * - ``change``: - - .. code-block:: javascript - - { - "type": "change", - "value": "5", - "selectors": [ - [ - "#quantity" - ], - [ - "xpath///*[@id=\"quantity\"]" - ] - ], - "target": "main" - } - - - - ``enter_value``: - - .. code-block:: javascript - - { - "name": "", - "type": "enter_value", - "selector_type": "id", - "selector": "quantity", - "option_selector_type": "index", - "option_selector": "5", - "wait_for_nav": false - } - - * - ``waitForElement``: - - .. code-block:: javascript - - { - "type": "waitForElement", - "selectors": [ - [ - "body", - "#homepage_example", - ".css-4t2fjl", - ".eanm77i0" - ] - ] - } - - - - - ``assert_element_present``: - - .. code-block:: javascript - - { - "name": "", - "type": "assert_element_present", - "wait_for_nav": false, - "selector_type": "css", - "selector": "body,#homepage_example, .css-4t2fjl, .eanm77i0" - } - - * - ``waitForElement`` visible false: - - .. code-block:: javascript - - { - "type": "waitForElement", - "selectors": [ - [ - "body", - "#homepage_product_brand-example", - ".css-4t2fjl", - ".eanm77i0" - ] - ], - "visible": false - } - - - - ``assert_element_not_present``: - - .. code-block:: javascript - - { - "name": "", - "type": "assert_element_not_present", - "wait_for_nav": false, - "selector_type": "css", - "selector": "body,#homepage_product_brand-example" - } - * - ``customStep``: - - .. code-block:: javascript - - { - "type": "customStep", - "timeout": 5000, - "target": "main", - "name": "customParam", - "parameters": {} - } - - - - ``run_javascript``: - - .. code-block:: javascript - - { - "name": "Unsupported step customStep", - "type": "run_javascript", - "value": "", - "wait_for_nav": false - } - - + View your Browser test ==================================== @@ -681,6 +456,27 @@ The following image shows how to configure a test to go to a URL, wait for 10 se :alt: This image shows a browser test with three steps: go to url, wait 20 seconds, then log in. + +Here are the limits for each type of wait time. After 30 minutes a run times out. + +.. list-table:: + :header-rows: 1 + :widths: 50 50 + + * - :strong:`Description` + - :strong:`Limit` + + * - Assert steps + - 90 seconds + + * - Wait for navigation + - 20 seconds + + * - Global timeout for all runs + - 30 minutes + + + .. _collect-interactive-metrics: Collect interactive metrics From 29c778e7778c7c66ce32590e074352bc282c1943 Mon Sep 17 00:00:00 2001 From: gschatz Date: Wed, 31 Jul 2024 12:35:34 -0700 Subject: [PATCH 2/3] add tables --- .../browser-test/set-up-browser-test.rst | 23 +++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/synthetics/browser-test/set-up-browser-test.rst b/synthetics/browser-test/set-up-browser-test.rst index ade8c03ee..70fdd4008 100644 --- a/synthetics/browser-test/set-up-browser-test.rst +++ b/synthetics/browser-test/set-up-browser-test.rst @@ -441,7 +441,7 @@ Wait times Optimize your test coverage by adding custom wait times to capture longer page loads and improve the accuracy of run results. Applications with long load times can cause a Browser test to fail. If you know that there are certain steps in a workflow that take longer than 10 seconds, add a custom wait time to your Browser test. * Wait times are available with Browser tests only. -* The maximum cumulative wait time for each test is 200 seconds. +* The maximum custom wait time for each test is 200 seconds. Follow these steps to configure custom wait times for your Browser tests: @@ -456,8 +456,10 @@ The following image shows how to configure a test to go to a URL, wait for 10 se :alt: This image shows a browser test with three steps: go to url, wait 20 seconds, then log in. +Limits and defaults for configurable wait times +------------------------------------------------------ +Here are the limits for each type of wait time. The maximum limit for a run is 30 minutes, afterwhich it times out. -Here are the limits for each type of wait time. After 30 minutes a run times out. .. list-table:: :header-rows: 1 @@ -471,9 +473,22 @@ Here are the limits for each type of wait time. After 30 minutes a run times out * - Wait for navigation - 20 seconds + + +.. list-table:: + :header-rows: 1 + :widths: 50 50 + + * - :strong:`Description` + - :strong:`Default` + + * - Wait time for assert + - 10 seconds + + * - Wait for navigation + - 2 seconds - * - Global timeout for all runs - - 30 minutes + From e3a95534c5178ba6cccebcaeef9d6851178be22d Mon Sep 17 00:00:00 2001 From: gschatz-splunk <69330797+gschatz-splunk@users.noreply.github.com> Date: Tue, 6 Aug 2024 08:13:46 -0700 Subject: [PATCH 3/3] Update set-up-browser-test.rst --- synthetics/browser-test/set-up-browser-test.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/synthetics/browser-test/set-up-browser-test.rst b/synthetics/browser-test/set-up-browser-test.rst index 70fdd4008..2d3c06b70 100644 --- a/synthetics/browser-test/set-up-browser-test.rst +++ b/synthetics/browser-test/set-up-browser-test.rst @@ -458,7 +458,7 @@ The following image shows how to configure a test to go to a URL, wait for 10 se Limits and defaults for configurable wait times ------------------------------------------------------ -Here are the limits for each type of wait time. The maximum limit for a run is 30 minutes, afterwhich it times out. +Here are the limits for each type of wait time. The maximum limit for a run is 30 minutes, after which it times out. .. list-table::