Abhi/connection properties (#126)

* Exposing more connection properties WIP 1

* fix dictionary key checks

Author: abhisheksinha89

mssqlcli/jsonrpc/contracts/connectionservice.py

@@ -85,20 +85,34 @@ class ConnectionDetails(object):
     """
 
     def __init__(self, parameters):
+        # Required params
         self.ServerName = parameters[u'ServerName']
         self.DatabaseName = parameters[u'DatabaseName']
         self.UserName = parameters[u'UserName']
         self.Password = parameters[u'Password']
         self.AuthenticationType = parameters[u'AuthenticationType']
         self.MultipleActiveResultSets = parameters[u'MultipleActiveResultSets']
+        # Optional Params
+        if u'Encrypt' in parameters:
+            self.Encrypt = parameters[u'Encrypt']
+        if u'TrustServerCertificate' in parameters:
+            self.TrustServerCertificate = parameters[u'TrustServerCertificate']
+        if u'ConnectTimeout' in parameters:
+            self.ConnectTimeout = parameters[u'ConnectTimeout']
+        if u'ApplicationIntent' in parameters:
+            self.ApplicationIntent = parameters[u'ApplicationIntent']
+        if u'MultiSubnetFailover' in parameters:
+            self.MultiSubnetFailover = parameters[u'MultiSubnetFailover']
+        if u'PacketSize' in parameters:
+            self.PacketSize = parameters[u'PacketSize']
 
     def format(self):
         return vars(self)
 
 
 class ConnectionParams(object):
     def __init__(self, parameters):
-        self.owner_uri = parameters['OwnerUri']
+        self.owner_uri = parameters[u'OwnerUri']
         self.connection_details = ConnectionDetails(parameters)
 
     def format(self):
@@ -119,9 +133,13 @@ def __init__(self, params):
         self.error_message = inner_params[u'errorMessage']
         self.error_number = inner_params[u'errorNumber']
         # server information.
-        self.is_cloud = inner_params[u'serverInfo'][u'isCloud'] if u'serverInfo' in inner_params else False
-        self.server_version = inner_params[u'serverInfo'][u'serverVersion'] if u'serverInfo' in inner_params else None
-        self.server_edition = inner_params[u'serverInfo'][u'serverEdition'] if u'serverInfo' in inner_params else None
+        if u'serverInfo' in inner_params and inner_params[u'serverInfo']:
+            self.is_cloud = inner_params[u'serverInfo'][u'isCloud'] if \
+                u'isCloud' in inner_params[u'serverInfo'] else False
+            self.server_version = inner_params[u'serverInfo'][u'serverVersion'] if \
+                u'serverVersion' in inner_params[u'serverInfo'] else None
+            self.server_edition = inner_params[u'serverInfo'][u'serverEdition'] if \
+                u'serverEdition' in inner_params[u'serverInfo'] else None
 
 
 class ConnectionResponse(object):

mssqlcli/main.py

@@ -259,7 +259,8 @@ def initialize_logging(self):
         root_logger.debug('Log file %r.', log_file)
 
     def connect(self, database='', server='', user='', port='', passwd='',
-                dsn='', **kwargs):
+                dsn='', encrypt=None, trust_server_certificate=None, connection_timeout=None, application_intent=None,
+                multi_subnet_failover=None, packet_size=None, **kwargs):
         # Connect to the database.
 
         if not user and not self.integrated_auth:
@@ -304,7 +305,13 @@ def connect(self, database='', server='', user='', port='', passwd='',
 
             self.mssqlcliclient_query_execution = MssqlCliClient(self.sqltoolsclient, server, user, passwd,
                                                                  database=database,
-                                                                 authentication_type=authentication_type, **kwargs)
+                                                                 authentication_type=authentication_type,
+                                                                 encrypt=encrypt,
+                                                                 trust_server_certificate=trust_server_certificate,
+                                                                 connection_timeout=connection_timeout,
+                                                                 application_intent=application_intent,
+                                                                 multi_subnet_failover=multi_subnet_failover,
+                                                                 packet_size=packet_size,**kwargs)
 
             if not self.mssqlcliclient_query_execution.connect():
                 click.secho(
@@ -674,9 +681,23 @@ def get_last_query(self):
               help='Skip intro on startup and goodbye on exit.')
 @click.option('--auto-vertical-output', is_flag=True,
               help='Automatically switch to vertical output mode if the result is wider than the terminal width.')
-def cli(username, server, prompt_passwd,
-        database, version, mssqlclirc, row_limit,
-        less_chatty, auto_vertical_output, integrated_auth):
+@click.option('-N', '--encrypt', is_flag=True, default=False,
+              help='SQL Server uses SSL encryption for all data if the server has a certificate installed.')
+@click.option('-C', '--trust-server-certificate', is_flag=True, default=False,
+              help='The channel will be encrypted while bypassing walking the certificate chain to validate trust.')
+@click.option('-l', '--connect-timeout', default=0, type=int,
+              help='Time in seconds to wait for a connection to the server before terminating request.')
+@click.option('-K', '--application-intent', default='',
+              help='Declares the application workload type when connecting to a database in a SQL Server Availability '
+                   'Group.')
+@click.option('-M', '--multi-subnet-failover', is_flag=True, default=False,
+              help='If application is connecting to AlwaysOn AG on different subnets, setting this provides faster '
+                   'detection and connection to currently active server.')
+@click.option('-a', '--packet-size', default=0, type=int,
+              help='Size in bytes of the network packets used to communicate with SQL Server.')
+def cli(username, server, prompt_passwd, database, version, mssqlclirc, row_limit, less_chatty, auto_vertical_output,
+        integrated_auth, encrypt, trust_server_certificate, connect_timeout, application_intent, multi_subnet_failover,
+        packet_size):
 
     if version:
         print('Version:', __version__)
@@ -695,7 +716,10 @@ def cli(username, server, prompt_passwd,
                         mssqlclirc_file=mssqlclirc, less_chatty=less_chatty, auto_vertical_output=auto_vertical_output,
                         integrated_auth=integrated_auth)
 
-    mssqlcli.connect(database, server, username, port='')
+    mssqlcli.connect(database, server, username, port='', encrypt=encrypt,
+                     trust_server_certificate=trust_server_certificate, connection_timeout=connect_timeout,
+                     application_intent=application_intent, multi_subnet_failover=multi_subnet_failover,
+                     packet_size=packet_size)
 
     mssqlcli.logger.debug('Launch Params: \n'
                           '\tdatabase: %r'

mssqlcli/mssqlcliclient.py

@@ -22,7 +22,8 @@ class MssqlCliClient(object):
 
     def __init__(self, sql_tools_client, server_name, user_name, password,
                  authentication_type=u'SqlLogin', database=u'master', owner_uri=None, multiple_active_result_sets=True,
-                 **kwargs):
+                 encrypt=None, trust_server_certificate=None, connection_timeout=None, application_intent=None,
+                 multi_subnet_failover=None, packet_size=None, **kwargs):
         self.server_name = server_name
         self.user_name = user_name
         self.password = password
@@ -31,6 +32,12 @@ def __init__(self, sql_tools_client, server_name, user_name, password,
         self.owner_uri = owner_uri
         self.is_connected = False
         self.multiple_active_result_sets = multiple_active_result_sets
+        self.encrypt = encrypt
+        self.trust_server_certificate = trust_server_certificate
+        self.connection_timeout = connection_timeout
+        self.application_intent = application_intent
+        self.multi_subnet_failover = multi_subnet_failover
+        self.packet_size = packet_size
         self.extra_params = {k: v for k, v in kwargs.items()}
         self.sql_tools_client = sql_tools_client
         self.server_version = None
@@ -51,6 +58,7 @@ def connect(self):
         if self.is_connected:
             return self.owner_uri
 
+        # Required params
         connection_params = {u'ServerName': self.server_name,
                              u'DatabaseName': self.database,
                              u'UserName': self.user_name,
@@ -59,6 +67,20 @@ def connect(self):
                              u'OwnerUri': self.owner_uri,
                              u'MultipleActiveResultSets': self.multiple_active_result_sets}
 
+        # Optional params
+        if self.encrypt:
+            connection_params[u'Encrypt'] = self.encrypt
+        if self.trust_server_certificate:
+            connection_params[u'TrustServerCertificate'] = self.trust_server_certificate
+        if self.connection_timeout:
+            connection_params[u'ConnectTimeout'] = self.connection_timeout
+        if self.application_intent:
+            connection_params[u'ApplicationIntent'] = self.application_intent
+        if self.multi_subnet_failover:
+            connection_params[u'MultiSubnetFailover'] = self.multi_subnet_failover
+        if self.packet_size:
+            connection_params[u'PacketSize'] = self.packet_size
+
         connection_params.update(self.extra_params)
 
         connection_request = self.sql_tools_client.create_request(