Add the new "--variables={}" command-line option

Author: mdmintz

seleniumbase/fixtures/base_case.py

@@ -11453,6 +11453,32 @@ def setUp(self, masterqa_mode=False):
             self.var1 = sb_config.var1
             self.var2 = sb_config.var2
             self.var3 = sb_config.var3
+            variables = sb_config.variables
+            if variables and type(variables) is str and len(variables) > 0:
+                import ast
+
+                bad_input = False
+                if (
+                    not variables.startswith("{")
+                    or not variables.endswith("}")
+                ):
+                    bad_input = True
+                else:
+                    try:
+                        variables = ast.literal_eval(variables)
+                        if not type(variables) is dict:
+                            bad_input = True
+                    except Exception:
+                        bad_input = True
+                if bad_input:
+                    raise Exception(
+                        '\nExpecting a Python dictionary for "variables"!'
+                        "\nEg. --variables=\"{'KEY1':'VALUE', 'KEY2':123}\""
+                    )
+            else:
+                variables = {}
+            sb_config.variables = variables
+            self.variables = sb_config.variables
             self.slow_mode = sb_config.slow_mode
             self.demo_mode = sb_config.demo_mode
             self.demo_sleep = sb_config.demo_sleep

seleniumbase/plugins/base_plugin.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 """ This is the Nosetest plugin for setting base configuration and logging. """
 
+import ast
 import sys
 import time
 from nose.plugins import Plugin
@@ -20,6 +21,7 @@ class Base(Plugin):
     --var1=STRING  (Extra test data. Access with "self.var1" in tests.)
     --var2=STRING  (Extra test data. Access with "self.var2" in tests.)
     --var3=STRING  (Extra test data. Access with "self.var3" in tests.)
+    --variables=DICT  (Extra test data. Access with "self.variables".)
     --settings-file=FILE  (Override default SeleniumBase settings.)
     --archive-logs  (Archive old log files instead of deleting them.)
     --archive-downloads  (Archive old downloads instead of deleting.)
@@ -86,6 +88,12 @@ def options(self, parser, env):
             default=None,
             help="Extra data to pass to tests from the command line.",
         )
+        parser.add_option(
+            "--variables",
+            dest="variables",
+            default=None,
+            help="A var dict to pass to tests from the command line.",
+        )
         parser.add_option(
             "--settings_file",
             "--settings-file",
@@ -182,13 +190,37 @@ def configure(self, options, conf):
             report_helper.clear_out_old_report_logs(archive_past_runs=False)
 
     def beforeTest(self, test):
+        variables = self.options.variables
+        if variables and type(variables) is str and len(variables) > 0:
+            bad_input = False
+            if (
+                not variables.startswith("{")
+                or not variables.endswith("}")
+            ):
+                bad_input = True
+            else:
+                try:
+                    variables = ast.literal_eval(variables)
+                    if not type(variables) is dict:
+                        bad_input = True
+                except Exception:
+                    bad_input = True
+            if bad_input:
+                raise Exception(
+                    '\nExpecting a Python dictionary for "variables"!'
+                    "\nEg. --variables=\"{'KEY1':'VALUE', 'KEY2':123}\""
+                )
+        else:
+            variables = {}
+        test.test.is_nosetest = True
         test.test.environment = self.options.environment
         test.test.env = self.options.environment  # Add a shortened version
         test.test.account = self.options.account
         test.test.data = self.options.data
         test.test.var1 = self.options.var1
         test.test.var2 = self.options.var2
         test.test.var3 = self.options.var3
+        test.test.variables = variables  # Already verified is a dictionary
         test.test.settings_file = self.options.settings_file
         test.test.log_path = self.options.log_path
         if self.options.archive_downloads:

seleniumbase/plugins/pytest_plugin.py

@@ -33,6 +33,7 @@ def pytest_addoption(parser):
     --var1=STRING  (Extra test data. Access with "self.var1" in tests.)
     --var2=STRING  (Extra test data. Access with "self.var2" in tests.)
     --var3=STRING  (Extra test data. Access with "self.var3" in tests.)
+    --variables=DICT  (Extra test data. Access with "self.variables".)
     --user-data-dir=DIR  (Set the Chrome user data directory to use.)
     --protocol=PROTOCOL  (The Selenium Grid protocol: http|https.)
     --server=SERVER  (The Selenium Grid server/IP used for tests.)
@@ -217,6 +218,12 @@ def pytest_addoption(parser):
         default=None,
         help="Extra data to pass to tests from the command line.",
     )
+    parser.addoption(
+        "--variables",
+        dest="variables",
+        default=None,
+        help="A var dict to pass to tests from the command line.",
+    )
     parser.addoption(
         "--cap_file",
         "--cap-file",
@@ -1068,6 +1075,7 @@ def pytest_configure(config):
     sb_config.var1 = config.getoption("var1")
     sb_config.var2 = config.getoption("var2")
     sb_config.var3 = config.getoption("var3")
+    sb_config.variables = config.getoption("variables")
     sb_config.environment = config.getoption("environment")
     sb_config.with_selenium = config.getoption("with_selenium")
     sb_config.user_agent = config.getoption("user_agent")