feat: support for new --parseinclude option in robot config

d-biehl · d-biehl · commit 6b84986e7109 · 2023-06-05T21:34:27.000+02:00
diff --git a/etc/robot.toml.json b/etc/robot.toml.json
@@ -373,6 +373,25 @@
             "null"
           ]
         },
+        "extra-parse-include": {
+          "default": null,
+          "description": "Appends entries to the --parseinclude option.\n\nParse only files matching `pattern`. It can be:\n- a file name or pattern like `example.robot` or\n`*.robot` to parse all files matching that name,\n- a file path like `path/to/example.robot`, or\n- a directory path like `path/to/example` to parse\nall files in that directory, recursively.\n\ncorresponds to the `-I --parseinclude pattern *` option of _robot_\n",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/StringExpression"
+              }
+            ]
+          },
+          "title": "Extra parse include",
+          "type": [
+            "array",
+            "null"
+          ]
+        },
         "extra-pre-rebot-modifiers": {
           "additionalProperties": {
             "items": {
@@ -823,6 +842,25 @@
           "description": "Where to create output files. The default is the\ndirectory where tests are run from and the given path\nis considered relative to that unless it is absolute.\n\ncorresponds to the `-d --outputdir dir` option of _robot_\n",
           "title": "Output dir"
         },
+        "parse-include": {
+          "default": null,
+          "description": "Parse only files matching `pattern`. It can be:\n- a file name or pattern like `example.robot` or\n`*.robot` to parse all files matching that name,\n- a file path like `path/to/example.robot`, or\n- a directory path like `path/to/example` to parse\nall files in that directory, recursively.\n\ncorresponds to the `-I --parseinclude pattern *` option of _robot_\n",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/StringExpression"
+              }
+            ]
+          },
+          "title": "Parse include",
+          "type": [
+            "array",
+            "null"
+          ]
+        },
         "pre-rebot-modifiers": {
           "additionalProperties": {
             "items": {
@@ -1689,6 +1727,25 @@
             "null"
           ]
         },
+        "extra-parse-include": {
+          "default": null,
+          "description": "Appends entries to the --parseinclude option.\n\nParse only files matching `pattern`. It can be:\n- a file name or pattern like `example.robot` or\n`*.robot` to parse all files matching that name,\n- a file path like `path/to/example.robot`, or\n- a directory path like `path/to/example` to parse\nall files in that directory, recursively.\n\ncorresponds to the `-I --parseinclude pattern *` option of _robot_\n",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/StringExpression"
+              }
+            ]
+          },
+          "title": "Extra parse include",
+          "type": [
+            "array",
+            "null"
+          ]
+        },
         "extra-parsers": {
           "additionalProperties": {
             "items": {
@@ -2077,7 +2134,7 @@
             ]
           },
           "default": null,
-          "description": "Appends entries to the --variable option.\n\nSet variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`. See --variablefile for a more\npowerful variable setting mechanism.\n\nExamples:\n\n```\n--variable str:Hello       =>  ${str} = `Hello`\n-v hi:Hi_World -E space:_  =>  ${hi} = `Hi World`\n-v x: -v y:42              =>  ${x} = ``, ${y} = `42`\n```\n\ncorresponds to the `-v --variable name:value *` option of _rebot_\n",
+          "description": "Appends entries to the --variable option.\n\nSet variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`. See --variablefile for a more\npowerful variable setting mechanism.\n\nExamples:\n\n```\n--variable name:Robot  =>  ${name} = `Robot`\n-v \"hello:Hello world\" =>  ${hello} = `Hello world`\n-v x: -v y:42          =>  ${x} = ``, ${y} = `42`\n```\n\ncorresponds to the `-v --variable name:value *` option of _rebot_\n",
           "title": "Extra variables",
           "type": [
             "object",
@@ -2339,6 +2396,25 @@
           "description": "Where to create output files. The default is the\ndirectory where tests are run from and the given path\nis considered relative to that unless it is absolute.\n\ncorresponds to the `-d --outputdir dir` option of _robot_\n",
           "title": "Output dir"
         },
+        "parse-include": {
+          "default": null,
+          "description": "Parse only files matching `pattern`. It can be:\n- a file name or pattern like `example.robot` or\n`*.robot` to parse all files matching that name,\n- a file path like `path/to/example.robot`, or\n- a directory path like `path/to/example` to parse\nall files in that directory, recursively.\n\ncorresponds to the `-I --parseinclude pattern *` option of _robot_\n",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/StringExpression"
+              }
+            ]
+          },
+          "title": "Parse include",
+          "type": [
+            "array",
+            "null"
+          ]
+        },
         "parsers": {
           "additionalProperties": {
             "items": {
@@ -2993,7 +3069,7 @@
             ]
           },
           "default": null,
-          "description": "Set variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`. See --variablefile for a more\npowerful variable setting mechanism.\n\nExamples:\n\n```\n--variable str:Hello       =>  ${str} = `Hello`\n-v hi:Hi_World -E space:_  =>  ${hi} = `Hi World`\n-v x: -v y:42              =>  ${x} = ``, ${y} = `42`\n```\n\ncorresponds to the `-v --variable name:value *` option of _robot_\n",
+          "description": "Set variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`. See --variablefile for a more\npowerful variable setting mechanism.\n\nExamples:\n\n```\n--variable name:Robot  =>  ${name} = `Robot`\n-v \"hello:Hello world\" =>  ${hello} = `Hello world`\n-v x: -v y:42          =>  ${x} = ``, ${y} = `42`\n```\n\ncorresponds to the `-v --variable name:value *` option of _robot_\n",
           "title": "Variables",
           "type": [
             "object",
@@ -3479,6 +3555,25 @@
             "null"
           ]
         },
