Coverage for portality / ui / debug_toolbar.py: 97%

1from flask_debugtoolbar import DebugToolbarExtension 

2from flask_debugtoolbar.panels import DebugPanel 

3 

4from portality.lib import paths 

5 

6 

7class BranchNamePanel(DebugPanel): 

8 name = 'branch_name' 

9 has_content = True 

10 

11 def get_branch_name(self): 

12 _git_head_file = paths.get_project_root().joinpath('.git/HEAD') 

13 if _git_head_file.is_file(): 

14 return (_git_head_file.read_text() 

15 .strip().replace('ref: refs/heads/', '') 

16 .replace('ref: ', '')) 

17 return 'Unknown, git HEAD not found ' 

18 

19 def nav_title(self): 

20 return 'Branch name' 

21 

22 def title(self): 

23 return 'Branch name' 

24 

25 def nav_subtitle(self): 

26 return self.get_branch_name() 

27 

28 def url(self): 

29 return '' 

30 

31 def content(self): 

32 return f'<h1 style="font-size: 30px;">{self.get_branch_name()}</h1>' 

33 

34 

35class DoajDebugToolbar(DebugToolbarExtension): 

36 

37 def _default_config(self, app): 

38 config = super()._default_config(app) 

39 

40 # add branch name panel 

41 config['DEBUG_TB_PANELS'] += (f'{BranchNamePanel.__module__}.{BranchNamePanel.__name__}',) 

42 

43 # remove env list panel if not enabled 

44 key_env_list = 'flask_debugtoolbar.panels.config_vars.ConfigVarsDebugPanel' 

45 panels = list(config['DEBUG_TB_PANELS']) 

46 

47 if not app.config.get('DEBUG_TB_ENV_LIST_ENABLED', False) and key_env_list in panels: 

48 panels.remove(key_env_list) 

49 config['DEBUG_TB_PANELS'] = tuple(panels) 

50 

51 return config