Little cleanup to VariableError tests and docs. robotframework#1869

pekkaklarck · pekkaklarck · commit a04008f317f9 · 2015-07-06T00:11:45.000+03:00
Also enhanced docs about internally used exceptions a bit in general.
diff --git a/atest/robot/running/test_template.robot b/atest/robot/running/test_template.robot
@@ -70,7 +70,10 @@ Templates and timeouts
 Templates, timeouts, and for loops
     Check Test Case  ${TESTNAME}
 
-Templates and syntax errors
+Templated test ends after syntax errors
+    Check Test Case  ${TESTNAME}
+
+Templated test continues after variable error
     Check Test Case  ${TESTNAME}
 
 Templates and fatal errors
diff --git a/atest/robot/standard_libraries/builtin/wait_until_keyword_succeeds.robot b/atest/robot/standard_libraries/builtin/wait_until_keyword_succeeds.robot
@@ -88,7 +88,8 @@ Fail With Nonexisting Variable Inside Wait Until Keyword Succeeds
 
 Pass With Initially Nonexisting Variable Inside Wait Until Keyword Succeeds
     ${tc} =    Check Test Case    ${TESTNAME}
-    Check Log Message    ${tc.kws[0].kws[0].kws[0].msgs[0]}    Variable '\${dynamically created variable}' not found.    FAIL
+    Check Log Message    ${tc.kws[0].kws[0].kws[0].msgs[0]}    Variable '\${created after accessing first time}' not found.    FAIL
+    Check Log Message    ${tc.kws[0].kws[1].kws[0].msgs[0]}    created in keyword teardown
     Length Should Be    ${tc.kws[0].kws}    2
 
 Variable Values Should Not Be Visible In Keyword Arguments
diff --git a/atest/testdata/running/test_template.robot b/atest/testdata/running/test_template.robot
@@ -168,9 +168,18 @@ Templates, timeouts, and for loops
     :FOR  ${i}  IN RANGE  10
     \    0.05 seconds
 
-Templates and syntax errors
+Templated test ends after syntax errors
     [Documentation]  FAIL Keyword 'BuiltIn.Should Be Equal' expected 2 to 4 arguments, got 5.
     syntax    error    makes    test    end
+    not compared    anymore
+
+Templated test continues after variable error
+    [Documentation]  FAIL  Several failures occurred:\n\n
+    ...  1) Variable '\${this does not exist}' not found.\n\n
+    ...  2) compared and not equal != fails
+    ${this does not exist}    ${this does not exist either}
+    compared and equal        compared and equal
+    compared and not equal    fails
 
 Templates and fatal errors 1
     [Documentation]  FAIL  Several failures occurred:\n\n
diff --git a/atest/testdata/standard_libraries/builtin/wait_until_keyword_succeeds.robot b/atest/testdata/standard_libraries/builtin/wait_until_keyword_succeeds.robot
@@ -105,12 +105,11 @@ Keyword Not Found Inside Wait Until Keyword Succeeds
     Wait Until Keyword Succeeds    1 second    0.1s    Non Existing KW
 
 Fail With Nonexisting Variable Inside Wait Until Keyword Succeeds
-    [Documentation]    FAIL  GLOB:Keyword 'Get Length Nonexisting Variable' failed after retrying 3 times. * Variable '${nonexisting}' not found.
-    Wait Until Keyword Succeeds    3 times    0s    Get Length Nonexisting Variable
+    [Documentation]    FAIL  GLOB:Keyword 'Access Nonexisting Variable' failed after retrying 3 times. * Variable '${nonexisting}' not found.
+    Wait Until Keyword Succeeds    3 times    0s    Access Nonexisting Variable
 
 Pass With Initially Nonexisting Variable Inside Wait Until Keyword Succeeds
-    Wait Until Keyword Succeeds    3 times    0s    Get Length Initially Nonexisting Variable
-
+    Wait Until Keyword Succeeds    3 times    0s    Access Initially Nonexisting Variable
 
 *** Keywords ***
 User Keyword
@@ -124,11 +123,10 @@ Timeouted UK with Wait Until KW
     [Timeout]    ${timeout}
     Wait Until Keyword Succeeds    100ms    10ms    Fail    Error in timeouted UK
 
-Get Length Nonexisting Variable
-    Get Length    ${nonexisting}
+Access Nonexisting Variable
+    Log    ${nonexisting}
     Fail    Should NEVER be executed
 
-Get Length Initially Nonexisting Variable
-    Get Length    ${dynamically created variable}
-    [Teardown]    Set Test Variable    ${dynamically created variable}    dynamic_variable_value
-
+Access Initially Nonexisting Variable
+    Log    ${created after accessing first time}
+    [Teardown]    Set Test Variable    ${created after accessing first time}    created in keyword teardown
diff --git a/src/robot/errors.py b/src/robot/errors.py
@@ -12,6 +12,12 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+"""Exceptions and return codes used internally.
+
+External libraries should not used exceptions defined here.
+"""
+
+
 # Return codes from Robot and Rebot.
 # RC below 250 is the number of failed critical tests and exactly 250
 # means that number or more such failures.
@@ -48,13 +54,13 @@ class FrameworkError(RobotError):
 class DataError(RobotError):
     """Used when the provided test data is invalid.
 
-    DataErrors are not be caught by keywords that run other keywords
-    (e.g. `Run Keyword And Expect Error`). Libraries should thus use
-    this exception with care.
+    DataErrors are not caught by keywords that run other keywords
+    (e.g. `Run Keyword And Expect Error`).
     """
 
+
 class VariableError(DataError):
-    """Used when variable syntax or evaluation is invalid.
+    """Used when variable does not exist.
 
     VariableErrors are caught by keywords that run other keywords
     (e.g. `Run Keyword And Expect Error`).
@@ -67,7 +73,7 @@ class TimeoutError(RobotError):
     This exception is handled specially so that execution of the
     current test is always stopped immediately and it is not caught by
     keywords executing other keywords (e.g. `Run Keyword And Expect
-    Error`). Libraries should thus NOT use this exception themselves.
+    Error`).
     """
 
 
