Coverage for /Users/buh/.pyenv/versions/3.12.2/envs/es-testbed/lib/python3.12/site-packages/es_testbed/mgrs/templatemgr.py: 96%

28 statements  

« prev     ^ index     » next       coverage.py v7.4.4, created at 2024-05-02 11:57 -0600

1"""Index Template Entity Manager Class""" 

2 

3import typing as t 

4from .entitymgr import EntityMgr 

5from ..exceptions import ResultNotExpected 

6from ..helpers.es_api import exists, put_idx_tmpl 

7from ..helpers.utils import getlogger 

8 

9if t.TYPE_CHECKING: 

10 from elasticsearch8 import Elasticsearch 

11 from dotmap import DotMap 

12 

13# pylint: disable=missing-docstring,too-many-arguments 

14 

15 

16class TemplateMgr(EntityMgr): 

17 """Index Template entity manager""" 

18 

19 kind = 'template' 

20 listname = 'index_templates' 

21 

22 def __init__( 

23 self, 

24 client: t.Union['Elasticsearch', None] = None, 

25 plan: t.Union['DotMap', None] = None, 

26 ): 

27 self.logger = getlogger('es_testbed.TemplateMgr') 

28 super().__init__(client=client, plan=plan) 

29 

30 @property 

31 def patterns(self) -> t.Sequence[str]: 

32 """Return the list of index patterns associated with this template""" 

33 _ = [] 

34 _.append(f"{self.get_pattern('index')}*") 

35 _.append(f"{self.get_pattern('data_stream')}*") 

36 return _ 

37 

38 def get_pattern(self, kind: str) -> str: 

39 """Return the a formatted index search pattern string""" 

40 return f'{self.plan.prefix}-{self.ident(dkey=kind)}-{self.plan.uniq}' 

41 

42 def setup(self) -> None: 

43 """Setup the entity manager""" 

44 ds = {} if self.plan.type == 'data_stream' else None 

45 put_idx_tmpl( 

46 self.client, 

47 self.name, 

48 self.patterns, 

49 components=self.plan.component_templates, 

50 data_stream=ds, 

51 ) 

52 if not exists(self.client, self.kind, self.name): 

53 raise ResultNotExpected( 

54 f'Unable to verify creation of index template {self.name}' 

55 ) 

56 self.appender(self.name) 

57 self.logger.info('Successfully created index template: %s', self.last) 

58 self.success = True