Merge pull request #1351 from seleniumbase/fix-behave-issue-with-escaped-characters

Fix issue with escaped characters in Behave ".feature" files

Author: mdmintz

examples/behave_bdd/ReadMe.md

@@ -13,18 +13,18 @@ Dashboard: /Users/michael/github/SeleniumBase/examples/behave_bdd/dashboard.html
 Feature: SeleniumBase scenarios for the RealWorld App # features/realworld.feature:1
 
   Scenario: Verify RealWorld App (log in / sign out)  # features/realworld.feature:3
-    Given Open "seleniumbase.io/realworld/login"      # ../../sbase/steps.py:4
-    And Clear Session Storage                         # ../../sbase/steps.py:374
-    When Type "demo_user" into "#username"            # ../../sbase/steps.py:22
-    And Type "secret_pass" into "#password"           # ../../sbase/steps.py:22
-    And Do MFA "GAXG2MTEOR3DMMDG" into "#totpcode"    # ../../sbase/steps.py:179
-    Then Assert exact text "Welcome!" in "h1"         # ../../sbase/steps.py:75
-    And Highlight "img#image1"                        # ../../sbase/steps.py:82
-    And Click 'a:contains("This Page")'               # ../../sbase/steps.py:13
-    And Save screenshot to logs                       # ../../sbase/steps.py:107
-    When Click link "Sign out"                        # ../../sbase/steps.py:91
-    Then Assert element 'a:contains("Sign in")'       # ../../sbase/steps.py:52
-    And Assert text "You have been signed out!"       # ../../sbase/steps.py:68
+    Given Open "seleniumbase.io/realworld/login"      # ../../sbase/steps.py:10
+    And Clear Session Storage                         # ../../sbase/steps.py:389
+    When Type "demo_user" into "#username"            # ../../sbase/steps.py:28
+    And Type "secret_pass" into "#password"           # ../../sbase/steps.py:28
+    And Do MFA "GAXG2MTEOR3DMMDG" into "#totpcode"    # ../../sbase/steps.py:192
+    Then Assert exact text "Welcome!" in "h1"         # ../../sbase/steps.py:85
+    And Highlight "img#image1"                        # ../../sbase/steps.py:93
+    And Click 'a:contains("This Page")'               # ../../sbase/steps.py:19
+    And Save screenshot to logs                       # ../../sbase/steps.py:118
+    When Click link "Sign out"                        # ../../sbase/steps.py:102
+    Then Assert element 'a:contains("Sign in")'       # ../../sbase/steps.py:60
+    And Assert text "You have been signed out!"       # ../../sbase/steps.py:77
    ✅ Scenario Passed!
 
 - Dashboard: /Users/michael/github/SeleniumBase/examples/behave_bdd/dashboard.html
@@ -72,7 +72,7 @@ Feature: SeleniumBase scenarios for the Calculator App # features/calculator.fea
 Took 0m1.672s
 ```
 
-🔵🐝⚪ With the Dashboard enabled, you'll get one of these:
+🐝⚪ With the Dashboard enabled, you'll get one of these:
 
 <img src="https://seleniumbase.io/cdn/img/sb_behave_dashboard.png" title="SeleniumBase" width="600">
 

integrations/behave/ReadMe.md

@@ -69,7 +69,7 @@ Feature: SeleniumBase scenarios for the Calculator App # features/calculator.fea
 Took 0m1.672s
 ```
 
-🔵🐝⚪ With the Dashboard enabled, you'll get one of these:
+🐝⚪ With the Dashboard enabled, you'll get one of these:
 
 <img src="https://seleniumbase.io/cdn/img/sb_behave_dashboard.png" title="SeleniumBase" width="600">
 

sbase/steps.py

@@ -1,6 +1,12 @@
 from behave import step
 
 
+def normalize_text(text):
+    text = text.replace("\\\\", "\\").replace("\\t", "\t").replace("\\n", "\n")
+    text = text.replace('\\"', '"').replace("\\'", "'")
+    return text
+
+
 @step("Open '{url}'")
 @step('Open "{url}"')
 @step("Open URL '{url}'")
