Add rest support to new parser

yanne · yanne · commit 33972447bbb7 · 2019-09-03T07:29:37.000+03:00
diff --git a/atest/robot/parsing/data_formats/formats_resource.robot b/atest/robot/parsing/data_formats/formats_resource.robot
@@ -6,7 +6,7 @@ ${FORMATS DIR}     ${DATA DIR}/parsing/data_formats
 ${TSV DIR}         ${FORMATS DIR}/tsv
 ${TXT DIR}         ${FORMATS DIR}/txt
 ${ROBOT DIR}       ${FORMATS DIR}/robot
-${REST DIR}        ${FORMATS DIR}/rest_directives
+${REST DIR}        ${FORMATS DIR}/rest
 ${MIXED DIR}       ${FORMATS DIR}/mixed_data
 ${RESOURCE DIR}    ${FORMATS DIR}/resources
 @{SAMPLE TESTS}    Passing    Failing    User Keyword    Nön-äscïï    Own Tags    Default Tags    Variable Table
@@ -63,13 +63,3 @@ Check Suite With Init
     Should Be Equal    ${suite.teardown}    ${None}
     Should Contain Suites    ${suite}    Sub Suite1    Sub Suite2
     Should Contain Tests    ${suite}    @{SUBSUITE_TESTS}
-
-*** Keywords ***
-Check Automatic Parsing Deprecated Message
-    [Arguments]    ${index}    ${path}
-    ${path} =    Normalize Path    ${path}
-    ${msg} =    Catenate
-    ...    Automatically parsing other than '*.robot' files is deprecated.
-    ...    Convert '${path}' to '*.robot' format or use '--extension' to
-    ...    explicitly configure which files to parse.
-    Check Log Message    @{ERRORS}[${index}]    ${msg}    WARN
diff --git a/atest/robot/parsing/data_formats/rest.robot b/atest/robot/parsing/data_formats/rest.robot
@@ -10,14 +10,9 @@ ReST With reST Resource
     Previous Run Should Have Been Successful
     Check Test Case    Resource File
 
-Parsing reST files automatically is deprecated
-    Previous Run Should Have Been Successful
-    Check Automatic Parsing Deprecated Message    0    ${RESTDIR}/sample.rst
-    Length should be    ${ERRORS}    1
-
-Using --extension avoids deprecation warning
-    Run sample file and check tests    --extension rst    ${RESTDIR}/sample.rst
-    Length should be    ${ERRORS}    0
-
 ReST Directory
     Run Suite Dir And Check Results    ${EMPTY}    ${RESTDIR}
+
+Directory With reST Init
+    Previous Run Should Have Been Successful
+    Check Suite With Init    ${SUITE.suites[1]}
diff --git a/atest/testdata/parsing/data_formats/rest/empty.rest b/atest/testdata/parsing/data_formats/rest/empty.rest
diff --git a/atest/testdata/parsing/data_formats/rest/include.rst b/atest/testdata/parsing/data_formats/rest/include.rst
diff --git a/atest/testdata/parsing/data_formats/rest/invalid.rest b/atest/testdata/parsing/data_formats/rest/invalid.rest
diff --git a/atest/testdata/parsing/data_formats/rest/not_a_picture.jpg b/atest/testdata/parsing/data_formats/rest/not_a_picture.jpg
@@ -0,0 +1 @@
+This is not really a picture, but this should be ignored in parsing.
diff --git a/atest/testdata/parsing/data_formats/rest/sample.rst b/atest/testdata/parsing/data_formats/rest/sample.rst
@@ -1,4 +1,4 @@
-.. include:: ../rest/empty.rest
+.. include:: empty.rest
 .. include:: include.rst
 
 ReST Test Data Example