+        "extra-parse-include": {
+          "default": null,
+          "description": "Appends entries to the --parseinclude option.\n\nParse only files matching `pattern`. It can be:\n- a file name or pattern like `example.robot` or\n`*.robot` to parse all files matching that name,\n- a file path like `path/to/example.robot`, or\n- a directory path like `path/to/example` to parse\nall files in that directory, recursively.\n\ncorresponds to the `-I --parseinclude pattern *` option of _robot_\n",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/StringExpression"
+              }
+            ]
+          },
+          "title": "Extra parse include",
+          "type": [
+            "array",
+            "null"
+          ]
+        },
         "extra-parsers": {
           "additionalProperties": {
             "items": {
@@ -3856,7 +3951,7 @@
             ]
           },
           "default": null,
-          "description": "Appends entries to the --variable option.\n\nSet variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`. See --variablefile for a more\npowerful variable setting mechanism.\n\nExamples:\n\n```\n--variable str:Hello       =>  ${str} = `Hello`\n-v hi:Hi_World -E space:_  =>  ${hi} = `Hi World`\n-v x: -v y:42              =>  ${x} = ``, ${y} = `42`\n```\n\ncorresponds to the `-v --variable name:value *` option of _rebot_\n",
+          "description": "Appends entries to the --variable option.\n\nSet variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`. See --variablefile for a more\npowerful variable setting mechanism.\n\nExamples:\n\n```\n--variable name:Robot  =>  ${name} = `Robot`\n-v \"hello:Hello world\" =>  ${hello} = `Hello world`\n-v x: -v y:42          =>  ${x} = ``, ${y} = `42`\n```\n\ncorresponds to the `-v --variable name:value *` option of _rebot_\n",
           "title": "Extra variables",
           "type": [
             "object",
@@ -4118,6 +4213,25 @@
           "description": "Where to create output files. The default is the\ndirectory where tests are run from and the given path\nis considered relative to that unless it is absolute.\n\ncorresponds to the `-d --outputdir dir` option of _robot_\n",
           "title": "Output dir"
         },
+        "parse-include": {
+          "default": null,
+          "description": "Parse only files matching `pattern`. It can be:\n- a file name or pattern like `example.robot` or\n`*.robot` to parse all files matching that name,\n- a file path like `path/to/example.robot`, or\n- a directory path like `path/to/example` to parse\nall files in that directory, recursively.\n\ncorresponds to the `-I --parseinclude pattern *` option of _robot_\n",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/StringExpression"
+              }
+            ]
+          },
+          "title": "Parse include",
+          "type": [
+            "array",
+            "null"
+          ]
+        },
         "parsers": {
           "additionalProperties": {
             "items": {
@@ -4765,7 +4879,7 @@
             ]
           },
           "default": null,
-          "description": "Set variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`. See --variablefile for a more\npowerful variable setting mechanism.\n\nExamples:\n\n```\n--variable str:Hello       =>  ${str} = `Hello`\n-v hi:Hi_World -E space:_  =>  ${hi} = `Hi World`\n-v x: -v y:42              =>  ${x} = ``, ${y} = `42`\n```\n\ncorresponds to the `-v --variable name:value *` option of _robot_\n",
+          "description": "Set variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`. See --variablefile for a more\npowerful variable setting mechanism.\n\nExamples:\n\n```\n--variable name:Robot  =>  ${name} = `Robot`\n-v \"hello:Hello world\" =>  ${hello} = `Hello world`\n-v x: -v y:42          =>  ${x} = ``, ${y} = `42`\n```\n\ncorresponds to the `-v --variable name:value *` option of _robot_\n",
           "title": "Variables",
           "type": [
             "object",
diff --git a/hatch.toml b/hatch.toml
@@ -39,6 +39,7 @@ test = "pytest {args}"
 test-reset = "test --regtest-reset"
 install-bundled-editable = "python ./scripts/install_bundled_editable.py"
 create-json-schema = "python ./scripts/create_robot_toml_json_schema.py"
+generate-rf-options = "python ./scripts/generate_rf_options.py"
 install-packages = "python ./scripts/install_packages.py"
 
 [envs.rfmaster]
@@ -53,6 +54,10 @@ extra-dependencies=[
   "robotframework @ git+https://github.com/robotframework/robotframework.git"
 ]
 
+[envs.rfdevel]
+python = "3.11"
+post-install-commands = ["pip install -U -e {root:uri}/../robotframework"]
+
 [envs.devel]
 python = "3.8"
 
diff --git a/packages/robot/src/robotcode/robot/config/model.py b/packages/robot/src/robotcode/robot/config/model.py
@@ -537,6 +537,21 @@ class CommonOptions(BaseOptions):
         robot_priority=500,
         robot_short_name="d",
     )
+    parse_include: Optional[List[Union[str, StringExpression]]] = field(
+        description="""\
+            Parse only files matching `pattern`. It can be:
+            - a file name or pattern like `example.robot` or
+            `*.robot` to parse all files matching that name,
+            - a file path like `path/to/example.robot`, or
+            - a directory path like `path/to/example` to parse
+            all files in that directory, recursively.
+
+            corresponds to the `-I --parseinclude pattern *` option of _robot_
+            """,
+        robot_name="parseinclude",
+        robot_priority=500,
+        robot_short_name="I",
+    )
     pre_rebot_modifiers: Optional[Dict[str, List[Union[str, StringExpression]]]] = field(
         description="""\
             Class to programmatically modify the result
@@ -941,6 +956,20 @@ class CommonExtraOptions(BaseOptions):
             corresponds to the `-M --metadata name:value *` option of _robot_
             """,
     )
+    extra_parse_include: Optional[List[Union[str, StringExpression]]] = field(
+        description="""\
+            Appends entries to the --parseinclude option.
+
+            Parse only files matching `pattern`. It can be:
+            - a file name or pattern like `example.robot` or
+            `*.robot` to parse all files matching that name,
+            - a file path like `path/to/example.robot`, or
+            - a directory path like `path/to/example` to parse
+            all files in that directory, recursively.
+
+            corresponds to the `-I --parseinclude pattern *` option of _robot_
+            """,
+    )
     extra_pre_rebot_modifiers: Optional[Dict[str, List[Union[str, StringExpression]]]] = field(
         description="""\
             Appends entries to the --prerebotmodifier option.
@@ -1488,9 +1517,9 @@ class RobotOptions(BaseOptions):
             Examples:
 
             ```
-            --variable str:Hello       =>  ${str} = `Hello`
-            -v hi:Hi_World -E space:_  =>  ${hi} = `Hi World`
-            -v x: -v y:42              =>  ${x} = ``, ${y} = `42`
+            --variable name:Robot  =>  ${name} = `Robot`
+            -v "hello:Hello world" =>  ${hello} = `Hello world`
+            -v x: -v y:42          =>  ${x} = ``, ${y} = `42`
             ```
 
             corresponds to the `-v --variable name:value *` option of _robot_
@@ -1607,9 +1636,9 @@ class RobotExtraOptions(BaseOptions):
             Examples:
 
             ```
-            --variable str:Hello       =>  ${str} = `Hello`
-            -v hi:Hi_World -E space:_  =>  ${hi} = `Hi World`
-            -v x: -v y:42              =>  ${x} = ``, ${y} = `42`
+            --variable name:Robot  =>  ${name} = `Robot`
+            -v "hello:Hello world" =>  ${hello} = `Hello world`
+            -v x: -v y:42          =>  ${x} = ``, ${y} = `42`
             ```
 
             corresponds to the `-v --variable name:value *` option of _rebot_
diff --git a/packages/runner/src/robotcode/runner/cli/discover/discover.py b/packages/runner/src/robotcode/runner/cli/discover/discover.py
@@ -344,11 +344,11 @@ def handle_options(
             if settings.pythonpath:
                 sys.path = settings.pythonpath + sys.path
 
-        if get_robot_version() > (6, 1, 0, "a", 1, None):
+        if get_robot_version() > (6, 1, 0):
             builder = TestSuiteBuilder(
-                settings["SuiteNames"],
-                custom_parsers=settings.parsers,
                 included_extensions=settings.extension,
+                included_files=settings.parse_include,
+                custom_parsers=settings.parsers,
                 rpa=settings.rpa,
                 lang=settings.languages,
                 allow_empty_suite=settings.run_empty_suite,
diff --git a/packages/runner/src/robotcode/runner/cli/robot.py b/packages/runner/src/robotcode/runner/cli/robot.py
@@ -151,6 +151,8 @@ def robot(
     The options and arguments are passed to `robot` as is.
 
     Examples:
+
+    \b
     ```
     robotcode run
     ```
