def test_pipeline_builder(self):
"""Test the pipeline builder"""
# preset
preset = Pipeline([{'find': 1}])
pipeline_builder = PipelineBuilder(preset)
assert pipeline_builder.pipeline == preset
# clear
empty = Pipeline([])
pipeline_builder.clear()
assert pipeline_builder.pipeline == empty
class PipelineBuilder(Builder):
"""Pipeline query builder for database aggregation search"""
def __init__(self, pipeline: Pipeline = None):
"""Init constructor
Args:
pipeline: preset a for defined pipeline
"""
self._pipeline = pipeline or Pipeline([])
def __len__(self) -> int:
"""Get the number of aggregate pipes inside the pipeline
Returns (int): number of pipes
"""
return len(self.pipeline)
def clear(self):
"""Clear the pipeline"""
self.pipeline = Pipeline([])
@property
def pipeline(self) -> Pipeline:
return self._pipeline
@pipeline.setter
def pipeline(self, pipes: List[dict]):
self._pipeline = Pipeline(pipes)
def add_pipe(self, pipe: dict):
"""Add a pipe to the pipeline"""
self.pipeline.append(pipe)
def remove_pipe(self, pipe: dict):
"""Remove a pipe to the pipeline"""
self.pipeline.remove(pipe)
def build(self, *args, **kwargs) -> Pipeline:
raise NotImplementedError
def pipeline(self, pipes: List[dict]):
self._pipeline = Pipeline(pipes)
def clear(self):
"""Clear the pipeline"""
self.pipeline = Pipeline([])
def __init__(self, pipeline: Pipeline = None):
"""Init constructor
Args:
pipeline: preset a for defined pipeline
"""
self._pipeline = pipeline or Pipeline([])
class PipelineBuilder(Builder):
"""Pipeline query builder for database aggregation search"""
def __init__(self, pipeline: Pipeline = None):
"""Init constructor
Args:
pipeline: preset a for defined pipeline
"""
self._pipeline = pipeline or Pipeline([])
def __len__(self) -> int:
"""Get the number of aggregate pipes inside the pipeline
Returns (int): number of pipes
"""
return len(self.pipeline)
def clear(self):
"""Clear the pipeline"""
self.pipeline = Pipeline([])
@property
def pipeline(self) -> Pipeline:
return self._pipeline
@pipeline.setter
def pipeline(self, pipes: List[dict]):
self._pipeline = Pipeline(pipes)
def add_pipe(self, pipe: dict):
"""Add a pipe to the pipeline"""
self.pipeline.append(pipe)
def remove_pipe(self, pipe: dict):
"""Remove a pipe to the pipeline"""
self.pipeline.remove(pipe)
def get_regex_pipes_values(self) -> List[str]:
"""Extract the regex pipes value from the pipeline"""
regex_pipes: List[str] = []
def gen_dict_extract(key, var) -> str:
for k, v in var.items():
if k == key:
yield v
if isinstance(v, dict):
for result in gen_dict_extract(key, v):
yield result
elif isinstance(v, list):
for d in v:
for result in gen_dict_extract(key, d):
yield result
for pipe in self.pipeline:
pipe_extract = []
extract_generator = gen_dict_extract('$regex', pipe)
while True:
try:
pipe_extract.append(next(extract_generator))
except StopIteration:
break
except Exception:
continue
if len(pipe_extract) > 0:
for px in pipe_extract:
regex_pipes.append(px)
return regex_pipes
def build(self, params: List[SearchParam],
obj_manager: CmdbObjectManager = None,
active_flag: bool = False) -> Pipeline:
"""Build a pipeline query out of frontend params"""
# clear pipeline
self.clear()
# fetch only active objects
if active_flag:
self.add_pipe(self.match_({'active': {"$eq": True}}))
# text builds
text_params = [_ for _ in params if _.search_form == 'text']
for param in text_params:
regex = self.regex_('fields.value', param.search_text, 'ims')
self.add_pipe(self.match_(regex))
# type builds
type_params = [_ for _ in params if _.search_form == 'type']
for param in type_params:
if param.settings and len(param.settings.get('types', [])) > 0:
type_id_in = self.in_('type_id', param.settings['types'])
self.add_pipe(self.match_(type_id_in))
# category builds
category_params = [_ for _ in params if _.search_form == 'category']
for param in category_params:
if param.settings and len(param.settings.get('categories', [])) > 0:
type_list = obj_manager.get_types_by(**self.in_('category_id', param.settings['categories']))
type_ids = []
for curr_type in type_list:
type_ids.append(curr_type.get_public_id())
type_id_in = self.in_('type_id', type_ids)
self.add_pipe(self.match_(type_id_in))
# public builds
id_params = [_ for _ in params if _.search_form == 'publicID']
for param in id_params:
self.add_pipe(self.match_({'public_id': int(param.search_text)}))
return self.pipeline