Support '.yml' extension w/ YAML variable files. Fixes robotframework#3195.

pekkaklarck · pekkaklarck · commit e657d03689a4 · 2019-08-22T00:04:49.000+03:00
diff --git a/atest/robot/variables/yaml_variable_file.robot b/atest/robot/variables/yaml_variable_file.robot
@@ -1,5 +1,6 @@
 *** Settings ***
-Suite Setup      Run Tests    --variablefile ${VARDIR}/cli.yaml --pythonpath ${VARDIR}    variables/yaml_variable_file.robot
+Suite Setup      Run Tests    --variablefile ${VARDIR}/cli.yaml -V ${VARDIR}/cli.YML --pythonpath ${VARDIR}
+...              variables/yaml_variable_file.robot
 Force Tags       require-yaml
 Resource         atest_resource.robot
 
@@ -10,6 +11,9 @@ ${VARDIR}        ${DATADIR}/../testresources/res_and_var_files
 Valid YAML file
     Check Test Case    ${TESTNAME}
 
+Valid YML file
+    Check Test Case    ${TESTNAME}
+
 Non-ASCII strings
     [Tags]    no-ipy
     Check Test Case    ${TESTNAME}
diff --git a/atest/testdata/variables/valid.yml b/atest/testdata/variables/valid.yml
@@ -0,0 +1,11 @@
+string in yml:   Hello, YML!
+integer in yml:  42
+float in yml:    3.14
+list in yml:
+- one
+- 2
+dict in yml:
+  a: '1'
+  b: 2
+  3: [one, 2]
+  key with spaces: value with spaces
diff --git a/atest/testdata/variables/yaml_variable_file.robot b/atest/testdata/variables/yaml_variable_file.robot
@@ -1,5 +1,6 @@
 *** Settings ***
 Variables        valid.yaml
+Variables        valid.yml
 Variables        pythonpath.yaml
 Variables        ./invalid.YAML
 Variables        ..${/}variables${/}non_dict.yaml
@@ -20,6 +21,13 @@ Valid YAML file
     ${LIST}       ${EXPECTED LIST}
     ${DICT}       ${EXPECTED DICT}
 
+Valid YML file
+    ${STRING IN YML}     Hello, YML!
+    ${INTEGER IN YML}    ${42}
+    ${FLOAT IN YML}      ${3.14}
+    ${LIST IN YML}       ${EXPECTED LIST}
+    ${DICT IN YML}       ${EXPECTED DICT}
+
 Non-ASCII strings
     ${NON}    äscii
     ${NÖN}    äscii
@@ -40,3 +48,4 @@ Import Variables keyword
 
 YAML file from CLI
     ${YAML FILE FROM CLI}    woot!
+    ${YML FILE FROM CLI}     kewl!
diff --git a/atest/testresources/res_and_var_files/cli.YML b/atest/testresources/res_and_var_files/cli.YML
@@ -0,0 +1 @@
+yml file from cli: kewl!
diff --git a/doc/userguide/src/CreatingTestData/ResourceAndVariableFiles.rst b/doc/userguide/src/CreatingTestData/ResourceAndVariableFiles.rst
@@ -576,15 +576,14 @@ The following example demonstrates a simple YAML file:
           pip_ installed, you can install it simply by running
           `pip install pyyaml`.
 
-          YAML support is new in Robot Framework 2.9. Starting from
-          version 2.9.2, the `standalone JAR distribution`_ has
-          PyYAML included by default.
+          YAML variable files must have either :file:`.yaml` or :file:`.yml`
+          extension. Support for the :file:`.yml` extension is new in
+          Robot Framework 3.2.
 
 YAML variable files can be used exactly like normal variable files
 from the command line using :option:`--variablefile` option, in the settings
 table using :setting:`Variables` setting, and dynamically using the
-:name:`Import Variables` keyword. The only thing to remember is that paths to
-YAML files must always end with :file:`.yaml` extension.
+:name:`Import Variables` keyword.
 
 If the above YAML file is imported, it will create exactly the same
 variables as the following variable table:
@@ -609,5 +608,5 @@ Most importantly, values of these dictionaries are accessible as attributes
 like `${DICT.one}`, assuming their names are valid as Python attribute names.
 If the name contains spaces or is otherwise not a valid attribute name, it is
 always possible to access dictionary values using syntax like
-`&{DICT}[with spaces]` syntax. The created dictionaries are also ordered, but
+`${DICT}[with spaces]` syntax. The created dictionaries are also ordered, but
 unfortunately the original source order of in the YAML file is not preserved.
diff --git a/src/robot/variables/filesetter.py b/src/robot/variables/filesetter.py
@@ -41,7 +41,7 @@ def _import_if_needed(self, path_or_variables, args=None):
             return path_or_variables
         LOGGER.info("Importing variable file '%s' with args %s"
                     % (path_or_variables, args))
-        if path_or_variables.lower().endswith('.yaml'):
+        if path_or_variables.lower().endswith(('.yaml', '.yml')):
             importer = YamlImporter()
         else:
             importer = PythonImporter()
