GG-32404: Add AuthenticationError (#22)

Author: isapego

pygridgain/connection/__init__.py

@@ -27,7 +27,7 @@
 
 from pygridgain.constants import *
 from pygridgain.exceptions import (
-    HandshakeError, ParameterError, SocketError, connection_errors,
+    HandshakeError, ParameterError, SocketError, connection_errors, AuthenticationError,
 )
 from pygridgain.datatypes import Byte, ByteArrayObject, Int, Short, String, UUIDObject
 from pygridgain.datatypes.internal import Struct
@@ -41,6 +41,8 @@
 
 from ..stream import BinaryStream, READ_BACKWARD
 
+CLIENT_STATUS_AUTH_FAILURE = 2000
+
 
 class Connection:
     """
@@ -204,6 +206,7 @@ def read_response(self) -> Union[dict, OrderedDict]:
                     ('version_minor', Short),
                     ('version_patch', Short),
                     ('message', String),
+                    ('client_status', Int)
                 ])
             elif self.get_protocol_version() >= (1, 7, 0):
                 response_end = Struct([
@@ -300,7 +303,7 @@ def _connect_version(
             # disconnect but keep in use
             self.close(release=False)
 
-            error_text = 'Handshake error: {}'.format(hs_response['message'])
+            error_text = f'Handshake error: {hs_response["message"]}'
             # if handshake fails for any reason other than protocol mismatch
             # (i.e. authentication error), server version is 0.0.0
             if any([
@@ -318,6 +321,8 @@ def _connect_version(
                     client_patch=protocol_version[2],
                     **hs_response
                 )
+            elif hs_response['client_status'] == CLIENT_STATUS_AUTH_FAILURE:
+                raise AuthenticationError(error_text)
             raise HandshakeError((
                 hs_response['version_major'],
                 hs_response['version_minor'],
@@ -422,7 +427,6 @@ def _recv(buffer, num_bytes):
         _recv(memoryview(data)[4:], response_len)
         return data
 
-
     def close(self, release=True):
         """
         Try to mark socket closed, then unlink it. This is recommended but

pygridgain/exceptions.py

@@ -25,6 +25,15 @@ class ParseError(Exception):
     pass
 
 
+class AuthenticationError(Exception):
+    """
+    This exception is raised on authentication failure.
+    """
+
+    def __init__(self, message: str):
+        self.message = message
+
+
 class HandshakeError(SocketError):
     """
     This exception is raised on GridGain binary protocol handshake failure,

tests/config/ignite-config.xml.jinja2

@@ -26,8 +26,18 @@
         http://www.springframework.org/schema/util/spring-util.xsd">
 
     <bean id="grid.cfg" class="org.apache.ignite.configuration.IgniteConfiguration">
-        {% if use_ssl %}
-            <property name="connectorConfiguration"><null/></property>
+        {% if enable_auth %}
+        <property name="authenticationEnabled" value="true"/>
+
+        <property name="persistentStoreConfiguration">
+            <bean class="org.apache.ignite.configuration.PersistentStoreConfiguration"/>
+        </property>
+
+        <property name="connectorConfiguration">
+            <bean class="org.apache.ignite.configuration.ConnectorConfiguration">
+                <property name="port" value="{{ connector_port }}"/>
+            </bean>
+        </property>
         {% endif %}
 
         <property name="clientConnectorConfiguration">

tests/conftest.py

@@ -82,8 +82,15 @@ def server3(request):
 
 @pytest.fixture(scope='module')
 def start_ignite_server(use_ssl):
-    def start(idx=1, cluster_idx=1, jvm_opts=''):
-        return _start_ignite(idx, use_ssl=use_ssl, cluster_idx=cluster_idx, jvm_opts=jvm_opts)
+    def start(idx=1, debug=False, enable_auth=False, cluster_idx=1, jvm_opts=''):
+        return _start_ignite(
+            idx=idx,
+            debug=debug,
+            use_ssl=use_ssl,
+            enable_auth=enable_auth,
+            cluster_idx=cluster_idx,
+            jvm_opts=jvm_opts
+        )
 
     return start
 
@@ -136,10 +143,9 @@ def cache(client):
 
 @pytest.fixture(scope='module')
 def start_client(use_ssl, ssl_keyfile, ssl_keyfile_password, ssl_certfile, ssl_ca_certfile, ssl_cert_reqs, ssl_ciphers,
-                 ssl_version,username, password):
+                 ssl_version, username, password):
     def start(**kwargs):
-        cli_kw = kwargs.copy()
-        cli_kw.update({
+        cli_kw = {
             'use_ssl': use_ssl,
             'ssl_keyfile': ssl_keyfile,
             'ssl_keyfile_password': ssl_keyfile_password,
@@ -150,7 +156,8 @@ def start(**kwargs):
             'ssl_version': ssl_version,
             'username': username,
             'password': password
-        })
+        }
+        cli_kw.update(kwargs.copy())
         return Client(**cli_kw)
 
     return start

tests/test_connection.py

@@ -0,0 +1,45 @@
+#
+# Copyright 2019 GridGain Systems, Inc. and Contributors.
+#
+# Licensed under the GridGain Community Edition License (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.gridgain.com/products/software/community-edition/gridgain-community-edition-license
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import pytest
+
+from pygridgain.exceptions import AuthenticationError
+from tests.util import kill_process_tree, clear_workdir
+
+
+def test_auth_success(start_ignite_server, start_client):
+    clear_workdir()
+
+    server_id = 10
+    server = start_ignite_server(idx=server_id, cluster_idx=2, enable_auth=True)
+    try:
+        client = start_client(username='ignite', password='ignite')
+        client.connect('127.0.0.1', 10800 + server_id)
+    finally:
+        kill_process_tree(server.pid)
+
+
+def test_auth_failure(start_ignite_server, start_client):
+    clear_workdir()
+
+    server_id = 10
+    server = start_ignite_server(idx=server_id, cluster_idx=2, enable_auth=True, debug=True)
+    try:
+        client = start_client(username='incorrect-user-name', password='incorrect-password')
+        with pytest.raises(AuthenticationError) as auth_error:
+            client.connect('127.0.0.1', 10800 + server_id)
+            assert auth_error.match('Handshake error: The user name or password is incorrect')
+    finally:
+        kill_process_tree(server.pid)

tests/util.py

@@ -16,6 +16,7 @@
 
 import glob
 import os
+import shutil
 
 import jinja2 as jinja2
 import psutil
@@ -113,7 +114,7 @@ def create_config_file(tpl_name, file_name, **kwargs):
         f.write(template.render(**kwargs))
 
 
-def _start_ignite(idx=1, debug=False, use_ssl=False, cluster_idx=1, jvm_opts=''):
+def _start_ignite(idx=1, debug=False, use_ssl=False, enable_auth=False, cluster_idx=1, jvm_opts=''):
     clear_logs(idx)
 
     runner = get_ignite_runner()
@@ -123,19 +124,21 @@ def _start_ignite(idx=1, debug=False, use_ssl=False, cluster_idx=1, jvm_opts='')
     if debug:
         env["JVM_OPTS"] = env.get("JVM_OPTS", '') + \
                           "-Djava.net.preferIPv4Stack=true -Xdebug -Xnoagent -Djava.compiler=NONE " \
-                          "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address={5005} "
+                          "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 "
 
     if jvm_opts:
         env["JVM_OPTS"] = env.get("JVM_OPTS", '') + jvm_opts
 
     port_offset = (cluster_idx - 1) * 10
     params = {
-        'ignite_instance_idx': str(idx),
+        'ignite_instance_idx': idx,
         'ignite_client_port': 10800 + idx,
         'use_ssl': use_ssl,
+        'enable_auth': enable_auth,
         'discovery_port': 48500 + port_offset,
         'discovery_port_range': 48510 + port_offset,
         'communication_port': 48100 + port_offset,
+        'connector_port': 10080 + idx,
     }
 
     create_config_file('log4j.xml.jinja2', f'log4j-{idx}.xml', **params)
@@ -146,7 +149,7 @@ def _start_ignite(idx=1, debug=False, use_ssl=False, cluster_idx=1, jvm_opts='')
 
     srv = subprocess.Popen(ignite_cmd, env=env, cwd=get_test_dir())
 
-    started = wait_for_condition(lambda: check_server_started(idx), timeout=30)
+    started = wait_for_condition(lambda: check_server_started(idx), timeout=60)
     if started:
         return srv
 
@@ -168,3 +171,10 @@ def get_log_files(idx=1):
 def clear_logs(idx=1):
     for f in get_log_files(idx):
         os.remove(f)
+
+
+def clear_workdir():
+    for path in get_ignite_dirs():
+        work_dir = os.path.join(path, 'work')
+        if os.path.exists(work_dir):
+            shutil.rmtree(work_dir, ignore_errors=True)