diff --git a/atest/testdata/parsing/data_formats/rest/with_init/__init__.rst b/atest/testdata/parsing/data_formats/rest/with_init/__init__.rst
@@ -0,0 +1,11 @@
+.. code:: robotframework
+
+  ** Settings **
+  Suite Setup     Suite Setup
+  Documentation   Testing suite init file
+
+  ** Variables **
+  ${msg} =  Running suite setup
+
+  ** Keywords **
+  Suite Setup      Log      ${msg}     # No more arguments!
diff --git a/atest/testdata/parsing/data_formats/rest/with_init/sub_suite1.rst b/atest/testdata/parsing/data_formats/rest/with_init/sub_suite1.rst
@@ -0,0 +1,5 @@
+.. code:: robotframework
+
+  *Test Case*     Whatever
+  Suite1 Test                                   No Operation
+
diff --git a/atest/testdata/parsing/data_formats/rest/with_init/sub_suite2.rst b/atest/testdata/parsing/data_formats/rest/with_init/sub_suite2.rst
@@ -0,0 +1,9 @@
+.. code:: robotframework
+
+    ********************* Test Cases* ***************************************
+    |  Suite2 Test  |  [Documentation] |  FAIL    |  Expected failure  |
+    |               |  Fail            |  ${msg}  |                    |
+    |               |                  |          |  |  |  |  |  |  |  |
+
+    ********************* Variables *****************************************
+    |  ${msg}  |  Expected failure  |
diff --git a/src/robot/parsing/lexerwrapper.py b/src/robot/parsing/lexerwrapper.py
@@ -19,6 +19,8 @@
 from robot.output import LOGGER
 from robot.utils import Utf8Reader, get_error_message
 
+from .restreader import read_rest
+
 
 PROCESS_CURDIR = True
 
@@ -35,7 +37,10 @@ def _read(self, path):
         try:
             # IronPython handles BOM incorrectly if not using binary mode:
             # https://ironpython.codeplex.com/workitem/34655
-            return Utf8Reader(open(path, 'rb')).read()
+            with open(path, 'rb') as data:
+                if os.path.splitext(path)[1].lower() in ('.rest', '.rst'):
+                    return read_rest(data)
+                return Utf8Reader(data).read()
         except:
             raise DataError(get_error_message())
 
diff --git a/src/robot/parsing/restreader.py b/src/robot/parsing/restreader.py
@@ -13,40 +13,16 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-from io import BytesIO
 
-from .htmlreader import HtmlReader
-from .robotreader import RobotReader
+def read_rest(rstfile):
+    from .restsupport import publish_doctree, RobotDataStorage
 
+    doctree = publish_doctree(
+        rstfile.read(), source_path=rstfile.name,
+        settings_overrides={
+            'input_encoding': 'UTF-8',
+            'report_level': 4
+        })
+    store = RobotDataStorage(doctree)
+    return store.get_data()
 
-def RestReader():
-    from .restsupport import (publish_doctree, publish_from_doctree,
-                              RobotDataStorage)
-
-    class RestReader(object):
-
-        def read(self, rstfile, rawdata):
-            doctree = publish_doctree(
-                rstfile.read(), source_path=rstfile.name,
-                settings_overrides={
-                    'input_encoding': 'UTF-8',
-                    'report_level': 4
-                })
-            store = RobotDataStorage(doctree)
-            if store.has_data():
-                return self._read_text(store.get_data(), rawdata, rstfile.name)
-            return self._read_html(doctree, rawdata, rstfile.name)
-
-        def _read_text(self, data, rawdata, path):
-            robotfile = BytesIO(data.encode('UTF-8'))
-            return RobotReader().read(robotfile, rawdata, path)
-
-        def _read_html(self, doctree, rawdata, path):
-            htmlfile = BytesIO()
-            htmlfile.write(publish_from_doctree(
-                doctree, writer_name='html',
-                settings_overrides={'output_encoding': 'UTF-8'}))
-            htmlfile.seek(0)
-            return HtmlReader().read(htmlfile, rawdata, path)
-
-    return RestReader()
diff --git a/src/robot/parsing/restsupport.py b/src/robot/parsing/restsupport.py
@@ -16,7 +16,7 @@
 from robot.errors import DataError
 
 try:
-    from docutils.core import publish_doctree, publish_from_doctree
+    from docutils.core import publish_doctree
     from docutils.parsers.rst.directives import register_directive
     from docutils.parsers.rst.directives.body import CodeBlock
 except ImportError:

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-.. include:: ../rest/empty.rest`
	`1`	`+.. include:: empty.rest`
`2`	`2`	`.. include:: include.rst`
`3`	`3`
`4`	`4`	`ReST Test Data Example`