From 5a3252a13965ddf2e750ace5adb8cf911917b7bf Mon Sep 17 00:00:00 2001
From: Kevin Garton <71028750+ddl-kgarton@users.noreply.github.com>
Date: Mon, 15 May 2023 14:45:14 -0500
Subject: [PATCH] QE-11613 Add helper for ensuring state; use for checkboxes
 (#329)

These steps will allow us to have idempotent steps for things like
configuration.
---
 data/www/checkboxes.html         |   4 ++
 features/browser/helpers.feature |  14 ++++
 pyproject.toml                   |   2 +-
 src/cucu/helpers.py              | 115 +++++++++++++++++++++++++++++++
 src/cucu/steps/checkbox_steps.py |   8 ++-
 5 files changed, 141 insertions(+), 2 deletions(-)

diff --git a/data/www/checkboxes.html b/data/www/checkboxes.html
index 806a1250..223da6c8 100644
--- a/data/www/checkboxes.html
+++ b/data/www/checkboxes.html
@@ -94,6 +94,10 @@
     <br/>
     <input onclick="update('disabled checkbox')" disabled type="checkbox"><label>disabled checkbox</label></input>
     <br/>
+    <input onclick="update('default checked checkbox')" type="checkbox" checked><label>default checked checkbox</label></input>
+    <br/>
+    <input onclick="update('default unchecked checkbox')" type="checkbox"><label>default unchecked checkbox</label></input>
+    <br/>
 
     <label class="container">
         <input type="checkbox">
diff --git a/features/browser/helpers.feature b/features/browser/helpers.feature
index d40343e5..948e67b8 100644
--- a/features/browser/helpers.feature
+++ b/features/browser/helpers.feature
@@ -30,6 +30,20 @@ Feature: Helpers
       Then I should see the checkbox "checkbox with inner label" is checked
       """
 
+  Scenario: User can ensure a checkbox is in a desired state
+    Given I start a webserver at directory "data/www" and save the port to the variable "PORT"
+      And I open a browser at the url "http://{HOST_ADDRESS}:{PORT}/checkboxes.html"
+     When I ensure the checkbox "default checked checkbox" is checked
+     Then I should see the checkbox "default checked checkbox" is checked
+     When I uncheck the checkbox "default checked checkbox"
+      And I ensure the checkbox "default checked checkbox" is checked
+     Then I should see the checkbox "default checked checkbox" is checked
+     When I ensure the checkbox "default unchecked checkbox" is not checked
+     Then I should see the checkbox "default unchecked checkbox" is not checked
+     When I check the checkbox "default unchecked checkbox"
+      And I ensure the checkbox "default unchecked checkbox" is not checked
+     Then I should see the checkbox "default unchecked checkbox" is not checked
+
   Scenario: User gets appropriate error when waiting to see a checkbox is not in the expected state
     Given I set the variable "CUCU_STEP_WAIT_TIMEOUT_S" to "5"
       And I start a webserver at directory "data/www" and save the port to the variable "PORT"
diff --git a/pyproject.toml b/pyproject.toml
index 6cdb6659..d9e03ed0 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cucu"
-version = "0.128.0"
+version = "0.129.0"
 license = "MIT"
 description = ""
 authors = ["Rodney Gomes <rodneygomes@gmail.com>"]
diff --git a/src/cucu/helpers.py b/src/cucu/helpers.py
index 202704a0..2e289166 100644
--- a/src/cucu/helpers.py
+++ b/src/cucu/helpers.py
@@ -371,6 +371,121 @@ def action_the_nth(ctx, seconds, nth, name):
             )
 
 
+def define_ensure_state_on_thing_with_name_steps(
+    thing, state, find_func, state_func, action_func, with_nth=False
+):
+    """
+    defines steps with with the following signatures:
+
+      I ensure the {thing} "{name}" is {state}
+      I wait to ensure the {thing} "{name}" is {state}
+      I wait up to "{seconds}" seconds to ensure the {thing} "{name}" is {state}
+
+      when with_nth=True we also define:
+
+      I ensure the "{nth}" {thing} "{name}" is {state}
+      I wait to ensure the "{nth}" {thing} "{name}" is {state}
+      I wait up to "{seconds}" seconds to ensure the "{nth}" {thing} "{name}" is {state}
+
+    parameters:
+        thing(string):       name of the thing we're creating the steps for such
+                             as button, dialog, etc.
+        state(stirng):       the name of the state we want to ensure, such as:
+                             filled, checked, empty, not empty, etc.
+        find_func(function): function that returns the desired element:
+
+                             def find_func(ctx, name, index=):
+                                '''
+                                ctx(object):  behave context object
+                                name(string): name of the thing to find
+                                index(int):   when there are multiple elements
+                                              with the same name and you've
+                                              specified with_nth=True
+                                '''
+        state_func(function): function that returns True if the element is in
+                              the desired state and False otherwise:
+
+                               def state_func(element):
+                                  '''
+                                  element(object): the element found
+                                  '''
+        action_func(function): action that will set the desired state on the
+                               element if state_func returns False:
+                               def action_func(ctx, element):
+                                  '''
+                                  ctx(object):  behave context object
+                                  element(object): the element found
+                                  '''
+        with_nth(bool):     when set to True we'll define the expanded set of
+                            "nth" steps. default: False
+    """
+
+    # undecorated def for reference below
+    def base_ensure_the(ctx, thing, name, index=0):
+        prefix = nth_to_ordinal(index)
+        element = find_func(ctx, name, index=index)
+
+        if element is None:
+            raise RuntimeError(f'unable to find the {prefix}{thing} "{name}"')
+
+        if not state_func(element):
+            action_func(ctx, element)
+
+    @step(f'I immediately ensure the {thing} "{{name}}" is {state}')
+    def immediately_ensure_the(ctx, name, state):
+        base_ensure_the(ctx, thing, name)
+
+    @step(f'I ensure the {thing} "{{name}}" is {state}')
+    def ensure_the(ctx, name):
+        retry(
+            base_ensure_the,
+            retry_after_s=float(CONFIG["CUCU_SHORT_UI_RETRY_AFTER_S"]),
+            wait_up_to_s=float(CONFIG["CUCU_SHORT_UI_WAIT_TIMEOUT_S"]),
+        )(ctx, thing, name)
+
+    @step(f'I wait to ensure the {thing} "{{name}}" is {state}')
+    def wait_to_ensure_the(ctx, name):
+        retry(base_ensure_the)(ctx, thing, name)
+
+    @step(
+        f'I wait up to "{{seconds}}" seconds to ensure the {thing} "{{name}}" is {state}'
+    )
+    def wait_up_to_seconds_to_ensure_the(ctx, seconds, name):
+        seconds = float(seconds)
+        retry(base_ensure_the, wait_up_to_s=seconds)(ctx, thing, name)
+
+    if with_nth:
+
+        @step(
+            f'I immediately ensure the "{{nth:nth}}" {thing} "{{name}}" is {state}'
+        )
+        def immediately_ensure_the_nth(ctx, nth, name):
+            base_ensure_the(ctx, thing, name, index=nth)
+
+        @step(f'I ensure the "{{nth:nth}}" {thing} "{{name}}"')
+        def ensure_the_nth(ctx, nth, name):
+            retry(
+                base_ensure_the,
+                retry_after_s=float(CONFIG["CUCU_SHORT_UI_RETRY_AFTER_S"]),
+                wait_up_to_s=float(CONFIG["CUCU_SHORT_UI_WAIT_TIMEOUT_S"]),
+            )(ctx, thing, name, index=nth)
+
+        @step(
+            f'I wait to ensure the "{{nth:nth}}" {thing} "{{name}}" is {state}'
+        )
+        def ensure_the_nth(ctx, nth, name):
+            retry(base_ensure_the)(ctx, thing, name, index=nth)
+
+        @step(
+            f'I wait up to "{{seconds}}" seconds to ensure the "{{nth:nth}}" {thing} "{{name}}" is {state}'
+        )
+        def ensure_the_nth(ctx, seconds, nth, name):
+            seconds = float(seconds)
+            retry(base_ensure_the, wait_up_to_s=seconds)(
+                ctx, thing, name, index=nth
+            )
+
+
 def define_thing_with_name_in_state_steps(
     thing, state, find_func, is_in_state_func, with_nth=False
 ):
diff --git a/src/cucu/steps/checkbox_steps.py b/src/cucu/steps/checkbox_steps.py
index 864f4917..fcdeba83 100644
--- a/src/cucu/steps/checkbox_steps.py
+++ b/src/cucu/steps/checkbox_steps.py
@@ -1,4 +1,4 @@
-from cucu import helpers, fuzzy
+from cucu import helpers, fuzzy, step
 from . import base_steps
 
 
@@ -97,3 +97,9 @@ def uncheck_checkbox(ctx, checkbox):
 helpers.define_run_steps_if_I_can_see_element_with_name_steps(
     "checkbox", find_checkbox
 )
+helpers.define_ensure_state_on_thing_with_name_steps(
+    "checkbox", "checked", find_checkbox, is_checked, check_checkbox
+)
+helpers.define_ensure_state_on_thing_with_name_steps(
+    "checkbox", "not checked", find_checkbox, is_not_checked, uncheck_checkbox
+)