-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathconfigurator.py
executable file
·1298 lines (962 loc) · 41.7 KB
/
configurator.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#! /usr/bin/env python3
'''
configurator.py
- Helps with Senzing configuration.
'''
# Import from standard library. https://docs.python.org/3/library/
import argparse
import json
import linecache
import logging
import os
import shutil
import signal
import string
import sys
import time
from enum import IntFlag
from urllib.parse import urlparse, urlunparse
# Import from https://pypi.org/
from flask import Flask, Response, json
from flask import request as flask_request
from flask_api import status
# Import Senzing libraries.
# Determine "Major" version of Senzing SDK.
SENZING_SDK_VERSION_MAJOR = None
# Import from Senzing.
try:
from senzing import G2Config, G2ConfigMgr, G2Engine, G2EngineFlags, G2Exception, G2ModuleException
SENZING_SDK_VERSION_MAJOR = 3
except Exception:
# Fall back to pre-Senzing-Python-SDK style of imports.
try:
from G2Config import G2Config
from G2ConfigMgr import G2ConfigMgr
from G2Engine import G2Engine
from G2Exception import G2Exception, G2ModuleException
# Create a class like what is seen in Senzing Version 3.
class G2EngineFlags(IntFlag):
''' Create an object similar to what is seen in Senzing V2. '''
G2_EXPORT_DEFAULT_FLAGS = G2Engine.G2_EXPORT_DEFAULT_FLAGS
SENZING_SDK_VERSION_MAJOR = 2
except Exception:
SENZING_SDK_VERSION_MAJOR = None
# Flask application.
APP = Flask(__name__)
# Metadata
__all__ = []
__version__ = "1.1.9" # See https://www.python.org/dev/peps/pep-0396/
__date__ = '2019-09-06'
__updated__ = '2023-04-03'
SENZING_PRODUCT_ID = "5009" # See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-product-ids.md
LOG_FORMAT = '%(asctime)s %(message)s'
# Working with bytes.
KILOBYTES = 1024
MEGABYTES = 1024 * KILOBYTES
GIGABYTES = 1024 * MEGABYTES
# Lists from https://www.ietf.org/rfc/rfc1738.txt
SAFE_CHARACTER_LIST = ['$', '-', '_', '.', '+', '!', '*', '(', ')', ',', '"'] + list(string.ascii_letters)
UNSAFE_CHARACTER_LIST = ['"', '<', '>', '#', '%', '{', '}', '|', '\\', '^', '~', '[', ']', '`']
RESERVED_CHARACTER_LIST = [';', ',', '/', '?', ':', '@', '=', '&']
# The "configuration_locator" describes where configuration variables are in:
# 1) Command line options, 2) Environment variables, 3) Configuration files, 4) Default values
GLOBAL_CONFIG = {}
CONFIGURATION_LOCATOR = {
"config_path": {
"default": "/etc/opt/senzing",
"env": "SENZING_CONFIG_PATH",
"cli": "config-path"
},
"debug": {
"default": False,
"env": "SENZING_DEBUG",
"cli": "debug"
},
"engine_configuration_json": {
"default": None,
"env": "SENZING_ENGINE_CONFIGURATION_JSON",
"cli": "engine-configuration-json"
},
"g2_database_url_generic": {
"default": "sqlite3://na:na@/var/opt/senzing/sqlite/G2C.db",
"env": "SENZING_DATABASE_URL",
"cli": "database-url"
},
"g2_internal_database": {
"default": None,
"env": "SENZING_INTERNAL_DATABASE",
"cli": "internal-database"
},
"host": {
"default": "0.0.0.0",
"env": "SENZING_HOST",
"cli": "host"
},
"port": {
"default": 8253,
"env": "SENZING_PORT",
"cli": "port"
},
"resource_path": {
"default": "/opt/senzing/g2/resources",
"env": "SENZING_RESOURCE_PATH",
"cli": "resource-path"
},
"sleep_time_in_seconds": {
"default": 0,
"env": "SENZING_SLEEP_TIME_IN_SECONDS",
"cli": "sleep-time-in-seconds"
},
"subcommand": {
"default": None,
"env": "SENZING_SUBCOMMAND",
},
"support_path": {
"default": "/opt/senzing/data",
"env": "SENZING_SUPPORT_PATH",
"cli": "support-path"
}
}
# Enumerate keys in 'configuration_locator' that should not be printed to the log.
KEYS_TO_REDACT = [
"engine_configuration_json",
"g2_database_url_generic",
"g2_database_url_specific"
]
# Global cached objects
G2_CONFIGURATION_MANAGER_SINGLETON = None
G2_ENGINE_SINGLETON = None
G2_CONFIG_SINGLETON = None
# -----------------------------------------------------------------------------
# Define argument parser
# -----------------------------------------------------------------------------
def get_parser():
''' Parse commandline arguments. '''
subcommands = {
'service': {
"help": 'Receive HTTP requests.',
"arguments": {
"--config-path": {
"dest": "config_path",
"metavar": "SENZING_CONFIG_PATH",
"help": "Location of Senzing's configuration template. Default: /opt/senzing/g2/data"
},
"--database-url": {
"dest": "g2_database_url_generic",
"metavar": "SENZING_DATABASE_URL",
"help": "Information for connecting to database."
},
"--debug": {
"dest": "debug",
"action": "store_true",
"help": "Enable debugging. (SENZING_DEBUG) Default: False"
},
"--host": {
"dest": "host",
"metavar": "SENZING_HOST",
"help": "Host to listen on. Default: 0.0.0.0"
},
"--port": {
"dest": "port",
"metavar": "SENZING_PORT",
"help": "Port to listen on. Default: 8080"
},
"--support-path": {
"dest": "support_path",
"metavar": "SENZING_SUPPORT_PATH",
"help": "Location of Senzing's support. Default: /opt/senzing/g2/data"
},
},
},
'sleep': {
"help": 'Do nothing but sleep. For Docker testing.',
"arguments": {
"--sleep-time-in-seconds": {
"dest": "sleep_time_in_seconds",
"metavar": "SENZING_SLEEP_TIME_IN_SECONDS",
"help": "Sleep time in seconds. DEFAULT: 0 (infinite)"
},
},
},
'version': {
"help": 'Print version of configurator.py.',
},
'docker-acceptance-test': {
"help": 'For Docker acceptance testing.',
},
}
parser = argparse.ArgumentParser(prog="configurator.py", description="Perform Senzing configuration. For more information, see https://github.com/senzing-garage/configurator")
subparsers = parser.add_subparsers(dest='subcommand', help='Subcommands (SENZING_SUBCOMMAND):')
for subcommand_key, subcommand_values in subcommands.items():
subcommand_help = subcommand_values.get('help', "")
subcommand_arguments = subcommand_values.get('arguments', {})
subparser = subparsers.add_parser(subcommand_key, help=subcommand_help)
for argument_key, argument_values in subcommand_arguments.items():
subparser.add_argument(argument_key, **argument_values)
return parser
# -----------------------------------------------------------------------------
# Message handling
# -----------------------------------------------------------------------------
# 1xx Informational (i.e. logging.info())
# 3xx Warning (i.e. logging.warning())
# 5xx User configuration issues (either logging.warning() or logging.err() for Client errors)
# 7xx Internal error (i.e. logging.error for Server errors)
# 9xx Debugging (i.e. logging.debug())
MESSAGE_INFO = 100
MESSAGE_WARN = 300
MESSAGE_ERROR = 700
MESSAGE_DEBUG = 900
MESSAGE_DICTIONARY = {
"100": "senzing-" + SENZING_PRODUCT_ID + "{0:04d}I",
"101": "Adding datasource '{0}'. Response: {1}",
"104": "CONFIG_DATA_ID: {0} plus datasources: {1}",
"105": "CONFIG_DATA_ID: {0} passed validity tests.",
"292": "Configuration change detected. Old: {0} New: {1}",
"293": "For information on warnings and errors, see https://github.com/senzing-garage/configurator#errors",
"294": "Version: {0} Updated: {1}",
"295": "Sleeping infinitely.",
"296": "Sleeping {0} seconds.",
"297": "Enter {0}",
"298": "Exit {0}",
"299": "{0}",
"300": "senzing-" + SENZING_PRODUCT_ID + "{0:04d}W",
"301": "SYS_CFG.CONFIG_DATA_ID: {0} did not pass initialization validation.",
"302": "SYS_CFG.CONFIG_DATA_ID: {0} did not pass search validation.",
"499": "{0}",
"500": "senzing-" + SENZING_PRODUCT_ID + "{0:04d}E",
"695": "Unknown database scheme '{0}' in database url '{1}'",
"696": "Bad SENZING_SUBCOMMAND: {0}.",
"697": "No processing done.",
"698": "Program terminated with error.",
"699": "{0}",
"700": "senzing-" + SENZING_PRODUCT_ID + "{0:04d}E",
"701": "Error '{0}' caused by {1} error '{2}'",
"886": "G2Engine.addRecord() bad return code: {0}; JSON: {1}",
"888": "G2Engine.addRecord() G2ModuleNotInitialized: {0}; JSON: {1}",
"889": "G2Engine.addRecord() G2ModuleGenericException: {0}; JSON: {1}",
"890": "G2Engine.addRecord() Exception: {0}; JSON: {1}",
"891": "Original and new database URLs do not match. Original URL: {0}; Reconstructed URL: {1}",
"892": "Could not initialize G2Product with '{0}'. Error: {1}",
"893": "Could not initialize G2Hasher with '{0}'. Error: {1}",
"894": "Could not initialize G2Diagnostic with '{0}'. Error: {1}",
"895": "Could not initialize G2Audit with '{0}'. Error: {1}",
"896": "Could not initialize G2ConfigMgr with '{0}'. Error: {1}",
"897": "Could not initialize G2Config with '{0}'. Error: {1}",
"898": "Could not initialize G2Engine with '{0}'. Error: {1}",
"899": "{0}",
"900": "senzing-" + SENZING_PRODUCT_ID + "{0:04d}D",
"901": "Signal: {0}; Frame: {1}",
"902": "Subcommand: {0}; Args: {1}",
"998": "Debugging enabled.",
"999": "{0}",
}
def message(index, *args):
''' Return an instantiated message. '''
index_string = str(index)
template = MESSAGE_DICTIONARY.get(index_string, "No message for index {0}.".format(index_string))
return template.format(*args)
def message_generic(generic_index, index, *args):
''' Return a formatted message. '''
return "{0} {1}".format(message(generic_index, index), message(index, *args))
def message_info(index, *args):
''' Return an info message. '''
return message_generic(MESSAGE_INFO, index, *args)
def message_warning(index, *args):
''' Return a warning message. '''
return message_generic(MESSAGE_WARN, index, *args)
def message_error(index, *args):
''' Return an error message. '''
return message_generic(MESSAGE_ERROR, index, *args)
def message_debug(index, *args):
''' Return a debug message. '''
return message_generic(MESSAGE_DEBUG, index, *args)
def get_exception():
''' Get details about an exception. '''
exception_type, exception_object, traceback = sys.exc_info()
frame = traceback.tb_frame
line_number = traceback.tb_lineno
filename = frame.f_code.co_filename
linecache.checkcache(filename)
line = linecache.getline(filename, line_number, frame.f_globals)
return {
"filename": filename,
"line_number": line_number,
"line": line.strip(),
"exception": exception_object,
"type": exception_type,
"traceback": traceback,
}
# -----------------------------------------------------------------------------
# Database URL parsing
# -----------------------------------------------------------------------------
def translate(mapping, astring):
''' Translate characters. '''
new_string = str(astring)
for key, value in mapping.items():
new_string = new_string.replace(key, value)
return new_string
def get_unsafe_characters(astring):
''' Return the list of unsafe characters found in astring. '''
result = []
for unsafe_character in UNSAFE_CHARACTER_LIST:
if unsafe_character in astring:
result.append(unsafe_character)
return result
def get_safe_characters(astring):
''' Return the list of safe characters found in astring. '''
result = []
for safe_character in SAFE_CHARACTER_LIST:
if safe_character not in astring:
result.append(safe_character)
return result
def parse_database_url(original_senzing_database_url):
''' Given a canonical database URL, decompose into URL components. '''
result = {}
# Get the value of SENZING_DATABASE_URL environment variable.
senzing_database_url = original_senzing_database_url
# Create lists of safe and unsafe characters.
unsafe_characters = get_unsafe_characters(senzing_database_url)
safe_characters = get_safe_characters(senzing_database_url)
# Detect an error condition where there are not enough safe characters.
if len(unsafe_characters) > len(safe_characters):
logging.error(message_error(730, unsafe_characters, safe_characters))
return result
# Perform translation.
# This makes a map of safe character mapping to unsafe characters.
# "senzing_database_url" is modified to have only safe characters.
translation_map = {}
safe_characters_index = 0
for unsafe_character in unsafe_characters:
safe_character = safe_characters[safe_characters_index]
safe_characters_index += 1
translation_map[safe_character] = unsafe_character
senzing_database_url = senzing_database_url.replace(unsafe_character, safe_character)
# Parse "translated" URL.
parsed = urlparse(senzing_database_url)
schema = parsed.path.strip('/')
# Construct result.
result = {
'scheme': translate(translation_map, parsed.scheme),
'netloc': translate(translation_map, parsed.netloc),
'path': translate(translation_map, parsed.path),
'params': translate(translation_map, parsed.params),
'query': translate(translation_map, parsed.query),
'fragment': translate(translation_map, parsed.fragment),
'username': translate(translation_map, parsed.username),
'password': translate(translation_map, parsed.password),
'hostname': translate(translation_map, parsed.hostname),
'port': translate(translation_map, parsed.port),
'schema': translate(translation_map, schema),
}
# For safety, compare original URL with reconstructed URL.
url_parts = [
result.get('scheme'),
result.get('netloc'),
result.get('path'),
result.get('params'),
result.get('query'),
result.get('fragment'),
]
test_senzing_database_url = urlunparse(url_parts)
if test_senzing_database_url != original_senzing_database_url:
logging.warning(message_warning(891, original_senzing_database_url, test_senzing_database_url))
# Return result.
return result
# -----------------------------------------------------------------------------
# Configuration
# -----------------------------------------------------------------------------
def get_g2_database_url_specific(generic_database_url):
''' Given a canonical database URL, transform to the specific URL. '''
result = ""
parsed_database_url = parse_database_url(generic_database_url)
scheme = parsed_database_url.get('scheme')
# Format database URL for a particular database.
if scheme in ['mysql']:
result = "{scheme}://{username}:{password}@{hostname}:{port}/?schema={schema}".format(**parsed_database_url)
elif scheme in ['postgresql']:
result = "{scheme}://{username}:{password}@{hostname}:{port}:{schema}/".format(**parsed_database_url)
elif scheme in ['db2']:
result = "{scheme}://{username}:{password}@{schema}".format(**parsed_database_url)
elif scheme in ['sqlite3']:
result = "{scheme}://{netloc}{path}".format(**parsed_database_url)
elif scheme in ['mssql']:
result = "{scheme}://{username}:{password}@{schema}".format(**parsed_database_url)
else:
logging.error(message_error(695, scheme, generic_database_url))
return result
def get_configuration(subcommand, args):
''' Order of precedence: CLI, OS environment variables, INI file, default. '''
result = {}
# Copy default values into configuration dictionary.
for key, value in list(CONFIGURATION_LOCATOR.items()):
result[key] = value.get('default', None)
# "Prime the pump" with command line args. This will be done again as the last step.
for key, value in list(args.__dict__.items()):
new_key = key.format(subcommand.replace('-', '_'))
if value:
result[new_key] = value
# Copy OS environment variables into configuration dictionary.
for key, value in list(CONFIGURATION_LOCATOR.items()):
os_env_var = value.get('env', None)
if os_env_var:
os_env_value = os.getenv(os_env_var, None)
if os_env_value:
result[key] = os_env_value
# Copy 'args' into configuration dictionary.
for key, value in list(args.__dict__.items()):
new_key = key.format(subcommand.replace('-', '_'))
if value:
result[new_key] = value
# Add program information.
result['program_version'] = __version__
result['program_updated'] = __updated__
result['senzing_sdk_version_major'] = SENZING_SDK_VERSION_MAJOR
# Special case: subcommand from command-line
if args.subcommand:
result['subcommand'] = args.subcommand
# Special case: Change boolean strings to booleans.
booleans = [
'debug'
]
for boolean in booleans:
boolean_value = result.get(boolean)
if isinstance(boolean_value, str):
boolean_value_lower_case = boolean_value.lower()
if boolean_value_lower_case in ['true', '1', 't', 'y', 'yes']:
result[boolean] = True
else:
result[boolean] = False
# Special case: Change integer strings to integers.
integers = [
'sleep_time_in_seconds'
]
for integer in integers:
integer_string = result.get(integer)
result[integer] = int(integer_string)
# Special case: Determine absolute paths.
paths = [
'config_path',
'resource_path',
'support_path',
]
for path in paths:
relative_path = result.get(path)
if relative_path:
result[path] = os.path.abspath(relative_path)
# Special case: Tailored database URL
# If requested, prepare internal database.
if result.get('g2_internal_database'):
g2_internal_database_path = result.get('g2_internal_database')
g2_internal_database_directory = os.path.dirname(g2_internal_database_path)
try:
os.makedirs(g2_internal_database_directory)
except FileExistsError:
pass
shutil.copyfile("/var/opt/senzing/g2/data/G2C.db", g2_internal_database_path)
result['g2_database_url_specific'] = "sqlite3://na:na@{0}".format(g2_internal_database_path)
else:
result['g2_database_url_specific'] = get_g2_database_url_specific(result.get("g2_database_url_generic"))
return result
def validate_configuration(config):
''' Check aggregate configuration from commandline options, environment variables, config files, and defaults. '''
user_warning_messages = []
user_error_messages = []
# Perform subcommand specific checking.
subcommand = config.get('subcommand')
if subcommand in ['service']:
if not config.get('support_path'):
user_error_messages.append(message_error(414))
# Log warning messages.
for user_warning_message in user_warning_messages:
logging.warning(user_warning_message)
# Log error messages.
for user_error_message in user_error_messages:
logging.error(user_error_message)
# Log where to go for help.
if len(user_warning_messages) > 0 or len(user_error_messages) > 0:
logging.info(message_info(293))
# If there are error messages, exit.
if len(user_error_messages) > 0:
exit_error(697)
def redact_configuration(config):
''' Return a shallow copy of config with certain keys removed. '''
result = config.copy()
for key in KEYS_TO_REDACT:
try:
result.pop(key)
except Exception:
pass
return result
# -----------------------------------------------------------------------------
# Class: G2Client
# -----------------------------------------------------------------------------
class G2Client:
'''
Create a Facade software design pattern as a client of Senzing.
Synthesizes the use of G2Engine, G2Config, and G2ConfigurationManager.
'''
def __init__(self, config, g2_engine, g2_configuration_manager, g2_config):
self.config = config
self.g2_config = g2_config
self.g2_configuration_manager = g2_configuration_manager
self.g2_engine = g2_engine
self.senzing_sdk_version_major = config.get("senzing_sdk_version_major")
# Must run after instance variable are set.
self.datasources = self.get_datasources()
def add_datasources(self, datasources):
''' Add a data source to G2 configuration. '''
config_handle = self.get_config_handle()
response_bytearray = bytearray()
# Add data sources to configuration.
for datasource in datasources:
data_source_dictionary = {
"DSRC_CODE": datasource
}
data_source_json = json.dumps(data_source_dictionary)
self.g2_config.addDataSource(config_handle, data_source_json, response_bytearray)
logging.info(message_info(101, datasource, response_bytearray.decode()))
config_id = self.get_default_config_id()
configuration_comment = message(104, config_id, datasources)
# Push configuration to database.
self.persist_configuration(config_handle, configuration_comment)
def get_config_handle(self):
''' Get configuration handle from new or existing "default" configuration. '''
# Determine if a default configuration exists.
config_id_bytearray = bytearray()
self.g2_configuration_manager.getDefaultConfigID(config_id_bytearray)
# Find the "config_handle" of the configuration, creating a new configuration if needed.
if config_id_bytearray:
config_id_int = int(config_id_bytearray)
configuration_bytearray = bytearray()
self.g2_configuration_manager.getConfig(config_id_int, configuration_bytearray)
configuration_json = configuration_bytearray.decode()
config_handle = self.g2_config.load(configuration_json)
else:
config_handle = self.g2_config.create()
return config_handle
def get_datasources(self):
''' Determine datasources already defined. '''
config_handle = self.get_config_handle()
datasources_bytearray = bytearray()
self.g2_config.listDataSources(config_handle, datasources_bytearray)
datasources_dictionary = json.loads(datasources_bytearray.decode())
return [x.get("DSRC_CODE") for x in datasources_dictionary.get("DATA_SOURCES")]
def get_default_config_id(self):
''' Get the current configuration id. SYS_CFG.CONFIG_DATA_ID'''
configuration_id_bytearray = bytearray()
self.g2_configuration_manager.getDefaultConfigID(configuration_id_bytearray)
return configuration_id_bytearray.decode()
def get_g2_configuration_dictionary(self):
''' Construct a dictionary in the form of the old ini files. '''
result = {
"PIPELINE": {
"CONFIGPATH": self.config.get("config_path"),
"RESOURCEPATH": self.config.get("resource_path"),
"SUPPORTPATH": self.config.get("support_path"),
},
"SQL": {
"CONNECTION": self.config.get("g2_database_url_specific"),
}
}
license_base64_encoded = self.config.get("license_base64_encoded")
if license_base64_encoded:
result["PIPELINE"]["LICENSESTRINGBASE64"] = license_base64_encoded
return result
def get_g2_configuration_json(self):
''' Return a JSON string with Senzing configuration. '''
result = ""
if self.config.get('engine_configuration_json'):
result = self.config.get('engine_configuration_json')
else:
result = json.dumps(self.get_g2_configuration_dictionary())
return result
def persist_configuration(self, config_handle, configuration_comment=""):
''' Save configuration to the Senzing G2 database. '''
# Get JSON string with new datasource added.
configuration_bytearray = bytearray()
self.g2_config.save(config_handle, configuration_bytearray)
configuration_json = configuration_bytearray.decode()
# Add configuration to G2 database SYS_CFG table.
configuration_id_bytearray = bytearray()
self.g2_configuration_manager.addConfig(configuration_json, configuration_comment, configuration_id_bytearray)
# Test configuration.
is_good_configuration = self.test_configuration(configuration_id_bytearray)
if not is_good_configuration:
logging.warning(message_warning(301, configuration_id_bytearray.decode()))
return
# Set Default configuration.
self.g2_configuration_manager.setDefaultConfigID(configuration_id_bytearray)
# Re-initialize G2 engine.
self.g2_engine.reinit(configuration_id_bytearray)
def test_configuration(self, configuration_id):
''' Test the configuration. '''
result = True
# Test engine initialization.
g2_engine_name = "Test g2_engine"
g2_configuration_json = self.get_g2_configuration_json()
try:
self.g2_engine.initWithConfigID(g2_engine_name, g2_configuration_json, configuration_id, self.config.get('debug', False))
except G2Exception as err:
result = False
logging.warning(message_warning(301, g2_configuration_json, err))
# Test engine search.
data = {}
data_as_json = json.dumps(data)
flags = G2EngineFlags.G2_EXPORT_DEFAULT_FLAGS
response_bytearray = bytearray()
try:
if self.config.get('senzing_sdk_version_major') == 2:
self.g2_engine.searchByAttributesV2(data_as_json, flags, response_bytearray)
else:
self.g2_engine.searchByAttributes(data_as_json, response_bytearray, flags)
except G2Exception as err:
result = False
logging.warning(message_warning(302, flags, err))
# Log a successful result.
if result:
logging.info(message_info(105, configuration_id.decode()))
# Epilog.
return result
# -----------------------------------------------------------------------------
# Class: G2Initializer
# -----------------------------------------------------------------------------
class G2Initializer:
'''
Add a default Senzing configuration into the Senzing Model.
'''
def __init__(self, g2_configuration_manager, g2_config):
self.g2_config = g2_config
self.g2_configuration_manager = g2_configuration_manager
def initialize(self):
''' Initialize the G2 database. '''
# Determine of a default/initial G2 configuration already exists.
default_config_id_bytearray = bytearray()
try:
self.g2_configuration_manager.getDefaultConfigID(default_config_id_bytearray)
except Exception as err:
raise Exception("G2ConfigMgr.getDefaultConfigID({0}) failed".format(default_config_id_bytearray)) from err
# If a default configuration exists, there is nothing more to do.
if default_config_id_bytearray:
return
# If there is no default configuration, create one in the 'configuration_bytearray' variable.
config_handle = self.g2_config.create()
configuration_bytearray = bytearray()
try:
return_code = self.g2_config.save(config_handle, configuration_bytearray)
except Exception as err:
raise Exception("G2Confg.save({0}, {1}) failed".format(config_handle, configuration_bytearray)) from err
if return_code != 0:
raise Exception("G2Confg.save({0}, {1}) return code {2}".format(config_handle, configuration_bytearray, return_code))
self.g2_config.close(config_handle)
# Save configuration JSON into G2 database.
config_comment = "Initial configuration."
new_config_id = bytearray()
try:
return_code = self.g2_configuration_manager.addConfig(configuration_bytearray.decode(), config_comment, new_config_id)
except Exception as err:
raise Exception("G2ConfigMgr.addConfig({0}, {1}, {2}) failed".format(configuration_bytearray.decode(), config_comment, new_config_id)) from err
if return_code != 0:
raise Exception("G2ConfigMgr.addConfig({0}, {1}, {2}) return code {3}".format(configuration_bytearray.decode(), config_comment, new_config_id, return_code))
# Set the default configuration ID.
try:
return_code = self.g2_configuration_manager.setDefaultConfigID(new_config_id)
except Exception as err:
raise Exception("G2ConfigMgr.setDefaultConfigID({0}) failed".format(new_config_id)) from err
if return_code != 0:
raise Exception("G2ConfigMgr.setDefaultConfigID({0}) return code {1}".format(new_config_id, return_code))
# -----------------------------------------------------------------------------
# Utility functions
# -----------------------------------------------------------------------------
def create_signal_handler_function(args):
''' Tricky code. Uses currying technique. Create a function for signal handling.
that knows about "args".
'''
def result_function(signal_number, frame):
logging.info(message_info(298, args))
logging.debug(message_debug(901, signal_number, frame))
sys.exit(0)
return result_function
def bootstrap_signal_handler(signal_number, frame):
''' Exit on signal error. '''
logging.debug(message_debug(901, signal_number, frame))
sys.exit(0)
def entry_template(config):
''' Format of entry message. '''
debug = config.get("debug", False)
config['start_time'] = time.time()
if debug:
final_config = config
else:
final_config = redact_configuration(config)
config_json = json.dumps(final_config, sort_keys=True)
return message_info(297, config_json)
def exit_template(config):
''' Format of exit message. '''
debug = config.get("debug", False)
stop_time = time.time()
config['stop_time'] = stop_time
config['elapsed_time'] = stop_time - config.get('start_time', stop_time)
if debug:
final_config = config
else:
final_config = redact_configuration(config)
config_json = json.dumps(final_config, sort_keys=True)
return message_info(298, config_json)
def exit_error(index, *args):
''' Log error message and exit program. '''
logging.error(message_error(index, *args))
logging.error(message_error(698))
sys.exit(1)
def exit_silently():
''' Exit program. '''
sys.exit(0)
# -----------------------------------------------------------------------------
# Senzing services.
# -----------------------------------------------------------------------------
def get_g2_configuration_dictionary(config):
''' Construct a dictionary in the form of the old ini files. '''
result = {
"PIPELINE": {
"CONFIGPATH": config.get("config_path"),
"RESOURCEPATH": config.get("resource_path"),
"SUPPORTPATH": config.get("support_path"),
},
"SQL": {
"CONNECTION": config.get("g2_database_url_specific"),
}
}
license_base64_encoded = config.get("license_base64_encoded")
if license_base64_encoded:
result["PIPELINE"]["LICENSESTRINGBASE64"] = license_base64_encoded
return result
def get_g2_configuration_json(config):
''' Return a JSON string with Senzing configuration. '''
result = ""
if config.get('engine_configuration_json'):
result = config.get('engine_configuration_json')
else:
result = json.dumps(get_g2_configuration_dictionary(config))
return result
def get_g2_config(config, g2_config_name="configurator-G2-config"):
''' Get the G2Config resource. '''
global G2_CONFIG_SINGLETON
if G2_CONFIG_SINGLETON:
return G2_CONFIG_SINGLETON
try:
g2_configuration_json = get_g2_configuration_json(config)
result = G2Config()
# Backport methods from earlier Senzing versions.
if config.get('senzing_sdk_version_major') == 2:
result.addDataSource = result.addDataSourceV2
result.init = result.initV2
result.listDataSources = result.listDataSourcesV2
# Initialize G2ConfigMgr.
result.init(g2_config_name, g2_configuration_json, config.get('debug', False))
except G2ModuleException as err:
exit_error(897, g2_configuration_json, err)
G2_CONFIG_SINGLETON = result
return result
def get_g2_configuration_manager(config, g2_configuration_manager_name="configurator-G2-configuration-manager"):
''' Get the G2ConfigMgr resource. '''
global G2_CONFIGURATION_MANAGER_SINGLETON
if G2_CONFIGURATION_MANAGER_SINGLETON:
return G2_CONFIGURATION_MANAGER_SINGLETON
try:
g2_configuration_json = get_g2_configuration_json(config)
result = G2ConfigMgr()
# Backport methods from earlier Senzing versions.