Merge pull request #1072 from RasaHQ/ATO-1661-add-endpoints-arg-to-ra…

…sa-sdk-cli

[ATO-1661] Add `--endpoints` flag to rasa-sdk cli

changelog/1072.improvement.md

@@ -0,0 +1 @@
+Add an `--endpoint` flag to the rasa_sdk CLI to enable tracing configuration.

rasa_sdk/cli/arguments.py

@@ -1,6 +1,6 @@
 import argparse
 
-from rasa_sdk.constants import DEFAULT_SERVER_PORT
+from rasa_sdk.constants import DEFAULT_SERVER_PORT, DEFAULT_ENDPOINTS_PATH
 
 
 def action_arg(action):
@@ -54,3 +54,8 @@ def add_endpoint_arguments(parser):
         help="Enable auto-reloading of modules containing Action subclasses.",
         action="store_true",
     )
+    parser.add_argument(
+        "--endpoints",
+        default=DEFAULT_ENDPOINTS_PATH,
+        help="Configuration file for the assistant as a yml file.",
+    )

rasa_sdk/constants.py

@@ -10,3 +10,4 @@
 PYTHON_LOGGING_SCHEMA_DOCS = (
     "https://docs.python.org/3/library/logging.config.html#dictionary-schema-details"
 )
+DEFAULT_ENDPOINTS_PATH = "endpoints.yml"

tests/test_arguments.py

@@ -0,0 +1,21 @@
+import rasa_sdk.endpoint as ep
+import pytest
+
+from rasa_sdk.constants import DEFAULT_ENDPOINTS_PATH
+
+
+@pytest.mark.parametrize(
+    "args, expected",
+    [
+        ([], DEFAULT_ENDPOINTS_PATH),
+        (["--endpoints", "a.yml"], "a.yml"),
+    ],
+)
+def test_arg_parser_endpoints(args, expected):
+    parser = ep.create_argument_parser()
+    cmdline_args = parser.parse_args(args)
+    assert cmdline_args.endpoints == expected
+
+    help_text = parser.format_help()
+    assert "--endpoints ENDPOINTS" in help_text
+    assert " Configuration file for the assistant as a yml file." in help_text