generated from ansible-collections/collection_template
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactoring the code and adding units tests (#30)
* Refactoring the code and adding units tests * Fixing the python version for units tests
- Loading branch information
1 parent
864ae83
commit d9c0343
Showing
9 changed files
with
221 additions
and
232 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| # This code is part of Ansible, but is an independent component. | ||
| # This particular file snippet, and this file snippet only, is BSD licensed. | ||
| # Modules you write using this snippet, which is embedded dynamically by Ansible | ||
| # still belong to the author of the module, and may assign their own license | ||
| # to the complete work. | ||
| # | ||
| # Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause) | ||
|
|
||
| from __future__ import absolute_import, division, print_function | ||
|
|
||
| __metaclass__ = type | ||
|
|
||
| from ansible.module_utils.basic import missing_required_lib | ||
| from ansible.module_utils._text import to_native | ||
|
|
||
| Client = None | ||
| try: | ||
| from clickhouse_driver import Client | ||
| from clickhouse_driver import __version__ as driver_version | ||
| HAS_DB_DRIVER = True | ||
| except ImportError: | ||
| HAS_DB_DRIVER = False | ||
|
|
||
| PRIV_ERR_CODE = 497 | ||
|
|
||
|
|
||
| def client_common_argument_spec(): | ||
| """ | ||
| Return a dictionary with connection options. | ||
| The options are commonly used by many modules. | ||
| """ | ||
| return dict( | ||
| login_host=dict(type='str', default='localhost'), | ||
| login_port=dict(type='int', default=None), | ||
| login_db=dict(type='str', default=None), | ||
| login_user=dict(type='str', default=None), | ||
| login_password=dict(type='str', default=None, no_log=True), | ||
| client_kwargs=dict(type='dict', default={}), | ||
| ) | ||
|
|
||
|
|
||
| def get_main_conn_kwargs(module): | ||
| """Retrieves main connection arguments values and translates | ||
| them into corresponding clickhouse_driver.Client() arguments. | ||
| Returns a dictionary of arguments with values to pass to Client(). | ||
| """ | ||
| main_conn_kwargs = {} | ||
| main_conn_kwargs['host'] = module.params['login_host'] # Has a default value | ||
| if module.params['login_port']: | ||
| main_conn_kwargs['port'] = module.params['login_port'] | ||
| if module.params['login_db']: | ||
| main_conn_kwargs['database'] = module.params['login_db'] | ||
| if module.params['login_user']: | ||
| main_conn_kwargs['user'] = module.params['login_user'] | ||
| if module.params['login_password']: | ||
| main_conn_kwargs['password'] = module.params['login_password'] | ||
| return main_conn_kwargs | ||
|
|
||
|
|
||
| def check_clickhouse_driver(module): | ||
| """Checks if the driver is present. | ||
| Informs user if no driver and fails. | ||
| """ | ||
| if not HAS_DB_DRIVER: | ||
| module.fail_json(msg=missing_required_lib('clickhouse_driver')) | ||
|
|
||
|
|
||
| def version_clickhouse_driver(): | ||
| """ | ||
| Returns the current version of clickhouse_driver. | ||
| """ | ||
| return driver_version | ||
|
|
||
|
|
||
| def connect_to_db_via_client(module, main_conn_kwargs, client_kwargs): | ||
| """Connects to DB using the Client() class. | ||
| Returns Client() object. | ||
| """ | ||
| try: | ||
| # Merge the kwargs as Python 2 would through an error | ||
| # when unpaking them separately to Client() | ||
| client_kwargs.update(main_conn_kwargs) | ||
| client = Client(**client_kwargs) | ||
| except Exception as e: | ||
| module.fail_json(msg="Failed to connect to database: %s" % to_native(e)) | ||
|
|
||
| return client | ||
|
|
||
|
|
||
| def execute_query(module, client, query, execute_kwargs=None): | ||
| """Execute query. | ||
| Returns rows returned in response. | ||
| """ | ||
| # Some modules do not pass this argument | ||
| if execute_kwargs is None: | ||
| execute_kwargs = {} | ||
|
|
||
| try: | ||
| result = client.execute(query, **execute_kwargs) | ||
| except Exception as e: | ||
| if "Not enough privileges" in to_native(e): | ||
| return PRIV_ERR_CODE | ||
| module.fail_json(msg="Failed to execute query: %s" % to_native(e)) | ||
|
|
||
| return result |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.