@@ -33,6 +39,7 @@ def click_element(context, selector):
 @step('Into "{selector}" type \'{text}\'')
 def type_text(context, selector, text):
     sb = context.sb
+    text = normalize_text(text)
     sb.type(selector, text)
 
 
@@ -46,6 +53,7 @@ def type_text(context, selector, text):
 @step('Into "{selector}" add \'{text}\'')
 def add_text(context, text, selector):
     sb = context.sb
+    text = normalize_text(text)
     sb.add_text(selector, text)
 
 
@@ -62,20 +70,23 @@ def assert_element(context, selector):
 @step('Assert text "{text}" in \'{selector}\'')
 def assert_text_in_element(context, text, selector):
     sb = context.sb
+    text = normalize_text(text)
     sb.assert_text(text, selector)
 
 
 @step("Assert text '{text}'")
 @step('Assert text "{text}"')
 def assert_text(context, text):
     sb = context.sb
+    text = normalize_text(text)
     sb.assert_text(text)
 
 
 @step("Assert exact text '{text}' in '{selector}'")
 @step('Assert exact text "{text}" in "{selector}"')
 def assert_exact_text(context, text, selector):
     sb = context.sb
+    text = normalize_text(text)
     sb.assert_exact_text(text, selector)
 
 
@@ -139,6 +150,7 @@ def go_forward(context):
 @step('JS type text "{text}" into \'{selector}\'')
 def js_type(context, text, selector):
     sb = context.sb
+    text = normalize_text(text)
     sb.js_type(selector, text)
 
 
@@ -148,6 +160,7 @@ def js_type(context, text, selector):
 @step('Set value of \'{selector}\' to "{text}"')
 def set_value(context, text, selector):
     sb = context.sb
+    text = normalize_text(text)
     sb.set_value(selector, text)
 
 
@@ -258,6 +271,7 @@ def hover_and_click(context, hover_selector, click_selector):
 @step('Find "{selector}" and select \'{text}\'')
 def select_option_by_text(context, selector, text):
     sb = context.sb
+    text = normalize_text(text)
     sb.select_option_by_text(selector, text)
 
 
@@ -267,6 +281,7 @@ def select_option_by_text(context, selector, text):
 @step('Find "{selector}" and select \'{text}\' by {option}')
 def select_option_by_option(context, selector, text, option):
     sb = context.sb
+    text = normalize_text(text)
     if option.startswith("'") or option.startswith('"'):
         option = option[1:]
     if option.endswith("'") or option.endswith('"'):
@@ -440,13 +455,15 @@ def assert_element_not_visible(context, selector):
 @step('Assert link text "{text}"')
 def assert_link_text(context, text):
     sb = context.sb
+    text = normalize_text(text)
     sb.assert_link_text(text)
 
 
 @step("Assert title '{title}'")
 @step('Assert title "{title}"')
 def assert_title(context, title):
     sb = context.sb
+    title = normalize_text(title)
     sb.assert_title(title)
 
 
@@ -494,6 +511,7 @@ def assert_attribute(context, selector, attribute):
 @step('In \'{selector}\' assert attribute/value "{attribute}"/"{value}"')
 def assert_attribute_has_value(context, selector, attribute, value):
     sb = context.sb
+    value = normalize_text(value)
     sb.assert_attribute(selector, attribute, value)
 
 
@@ -542,20 +560,23 @@ def deferred_assert_element_present(context, selector):
 @step('Deferred assert text "{text}" in \'{selector}\'')
 def deferred_assert_text_in_element(context, text, selector):
     sb = context.sb
+    text = normalize_text(text)
     sb.deferred_assert_text(text, selector)
 
 
 @step("Deferred assert text '{text}'")
 @step('Deferred assert text "{text}"')
 def deferred_assert_text(context, text):
     sb = context.sb
+    text = normalize_text(text)
     sb.deferred_assert_text(text)
 
 
 @step("Deferred assert exact text '{text}' in '{selector}'")
 @step('Deferred assert exact text "{text}" in "{selector}"')
 def deferred_assert_exact_text(context, text, selector):
     sb = context.sb
+    text = normalize_text(text)
     sb.deferred_assert_exact_text(text, selector)
 
 

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "3.2.5"
+__version__ = "3.2.6"