db_sync_tool.remote.client.close_ssh_clients() - Code Metrics - Inspection of "[Task] Manual database credentials" - jackd248/db-sync-tool - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ffbe9f...5c3c8b )

by Konrad

created 2020-11-27 11:54 UTC

db_sync_tool.remote.client.close_ssh_clients() A

↳ Parent: db_sync_tool.remote.client

Complexity

Conditions

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	7
dl	0
loc	12
rs	10
c	0
b	0
f	0
cc	3
nop	0

#!/usr/bin/env python3

# -*- coding: utf-8 -*-

import sys
import paramiko
from db_sync_tool.utility import mode, system, helper, output
from db_sync_tool.remote import utility

ssh_client_origin = None

ssh_client_target = None



def load_ssh_client_origin():
    """
    Loading the origin ssh client
    :return:
    """
    global ssh_client_origin

    ssh_client_origin = load_ssh_client(mode.Client.ORIGIN)
    utility.run_before_script(mode.Client.ORIGIN)


def load_ssh_client_target():
    """
    Loading the target ssh client
    :return:
    """
    global ssh_client_target

    ssh_client_target = load_ssh_client(mode.Client.TARGET)
    utility.run_before_script(mode.Client.TARGET)


def load_ssh_client(ssh):
    """
    Initializing the given ssh client
    :param ssh: String
    :return:
    """
    _host_name = helper.get_ssh_host_name(ssh, True)
    _ssh_client = paramiko.SSHClient()
    _ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())

    _ssh_port = _ssh_port = system.config[ssh]['port'] if 'port' in system.config[ssh] else 22
    _ssh_key = None
    _ssh_password = None

    # Check authentication
    if 'ssh_key' in system.config[ssh]:
        _authentication_method = f'{output.CliFormat.BLACK} - (authentication: key){output.CliFormat.ENDC}'

        _ssh_key = system.config[ssh]['ssh_key']
    elif 'password' in system.config[ssh]:
        _authentication_method = f'{output.CliFormat.BLACK} - (authentication: password){output.CliFormat.ENDC}'

        _ssh_password = system.config[ssh]['password']
    else:
        sys.exit(
            output.message(
                output.Subject.ERROR,
                f'Missing SSH authentication. Neither ssh key nor ssh password given.',

                False
            )
        )

    # Try to connect to remote client via paramiko
    try:
        _ssh_client.connect(hostname=system.config[ssh]['host'],
                            username=system.config[ssh]['user'],
                            key_filename=_ssh_key,
                            password=_ssh_password,
                            port=_ssh_port,
                            compress=True)

    except paramiko.ssh_exception.AuthenticationException:
        sys.exit(
            output.message(
                output.Subject.ERROR,
                f'SSH authentication for {_host_name} failed',
                False
            )
        )

    output.message(
        output.host_to_subject(ssh),
        f'Initialize remote SSH connection {_host_name}{_authentication_method}',
        True
    )

    return _ssh_client


def close_ssh_clients():
    """
    Closing ssh client sessions
    :return:
    """
    utility.run_after_script(mode.Client.ORIGIN)
    if not ssh_client_origin is None:
        ssh_client_origin.close()

    utility.run_after_script(mode.Client.TARGET)
    if not ssh_client_target is None:
        ssh_client_target.close()


1			#!/usr/bin/env python3
			0 ignored issues – show introduced 2020-11-27 11:55 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2			# -- coding: utf-8 --
3
4			import sys
5			import paramiko
6			from db_sync_tool.utility import mode, system, helper, output
7			from db_sync_tool.remote import utility
8
9			ssh_client_origin = None
			0 ignored issues – show Coding Style Naming introduced 2020-11-27 11:55 UTC by Report Bug Copy Issue Report Constant name "ssh_client_origin" doesn't conform to UPPER_CASE naming style ('([^\\W\\da-z][^\\Wa-z]\|__.__)$' pattern) This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
10			ssh_client_target = None
			0 ignored issues – show Coding Style Naming introduced 2020-11-27 11:55 UTC by Report Bug Copy Issue Report Constant name "ssh_client_target" doesn't conform to UPPER_CASE naming style ('([^\\W\\da-z][^\\Wa-z]\|__.__)$' pattern) This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
