-
Notifications
You must be signed in to change notification settings - Fork 0
/
base_util.py
201 lines (167 loc) · 7.15 KB
/
base_util.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
from typing import Any, List
from yacs.config import CfgNode
import subprocess
import os
from pathlib import Path
import logging
import hashlib
LOG_FORMAT = "%(asctime)s|%(levelname)s|%(process)d|%(module)s|%(funcName)s|%(lineno)d|%(message)s"
logger = logging.getLogger(__name__)
def validate_config(config: CfgNode, validate_file_paths: bool = True) -> bool:
try:
__validate_environment_variables()
except AssertionError as e:
print("Error malconfigured worker: env vars incomplete")
print(str(e))
return False
parent_dirs_to_check: List[str] = [] # parent dirs of file paths must exist
# check the DANE.cfg (supplied by config.yml)
try:
# rabbitmq settings
assert config.RABBITMQ, "RABBITMQ"
assert check_setting(config.RABBITMQ.HOST, str), "RABBITMQ.HOST"
assert check_setting(config.RABBITMQ.PORT, int), "RABBITMQ.PORT"
assert check_setting(config.RABBITMQ.EXCHANGE, str), "RABBITMQ.EXCHANGE"
assert check_setting(
config.RABBITMQ.RESPONSE_QUEUE, str
), "RABBITMQ.RESPONSE_QUEUE"
assert check_setting(config.RABBITMQ.USER, str), "RABBITMQ.USER"
assert check_setting(config.RABBITMQ.PASSWORD, str), "RABBITMQ.PASSWORD"
# Elasticsearch settings
assert config.ELASTICSEARCH, "ELASTICSEARCH"
assert check_setting(config.ELASTICSEARCH.HOST, list), "ELASTICSEARCH.HOST"
assert (
len(config.ELASTICSEARCH.HOST) == 1
and type(config.ELASTICSEARCH.HOST[0]) is str
), "Invalid ELASTICSEARCH.HOST"
assert check_setting(config.ELASTICSEARCH.PORT, int), "ELASTICSEARCH.PORT"
assert check_setting(config.ELASTICSEARCH.USER, str, True), "ELASTICSEARCH.USER"
assert check_setting(
config.ELASTICSEARCH.PASSWORD, str, True
), "ELASTICSEARCH.PASSWORD"
assert check_setting(config.ELASTICSEARCH.SCHEME, str), "ELASTICSEARCH.SCHEME"
assert check_setting(config.ELASTICSEARCH.INDEX, str), "ELASTICSEARCH.INDEX"
# DANE python lib settings
assert config.PATHS, "PATHS"
assert check_setting(config.PATHS.TEMP_FOLDER, str), "PATHS.TEMP_FOLDER"
assert check_setting(config.PATHS.OUT_FOLDER, str), "PATHS.OUT_FOLDER"
# the FILE_SYSTEM sub config
assert config.FILE_SYSTEM, "FILE_SYSTEM"
assert check_setting(
config.FILE_SYSTEM.BASE_MOUNT, str
), "FILE_SYSTEM.BASE_MOUNT"
assert check_setting(config.FILE_SYSTEM.INPUT_DIR, str), "FILE_SYSTEM.INPUT_DIR"
assert check_setting(
config.FILE_SYSTEM.OUTPUT_DIR, str
), "FILE_SYSTEM.OUTPUT_DIR"
# Settings for this DANE worker
assert config.VISXP_PREP, "VISXP_PREP sub-config missing"
assert check_setting(
config.VISXP_PREP.RUN_KEYFRAME_EXTRACTION, bool
), "VISXP_PREP.RUN_KEYFRAME_EXTRACTION"
assert check_setting(
config.VISXP_PREP.RUN_AUDIO_EXTRACTION, bool
), "VISXP_PREP.RUN_AUDIO_EXTRACTION"
assert check_setting(
config.VISXP_PREP.SPECTROGRAM_WINDOW_SIZE_MS, int
), "VISXP_PREP.SPECTROGRAM_WINDOW_SIZE_MS"
assert check_setting(
config.VISXP_PREP.SPECTROGRAM_SAMPLERATE_HZ, list
), "VISXP_PREP.SPECTROGRAM_SAMPLERATE_HZ"
assert check_setting(
config.VISXP_PREP.TEST_INPUT_FILE, str, True
), "VISXP_PREP.TEST_INPUT_FILE"
# settings for input & output handling
assert config.INPUT, "INPUT"
assert check_setting(
config.INPUT.DELETE_ON_COMPLETION, bool
), "INPUT.DELETE_ON_COMPLETION"
assert config.OUTPUT, "OUTPUT"
assert check_setting(
config.OUTPUT.DELETE_ON_COMPLETION, bool
), "OUTPUT.DELETE_ON_COMPLETION"
assert check_setting(
config.OUTPUT.TRANSFER_ON_COMPLETION, bool
), "OUTPUT.TRANSFER_ON_COMPLETION"
if config.OUTPUT.TRANSFER_ON_COMPLETION:
# required only in case output must be transferred
assert check_setting(
config.OUTPUT.S3_ENDPOINT_URL, str
), "OUTPUT.S3_ENDPOINT_URL"
assert check_setting(config.OUTPUT.S3_BUCKET, str), "OUTPUT.S3_BUCKET"
assert check_setting(
config.OUTPUT.S3_FOLDER_IN_BUCKET, str
), "OUTPUT.S3_FOLDER_IN_BUCKET"
if "DANE_DEPENDENCIES" in config:
assert __check_dane_dependencies(
config.DANE_DEPENDENCIES
), "DANE_DEPENDENCIES"
# validate file paths (not while unit testing)
if validate_file_paths:
__validate_parent_dirs(parent_dirs_to_check)
__validate_dane_paths(config.PATHS.TEMP_FOLDER, config.PATHS.OUT_FOLDER)
except AssertionError as e:
print(f"Configuration error: {str(e)}")
return False
return True
def __validate_environment_variables() -> None:
# self.UNIT_TESTING = os.getenv('DW_ASR_UNIT_TESTING', False)
try:
assert True # TODO add secrets from the config.yml to the env
except AssertionError as e:
raise (e)
def __validate_dane_paths(dane_temp_folder: str, dane_out_folder: str) -> None:
i_dir = Path(dane_temp_folder)
o_dir = Path(dane_out_folder)
try:
assert os.path.exists(
i_dir.parent.absolute()
), f"{i_dir.parent.absolute()} does not exist"
assert os.path.exists(
o_dir.parent.absolute()
), f"{o_dir.parent.absolute()} does not exist"
except AssertionError as e:
raise (e)
def check_setting(setting: Any, t: type, optional=False) -> bool:
return (type(setting) is t and optional is False) or (
optional and (setting is None or type(setting) is t)
)
def __check_dane_dependencies(deps: Any) -> bool:
deps_to_check: list = deps if type(deps) is list else []
deps_allowed = ["DOWNLOAD"]
return any(dep in deps_allowed for dep in deps_to_check)
def __validate_parent_dirs(paths: list) -> None:
try:
for p in paths:
assert os.path.exists(
Path(p).parent.absolute()
), f"Parent dir of file does not exist: {p}"
except AssertionError as e:
raise (e)
def run_shell_command(cmd: str) -> bytes:
"""Run cmd and return stdout"""
logger.info(cmd)
try:
process = subprocess.Popen(
cmd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
shell=True, # needed to support file glob
)
stdout, stderr = process.communicate()
assert process.returncode == 0
logger.debug(stdout)
logger.error(stderr)
logger.info("Process is done: return stdout")
return stdout
except AssertionError:
logger.error("Subprocess call was not successful. Abort.")
raise
except subprocess.CalledProcessError:
logger.exception("CalledProcessError")
raise Exception # TODO use appropriate exception
except Exception:
logger.exception("Exception")
raise Exception # TODO use appropriate exception
def hash_string(s: str) -> str:
return hashlib.sha224("{0}".format(s).encode("utf-8")).hexdigest()