Use maxsplit=1, update sample config, add test.

Author: Kami

conf/st2rc.sample.ini

@@ -24,6 +24,7 @@ password = testpassword
 # Optional additional http basic auth credentials which are sent with each HTTP
 # request except the auth request to /v1/auth/tokens endpoint.
 # Available in StackStorm >= v3.4.0
+# NOTE: Username can't contain colon (:) character.
 # basic_auth = username:password
 
 [api]

st2client/st2client/client.py

@@ -131,13 +131,14 @@ def __init__(
         self.api_key = api_key
 
         if basic_auth:
-            if len(basic_auth.split(":")) != 2:
+            # NOTE: We assume username can't contain colons
+            if len(basic_auth.split(":", 1)) != 2:
                 raise ValueError(
                     "basic_auth config options needs to be in the "
                     "username:password notation"
                 )
 
-            self.basic_auth = tuple(basic_auth.split(":"))
+            self.basic_auth = tuple(basic_auth.split(":", 1))
         else:
             self.basic_auth = None
 

st2client/tests/unit/test_client.py

@@ -89,6 +89,25 @@ def test_basic_auth_option_success(self):
             "http://127.0.0.1:9101/v1/actions", auth=("username", "password"), params={}
         )
 
+    @mock.patch.object(
+        requests,
+        "get",
+        mock.MagicMock(return_value=base.FakeResponse(json.dumps({}), 200, "OK")),
+    )
+    def test_basic_auth_option_success_password_with_colon(self):
+        client = Client(basic_auth="username:password:with:colon")
+        self.assertEqual(client.basic_auth, ("username", "password:with:colon"))
+
+        self.assertEqual(requests.get.call_count, 0)
+        client.actions.get_all()
+        self.assertEqual(requests.get.call_count, 1)
+
+        requests.get.assert_called_with(
+            "http://127.0.0.1:9101/v1/actions",
+            auth=("username", "password:with:colon"),
+            params={},
+        )
+
     def test_basic_auth_option_invalid_notation(self):
         self.assertRaisesRegex(
             ValueError,