11
12
13			def load_ssh_client_origin():
14			"""
15			Loading the origin ssh client
16			:return:
17			"""
18			global ssh_client_origin
			0 ignored issues – show Coding Style introduced 2020-11-21 18:36 UTC by Report Bug Copy Issue Report Usage of the `global` statement should be avoided. Usage of `global` can make code hard to read and test, its usage is generally not recommended unless you are dealing with legacy code. Loading history... Coding Style Naming introduced 2020-11-21 18:36 UTC by Report Bug Copy Issue Report Constant name "ssh_client_origin" doesn't conform to UPPER_CASE naming style ('([^\\W\\da-z][^\\Wa-z]\|__.__)$' pattern) This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
19			ssh_client_origin = load_ssh_client(mode.Client.ORIGIN)
20			utility.run_before_script(mode.Client.ORIGIN)
21
22
23			def load_ssh_client_target():
24			"""
25			Loading the target ssh client
26			:return:
27			"""
28			global ssh_client_target
			0 ignored issues – show Coding Style introduced 2020-11-21 18:36 UTC by Report Bug Copy Issue Report Usage of the `global` statement should be avoided. Usage of `global` can make code hard to read and test, its usage is generally not recommended unless you are dealing with legacy code. Loading history... Coding Style Naming introduced 2020-11-21 18:36 UTC by Report Bug Copy Issue Report Constant name "ssh_client_target" doesn't conform to UPPER_CASE naming style ('([^\\W\\da-z][^\\Wa-z]\|__.__)$' pattern) This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
29			ssh_client_target = load_ssh_client(mode.Client.TARGET)
30			utility.run_before_script(mode.Client.TARGET)
31
32
33			def load_ssh_client(ssh):
34			"""
35			Initializing the given ssh client
36			:param ssh: String
37			:return:
38			"""
39			_host_name = helper.get_ssh_host_name(ssh, True)
40			_ssh_client = paramiko.SSHClient()
41			_ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
42
43			_ssh_port = _ssh_port = system.config[ssh]['port'] if 'port' in system.config[ssh] else 22
44			_ssh_key = None
45			_ssh_password = None
46
47			# Check authentication
48			if 'ssh_key' in system.config[ssh]:
49			_authentication_method = f'{output.CliFormat.BLACK} - (authentication: key){output.CliFormat.ENDC}'
			0 ignored issues – show Coding Style introduced 2020-11-21 18:36 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (107/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
50			_ssh_key = system.config[ssh]['ssh_key']
51			elif 'password' in system.config[ssh]:
52			_authentication_method = f'{output.CliFormat.BLACK} - (authentication: password){output.CliFormat.ENDC}'
			0 ignored issues – show Coding Style introduced 2020-11-21 18:36 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (112/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
53			_ssh_password = system.config[ssh]['password']
54			else:
55			sys.exit(
56			output.message(
57			output.Subject.ERROR,
58			f'Missing SSH authentication. Neither ssh key nor ssh password given.',
			0 ignored issues – show introduced 2020-11-27 11:55 UTC by Report Bug Copy Issue Report Using an f-string that does not have any interpolated variables Loading history...
59			False
60			)
61			)
62
63			# Try to connect to remote client via paramiko
64			try:
65			_ssh_client.connect(hostname=system.config[ssh]['host'],
66			username=system.config[ssh]['user'],
67			key_filename=_ssh_key,
68			password=_ssh_password,
69			port=_ssh_port,
70			compress=True)
71
72			except paramiko.ssh_exception.AuthenticationException:
73			sys.exit(
74			output.message(
75			output.Subject.ERROR,
76			f'SSH authentication for {_host_name} failed',
77			False
78			)
79			)
80
81			output.message(
82			output.host_to_subject(ssh),
83			f'Initialize remote SSH connection {_host_name}{_authentication_method}',
84			True
85			)
86
87			return _ssh_client
88
89
90			def close_ssh_clients():
91			"""
92			Closing ssh client sessions
93			:return:
94			"""
95			utility.run_after_script(mode.Client.ORIGIN)
96			if not ssh_client_origin is None:
97			ssh_client_origin.close()
98
99			utility.run_after_script(mode.Client.TARGET)
100			if not ssh_client_target is None:
101			ssh_client_target.close()
			0 ignored issues – show Coding Style introduced 2020-11-27 11:55 UTC by Report Bug Copy Issue Report Final newline missing Loading history...

jackd248 / db-sync-tool

Push — master ( ffbe9f...5c3c8b )

db_sync_tool.remote.client.close_ssh_clients() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like